Variables
Const API_KEY_HEADER_NAME
API_KEY_HEADER_NAME: "Ocp-Apim-Subscription-Key" = "Ocp-Apim-Subscription-Key"
Const DEFAULT_COGNITIVE_SCOPE
DEFAULT_COGNITIVE_SCOPE: "https://cognitiveservices.azure.com/.default" = "https://cognitiveservices.azure.com/.default"
Const FormRecognizerLoggingAllowedHeaderNames
FormRecognizerLoggingAllowedHeaderNames: string[] = ["apim-request-id","Location","Operation-Location","Strict-Transport-Security","X-Content-Type-Options","x-envoy-upstream-service-time"]
Const FormRecognizerLoggingAllowedQueryParameters
FormRecognizerLoggingAllowedQueryParameters: string[] = ["includeTextDetails","includeKeys","op"]
Const LIB_INFO
LIB_INFO: string = `azsdk-js-ai-formrecognizer/${SDK_VERSION}`
Const MAX_INPUT_DOCUMENT_SIZE
MAX_INPUT_DOCUMENT_SIZE: number = 50 * 1024 * 1024
Const SDK_VERSION
SDK_VERSION: string = "1.0.0-preview.3"
Const SIZE_ONE_MEGA
SIZE_ONE_MEGA: number = 1024 * 1024
Const logger
logger: any = createClientLogger("ai-form-recognizer")
Const packageName
packageName: "@azure/ai-form-recognizer" = "@azure/ai-form-recognizer"
Const packageVersion
packageVersion: "1.0.0-preview.3" = "1.0.0-preview.3"
Const serializer
serializer: any = new coreHttp.Serializer(Mappers, /* isXml */ false)
Const textPattern
textPattern: Object = /\/readResults\/(\d+)\/lines\/(\d+)(?:\/words\/(\d+))?/
Object literals
Const AnalyzeOperationResult
AnalyzeOperationResult: object
type
type: object
className
className: string = "AnalyzeOperationResult"
name
name: string = "Composite"
modelProperties
modelProperties: object
analyzeResult
analyzeResult: object
serializedName
serializedName: string = "analyzeResult"
type
type: object
className
className: string = "AnalyzeResult"
name
name: string = "Composite"
createdOn
createdOn: object
required
required: boolean = true
serializedName
serializedName: string = "createdDateTime"
type
type: object
name
name: string = "DateTime"
lastModified
lastModified: object
required
required: boolean = true
serializedName
serializedName: string = "lastUpdatedDateTime"
type
type: object
name
name: string = "DateTime"
status
status: object
required
required: boolean = true
serializedName
serializedName: string = "status"
type
type: object
allowedValues
allowedValues: string[] = ["notStarted", "running", "succeeded", "failed"]
name
name: string = "Enum"
Const AnalyzeResult
AnalyzeResult: object
type
type: object
className
className: string = "AnalyzeResult"
name
name: string = "Composite"
modelProperties
modelProperties: object
documentResults
documentResults: object
serializedName
serializedName: string = "documentResults"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "DocumentResult"
name
name: string = "Composite"
errors
errors: object
serializedName
serializedName: string = "errors"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "ErrorInformation"
name
name: string = "Composite"
pageResults
pageResults: object
serializedName
serializedName: string = "pageResults"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "PageResult"
name
name: string = "Composite"
readResults
readResults: object
required
required: boolean = true
serializedName
serializedName: string = "readResults"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "ReadResult"
name
name: string = "Composite"
version
version: object
required
required: boolean = true
serializedName
serializedName: string = "version"
type
type: object
name
name: string = "String"
Const CopyAuthorizationResult
CopyAuthorizationResult: object
type
type: object
className
className: string = "CopyAuthorizationResult"
name
name: string = "Composite"
modelProperties
modelProperties: object
accessToken
accessToken: object
required
required: boolean = true
serializedName
serializedName: string = "accessToken"
type
type: object
name
name: string = "String"
expirationDateTimeTicks
expirationDateTimeTicks: object
required
required: boolean = true
serializedName
serializedName: string = "expirationDateTimeTicks"
type
type: object
name
name: string = "Number"
modelId
modelId: object
required
required: boolean = true
serializedName
serializedName: string = "modelId"
type
type: object
name
name: string = "String"
Const CopyOperationResult
CopyOperationResult: object
type
type: object
className
className: string = "CopyOperationResult"
name
name: string = "Composite"
modelProperties
modelProperties: object
copyResult
copyResult: object
serializedName
serializedName: string = "copyResult"
type
type: object
className
className: string = "CopyResult"
name
name: string = "Composite"
createdOn
createdOn: object
required
required: boolean = true
serializedName
serializedName: string = "createdDateTime"
type
type: object
name
name: string = "DateTime"
lastModified
lastModified: object
required
required: boolean = true
serializedName
serializedName: string = "lastUpdatedDateTime"
type
type: object
name
name: string = "DateTime"
status
status: object
required
required: boolean = true
serializedName
serializedName: string = "status"
type
type: object
allowedValues
allowedValues: string[] = ["notStarted", "running", "succeeded", "failed"]
name
name: string = "Enum"
Const CopyRequest
CopyRequest: object
type
type: object
className
className: string = "CopyRequest"
name
name: string = "Composite"
modelProperties
modelProperties: object
copyAuthorization
copyAuthorization: object
serializedName
serializedName: string = "copyAuthorization"
type
type: object
className
className: string = "CopyAuthorizationResult"
name
name: string = "Composite"
targetResourceId
targetResourceId: object
required
required: boolean = true
serializedName
serializedName: string = "targetResourceId"
constraints
constraints: object
MaxLength
MaxLength: number = 1024
Pattern
Pattern: any = new RegExp("^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.CognitiveServices/accounts/[^/]*$")
type
type: object
name
name: string = "String"
targetResourceRegion
targetResourceRegion: object
required
required: boolean = true
serializedName
serializedName: string = "targetResourceRegion"
constraints
constraints: object
MaxLength
MaxLength: number = 24
MinLength
MinLength: number = 1
Pattern
Pattern: any = new RegExp("^[a-z0-9]+$")
type
type: object
name
name: string = "String"
Const CopyResult
CopyResult: object
type
type: object
className
className: string = "CopyResult"
name
name: string = "Composite"
modelProperties
modelProperties: object
errors
errors: object
serializedName
serializedName: string = "errors"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "ErrorInformation"
name
name: string = "Composite"
modelId
modelId: object
required
required: boolean = true
serializedName
serializedName: string = "modelId"
type
type: object
name
name: string = "Uuid"
Const DataTable
DataTable: object
type
type: object
className
className: string = "DataTable"
name
name: string = "Composite"
modelProperties
modelProperties: object
cells
cells: object
required
required: boolean = true
serializedName
serializedName: string = "cells"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "DataTableCell"
name
name: string = "Composite"
columns
columns: object
required
required: boolean = true
serializedName
serializedName: string = "columns"
constraints
constraints: object
InclusiveMinimum
InclusiveMinimum: number = 1
type
type: object
name
name: string = "Number"
rows
rows: object
required
required: boolean = true
serializedName
serializedName: string = "rows"
constraints
constraints: object
InclusiveMinimum
InclusiveMinimum: number = 1
type
type: object
name
name: string = "Number"
Const DataTableCell
DataTableCell: object
type
type: object
className
className: string = "DataTableCell"
name
name: string = "Composite"
modelProperties
modelProperties: object
boundingBox
boundingBox: object
required
required: boolean = true
serializedName
serializedName: string = "boundingBox"
constraints
constraints: object
MaxItems
MaxItems: number = 8
MinItems
MinItems: number = 8
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
name
name: string = "Number"
columnIndex
columnIndex: object
constraints
constraints: {}
required
required: boolean = true
serializedName
serializedName: string = "columnIndex"
type
type: object
name
name: string = "Number"
columnSpan
columnSpan: object
defaultValue
defaultValue: number = 1
serializedName
serializedName: string = "columnSpan"
constraints
constraints: object
InclusiveMinimum
InclusiveMinimum: number = 1
type
type: object
name
name: string = "Number"
confidence
confidence: object
required
required: boolean = true
serializedName
serializedName: string = "confidence"
constraints
constraints: object
InclusiveMaximum
InclusiveMaximum: number = 1
type
type: object
name
name: string = "Number"
elements
elements: object
serializedName
serializedName: string = "elements"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
name
name: string = "String"
isFooter
isFooter: object
serializedName
serializedName: string = "isFooter"
type
type: object
name
name: string = "Boolean"
isHeader
isHeader: object
serializedName
serializedName: string = "isHeader"
type
type: object
name
name: string = "Boolean"
rowIndex
rowIndex: object
constraints
constraints: {}
required
required: boolean = true
serializedName
serializedName: string = "rowIndex"
type
type: object
name
name: string = "Number"
rowSpan
rowSpan: object
defaultValue
defaultValue: number = 1
serializedName
serializedName: string = "rowSpan"
constraints
constraints: object
InclusiveMinimum
InclusiveMinimum: number = 1
type
type: object
name
name: string = "Number"
text
text: object
required
required: boolean = true
serializedName
serializedName: string = "text"
type
type: object
name
name: string = "String"
Const DocumentResult
DocumentResult: object
type
type: object
className
className: string = "DocumentResult"
name
name: string = "Composite"
modelProperties
modelProperties: object
docType
docType: object
required
required: boolean = true
serializedName
serializedName: string = "docType"
type
type: object
name
name: string = "String"
fields
fields: object
required
required: boolean = true
serializedName
serializedName: string = "fields"
type
type: object
name
name: string = "Dictionary"
value
value: object
type
type: object
className
className: string = "FieldValue"
name
name: string = "Composite"
pageRange
pageRange: object
required
required: boolean = true
serializedName
serializedName: string = "pageRange"
constraints
constraints: object
MaxItems
MaxItems: number = 2
MinItems
MinItems: number = 2
type
type: object
name
name: string = "Sequence"
element
element: object
constraints
constraints: object
InclusiveMinimum
InclusiveMinimum: number = 1
type
type: object
name
name: string = "Number"
Const ErrorInformation
ErrorInformation: object
type
type: object
className
className: string = "ErrorInformation"
name
name: string = "Composite"
modelProperties
modelProperties: object
code
code: object
required
required: boolean = true
serializedName
serializedName: string = "code"
type
type: object
name
name: string = "String"
message
message: object
required
required: boolean = true
serializedName
serializedName: string = "message"
type
type: object
name
name: string = "String"
Const ErrorResponse
ErrorResponse: object
type
type: object
className
className: string = "ErrorResponse"
name
name: string = "Composite"
modelProperties
modelProperties: object
error
error: object
serializedName
serializedName: string = "error"
type
type: object
className
className: string = "ErrorInformation"
name
name: string = "Composite"
Const FieldValue
FieldValue: object
type
type: object
className
className: string = "FieldValue"
name
name: string = "Composite"
modelProperties
modelProperties: object
boundingBox
boundingBox: object
serializedName
serializedName: string = "boundingBox"
constraints
constraints: object
MaxItems
MaxItems: number = 8
MinItems
MinItems: number = 8
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
name
name: string = "Number"
confidence
confidence: object
serializedName
serializedName: string = "confidence"
constraints
constraints: object
InclusiveMaximum
InclusiveMaximum: number = 1
type
type: object
name
name: string = "Number"
elements
elements: object
serializedName
serializedName: string = "elements"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
name
name: string = "String"
pageNumber
pageNumber: object
serializedName
serializedName: string = "page"
constraints
constraints: object
InclusiveMinimum
InclusiveMinimum: number = 1
type
type: object
name
name: string = "Number"
text
text: object
serializedName
serializedName: string = "text"
type
type: object
name
name: string = "String"
type
type: object
required
required: boolean = true
serializedName
serializedName: string = "type"
type
type: object
allowedValues
allowedValues: string[] = ["string","date","time","phoneNumber","number","integer","array","object"]
name
name: string = "Enum"
valueArray
valueArray: object
serializedName
serializedName: string = "valueArray"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "FieldValue"
name
name: string = "Composite"
valueDate
valueDate: object
serializedName
serializedName: string = "valueDate"
type
type: object
name
name: string = "Date"
valueInteger
valueInteger: object
serializedName
serializedName: string = "valueInteger"
type
type: object
name
name: string = "Number"
valueNumber
valueNumber: object
serializedName
serializedName: string = "valueNumber"
type
type: object
name
name: string = "Number"
valueObject
valueObject: object
serializedName
serializedName: string = "valueObject"
type
type: object
name
name: string = "Dictionary"
value
value: object
type
type: object
className
className: string = "FieldValue"
name
name: string = "Composite"
valuePhoneNumber
valuePhoneNumber: object
serializedName
serializedName: string = "valuePhoneNumber"
type
type: object
name
name: string = "String"
valueString
valueString: object
serializedName
serializedName: string = "valueString"
type
type: object
name
name: string = "String"
valueTime
valueTime: object
serializedName
serializedName: string = "valueTime"
type
type: object
name
name: string = "String"
Const FormFieldsReport
FormFieldsReport: object
type
type: object
className
className: string = "FormFieldsReport"
name
name: string = "Composite"
modelProperties
modelProperties: object
accuracy
accuracy: object
required
required: boolean = true
serializedName
serializedName: string = "accuracy"
type
type: object
name
name: string = "Number"
fieldName
fieldName: object
required
required: boolean = true
serializedName
serializedName: string = "fieldName"
type
type: object
name
name: string = "String"
Const GeneratedClientAnalyzeLayoutAsyncHeaders
GeneratedClientAnalyzeLayoutAsyncHeaders: object
type
type: object
className
className: string = "GeneratedClientAnalyzeLayoutAsyncHeaders"
name
name: string = "Composite"
modelProperties
modelProperties: object
operationLocation
operationLocation: object
serializedName
serializedName: string = "operation-location"
type
type: object
name
name: string = "String"
Const GeneratedClientAnalyzeReceiptAsyncHeaders
GeneratedClientAnalyzeReceiptAsyncHeaders: object
type
type: object
className
className: string = "GeneratedClientAnalyzeReceiptAsyncHeaders"
name
name: string = "Composite"
modelProperties
modelProperties: object
operationLocation
operationLocation: object
serializedName
serializedName: string = "operation-location"
type
type: object
name
name: string = "String"
Const GeneratedClientAnalyzeWithCustomModelHeaders
GeneratedClientAnalyzeWithCustomModelHeaders: object
type
type: object
className
className: string = "GeneratedClientAnalyzeWithCustomModelHeaders"
name
name: string = "Composite"
modelProperties
modelProperties: object
operationLocation
operationLocation: object
serializedName
serializedName: string = "operation-location"
type
type: object
name
name: string = "String"
Const GeneratedClientCopyCustomModelHeaders
GeneratedClientCopyCustomModelHeaders: object
type
type: object
className
className: string = "GeneratedClientCopyCustomModelHeaders"
name
name: string = "Composite"
modelProperties
modelProperties: object
operationLocation
operationLocation: object
serializedName
serializedName: string = "operation-location"
type
type: object
name
name: string = "String"
Const GeneratedClientGenerateModelCopyAuthorizationHeaders
GeneratedClientGenerateModelCopyAuthorizationHeaders: object
type
type: object
className
className: string = "GeneratedClientGenerateModelCopyAuthorizationHeaders"
name
name: string = "Composite"
modelProperties
modelProperties: object
location
location: object
serializedName
serializedName: string = "location"
type
type: object
name
name: string = "String"
Const GeneratedClientTrainCustomModelAsyncHeaders
GeneratedClientTrainCustomModelAsyncHeaders: object
type
type: object
className
className: string = "GeneratedClientTrainCustomModelAsyncHeaders"
name
name: string = "Composite"
modelProperties
modelProperties: object
location
location: object
serializedName
serializedName: string = "location"
type
type: object
name
name: string = "String"
Const KeyValueElement
KeyValueElement: object
type
type: object
className
className: string = "KeyValueElement"
name
name: string = "Composite"
modelProperties
modelProperties: object
boundingBox
boundingBox: object
serializedName
serializedName: string = "boundingBox"
constraints
constraints: object
MaxItems
MaxItems: number = 8
MinItems
MinItems: number = 8
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
name
name: string = "Number"
elements
elements: object
serializedName
serializedName: string = "elements"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
name
name: string = "String"
text
text: object
required
required: boolean = true
serializedName
serializedName: string = "text"
type
type: object
name
name: string = "String"
Const KeyValuePair
KeyValuePair: object
type
type: object
className
className: string = "KeyValuePair"
name
name: string = "Composite"
modelProperties
modelProperties: object
confidence
confidence: object
required
required: boolean = true
serializedName
serializedName: string = "confidence"
constraints
constraints: object
InclusiveMaximum
InclusiveMaximum: number = 1
type
type: object
name
name: string = "Number"
key
key: object
serializedName
serializedName: string = "key"
type
type: object
className
className: string = "KeyValueElement"
name
name: string = "Composite"
label
label: object
serializedName
serializedName: string = "label"
type
type: object
name
name: string = "String"
value
value: object
serializedName
serializedName: string = "value"
type
type: object
className
className: string = "KeyValueElement"
name
name: string = "Composite"
Const KeysResult
KeysResult: object
type
type: object
className
className: string = "KeysResult"
name
name: string = "Composite"
modelProperties
modelProperties: object
clusters
clusters: object
required
required: boolean = true
serializedName
serializedName: string = "clusters"
type
type: object
name
name: string = "Dictionary"
value
value: object
constraints
constraints: object
UniqueItems
UniqueItems: boolean = true
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
name
name: string = "String"
Const Model
Model: object
type
type: object
className
className: string = "Model"
name
name: string = "Composite"
modelProperties
modelProperties: object
keys
keys: object
serializedName
serializedName: string = "keys"
type
type: object
className
className: string = "KeysResult"
name
name: string = "Composite"
modelInfo
modelInfo: object
serializedName
serializedName: string = "modelInfo"
type
type: object
className
className: string = "ModelInfo"
name
name: string = "Composite"
trainResult
trainResult: object
serializedName
serializedName: string = "trainResult"
type
type: object
className
className: string = "TrainResult"
name
name: string = "Composite"
Const ModelInfo
ModelInfo: object
type
type: object
className
className: string = "ModelInfo"
name
name: string = "Composite"
modelProperties
modelProperties: object
completedOn
completedOn: object
required
required: boolean = true
serializedName
serializedName: string = "lastUpdatedDateTime"
type
type: object
name
name: string = "DateTime"
modelId
modelId: object
required
required: boolean = true
serializedName
serializedName: string = "modelId"
type
type: object
name
name: string = "Uuid"
requestedOn
requestedOn: object
required
required: boolean = true
serializedName
serializedName: string = "createdDateTime"
type
type: object
name
name: string = "DateTime"
status
status: object
required
required: boolean = true
serializedName
serializedName: string = "status"
type
type: object
allowedValues
allowedValues: string[] = ["creating", "ready", "invalid"]
name
name: string = "Enum"
Const Models
Models: object
type
type: object
className
className: string = "Models"
name
name: string = "Composite"
modelProperties
modelProperties: object
modelList
modelList: object
serializedName
serializedName: string = "modelList"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "ModelInfo"
name
name: string = "Composite"
nextLink
nextLink: object
serializedName
serializedName: string = "nextLink"
type
type: object
name
name: string = "String"
summary
summary: object
serializedName
serializedName: string = "summary"
type
type: object
className
className: string = "ModelsSummary"
name
name: string = "Composite"
Const ModelsSummary
ModelsSummary: object
type
type: object
className
className: string = "ModelsSummary"
name
name: string = "Composite"
modelProperties
modelProperties: object
count
count: object
required
required: boolean = true
serializedName
serializedName: string = "count"
type
type: object
name
name: string = "Number"
lastModified
lastModified: object
required
required: boolean = true
serializedName
serializedName: string = "lastUpdatedDateTime"
type
type: object
name
name: string = "DateTime"
limit
limit: object
required
required: boolean = true
serializedName
serializedName: string = "limit"
type
type: object
name
name: string = "Number"
Const PageResult
PageResult: object
type
type: object
className
className: string = "PageResult"
name
name: string = "Composite"
modelProperties
modelProperties: object
clusterId
clusterId: object
constraints
constraints: {}
serializedName
serializedName: string = "clusterId"
type
type: object
name
name: string = "Number"
keyValuePairs
keyValuePairs: object
serializedName
serializedName: string = "keyValuePairs"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "KeyValuePair"
name
name: string = "Composite"
pageNumber
pageNumber: object
required
required: boolean = true
serializedName
serializedName: string = "page"
constraints
constraints: object
InclusiveMinimum
InclusiveMinimum: number = 1
type
type: object
name
name: string = "Number"
tables
tables: object
serializedName
serializedName: string = "tables"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "DataTable"
name
name: string = "Composite"
Const ReadResult
ReadResult: object
type
type: object
className
className: string = "ReadResult"
name
name: string = "Composite"
modelProperties
modelProperties: object
angle
angle: object
required
required: boolean = true
serializedName
serializedName: string = "angle"
constraints
constraints: object
InclusiveMaximum
InclusiveMaximum: number = 180
InclusiveMinimum
InclusiveMinimum: number = -180
type
type: object
name
name: string = "Number"
height
height: object
constraints
constraints: {}
required
required: boolean = true
serializedName
serializedName: string = "height"
type
type: object
name
name: string = "Number"
language
language: object
serializedName
serializedName: string = "language"
type
type: object
name
name: string = "String"
lines
lines: object
serializedName
serializedName: string = "lines"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "TextLine"
name
name: string = "Composite"
pageNumber
pageNumber: object
required
required: boolean = true
serializedName
serializedName: string = "page"
constraints
constraints: object
InclusiveMinimum
InclusiveMinimum: number = 1
type
type: object
name
name: string = "Number"
unit
unit: object
required
required: boolean = true
serializedName
serializedName: string = "unit"
type
type: object
allowedValues
allowedValues: string[] = ["pixel", "inch"]
name
name: string = "Enum"
width
width: object
constraints
constraints: {}
required
required: boolean = true
serializedName
serializedName: string = "width"
type
type: object
name
name: string = "Number"
Const SourcePath
SourcePath: object
type
type: object
className
className: string = "SourcePath"
name
name: string = "Composite"
modelProperties
modelProperties: object
source
source: object
serializedName
serializedName: string = "source"
constraints
constraints: object
MaxLength
MaxLength: number = 2048
type
type: object
name
name: string = "String"
Const TextLine
TextLine: object
type
type: object
className
className: string = "TextLine"
name
name: string = "Composite"
modelProperties
modelProperties: object
boundingBox
boundingBox: object
required
required: boolean = true
serializedName
serializedName: string = "boundingBox"
constraints
constraints: object
MaxItems
MaxItems: number = 8
MinItems
MinItems: number = 8
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
name
name: string = "Number"
language
language: object
serializedName
serializedName: string = "language"
type
type: object
name
name: string = "String"
text
text: object
required
required: boolean = true
serializedName
serializedName: string = "text"
type
type: object
name
name: string = "String"
words
words: object
required
required: boolean = true
serializedName
serializedName: string = "words"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "TextWord"
name
name: string = "Composite"
Const TextWord
TextWord: object
type
type: object
className
className: string = "TextWord"
name
name: string = "Composite"
modelProperties
modelProperties: object
boundingBox
boundingBox: object
required
required: boolean = true
serializedName
serializedName: string = "boundingBox"
constraints
constraints: object
MaxItems
MaxItems: number = 8
MinItems
MinItems: number = 8
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
name
name: string = "Number"
confidence
confidence: object
serializedName
serializedName: string = "confidence"
constraints
constraints: object
InclusiveMaximum
InclusiveMaximum: number = 1
type
type: object
name
name: string = "Number"
text
text: object
required
required: boolean = true
serializedName
serializedName: string = "text"
type
type: object
name
name: string = "String"
Const TrainRequest
TrainRequest: object
type
type: object
className
className: string = "TrainRequest"
name
name: string = "Composite"
modelProperties
modelProperties: object
source
source: object
required
required: boolean = true
serializedName
serializedName: string = "source"
constraints
constraints: object
MaxLength
MaxLength: number = 2048
type
type: object
name
name: string = "String"
sourceFilter
sourceFilter: object
serializedName
serializedName: string = "sourceFilter"
type
type: object
className
className: string = "TrainSourceFilter"
name
name: string = "Composite"
useLabelFile
useLabelFile: object
serializedName
serializedName: string = "useLabelFile"
type
type: object
name
name: string = "Boolean"
Const TrainResult
TrainResult: object
type
type: object
className
className: string = "TrainResult"
name
name: string = "Composite"
modelProperties
modelProperties: object
averageModelAccuracy
averageModelAccuracy: object
serializedName
serializedName: string = "averageModelAccuracy"
type
type: object
name
name: string = "Number"
errors
errors: object
serializedName
serializedName: string = "errors"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "ErrorInformation"
name
name: string = "Composite"
fields
fields: object
serializedName
serializedName: string = "fields"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "FormFieldsReport"
name
name: string = "Composite"
trainingDocuments
trainingDocuments: object
required
required: boolean = true
serializedName
serializedName: string = "trainingDocuments"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "TrainingDocumentInfo"
name
name: string = "Composite"
Const TrainSourceFilter
TrainSourceFilter: object
type
type: object
className
className: string = "TrainSourceFilter"
name
name: string = "Composite"
modelProperties
modelProperties: object
includeSubFolders
includeSubFolders: object
serializedName
serializedName: string = "includeSubFolders"
type
type: object
name
name: string = "Boolean"
prefix
prefix: object
serializedName
serializedName: string = "prefix"
constraints
constraints: object
MaxLength
MaxLength: number = 1024
type
type: object
name
name: string = "String"
Const TrainingDocumentInfo
TrainingDocumentInfo: object
type
type: object
className
className: string = "TrainingDocumentInfo"
name
name: string = "Composite"
modelProperties
modelProperties: object
documentName
documentName: object
required
required: boolean = true
serializedName
serializedName: string = "documentName"
type
type: object
name
name: string = "String"
errors
errors: object
required
required: boolean = true
serializedName
serializedName: string = "errors"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "ErrorInformation"
name
name: string = "Composite"
pageCount
pageCount: object
required
required: boolean = true
serializedName
serializedName: string = "pages"
type
type: object
name
name: string = "Number"
status
status: object
required
required: boolean = true
serializedName
serializedName: string = "status"
type
type: object
allowedValues
allowedValues: string[] = ["succeeded", "partiallySucceeded", "failed"]
name
name: string = "Enum"
Const analyzeLayoutAsync$binaryOperationSpec
analyzeLayoutAsync$binaryOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.contentType1]
httpMethod
httpMethod: string = "POST"
path
path: string = "/layout/analyze"
requestBody
requestBody: any = Parameters.fileStream
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint]
responses
responses: object
202
202: object
headersMapper
headersMapper: any = Mappers.GeneratedClientAnalyzeLayoutAsyncHeaders
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const analyzeLayoutAsync$jsonOperationSpec
analyzeLayoutAsync$jsonOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.contentType2]
httpMethod
httpMethod: string = "POST"
path
path: string = "/layout/analyze"
requestBody
requestBody: any = Parameters.fileStream1
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint]
responses
responses: object
202
202: object
headersMapper
headersMapper: any = Mappers.GeneratedClientAnalyzeLayoutAsyncHeaders
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const analyzeReceiptAsync$binaryOperationSpec
analyzeReceiptAsync$binaryOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.contentType1]
httpMethod
httpMethod: string = "POST"
path
path: string = "/prebuilt/receipt/analyze"
queryParameters
queryParameters: any[] = [Parameters.includeTextDetails]
requestBody
requestBody: any = Parameters.fileStream
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint]
responses
responses: object
202
202: object
headersMapper
headersMapper: any = Mappers.GeneratedClientAnalyzeReceiptAsyncHeaders
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const analyzeReceiptAsync$jsonOperationSpec
analyzeReceiptAsync$jsonOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.contentType2]
httpMethod
httpMethod: string = "POST"
path
path: string = "/prebuilt/receipt/analyze"
queryParameters
queryParameters: any[] = [Parameters.includeTextDetails]
requestBody
requestBody: any = Parameters.fileStream1
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint]
responses
responses: object
202
202: object
headersMapper
headersMapper: any = Mappers.GeneratedClientAnalyzeReceiptAsyncHeaders
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const analyzeWithCustomModel$binaryOperationSpec
analyzeWithCustomModel$binaryOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.contentType1]
httpMethod
httpMethod: string = "POST"
path
path: string = "/custom/models/{modelId}/analyze"
queryParameters
queryParameters: any[] = [Parameters.includeTextDetails]
requestBody
requestBody: any = Parameters.fileStream
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.modelId]
responses
responses: object
202
202: object
headersMapper
headersMapper: any = Mappers.GeneratedClientAnalyzeWithCustomModelHeaders
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const analyzeWithCustomModel$jsonOperationSpec
analyzeWithCustomModel$jsonOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.contentType2]
httpMethod
httpMethod: string = "POST"
path
path: string = "/custom/models/{modelId}/analyze"
queryParameters
queryParameters: any[] = [Parameters.includeTextDetails]
requestBody
requestBody: any = Parameters.fileStream1
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.modelId]
responses
responses: object
202
202: object
headersMapper
headersMapper: any = Mappers.GeneratedClientAnalyzeWithCustomModelHeaders
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const contentType
contentType: object
parameterPath
parameterPath: string[] = ["options", "contentType"]
mapper
mapper: object
defaultValue
defaultValue: string = "application/json"
isConstant
isConstant: boolean = true
serializedName
serializedName: string = "Content-Type"
type
type: object
name
name: string = "String"
Const contentType1
contentType1: object
parameterPath
parameterPath: string = "contentType"
mapper
mapper: object
required
required: boolean = true
serializedName
serializedName: string = "Content-Type"
type
type: object
allowedValues
allowedValues: string[] = ["application/pdf","image/jpeg","image/png","image/tiff"]
name
name: string = "Enum"
Const contentType2
contentType2: object
parameterPath
parameterPath: string = "contentType"
mapper
mapper: object
defaultValue
defaultValue: string = "application/json"
isConstant
isConstant: boolean = true
serializedName
serializedName: string = "Content-Type"
type
type: object
name
name: string = "String"
Const copyCustomModelOperationSpec
copyCustomModelOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.contentType]
httpMethod
httpMethod: string = "POST"
path
path: string = "/custom/models/{modelId}/copy"
requestBody
requestBody: any = Parameters.copyRequest
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.modelId]
responses
responses: object
202
202: object
headersMapper
headersMapper: any = Mappers.GeneratedClientCopyCustomModelHeaders
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const copyRequest
copyRequest: object
mapper
mapper: any = Mappers.CopyRequest
parameterPath
parameterPath: string = "copyRequest"
Const deleteCustomModelOperationSpec
deleteCustomModelOperationSpec: object
httpMethod
httpMethod: string = "DELETE"
path
path: string = "/custom/models/{modelId}"
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.modelId]
responses
responses: object
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const endpoint
endpoint: object
parameterPath
parameterPath: string = "endpoint"
skipEncoding
skipEncoding: boolean = true
mapper
mapper: object
required
required: boolean = true
serializedName
serializedName: string = "endpoint"
type
type: object
name
name: string = "String"
Const fileStream
fileStream: object
parameterPath
parameterPath: string = "fileStream"
mapper
mapper: object
required
required: boolean = true
serializedName
serializedName: string = "fileStream"
type
type: object
name
name: string = "Stream"
Const fileStream1
fileStream1: object
mapper
mapper: any = Mappers.SourcePath
parameterPath
parameterPath: string[] = ["options", "fileStream"]
Const generateModelCopyAuthorizationOperationSpec
generateModelCopyAuthorizationOperationSpec: object
httpMethod
httpMethod: string = "POST"
path
path: string = "/custom/models/copyAuthorization"
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint]
responses
responses: object
201
201: object
bodyMapper
bodyMapper: any = Mappers.CopyAuthorizationResult
headersMapper
headersMapper: any = Mappers.GeneratedClientGenerateModelCopyAuthorizationHeaders
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const getAnalyzeFormResultOperationSpec
getAnalyzeFormResultOperationSpec: object
httpMethod
httpMethod: string = "GET"
path
path: string = "/custom/models/{modelId}/analyzeResults/{resultId}"
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.modelId, Parameters.resultId]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.AnalyzeOperationResult
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const getAnalyzeLayoutResultOperationSpec
getAnalyzeLayoutResultOperationSpec: object
httpMethod
httpMethod: string = "GET"
path
path: string = "/layout/analyzeResults/{resultId}"
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.resultId]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.AnalyzeOperationResult
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const getAnalyzeReceiptResultOperationSpec
getAnalyzeReceiptResultOperationSpec: object
httpMethod
httpMethod: string = "GET"
path
path: string = "/prebuilt/receipt/analyzeResults/{resultId}"
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.resultId]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.AnalyzeOperationResult
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const getCustomModelCopyResultOperationSpec
getCustomModelCopyResultOperationSpec: object
httpMethod
httpMethod: string = "GET"
path
path: string = "/custom/models/{modelId}/copyResults/{resultId}"
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint,Parameters.modelId,Parameters.resultId1]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.CopyOperationResult
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const getCustomModelOperationSpec
getCustomModelOperationSpec: object
httpMethod
httpMethod: string = "GET"
path
path: string = "/custom/models/{modelId}"
queryParameters
queryParameters: any[] = [Parameters.includeKeys]
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.modelId]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.Model
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const getCustomModelsOperationSpec
getCustomModelsOperationSpec: object
httpMethod
httpMethod: string = "GET"
path
path: string = "/custom/models"
queryParameters
queryParameters: any[] = [Parameters.op1]
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.Models
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const includeKeys
includeKeys: object
parameterPath
parameterPath: string[] = ["options", "includeKeys"]
mapper
mapper: object
serializedName
serializedName: string = "includeKeys"
type
type: object
name
name: string = "Boolean"
Const includeTextDetails
includeTextDetails: object
parameterPath
parameterPath: string[] = ["options", "includeTextDetails"]
mapper
mapper: object
serializedName
serializedName: string = "includeTextDetails"
type
type: object
name
name: string = "Boolean"
Const listCustomModelsNextOperationSpec
listCustomModelsNextOperationSpec: object
httpMethod
httpMethod: string = "GET"
path
path: string = "{nextLink}"
queryParameters
queryParameters: any[] = [Parameters.op]
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.nextLink]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.Models
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const listCustomModelsOperationSpec
listCustomModelsOperationSpec: object
httpMethod
httpMethod: string = "GET"
path
path: string = "/custom/models"
queryParameters
queryParameters: any[] = [Parameters.op]
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.Models
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const modelId
modelId: object
parameterPath
parameterPath: string = "modelId"
mapper
mapper: object
required
required: boolean = true
serializedName
serializedName: string = "modelId"
type
type: object
name
name: string = "Uuid"
Const nextLink
nextLink: object
parameterPath
parameterPath: string = "nextLink"
skipEncoding
skipEncoding: boolean = true
mapper
mapper: object
required
required: boolean = true
serializedName
serializedName: string = "nextLink"
type
type: object
name
name: string = "String"
Const op
op: object
parameterPath
parameterPath: string = "op"
mapper
mapper: object
defaultValue
defaultValue: string = "full"
isConstant
isConstant: boolean = true
serializedName
serializedName: string = "op"
type
type: object
name
name: string = "String"
Const op1
op1: object
parameterPath
parameterPath: string = "op"
mapper
mapper: object
defaultValue
defaultValue: string = "summary"
isConstant
isConstant: boolean = true
serializedName
serializedName: string = "op"
type
type: object
name
name: string = "String"
Const resultId
resultId: object
parameterPath
parameterPath: string = "resultId"
mapper
mapper: object
required
required: boolean = true
serializedName
serializedName: string = "resultId"
type
type: object
name
name: string = "Uuid"
Const resultId1
resultId1: object
parameterPath
parameterPath: string = "resultId"
mapper
mapper: object
required
required: boolean = true
serializedName
serializedName: string = "resultId"
type
type: object
name
name: string = "Uuid"
Const trainCustomModelAsyncOperationSpec
trainCustomModelAsyncOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.contentType]
httpMethod
httpMethod: string = "POST"
path
path: string = "/custom/models"
requestBody
requestBody: any = Parameters.trainRequest
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint]
responses
responses: object
201
201: object
headersMapper
headersMapper: any = Mappers.GeneratedClientTrainCustomModelAsyncHeaders
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const trainRequest
trainRequest: object
mapper
mapper: any = Mappers.TrainRequest
parameterPath
parameterPath: string = "trainRequest"
Options for begin copy model operation