functional-types v0.3.5

functional-types

functional-types

functional-types

functional-types

Index

Modules

• "AnnotationPair"
• "Array/Arbitraries"
• "Array/index"
• "Comparable"
• "ComparableSchema"
• "Comparison"
• "DateTime"
• "DocumentAnnotation"
• "Excel"
• "FileType"
• "Folder/Arbitraries"
• "Folder/index"
• "Json"
• "Label"
• "Response"
• "Schema"
• "Serialize/Arbitraries"
• "Serialize/ComparableSchema"
• "Serialize/Schema"
• "Serialize/index"
• "String"
• "TableAnnotation"
• "TextAnnotation"
• "Types"
• "Vertex/Arbitraries"
• "Vertex/index"
• "Vision"
• "fp-ts/Reader"
• "fp-ts/ReaderIO"
• "fp-ts/TaskEither"
• "index"

Interfaces

functional-types › "AnnotationPair" › AnnotationPair

Interface: AnnotationPair

Hierarchy

• AnnotationPair

Index

Properties

• left
• right

Properties

left

• left: TableAnnotation

Defined in src/AnnotationPair.ts:7

right

• right: TextAnnotation

Defined in src/AnnotationPair.ts:8

functional-types › "Comparable" › Annotation

Interface: Annotation

Hierarchy

• Annotation

Index

Properties

• file

Properties

file

• file: string

Defined in src/Comparable.ts:151

functional-types › "Comparable" › Comparable

Interface: Comparable <T>

Type parameters

▪ T

Hierarchy

• Comparable

Index

Properties

• attributes
• created_at
• files
• id
• schema_id
• updated_at

Properties

attributes

• attributes: Tree‹T›

Defined in src/Comparable.ts:111

created_at

• created_at: string

Defined in src/Comparable.ts:112

files

• files: string[]

Defined in src/Comparable.ts:110

id

• id: string

Defined in src/Comparable.ts:108

schema_id

• schema_id: string

Defined in src/Comparable.ts:109

updated_at

• updated_at: string

Defined in src/Comparable.ts:113

functional-types › "Comparable" › ComparableView

Interface: ComparableView

Hierarchy

• object

  ↳ ComparableView

Index

Properties

• attributes

Properties

attributes

• attributes: TreeView

Defined in src/Comparable.ts:129

functional-types › "Comparable" › FromLeafOptions

Interface: FromLeafOptions

Hierarchy

• FromTableOptions

  ↳ FromLeafOptions

Index

Properties

• key
• mergeKey
• predicate
• splitBy

Properties

Optional key

• key? : Predicate

Inherited from FromTableOptions.key

Defined in src/Comparable.ts:139

Optional mergeKey

• mergeKey? : boolean

Inherited from FromTableOptions.mergeKey

Defined in src/Comparable.ts:140

predicate

• predicate: Predicate

Defined in src/Comparable.ts:145

splitBy

• splitBy: Direction

Inherited from FromTableOptions.splitBy

Defined in src/Comparable.ts:141

functional-types › "Comparable" › FromTableOptions

Interface: FromTableOptions

Hierarchy

• FromTableOptions

  ↳ FromLeafOptions

Index

Properties

• key
• mergeKey
• splitBy

Properties

Optional key

• key? : Predicate

Defined in src/Comparable.ts:139

Optional mergeKey

• mergeKey? : boolean

Defined in src/Comparable.ts:140

splitBy

• splitBy: Direction

Defined in src/Comparable.ts:141

functional-types › "Comparable" › Leaf

Interface: Leaf

Hierarchy

• Leaf

Index

Properties

• metadata
• value

Properties

Optional metadata

• metadata? : Metadata

Defined in src/Comparable.ts:96

value

• value: string

Defined in src/Comparable.ts:95

functional-types › "Comparable" › Metadata

Interface: Metadata

Hierarchy

• Metadata

Index

Properties

• bounding_poly
• excel_position
• json_position

Properties

Optional bounding_poly

• bounding_poly? : Poly

Defined in src/Comparable.ts:89

Optional excel_position

• excel_position? : Position

Defined in src/Comparable.ts:90

Optional json_position

• json_position? : Reference

Defined in src/Comparable.ts:91

functional-types › "Comparable" › PartitionedGettables

Interface: PartitionedGettables <T>

Type parameters

▪ T: Annotation

Hierarchy

• PartitionedGettables

Index

Properties

• annotation
• gettables

Properties

annotation

• annotation: T

Defined in src/Comparable.ts:155

gettables

• gettables: S.Gettables

Defined in src/Comparable.ts:156

functional-types › "Comparable" › Partitions

Interface: Partitions

Hierarchy

• Partitions

Index

Properties

• branchByLabel
• cellByLabel
• tableByLabel

Properties

branchByLabel

• branchByLabel: Dictionary‹Branch›

Defined in src/Comparable.ts:133

cellByLabel

• cellByLabel: Dictionary‹D.CellByName›

Defined in src/Comparable.ts:135

tableByLabel

• tableByLabel: Dictionary‹D.TableByName›

Defined in src/Comparable.ts:134

functional-types › "Comparable" › Tree

Interface: Tree <T>

Type parameters

▪ T

Hierarchy

• Tree

Indexable

• [ index: string]: Node‹T›

functional-types › "ComparableSchema" › ComparableSchema

Interface: ComparableSchema

Hierarchy

• Pair‹SchemaPath›

  ↳ ComparableSchema

Index

Properties

• created_at
• id
• left
• name
• right
• updated_at

Properties

created_at

• created_at: string

Defined in src/ComparableSchema.ts:27

id

• id: string

Defined in src/ComparableSchema.ts:25

left

• left: SchemaPath

Inherited from Pair.left

Defined in src/Types.ts:21

name

• name: string

Defined in src/ComparableSchema.ts:26

right

• right: SchemaPath

Inherited from Pair.right

Defined in src/Types.ts:22

updated_at

• updated_at: string

Defined in src/ComparableSchema.ts:28

functional-types › "Comparison" › Comparison

Interface: Comparison

Hierarchy

• object

  ↳ Comparison

Index

Properties

• file_type
• files
• schema_id

Properties

file_type

• file_type: Pair‹DocumentType›

Defined in src/Comparison.ts:32

files

• files: Pair‹string[]›

Defined in src/Comparison.ts:30

schema_id

• schema_id: Pair‹string›

Defined in src/Comparison.ts:31

functional-types › "Comparison" › Leaf

Interface: Leaf

Hierarchy

• Leaf

Index

Properties

• details
• label
• metadata
• order
• severity
• value

Properties

details

• details: string

Defined in src/Comparison.ts:18

label

• label: string

Defined in src/Comparison.ts:16

metadata

• metadata: Metadata

Defined in src/Comparison.ts:21

order

• order: Pair‹number›

Defined in src/Comparison.ts:20

severity

• severity: Severity

Defined in src/Comparison.ts:17

value

• value: Pair‹string›

Defined in src/Comparison.ts:19

functional-types › "DocumentAnnotation" › Branch

Interface: Branch

Hierarchy

• Node

  ↳ Branch

  ↳ Descendant

Index

Properties

• boundingPoly
• children
• id
• label
• parent

Properties

boundingPoly

• boundingPoly: Poly

Inherited from Node.boundingPoly

Defined in src/DocumentAnnotation.ts:73

children

• children: Tree[]

Defined in src/DocumentAnnotation.ts:107

id

• id: string

Inherited from Node.id

Defined in src/DocumentAnnotation.ts:71

label

• label: string

Inherited from Node.label

Defined in src/DocumentAnnotation.ts:72

Optional parent

• parent? : Branch

Defined in src/DocumentAnnotation.ts:106

functional-types › "DocumentAnnotation" › Cell

Interface: Cell

Hierarchy

• Node

  ↳ Cell

  ↳ TableCell

Index

Properties

• boundingPoly
• id
• label
• text
• words

Properties

boundingPoly

• boundingPoly: Poly

Inherited from Node.boundingPoly

Defined in src/DocumentAnnotation.ts:73

id

• id: string

Inherited from Node.id

Defined in src/DocumentAnnotation.ts:71

label

• label: string

Inherited from Node.label

Defined in src/DocumentAnnotation.ts:72

text

• text: string

Defined in src/DocumentAnnotation.ts:78

words

• words: Word[]

Defined in src/DocumentAnnotation.ts:77

functional-types › "DocumentAnnotation" › Descendant

Interface: Descendant

Hierarchy

↳ Branch

↳ Descendant

Index

Properties

• boundingPoly
• children
• id
• label
• parent

Properties

boundingPoly

• boundingPoly: Poly

Inherited from Node.boundingPoly

Defined in src/DocumentAnnotation.ts:73

children

• children: Leaf[]

Overrides Branch.children

Defined in src/DocumentAnnotation.ts:111

id

• id: string

Inherited from Node.id

Defined in src/DocumentAnnotation.ts:71

label

• label: string

Inherited from Node.label

Defined in src/DocumentAnnotation.ts:72

Optional parent

• parent? : Branch

Inherited from Branch.parent

Defined in src/DocumentAnnotation.ts:106

functional-types › "DocumentAnnotation" › DocumentAnnotation

Interface: DocumentAnnotation

Hierarchy

• DocumentAnnotation

Index

Properties

• created_at
• file
• forestByPage
• id
• updated_at

Properties

created_at

• created_at: string

Defined in src/DocumentAnnotation.ts:126

file

• file: string

Defined in src/DocumentAnnotation.ts:124

forestByPage

• forestByPage: ForestByPage

Defined in src/DocumentAnnotation.ts:125

id

• id: string

Defined in src/DocumentAnnotation.ts:123

updated_at

• updated_at: string

Defined in src/DocumentAnnotation.ts:127

functional-types › "DocumentAnnotation" › Node

Interface: Node

Hierarchy

• Node

  ↳ Cell

  ↳ Table

  ↳ Branch

Index

Properties

• boundingPoly
• id
• label

Properties

boundingPoly

• boundingPoly: Poly

Defined in src/DocumentAnnotation.ts:73

id

• id: string

Defined in src/DocumentAnnotation.ts:71

label

• label: string

Defined in src/DocumentAnnotation.ts:72

functional-types › "DocumentAnnotation" › Table

Interface: Table

Hierarchy

• Node

  ↳ Table

Index

Properties

• boundingPoly
• cellById
• columnHeaders
• id
• intersectHeader
• label
• mergedColumnHeader
• mergedRowHeader
• rowHeaders

Properties

boundingPoly

• boundingPoly: Poly

Inherited from Node.boundingPoly

Defined in src/DocumentAnnotation.ts:73

cellById

• cellById: TableCellById

Defined in src/DocumentAnnotation.ts:96

columnHeaders

• columnHeaders: Cell[]

Defined in src/DocumentAnnotation.ts:92

id

• id: string

Inherited from Node.id

Defined in src/DocumentAnnotation.ts:71

intersectHeader

• intersectHeader: Cell

Defined in src/DocumentAnnotation.ts:93

label

• label: string

Inherited from Node.label

Defined in src/DocumentAnnotation.ts:72

mergedColumnHeader

• mergedColumnHeader: Cell

Defined in src/DocumentAnnotation.ts:95

mergedRowHeader

• mergedRowHeader: Cell

Defined in src/DocumentAnnotation.ts:94

rowHeaders

• rowHeaders: Cell[]

Defined in src/DocumentAnnotation.ts:91

functional-types › "DocumentAnnotation" › TableCell

Interface: TableCell

Hierarchy

↳ Cell

↳ TableCell

Index

Properties

• boundingPoly
• columnHeader
• id
• label
• rowHeader
• text
• words

Properties

boundingPoly

• boundingPoly: Poly

Inherited from Node.boundingPoly

Defined in src/DocumentAnnotation.ts:73

columnHeader

• columnHeader: Cell

Defined in src/DocumentAnnotation.ts:85

id

• id: string

Inherited from Node.id

Defined in src/DocumentAnnotation.ts:71

label

• label: string

Inherited from Node.label

Defined in src/DocumentAnnotation.ts:72

rowHeader

• rowHeader: Cell

Defined in src/DocumentAnnotation.ts:84

text

• text: string

Inherited from Cell.text

Defined in src/DocumentAnnotation.ts:78

words

• words: Word[]

Inherited from Cell.words

Defined in src/DocumentAnnotation.ts:77

functional-types › "Excel" › Excel

Interface: Excel

Hierarchy

• Excel

Index

Properties

• file
• sheetByName

Properties

file

• file: string

Defined in src/Excel.ts:28

sheetByName

• sheetByName: SheetByName

Defined in src/Excel.ts:29

functional-types › "Excel" › Position

Interface: Position

Hierarchy

• Position

Index

Properties

• cell
• file
• sheet

Properties

cell

• cell: string

Defined in src/Excel.ts:19

file

• file: string

Defined in src/Excel.ts:17

sheet

• sheet: string

Defined in src/Excel.ts:18

functional-types › "Folder/index" › Attributes

Interface: Attributes

Hierarchy

• Attributes

Index

Properties

• folder
• id
• name
• type

Properties

folder

• folder: string

Defined in src/Folder/index.ts:57

id

• id: string

Defined in src/Folder/index.ts:56

name

• name: string

Defined in src/Folder/index.ts:58

type

• type: FT.FileType

Defined in src/Folder/index.ts:59

functional-types › "Folder/index" › FilesReference

Interface: FilesReference

Hierarchy

• FilesReference

Index

Properties

• files

Properties

files

• files: string[]

Defined in src/Folder/index.ts:85

functional-types › "Folder/index" › Folder

Interface: Folder

Hierarchy

• Folder

Index

Properties

• created_at
• deleted_at
• id
• name
• tags
• updated_at

Properties

created_at

• created_at: string

Defined in src/Folder/index.ts:50

Optional deleted_at

• deleted_at? : string

Defined in src/Folder/index.ts:52

id

• id: string

Defined in src/Folder/index.ts:47

name

• name: string

Defined in src/Folder/index.ts:48

tags

• tags: Tag[]

Defined in src/Folder/index.ts:49

updated_at

• updated_at: string

Defined in src/Folder/index.ts:51

functional-types › "Folder/index" › FolderReference

Interface: FolderReference

Hierarchy

• FolderReference

Index

Properties

• folder

Properties

folder

• folder: string

Defined in src/Folder/index.ts:81

functional-types › "Folder/index" › Metadata

Interface: Metadata

Hierarchy

• Metadata

Index

Properties

• bucket
• content_type
• created_at
• generation
• id
• kind
• media_link
• name
• self_link
• size
• updated_at

Properties

bucket

• bucket: string

Defined in src/Folder/index.ts:68

content_type

• content_type: string

Defined in src/Folder/index.ts:70

created_at

• created_at: string

Defined in src/Folder/index.ts:72

generation

• generation: string

Defined in src/Folder/index.ts:69

id

• id: string

Defined in src/Folder/index.ts:64

kind

• kind: string

Defined in src/Folder/index.ts:63

media_link

• media_link: string

Defined in src/Folder/index.ts:66

name

• name: string

Defined in src/Folder/index.ts:67

self_link

• self_link: string

Defined in src/Folder/index.ts:65

size

• size: string

Defined in src/Folder/index.ts:71

updated_at

• updated_at: string

Defined in src/Folder/index.ts:73

functional-types › "Folder/index" › Reference

Interface: Reference

Hierarchy

• Reference

Index

Properties

• file

Properties

file

• file: string

Defined in src/Folder/index.ts:77

functional-types › "Label" › Label

Interface: Label

Hierarchy

• Label

Index

Properties

• color
• id
• name

Properties

color

• color: string

Defined in src/Label.ts:6

id

• id: string

Defined in src/Label.ts:4

name

• name: string

Defined in src/Label.ts:5

functional-types › "Response" › Failure

Interface: Failure

Hierarchy

• Failure

Index

Properties

• error

Properties

error

• error: string

Defined in src/Response.ts:25

functional-types › "Response" › Success

Interface: Success <T>

Type parameters

▪ T

Hierarchy

• Success

Index

Properties

• message
• payload

Properties

message

• message: string

Defined in src/Response.ts:20

payload

• payload: T

Defined in src/Response.ts:21

functional-types › "Schema" › Filters

Interface: Filters

Hierarchy

• Filters

Index

Properties

• keys
• values

Properties

Optional keys

• keys? : RegExp[]

Defined in src/Schema.ts:43

Optional values

• values? : RegExp[]

Defined in src/Schema.ts:44

functional-types › "Schema" › Gettable

Interface: Gettable

Hierarchy

• Gettable

Index

Properties

• attribute
• file
• options

Properties

attribute

• attribute: Path

Defined in src/Schema.ts:86

file

• file: FilePath

Defined in src/Schema.ts:85

Optional options

• options? : GettableOptions

Defined in src/Schema.ts:87

functional-types › "Schema" › GettableOptions

Interface: GettableOptions

Hierarchy

• GettableOptions

Index

Properties

• direction
• dividend
• end
• filters
• key
• lifts
• merge_type
• multiplies
• rejects
• replacements
• unnest

Properties

Optional direction

• direction? : Direction

Defined in src/Schema.ts:72

Optional dividend

• dividend? : boolean

Defined in src/Schema.ts:81

Optional end

• end? : RegExp

Defined in src/Schema.ts:79

Optional filters

• filters? : Filters

Defined in src/Schema.ts:78

Optional key

• key? : RegExp

Defined in src/Schema.ts:73

Optional lifts

• lifts? : RegExp[]

Defined in src/Schema.ts:76

Optional merge_type

• merge_type? : MergeType[]

Defined in src/Schema.ts:71

Optional multiplies

• multiplies? : Multiply[]

Defined in src/Schema.ts:80

Optional rejects

• rejects? : Filters

Defined in src/Schema.ts:77

Optional replacements

• replacements? : Replacements

Defined in src/Schema.ts:74

Optional unnest

• unnest? : number

Defined in src/Schema.ts:75

functional-types › "Schema" › Multiply

Interface: Multiply

Hierarchy

• Multiply

Index

Properties

• pattern
• scale

Properties

pattern

• pattern: RegExp

Defined in src/Schema.ts:66

scale

• scale: number

Defined in src/Schema.ts:67

functional-types › "Schema" › Predicate

Interface: Predicate

Hierarchy

• Predicate

Index

Properties

• properties
• value

Properties

Optional properties

• properties? : Property[]

Defined in src/Schema.ts:54

value

• value: RegExp

Defined in src/Schema.ts:53

functional-types › "Schema" › Property

Interface: Property

Hierarchy

• Property

Index

Properties

• pattern
• property

Properties

pattern

• pattern: RegExp

Defined in src/Schema.ts:49

property

• property: string

Defined in src/Schema.ts:48

functional-types › "Schema" › Replacement

Interface: Replacement

Hierarchy

• Replacement

Index

Properties

• pattern
• value

Properties

pattern

• pattern: RegExp

Defined in src/Schema.ts:32

value

• value: string

Defined in src/Schema.ts:33

functional-types › "Schema" › Replacements

Interface: Replacements

Hierarchy

• Replacements

Index

Properties

• keys
• leaf_values
• values

Properties

Optional keys

• keys? : Replacement[]

Defined in src/Schema.ts:37

Optional leaf_values

• leaf_values? : Replacement[]

Defined in src/Schema.ts:39

Optional values

• values? : Replacement[]

Defined in src/Schema.ts:38

functional-types › "Schema" › Schema

Interface: Schema

Hierarchy

• Schema

Index

Properties

• created_at
• file_type
• files
• gettables
• id
• name
• options
• updated_at

Properties

created_at

• created_at: string

Defined in src/Schema.ts:103

file_type

• file_type: DocumentType

Defined in src/Schema.ts:101

files

• files: FilePath[]

Defined in src/Schema.ts:100

gettables

• gettables: Gettables

Defined in src/Schema.ts:99

id

• id: string

Defined in src/Schema.ts:97

name

• name: string

Defined in src/Schema.ts:98

Optional options

• options? : SchemaOptions

Defined in src/Schema.ts:102

updated_at

• updated_at: string

Defined in src/Schema.ts:104

functional-types › "Schema" › SchemaOptions

Interface: SchemaOptions

Hierarchy

• SchemaOptions

Index

Properties

• merge

Properties

Optional merge

• merge? : boolean

Defined in src/Schema.ts:93

functional-types › "Serialize/ComparableSchema" › ComparableSchema

Interface: ComparableSchema

Hierarchy

• Pair‹SchemaPath›

  ↳ ComparableSchema

Index

Properties

• created_at
• id
• left
• name
• right
• updated_at

Properties

created_at

• created_at: string

Defined in src/Serialize/ComparableSchema.ts:13

id

• id: string

Defined in src/Serialize/ComparableSchema.ts:11

left

• left: SchemaPath

Inherited from Pair.left

Defined in src/Types.ts:21

name

• name: string

Defined in src/Serialize/ComparableSchema.ts:12

right

• right: SchemaPath

Inherited from Pair.right

Defined in src/Types.ts:22

updated_at

• updated_at: string

Defined in src/Serialize/ComparableSchema.ts:14

functional-types › "Serialize/Schema" › Filters

Interface: Filters

Hierarchy

• Filters

Index

Properties

• keys
• values

Properties

Optional keys

• keys? : string[]

Defined in src/Serialize/Schema.ts:45

Optional values

• values? : string[]

Defined in src/Serialize/Schema.ts:46

functional-types › "Serialize/Schema" › Gettable

Interface: Gettable

Hierarchy

• Gettable

Index

Properties

• attribute
• file
• options

Properties

attribute

• attribute: Path

Defined in src/Serialize/Schema.ts:86

file

• file: FilePath

Defined in src/Serialize/Schema.ts:85

Optional options

• options? : GettableOptions

Defined in src/Serialize/Schema.ts:87

functional-types › "Serialize/Schema" › GettableOptions

Interface: GettableOptions

Hierarchy

• GettableOptions

Index

Properties

• direction
• dividend
• end
• filters
• key
• lifts
• merge_type
• multiplies
• rejects
• replacements
• unnest

Properties

Optional direction

• direction? : Direction

Defined in src/Serialize/Schema.ts:72

Optional dividend

• dividend? : boolean

Defined in src/Serialize/Schema.ts:81

Optional end

• end? : string

Defined in src/Serialize/Schema.ts:79

Optional filters

• filters? : Filters

Defined in src/Serialize/Schema.ts:78

Optional key

• key? : string

Defined in src/Serialize/Schema.ts:73

Optional lifts

• lifts? : string[]

Defined in src/Serialize/Schema.ts:76

Optional merge_type

• merge_type? : MergeType[]

Defined in src/Serialize/Schema.ts:71

Optional multiplies

• multiplies? : Multiply[]

Defined in src/Serialize/Schema.ts:80

Optional rejects

• rejects? : Filters

Defined in src/Serialize/Schema.ts:77

Optional replacements

• replacements? : Replacements

Defined in src/Serialize/Schema.ts:74

Optional unnest

• unnest? : number

Defined in src/Serialize/Schema.ts:75

functional-types › "Serialize/Schema" › Multiply

Interface: Multiply

Hierarchy

• Multiply

Index

Properties

• pattern
• scale

Properties

pattern

• pattern: string

Defined in src/Serialize/Schema.ts:66

scale

• scale: number

Defined in src/Serialize/Schema.ts:67

functional-types › "Serialize/Schema" › Predicate

Interface: Predicate

Hierarchy

• Predicate

Index

Properties

• properties
• value

Properties

Optional properties

• properties? : Property[]

Defined in src/Serialize/Schema.ts:56

value

• value: string

Defined in src/Serialize/Schema.ts:55

functional-types › "Serialize/Schema" › Property

Interface: Property

Hierarchy

• Property

Index

Properties

• pattern
• property

Properties

pattern

• pattern: string

Defined in src/Serialize/Schema.ts:51

property

• property: string

Defined in src/Serialize/Schema.ts:50

functional-types › "Serialize/Schema" › Replacement

Interface: Replacement

Hierarchy

• Replacement

Index

Properties

• pattern
• value

Properties

pattern

• pattern: string

Defined in src/Serialize/Schema.ts:35

value

• value: string

Defined in src/Serialize/Schema.ts:36

functional-types › "Serialize/Schema" › Replacements

Interface: Replacements

Hierarchy

• Replacements

Index

Properties

• keys
• values

Properties

Optional keys

• keys? : Replacement[]

Defined in src/Serialize/Schema.ts:40

Optional values

• values? : Replacement[]

Defined in src/Serialize/Schema.ts:41

functional-types › "Serialize/Schema" › Schema

Interface: Schema

Hierarchy

• Schema

Index

Properties

• created_at
• file_type
• files
• gettables
• id
• name
• options
• updated_at

Properties

created_at

• created_at: string

Defined in src/Serialize/Schema.ts:103

file_type

• file_type: DocumentType

Defined in src/Serialize/Schema.ts:101

files

• files: FilePath[]

Defined in src/Serialize/Schema.ts:100

gettables

• gettables: Gettables

Defined in src/Serialize/Schema.ts:99

id

• id: string

Defined in src/Serialize/Schema.ts:97

name

• name: string

Defined in src/Serialize/Schema.ts:98

Optional options

• options? : SchemaOptions

Defined in src/Serialize/Schema.ts:102

updated_at

• updated_at: string

Defined in src/Serialize/Schema.ts:104

functional-types › "Serialize/Schema" › SchemaOptions

Interface: SchemaOptions

Hierarchy

• SchemaOptions

Index

Properties

• merge

Properties

Optional merge

• merge? : boolean

Defined in src/Serialize/Schema.ts:93

functional-types › "TableAnnotation" › TableAnnotation

Interface: TableAnnotation

Hierarchy

• TableAnnotation

Index

Properties

• boundingBoxesByPage
• created_at
• file
• id
• updated_at

Properties

boundingBoxesByPage

• boundingBoxesByPage: BoundingBoxesByPage

Defined in src/TableAnnotation.ts:34

created_at

• created_at: string

Defined in src/TableAnnotation.ts:35

file

• file: string

Defined in src/TableAnnotation.ts:33

id

• id: string

Defined in src/TableAnnotation.ts:32

updated_at

• updated_at: string

Defined in src/TableAnnotation.ts:36

functional-types › "TextAnnotation" › Page

Interface: Page

Hierarchy

• Page

Index

Properties

• paragraphsById
• wordsById

Properties

paragraphsById

• paragraphsById: ParagraphsById

Defined in src/TextAnnotation.ts:72

wordsById

• wordsById: WordsById

Defined in src/TextAnnotation.ts:71

functional-types › "TextAnnotation" › Paragraph

Interface: Paragraph

Hierarchy

• Paragraph

Index

Properties

• boundingPoly
• confidence
• id

Properties

boundingPoly

• boundingPoly: Poly

Defined in src/TextAnnotation.ts:62

confidence

• confidence: number

Defined in src/TextAnnotation.ts:63

id

• id: string

Defined in src/TextAnnotation.ts:61

functional-types › "TextAnnotation" › TextAnnotation

Interface: TextAnnotation

Hierarchy

• TextAnnotation

Index

Properties

• created_at
• file
• id
• pages
• updated_at

Properties

created_at

• created_at: string

Defined in src/TextAnnotation.ts:79

file

• file: string

Defined in src/TextAnnotation.ts:77

id

• id: string

Defined in src/TextAnnotation.ts:76

pages

• pages: Page[]

Defined in src/TextAnnotation.ts:78

updated_at

• updated_at: string

Defined in src/TextAnnotation.ts:80

functional-types › "TextAnnotation" › Word

Interface: Word

Hierarchy

• Word

Index

Properties

• boundingPoly
• breakType
• confidence
• id
• paragraph
• text

Properties

boundingPoly

• boundingPoly: Poly

Defined in src/TextAnnotation.ts:55

breakType

• breakType: BreakType

Defined in src/TextAnnotation.ts:54

confidence

• confidence: number

Defined in src/TextAnnotation.ts:57

id

• id: string

Defined in src/TextAnnotation.ts:52

paragraph

• paragraph: string

Defined in src/TextAnnotation.ts:53

text

• text: string

Defined in src/TextAnnotation.ts:56

functional-types › "Types" › Pair

Interface: Pair <T>

Type parameters

▪ T

Hierarchy

• Pair

  ↳ ComparableSchema

  ↳ ComparableSchema

Index

Properties

• left
• right

Properties

left

• left: T

Defined in src/Types.ts:21

right

• right: T

Defined in src/Types.ts:22

functional-types › "Vertex/index" › BoundingBox

Interface: BoundingBox

Hierarchy

• BoundingBox

  ↳ LabeledBoundingBox

Index

Properties

• boundingPoly
• columns
• rows

Properties

boundingPoly

• boundingPoly: Poly

Defined in src/Vertex/index.ts:63

columns

• columns: Line[]

Defined in src/Vertex/index.ts:65

rows

• rows: Line[]

Defined in src/Vertex/index.ts:64

functional-types › "Vertex/index" › Corners

Interface: Corners

Hierarchy

• Corners

Index

Properties

• end
• start

Properties

end

• end: Vertex

Defined in src/Vertex/index.ts:99

start

• start: Vertex

Defined in src/Vertex/index.ts:98

functional-types › "Vertex/index" › LabeledBoundingBox

Interface: LabeledBoundingBox

Hierarchy

• BoundingBox

  ↳ LabeledBoundingBox

Index

Properties

• boundingPoly
• columns
• id
• label
• rows
• score

Properties

boundingPoly

• boundingPoly: Poly

Inherited from BoundingBox.boundingPoly

Defined in src/Vertex/index.ts:63

columns

• columns: Line[]

Inherited from BoundingBox.columns

Defined in src/Vertex/index.ts:65

id

• id: string

Defined in src/Vertex/index.ts:92

label

• label: string

Defined in src/Vertex/index.ts:93

rows

• rows: Line[]

Inherited from BoundingBox.rows

Defined in src/Vertex/index.ts:64

Optional score

• score? : number

Defined in src/Vertex/index.ts:94

functional-types › "Vertex/index" › Rectangle

Interface: Rectangle

Hierarchy

• Rectangle

Index

Properties

• x0
• x1
• y0
• y1

Properties

x0

• x0: number

Defined in src/Vertex/index.ts:103

x1

• x1: number

Defined in src/Vertex/index.ts:105

y0

• y0: number

Defined in src/Vertex/index.ts:104

y1

• y1: number

Defined in src/Vertex/index.ts:106

functional-types › "Vertex/index" › Vertex

Interface: Vertex

Hierarchy

• Vertex

Index

Properties

• x
• y

Properties

x

• x: number

Defined in src/Vertex/index.ts:51

y

• y: number

Defined in src/Vertex/index.ts:52

functional-types › "Vision" › AnnotateImageRequest

Interface: AnnotateImageRequest

Hierarchy

• AnnotateImageRequest

Index

Properties

• features
• image
• imageContext

Properties

Optional features

• features? : Feature[]

Defined in src/Vision.ts:48

image

• image: Image

Defined in src/Vision.ts:47

Optional imageContext

• imageContext? : ImageContext

Defined in src/Vision.ts:49

functional-types › "Vision" › AnnotateImageResponse

Interface: AnnotateImageResponse

Hierarchy

• AnnotateImageResponse

Index

Properties

• fullTextAnnotation
• labelAnnotations
• textAnnotations

Properties

Optional fullTextAnnotation

• fullTextAnnotation? : TextAnnotation

Defined in src/Vision.ts:63

Optional labelAnnotations

• labelAnnotations? : EntityAnnotation[]

Defined in src/Vision.ts:54

Optional textAnnotations

• textAnnotations? : EntityAnnotation[]

Defined in src/Vision.ts:57

functional-types › "Vision" › AsyncAnnotateFileRequest

Interface: AsyncAnnotateFileRequest

Hierarchy

• AsyncAnnotateFileRequest

Index

Properties

• features
• imageContext
• inputConfig
• outputConfig
• responses

Properties

features

• features: Feature[]

Defined in src/Vision.ts:16

Optional imageContext

• imageContext? : ImageContext

Defined in src/Vision.ts:17

inputConfig

• inputConfig: InputConfig

Defined in src/Vision.ts:15

outputConfig

• outputConfig: OutputConfig

Defined in src/Vision.ts:18

Optional responses

• responses? : AnnotateImageResponse[]

Defined in src/Vision.ts:19

functional-types › "Vision" › Block

Interface: Block

Hierarchy

• Block

Index

Properties

• blockType
• boundingBox
• confidence
• paragraphs
• property

Properties

blockType

• blockType: BlockType

Defined in src/Vision.ts:152

boundingBox

• boundingBox: BoundingPoly

Defined in src/Vision.ts:150

Optional confidence

• confidence? : number

Defined in src/Vision.ts:153

paragraphs

• paragraphs: Paragraph[]

Defined in src/Vision.ts:151

Optional property

• property? : TextProperty

Defined in src/Vision.ts:139

functional-types › "Vision" › BoundingPoly

Interface: BoundingPoly

Hierarchy

• BoundingPoly

Index

Properties

• normalizedVertices
• vertices

Properties

Optional normalizedVertices

• normalizedVertices? : NormalizedVertex[]

Defined in src/Vision.ts:212

Optional vertices

• vertices? : Vertex[]

Defined in src/Vision.ts:211

functional-types › "Vision" › DetectedBreak

Interface: DetectedBreak

Hierarchy

• DetectedBreak

Index

Properties

• isPrefix
• type

Properties

Optional isPrefix

• isPrefix? : boolean

Defined in src/Vision.ts:199

type

• type: BreakType

Defined in src/Vision.ts:196

functional-types › "Vision" › DetectedLanguage

Interface: DetectedLanguage

Hierarchy

• DetectedLanguage

Index

Properties

• confidence
• languageCode

Properties

Optional confidence

• confidence? : number

Defined in src/Vision.ts:192

languageCode

• languageCode: string

Defined in src/Vision.ts:191

functional-types › "Vision" › EntityAnnotation

Interface: EntityAnnotation

Hierarchy

• EntityAnnotation

Index

Properties

• boundingPoly
• confidence
• description
• locale
• locations
• mid
• properties
• score
• topicality

Properties

Optional boundingPoly

• boundingPoly? : BoundingPoly

Defined in src/Vision.ts:99

confidence

• confidence: number

Defined in src/Vision.ts:97

description

• description: string

Defined in src/Vision.ts:95

locale

• locale: string

Defined in src/Vision.ts:94

locations

• locations: LocationInfo[]

Defined in src/Vision.ts:100

mid

• mid: string

Defined in src/Vision.ts:93

properties

• properties: Property[]

Defined in src/Vision.ts:101

score

• score: number

Defined in src/Vision.ts:96

topicality

• topicality: number

Defined in src/Vision.ts:98

functional-types › "Vision" › Feature

Interface: Feature

Hierarchy

• Feature

Index

Properties

• maxResult
• model
• type

Properties

Optional maxResult

• maxResult? : number

Defined in src/Vision.ts:78

Optional model

• model? : "builtin/stable" | "builtin/latest"

Defined in src/Vision.ts:79

type

• type: Type

Defined in src/Vision.ts:77

functional-types › "Vision" › GcsDestination

Interface: GcsDestination

Hierarchy

• GcsDestination

Index

Properties

• uri

Properties

uri

• uri: string

Defined in src/Vision.ts:43

functional-types › "Vision" › GcsSource

Interface: GcsSource

Hierarchy

• GcsSource

Index

Properties

• uri

Properties

uri

• uri: string

Defined in src/Vision.ts:29

functional-types › "Vision" › Image

Interface: Image

Hierarchy

• Image

Index

Properties

• content
• source

Properties

Optional content

• content? : Buffer

Defined in src/Vision.ts:67

Optional source

• source? : ImageSource

Defined in src/Vision.ts:68

functional-types › "Vision" › ImageContext

Interface: ImageContext

Hierarchy

• ImageContext

Index

Properties

• cropHintsParams
• languageHints
• latLongRect
• productSearchParams
• webDetectionParams

Properties

cropHintsParams

• cropHintsParams: unknown

Defined in src/Vision.ts:87

languageHints

• languageHints: string[]

Defined in src/Vision.ts:86

latLongRect

• latLongRect: unknown

Defined in src/Vision.ts:85

productSearchParams

• productSearchParams: unknown

Defined in src/Vision.ts:88

webDetectionParams

• webDetectionParams: unknown

Defined in src/Vision.ts:89

functional-types › "Vision" › ImageSource

Interface: ImageSource

Hierarchy

• ImageSource

Index

Properties

• gcsImageUri
• imageUri

Properties

Optional gcsImageUri

• gcsImageUri? : string

Defined in src/Vision.ts:72

Optional imageUri

• imageUri? : string

Defined in src/Vision.ts:73

functional-types › "Vision" › InputConfig

Interface: InputConfig

Hierarchy

• InputConfig

Index

Properties

• content
• gcsSource
• mimeType

Properties

Optional content

• content? : Buffer

Defined in src/Vision.ts:24

gcsSource

• gcsSource: GcsSource

Defined in src/Vision.ts:23

mimeType

• mimeType: string

Defined in src/Vision.ts:25

functional-types › "Vision" › LatLng

Interface: LatLng

Hierarchy

• LatLng

Index

Properties

• latitude
• longitude

Properties

latitude

• latitude: number

Defined in src/Vision.ts:250

longitude

• longitude: number

Defined in src/Vision.ts:252

functional-types › "Vision" › LocationInfo

Interface: LocationInfo

Hierarchy

• LocationInfo

Index

Properties

• latLng

Properties

latLng

• latLng: LatLng

Defined in src/Vision.ts:216

functional-types › "Vision" › NormalizedVertex

Interface: NormalizedVertex

Hierarchy

• Vertex

  ↳ NormalizedVertex

Index

Properties

• x
• y

Properties

x

• x: number

Overrides Vertex.x

Defined in src/Vision.ts:239

y

• y: number

Overrides Vertex.y

Defined in src/Vision.ts:240

functional-types › "Vision" › OutputConfig

Interface: OutputConfig

Hierarchy

• OutputConfig

Index

Properties

• batchSize
• gcsDestination

Properties

Optional batchSize

• batchSize? : number

Defined in src/Vision.ts:38

gcsDestination

• gcsDestination: GcsDestination

Defined in src/Vision.ts:39

functional-types › "Vision" › Page

Interface: Page

Hierarchy

• Page

Index

Properties

• blocks
• confidence
• height
• property
• width

Properties

blocks

• blocks: Block[]

Defined in src/Vision.ts:127

Optional confidence

• confidence? : number

Defined in src/Vision.ts:130

height

• height: number

Defined in src/Vision.ts:125

property

• property: TextProperty

Defined in src/Vision.ts:118

width

• width: number

Defined in src/Vision.ts:124

functional-types › "Vision" › Paragraph

Interface: Paragraph

Hierarchy

• Paragraph

Index

Properties

• boundingBox
• confidence
• property
• words

Properties

boundingBox

• boundingBox: BoundingPoly

Defined in src/Vision.ts:158

confidence

• confidence: number

Defined in src/Vision.ts:160

Optional property

• property? : TextProperty

Defined in src/Vision.ts:157

words

• words: Word[]

Defined in src/Vision.ts:159

functional-types › "Vision" › Property

Interface: Property

Hierarchy

• Property

Index