Form Recognizer
Extracts text (printed and handwritten OCR) and additional information (tables, checkbox, fields / key value pairs) from PDF or image documents and forms into structured data based on pre-trained models (layout, invoice, receipt, id, business card) or custom model created by a set of representative training forms using AI powered document understanding.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - US Department of Defense (DoD) |
| Power Automate | Standard | All Power Automate regions except the following: - US Department of Defense (DoD) |
| Power Apps | - | Not available |
| Contact | |
|---|---|
| Name | Microsoft |
| URL | https://aka.ms/formrecognizer |
| [email protected] |
| Connector Metadata | |
|---|---|
| Publisher | Microsoft |
| Website | https://aka.ms/formrecognizer |
| Privacy policy | https://aka.ms/form-recognizer/privacy |
| Categories | AI;Business Intelligence |
The Form Recognizer connector provide integration to Cognitive Service Form Recognizer. It allows analyze and extract informatino from Forms, Invoices, Receipts, Business Cards, and ID Documents.
Prerequisites
To use this integration, you will need a Cognitive Service Form Recognizer resource in the Azure portal. Create resource link. You will get an endpoint and a key for authenticating your applications. To make a connection, provide the Account key, site URL and select Create connection. For operation costs on your connection, learn more here.
How to get credentials
- Open Form Recognizer resource in Azure portal (see [Prerequisites]).
- Select Keys and Endpoint under Resource Management
- Copy Endpoint and Key and use them to create new connection.
Getting started with your connector
Simplest way to try the Form Recognizer connector is to use any prebuilt models (Analyze Invoice, Receipt, Business Card, or ID Document). Provide PDF or image of your document. Analyze using connector operation based on your document type and inspect detected fields.
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Account Key | securestring | Form Recognizer Account Key | True |
| Endpoint URL | string | Form Recognizer Endpoint Url (Example: https://your-formrecognizer-resource.cognitiveservices.azure.com/) | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Analyze Business Card |
Extract field text and semantic values from a given business card document. |
| Analyze Custom Form |
Extract key-value pairs, tables, and semantic values from a given document. |
| Analyze Document for Prebuilt or Custom models (v3.x API) |
Extract key-value pairs, tables, and semantic values from a given document (v3.x API). |
| Analyze ID Document |
Extract field text and semantic values from a given ID document. |
| Analyze Invoice |
Extract field text and semantic values from a given invoice document. |
| Analyze Layout |
Extract text and layout information from a given document. |
| Analyze Receipt |
Extract field text and semantic values from a given receipt document. |
| Classify document with document classifier (v3.1 API) |
Classify document with document classifier (v3.1 API). |
Analyze Business Card
Extract field text and semantic values from a given business card document.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Include Text Details
|
includeTextDetails | boolean |
Include text lines and element references in the result. Default: True (just for FR Connector). |
|
|
Pages
|
pages | string |
The page selection for multi-page PDF and TIFF documents, to extract Invoice information from individual pages and a range of pages (like page 2, and pages 5-7) by entering the page numbers and ranges separated by commas (e.g. '2, 5-7'). If not set, all pages will be processed. |
|
|
Locale
|
locale | string |
Locale of the invoice. Supported locale includes: en-US. |
|
|
Document/Image File Content
|
inputFileContent | binary |
A PDF document or image (JPG or PNG) file to analyze. |
|
|
Document/Image URL
|
inputFileUrl | string |
Url path for input file. Alternative to Document/Image File Content. |
Returns
Status and result of the queued analyze operation.
Analyze Custom Form
Extract key-value pairs, tables, and semantic values from a given document.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Model Identifier
|
modelId | True | string |
Format - uuid. Model identifier. |
|
Include Text Details
|
includeTextDetails | boolean |
Include text lines and element references in the result. Default: True (just for FR Connector). |
|
|
Pages
|
pages | string |
The page selection for multi-page PDF and TIFF documents, to extract Invoice information from individual pages and a range of pages (like page 2, and pages 5-7) by entering the page numbers and ranges separated by commas (e.g. '2, 5-7'). If not set, all pages will be processed. |
|
|
Document/Image File Content
|
inputFileContent | binary |
A PDF document or image (JPG or PNG) file to analyze. |
|
|
Document/Image URL
|
inputFileUrl | string |
Url path for input file. Alternative to Document/Image File Content. |
Returns
Status and result of the queued analyze operation.
Analyze Document for Prebuilt or Custom models (v3.x API)
Extract key-value pairs, tables, and semantic values from a given document (v3.x API).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Form Recognizer API version
|
api-version | True | string |
Form Recognizer API version. |
|
Model Identifier
|
modelId | True | string |
Prebuilt modelIds: prebuilt-read, prebuilt-layout, prebuilt-document, prebuilt-businessCard, prebuilt-idDocument, prebuilt-invoice, prebuilt-receipt, prebuilt-tax.us.w2, prebuilt-vaccinationCard, prebuilt-healthInsuranceCard.us. Custom modelId format - [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Unique model name. |
|
Pages
|
pages | string |
The page selection for multi-page PDF and TIFF documents, to extract Invoice information from individual pages and a range of pages (like page 2, and pages 5-7) by entering the page numbers and ranges separated by commas (e.g. '2, 5-7'). If not set, all pages will be processed. |
|
|
Locale
|
locale | string |
Locale hint for text recognition and document analysis. Value may contain only the language code (ex. "en", "fr") or BCP 47 language tag (ex. "en-US"). |
|
|
String Index Type
|
stringIndexType | string |
Method used to compute string offset and length. Supported options: textElements, unicodeCodePoint, utf16CodeUnit. |
|
|
Optional and Premium features
|
features | array |
List of optional analysis features ( such as ocrHighResolution, languages, barcodes, formulas, keyValuePairs and styleFont). |
|
|
Document/Image File Content
|
inputFileContent | binary |
A PDF document or image (JPG, PNG, BMP, TIFF) file to analyze. |
|
|
Document/Image URL
|
inputFileUrl | string |
Url path for input file. Alternative to Document/Image File Content. |
Returns
Status and result of the analyze operation.
Analyze ID Document
Extract field text and semantic values from a given ID document.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Include Text Details
|
includeTextDetails | boolean |
Include text lines and element references in the result. Default: True (just for FR Connector). |
|
|
Pages
|
pages | string |
The page selection for multi-page PDF and TIFF documents, to extract Invoice information from individual pages and a range of pages (like page 2, and pages 5-7) by entering the page numbers and ranges separated by commas (e.g. '2, 5-7'). If not set, all pages will be processed. |
|
|
Document/Image File Content
|
inputFileContent | binary |
A PDF document or image (JPG or PNG) file to analyze. |
|
|
Document/Image URL
|
inputFileUrl | string |
Url path for input file. Alternative to Document/Image File Content. |
Returns
Status and result of the queued analyze operation.
Analyze Invoice
Extract field text and semantic values from a given invoice document.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Include Text Details
|
includeTextDetails | boolean |
Include text lines and element references in the result. Default: True (just for FR Connector). |
|
|
Pages
|
pages | string |
The page selection for multi-page PDF and TIFF documents, to extract Invoice information from individual pages and a range of pages (like page 2, and pages 5-7) by entering the page numbers and ranges separated by commas (e.g. '2, 5-7'). If not set, all pages will be processed. |
|
|
Locale
|
locale | string |
Locale of the invoice. Supported locale includes: en-US. |
|
|
Document/Image File Content
|
inputFileContent | binary |
A PDF document or image (JPG or PNG) file to analyze. |
|
|
Document/Image URL
|
inputFileUrl | string |
Url path for input file. Alternative to Document/Image File Content. |
Returns
Status and result of the queued analyze operation.
Analyze Layout
Extract text and layout information from a given document.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Pages
|
pages | string |
The page selection for multi-page PDF and TIFF documents, to extract Invoice information from individual pages and a range of pages (like page 2, and pages 5-7) by entering the page numbers and ranges separated by commas (e.g. '2, 5-7'). If not set, all pages will be processed. |
|
|
Language
|
language | string |
The BCP-47 language code of the text in the document. |
|
|
Reading Order
|
readingOrder | string |
Optional parameter to specify which reading order algorithm should be applied when ordering the extract text elements. Can be either 'basic' or 'natural'. Will default to basic if not specified. |
|
|
Document/Image File Content
|
inputFileContent | binary |
A PDF document or image (JPG or PNG) file to analyze. |
|
|
Document/Image URL
|
inputFileUrl | string |
Url path for input file. Alternative to Document/Image File Content. |
Returns
Status and result of the queued analyze operation.
Analyze Receipt
Extract field text and semantic values from a given receipt document.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Include Text Details
|
includeTextDetails | boolean |
Include text lines and element references in the result. Default: True (just for FR Connector). |
|
|
Pages
|
pages | string |
The page selection for multi-page PDF and TIFF documents, to extract Invoice information from individual pages and a range of pages (like page 2, and pages 5-7) by entering the page numbers and ranges separated by commas (e.g. '2, 5-7'). If not set, all pages will be processed. |
|
|
Locale
|
locale | string |
Locale of the invoice. Supported locale includes: en-US. |
|
|
Document/Image File Content
|
inputFileContent | binary |
A PDF document or image (JPG or PNG) file to analyze. |
|
|
Document/Image URL
|
inputFileUrl | string |
Url path for input file. Alternative to Document/Image File Content. |
Returns
Status and result of the queued analyze operation.
Classify document with document classifier (v3.1 API)
Classify document with document classifier (v3.1 API).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Classifier Identifier
|
classifierId | True | string |
Format - [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Unique classifier name. |
|
Pages
|
pages | string |
The page selection for multi-page PDF and TIFF documents, to extract information from individual pages and a range of pages (like page 2, and pages 5-7) by entering the page numbers and ranges separated by commas (e.g. '2, 5-7'). If not set, all pages will be processed. |
|
|
Locale
|
locale | string |
Locale hint for text recognition and document analysis. Value may contain only the language code (ex. "en", "fr") or BCP 47 language tag (ex. "en-US"). |
|
|
String Index Type
|
stringIndexType | string |
Method used to compute string offset and length. Supported options: textElements, unicodeCodePoint, utf16CodeUnit. |
|
|
Document/Image File Content
|
inputFileContent | binary |
A PDF document or image (JPG, PNG, BMP, TIFF) file to analyze. |
|
|
Document/Image URL
|
inputFileUrl | string |
Url path for input file. Alternative to Document/Image File Content. |
Returns
Status and result of the analyze operation.
Definitions
OperationStatus
LayoutAnalyzeOperationResult
Status and result of the queued analyze operation.
| Name | Path | Type | Description |
|---|---|---|---|
|
status
|
status | OperationStatus |
Status of the queued operation. |
|
createdDateTime
|
createdDateTime | string |
Date and time (UTC) the analyze operation was submitted. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Date and time (UTC) when the status is last updated. |
|
analyzeResult
|
analyzeResult | LayoutAnalyzeResult |
Analyze operation result. |
InvoiceAnalyzeOperationResult
Status and result of the queued analyze operation.
| Name | Path | Type | Description |
|---|---|---|---|
|
status
|
status | OperationStatus |
Status of the queued operation. |
|
createdDateTime
|
createdDateTime | string |
Date and time (UTC) the analyze operation was submitted. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Date and time (UTC) when the status is last updated. |
|
analyzeResult
|
analyzeResult | InvoiceAnalyzeResult |
Analyze operation result. |
BusinessCardAnalyzeOperationResult
Status and result of the queued analyze operation.
| Name | Path | Type | Description |
|---|---|---|---|
|
status
|
status | OperationStatus |
Status of the queued operation. |
|
createdDateTime
|
createdDateTime | string |
Date and time (UTC) the analyze operation was submitted. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Date and time (UTC) when the status is last updated. |
|
analyzeResult
|
analyzeResult | BusinessCardAnalyzeResult |
Analyze operation result. |
ReceiptAnalyzeOperationResult
Status and result of the queued analyze operation.
| Name | Path | Type | Description |
|---|---|---|---|
|
status
|
status | OperationStatus |
Status of the queued operation. |
|
createdDateTime
|
createdDateTime | string |
Date and time (UTC) the analyze operation was submitted. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Date and time (UTC) when the status is last updated. |
|
analyzeResult
|
analyzeResult | ReceiptAnalyzeResult |
Analyze operation result. |
IdAnalyzeOperationResult
Status and result of the queued analyze operation.
| Name | Path | Type | Description |
|---|---|---|---|
|
status
|
status | OperationStatus |
Status of the queued operation. |
|
createdDateTime
|
createdDateTime | string |
Date and time (UTC) the analyze operation was submitted. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Date and time (UTC) when the status is last updated. |
|
analyzeResult
|
analyzeResult | IdAnalyzeResult |
Analyze operation result. |
CustomFormsAnalyzeOperationResult
Status and result of the queued analyze operation.
| Name | Path | Type | Description |
|---|---|---|---|
|
status
|
status | OperationStatus |
Status of the queued operation. |
|
createdDateTime
|
createdDateTime | string |
Date and time (UTC) the analyze operation was submitted. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Date and time (UTC) when the status is last updated. |
|
analyzeResult
|
analyzeResult | CustomFormsAnalyzeResult |
Analyze operation result. |
FormOperationError
Error reported during an operation.
| Name | Path | Type | Description |
|---|---|---|---|
|
message
|
message | string |
Error message. |
LayoutAnalyzeResult
Analyze operation result.
| Name | Path | Type | Description |
|---|---|---|---|
|
version
|
version | string |
Version of schema used for this result. |
|
readResults
|
readResults | array of ReadResult |
Text extracted from the input. |
|
pageResults
|
pageResults | array of PageResult |
Page-level information extracted from the input. |
|
errors
|
errors | array of FormOperationError |
List of errors reported during the analyze operation. |
InvoiceAnalyzeResult
Analyze operation result.
| Name | Path | Type | Description |
|---|---|---|---|
|
version
|
version | string |
Version of schema used for this result. |
|
readResults
|
readResults | array of ReadResult |
Text extracted from the input. |
|
pageResults
|
pageResults | array of PageResult |
Page-level information extracted from the input. |
|
documentResults
|
documentResults | array of InvoiceDocumentResult |
Document-level information extracted from the input. |
|
errors
|
errors | array of FormOperationError |
List of errors reported during the analyze operation. |
BusinessCardAnalyzeResult
Analyze operation result.
| Name | Path | Type | Description |
|---|---|---|---|
|
version
|
version | string |
Version of schema used for this result. |
|
readResults
|
readResults | array of ReadResult |
Text extracted from the input. |
|
pageResults
|
pageResults | array of PageResult |
Page-level information extracted from the input. |
|
documentResults
|
documentResults | array of BusinessCardDocumentResult |
Document-level information extracted from the input. |
|
errors
|
errors | array of FormOperationError |
List of errors reported during the analyze operation. |
ReceiptAnalyzeResult
Analyze operation result.
| Name | Path | Type | Description |
|---|---|---|---|
|
version
|
version | string |
Version of schema used for this result. |
|
readResults
|
readResults | array of ReadResult |
Text extracted from the input. |
|
pageResults
|
pageResults | array of PageResult |
Page-level information extracted from the input. |
|
documentResults
|
documentResults | array of ReceiptDocumentResult |
Document-level information extracted from the input. |
|
errors
|
errors | array of FormOperationError |
List of errors reported during the analyze operation. |
IdAnalyzeResult
Analyze operation result.
| Name | Path | Type | Description |
|---|---|---|---|
|
version
|
version | string |
Version of schema used for this result. |
|
readResults
|
readResults | array of ReadResult |
Text extracted from the input. |
|
pageResults
|
pageResults | array of PageResult |
Page-level information extracted from the input. |
|
documentResults
|
documentResults | array of IdDocumentResult |
Document-level information extracted from the input. |
|
errors
|
errors | array of FormOperationError |
List of errors reported during the analyze operation. |
CustomFormsAnalyzeResult
Analyze operation result.
| Name | Path | Type | Description |
|---|---|---|---|
|
version
|
version | string |
Version of schema used for this result. |
|
readResults
|
readResults | array of ReadResult |
Text extracted from the input. |
|
pageResults
|
pageResults | array of PageResult |
Page-level information extracted from the input. |
|
documentResults
|
documentResults | array of CustomFormsDocumentResult |
Document-level information extracted from the input. |
|
errors
|
errors | array of FormOperationError |
List of errors reported during the analyze operation. |
ReadResult
Text extracted from a page in the input document.
| Name | Path | Type | Description |
|---|---|---|---|
|
page
|
page | integer |
The 1-based page number in the input document. |
|
angle
|
angle | float |
The general orientation of the text in clockwise direction, measured in degrees between (-180, 180]. |
|
width
|
width | float |
The width of the image/PDF in pixels/inches, respectively. |
|
height
|
height | float |
The height of the image/PDF in pixels/inches, respectively. |
|
unit
|
unit | string |
The unit used by the width, height and boundingBox properties. For images, the unit is "pixel". For PDF, the unit is "inch". |
|
lines
|
lines | array of TextLine |
When includeTextDetails is set to true, a list of recognized text lines. The maximum number of lines returned is 300 per page. The lines are sorted top to bottom, left to right, although in certain cases proximity is treated with higher priority. As the sorting order depends on the detected text, it may change across images and OCR version updates. Thus, business logic should be built upon the actual line location instead of order. |
TextLine
An object representing an extracted text line.
| Name | Path | Type | Description |
|---|---|---|---|
|
text
|
text | string |
The text content of the line. |
|
boundingBox
|
boundingBox | BoundingBox |
Quadrangle bounding box, with coordinates specified relative to the top-left of the original image. The eight numbers represent the four points, clockwise from the top-left corner relative to the text orientation. For image, the (x, y) coordinates are measured in pixels. For PDF, the (x, y) coordinates are measured in inches. |
|
words
|
words | array of TextWord |
List of words in the text line. |
TextWord
An object representing a word.
| Name | Path | Type | Description |
|---|---|---|---|
|
text
|
text | string |
The text content of the word. |
|
boundingBox
|
boundingBox | BoundingBox |
Quadrangle bounding box, with coordinates specified relative to the top-left of the original image. The eight numbers represent the four points, clockwise from the top-left corner relative to the text orientation. For image, the (x, y) coordinates are measured in pixels. For PDF, the (x, y) coordinates are measured in inches. |
|
confidence
|
confidence | Confidence |
Confidence value. |
BoundingBox
Quadrangle bounding box, with coordinates specified relative to the top-left of the original image. The eight numbers represent the four points, clockwise from the top-left corner relative to the text orientation. For image, the (x, y) coordinates are measured in pixels. For PDF, the (x, y) coordinates are measured in inches.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
float |
PageResult
Extracted information from a single page.
| Name | Path | Type | Description |
|---|---|---|---|
|
page
|
page | integer |
Page number. |
|
clusterId
|
clusterId | integer |
Cluster identifier. |
|
keyValuePairs
|
keyValuePairs | array of KeyValuePair |
List of key-value pairs extracted from the page. |
|
tables
|
tables | array of DataTable |
List of data tables extracted from the page. |
KeyValuePair
Information about the extracted key-value pair.
| Name | Path | Type | Description |
|---|---|---|---|
|
label
|
label | string |
A user defined label for the key/value pair entry. |
|
key
|
key | KeyValueElement |
Information about the extracted key or value in a key-value pair. |
|
value
|
value | KeyValueElement |
Information about the extracted key or value in a key-value pair. |
|
confidence
|
confidence | Confidence |
Confidence value. |
KeyValueElement
Information about the extracted key or value in a key-value pair.
| Name | Path | Type | Description |
|---|---|---|---|
|
text
|
text | string |
The text content of the key or value. |
|
boundingBox
|
boundingBox | BoundingBox |
Quadrangle bounding box, with coordinates specified relative to the top-left of the original image. The eight numbers represent the four points, clockwise from the top-left corner relative to the text orientation. For image, the (x, y) coordinates are measured in pixels. For PDF, the (x, y) coordinates are measured in inches. |
|
elements
|
elements | array of ElementReference |
When includeTextDetails is set to true, a list of references to the text elements constituting this key or value. |
ElementReference
DataTable
Information about the extracted table contained in a page.
| Name | Path | Type | Description |
|---|---|---|---|
|
rows
|
rows | integer |
Number of rows. |
|
columns
|
columns | integer |
Number of columns. |
|
cells
|
cells | array of DataTableCell |
List of cells contained in the table. |
DataTableCell
Information about the extracted cell in a table.
| Name | Path | Type | Description |
|---|---|---|---|
|
rowIndex
|
rowIndex | integer |
Row index of the cell. |
|
columnIndex
|
columnIndex | integer |
Column index of the cell. |
|
rowSpan
|
rowSpan | integer |
Number of rows spanned by this cell. |
|
columnSpan
|
columnSpan | integer |
Number of columns spanned by this cell. |
|
text
|
text | string |
Text content of the cell. |
|
boundingBox
|
boundingBox | BoundingBox |
Quadrangle bounding box, with coordinates specified relative to the top-left of the original image. The eight numbers represent the four points, clockwise from the top-left corner relative to the text orientation. For image, the (x, y) coordinates are measured in pixels. For PDF, the (x, y) coordinates are measured in inches. |
|
elements
|
elements | array of ElementReference |
When includeTextDetails is set to true, a list of references to the text elements constituting this table cell. |
|
isHeader
|
isHeader | boolean |
Return if the current cell is a header cell. |
|
isFooter
|
isFooter | boolean |
Return if the current cell a footer cell. |
InvoiceDocumentResult
A set of extracted fields corresponding to the input document.
| Name | Path | Type | Description |
|---|---|---|---|
|
docType
|
docType | string |
Document type. |
|
pageRange
|
pageRange | array of integer |
First and last page number where the document is found. |
|
fields
|
fields | InvoiceFields |
Invoice fields for 2.1. |
BusinessCardDocumentResult
A set of extracted fields corresponding to the input document.
| Name | Path | Type | Description |
|---|---|---|---|
|
docType
|
docType | string |
Document type. |
|
pageRange
|
pageRange | array of integer |
First and last page number where the document is found. |
|
fields
|
fields | BusinessCardFields |
BusinessCard fields for 2.1. |
CustomFormsDocumentResult
A set of extracted fields corresponding to the input document.
| Name | Path | Type | Description |
|---|---|---|---|
|
docType
|
docType | string |
Document type. |
|
pageRange
|
pageRange | array of integer |
First and last page number where the document is found. |
|
Fields
|
_fields | array of CustomFormsFields |
Array of fields with fieldName and fieldValue properties. |
ReceiptDocumentResult
A set of extracted fields corresponding to the input document.
| Name | Path | Type | Description |
|---|---|---|---|
|
docType
|
docType | string |
Document type. |
|
pageRange
|
pageRange | array of integer |
First and last page number where the document is found. |
|
fields
|
fields | ReceiptFields |
Receiptfields for 2.1. |
IdDocumentResult
A set of extracted fields corresponding to the input document.
| Name | Path | Type | Description |
|---|---|---|---|
|
docType
|
docType | string |
Document type. |
|
pageRange
|
pageRange | array of integer |
First and last page number where the document is found. |
|
fields
|
fields | IdFields |
ID Document fields for 2.1. |
CustomFormsFields
Custom Form fields.
| Name | Path | Type | Description |
|---|---|---|---|
|
Field Name
|
fieldName | string | |
|
Field Value
|
fieldValue | FieldValue |
Predicted field value object. |
InvoiceFields
Invoice fields for 2.1.
| Name | Path | Type | Description |
|---|---|---|---|
|
Amount due (text)
|
AmountDue.text | string |
Returns amount due as written on the invoice. |
|
Amount due (number)
|
AmountDue.valueNumber | number |
Formatted as a number. Example: 1234.98. |
|
Confidence of amount due
|
AmountDue.confidence | float |
How confident the model is in its prediction. |
|
Billing address
|
BillingAddress.text | string | |
|
Confidence of billing address
|
BillingAddress.confidence | float |
How confident the model is in its prediction. |
|
Billing address recipient
|
BillingAddressRecipient.text | string | |
|
Confidence of billing address recipient
|
BillingAddressRecipient.confidence | float |
How confident the model is in its prediction. |
|
Customer address
|
CustomerAddress.text | string | |
|
Confidence of customer address
|
CustomerAddress.confidence | float |
How confident the model is in its prediction. |
|
Customer address recipient
|
CustomerAddressRecipient.text | string | |
|
Confidence of customer address recipient
|
CustomerAddressRecipient.confidence | float |
How confident the model is in its prediction. |
|
Customer ID
|
CustomerId.text | string | |
|
Confidence of customer ID
|
CustomerId.confidence | float |
How confident the model is in its prediction. |
|
Customer name
|
CustomerName.text | string | |
|
Confidence of customer name
|
CustomerName.confidence | float |
How confident the model is in its prediction. |
|
Due date (text)
|
DueDate.text | string |
Returns due date as written on the invoice. |
|
Due date (date)
|
DueDate.valueDate | date |
Formatted as a date. Example: 2019-05-31. |
|
Confidence of due date
|
DueDate.confidence | float |
How confident the model is in its prediction. |
|
Invoice date (text)
|
InvoiceDate.text | string |
Returns invoice date as written on the invoice. |
|
Invoice date (date)
|
InvoiceDate.valueDate | date |
Formatted as a date. Example: 2019-05-31. |
|
Confidence of invoice date
|
InvoiceDate.confidence | float |
How confident the model is in its prediction. |
|
Invoice ID
|
InvoiceId.text | string | |
|
Confidence of invoice ID
|
InvoiceId.confidence | float |
How confident the model is in its prediction. |
|
Invoice total (text)
|
InvoiceTotal.text | string |
Returns invoice total as written on the invoice. |
|
Invoice total (number)
|
InvoiceTotal.valueNumber | number |
Formatted as a number. Example: 1234.98. |
|
Confidence of invoice total
|
InvoiceTotal.confidence | float |
How confident the model is in its prediction. |
|
Previous unpaid balance (text)
|
PreviousUnpaidBalance.text | string |
Returns previous unpaid balance as written on the invoice. |
|
Previous unpaid balance (number)
|
PreviousUnpaidBalance.valueNumber | number |
Formatted as a number. Example: 1234.98. |
|
Confidence of previous unpaid balance
|
PreviousUnpaidBalance.confidence | float |
How confident the model is in its prediction. |
|
Purchase order
|
PurchaseOrder.text | string | |
|
Confidence of purchase order
|
PurchaseOrder.confidence | float |
How confident the model is in its prediction. |
|
Remittance address
|
RemittanceAddress.text | string | |
|
Confidence of remittance address
|
RemittanceAddress.confidence | float |
How confident the model is in its prediction. |
|
Remittance address recipient
|
RemittanceAddressRecipient.text | string | |
|
Confidence of remittance address recipient
|
RemittanceAddressRecipient.confidence | float |
How confident the model is in its prediction. |
|
Service address
|
ServiceAddress.text | string | |
|
Confidence of service address
|
ServiceAddress.confidence | float |
How confident the model is in its prediction. |
|
Service address recipient
|
ServiceAddressRecipient.text | string | |
|
Confidence of service address recipient
|
ServiceAddressRecipient.confidence | float |
How confident the model is in its prediction. |
|
Service end date (text)
|
ServiceEndDate.text | string |
Returns service end date as written on the invoice. |
|
Service end date (date)
|
ServiceEndDate.valueDate | date |
Formatted as a date. Example: 2019-05-31. |
|
Confidence of service end date
|
ServiceEndDate.confidence | float |
How confident the model is in its prediction. |
|
Service start date (text)
|
ServiceStartDate.text | string |
Returns service start date as written on the invoice. |
|
Service start date (date)
|
ServiceStartDate.valueDate | date |
Formatted as a date. Example: 2019-05-31. |
|
Confidence of service start date
|
ServiceStartDate.confidence | float |
How confident the model is in its prediction. |
|
Shipping address
|
ShippingAddress.text | string | |
|
Confidence of shipping address
|
ShippingAddress.confidence | float |
How confident the model is in its prediction. |
|
Shipping address recipient
|
ShippingAddressRecipient.text | string | |
|
Confidence of shipping address recipient
|
ShippingAddressRecipient.confidence | float |
How confident the model is in its prediction. |
|
Subtotal (text)
|
SubTotal.text | string |
Returns subtotal as written on the invoice. |
|
Subtotal (number)
|
SubTotal.valueNumber | number |
Formatted as a number. Example: 1234.98. |
|
Confidence of subtotal
|
SubTotal.confidence | float |
How confident the model is in its prediction. |
|
Total tax (text)
|
TotalTax.text | string |
Returns total tax as written on the invoice. |
|
Total tax (number)
|
TotalTax.valueNumber | number |
Formatted as a number. Example: 1234.98. |
|
Confidence of total tax
|
TotalTax.confidence | float |
How confident the model is in its prediction. |
|
Vendor address
|
VendorAddress.text | string | |
|
Confidence of vendor address
|
VendorAddress.confidence | float |
How confident the model is in its prediction. |
|
Vendor address recipient
|
VendorAddressRecipient.text | string | |
|
Confidence of vendor address recipient
|
VendorAddressRecipient.confidence | float |
How confident the model is in its prediction. |
|
Vendor name
|
VendorName.text | string | |
|
Confidence of vendor name
|
VendorName.confidence | float |
How confident the model is in its prediction. |
|
Items
|
Items.valueArray | array of object |
Array of line items |
|
Amount (text)
|
Items.valueArray.valueObject.Amount.text | string |
Returns amount as written on the invoice. |
|
Amount (number)
|
Items.valueArray.valueObject.Amount.valueNumber | number |
Formatted as a number. Example: 12. |
|
Confidence of amount
|
Items.valueArray.valueObject.Amount.confidence | float |
How confident the model is in its prediction. |
|
Description
|
Items.valueArray.valueObject.Description.text | string | |
|
Confidence of description
|
Items.valueArray.valueObject.Description.confidence | float |
How confident the model is in its prediction. |
|
Quantity (text)
|
Items.valueArray.valueObject.Quantity.text | string |
Returns quantity as written on the invoice. |
|
Quantity (number)
|
Items.valueArray.valueObject.Quantity.valueNumber | number |
Formatted as a number. Example: 12. |
|
Confidence of quantity
|
Items.valueArray.valueObject.Quantity.confidence | float |
How confident the model is in its prediction. |
|
Unit price (text)
|
Items.valueArray.valueObject.UnitPrice.text | string |
Returns unit price as written on the invoice. |
|
Unit price (number)
|
Items.valueArray.valueObject.UnitPrice.valueNumber | number |
Formatted as a number. Example: 12. |
|
Confidence of unit price
|
Items.valueArray.valueObject.UnitPrice.confidence | float |
How confident the model is in its prediction. |
|
Product code
|
Items.valueArray.valueObject.ProductCode.text | string | |
|
Confidence of product code
|
Items.valueArray.valueObject.ProductCode.confidence | float |
How confident the model is in its prediction. |
|
Unit
|
Items.valueArray.valueObject.Unit.text | string | |
|
Confidence of unit
|
Items.valueArray.valueObject.Unit.confidence | float |
How confident the model is in its prediction. |
|
Date (text)
|
Items.valueArray.valueObject.Date.text | string |
Returns date as written on the invoice. |
|
Date (date)
|
Items.valueArray.valueObject.Date.valueDate | date |
Formatted as a date. Example: 2019-05-31. |
|
Confidence of date
|
Items.valueArray.valueObject.Date.confidence | float |
How confident the model is in its prediction. |
|
Tax (text)
|
Items.valueArray.valueObject.Tax.text | string |
Returns tax as written on the invoice. |
|
Tax (number)
|
Items.valueArray.valueObject.Tax.valueNumber | number |
Formatted as a number. Example: 12. |
|
Confidence of tax
|
Items.valueArray.valueObject.Tax.confidence | float |
How confident the model is in its prediction. |
BusinessCardFields
BusinessCard fields for 2.1.
| Name | Path | Type | Description |
|---|---|---|---|
|
Contact names
|
ContactNames.valueArray | array of object |
Array of contact names |
|
First name
|
ContactNames.valueArray.valueObject.FirstName.text | string | |
|
Confidence of first name
|
ContactNames.valueArray.valueObject.FirstName.confidence | float |
How confident the model is in its prediction. |
|
Last name
|
ContactNames.valueArray.valueObject.LastName.text | string | |
|
Confidence of last name
|
ContactNames.valueArray.valueObject.LastName.confidence | float |
How confident the model is in its prediction. |
|
Company names
|
CompanyNames.valueArray | array of object |
Array of company names |
|
Company name
|
CompanyNames.valueArray.text | string | |
|
Confidence of company name
|
CompanyNames.valueArray.confidence | float |
How confident the model is in its prediction. |
|
Departments
|
Departments.valueArray | array of object |
Array of departments |
|
Department
|
Departments.valueArray.text | string | |
|
Confidence of department
|
Departments.valueArray.confidence | float |
How confident the model is in its prediction. |
|
Job titles
|
JobTitles.valueArray | array of object |
Array of job titles |
|
Job title
|
JobTitles.valueArray.text | string | |
|
Confidence of job title
|
JobTitles.valueArray.confidence | float |
How confident the model is in its prediction. |
|
Emails
|
Emails.valueArray | array of object |
Array of emails |
|
Email
|
Emails.valueArray.text | string | |
|
Confidence of email
|
Emails.valueArray.confidence | float |
How confident the model is in its prediction. |
|
Websites
|
Websites.valueArray | array of object |
Array of websites |
|
Website
|
Websites.valueArray.text | string | |
|
Confidence of website
|
Websites.valueArray.confidence | float |
How confident the model is in its prediction. |
|
Addresses
|
Addresses.valueArray | array of object |
Array of addresses |
|
Address
|
Addresses.valueArray.text | string | |
|
Confidence of address
|
Addresses.valueArray.confidence | float |
How confident the model is in its prediction. |
|
Mobile phones
|
MobilePhones.valueArray | array of object |
Array of mobile phones |
|
Mobile phone
|
MobilePhones.valueArray.text | string | |
|
Confidence of mobile phone
|
MobilePhones.valueArray.confidence | float |
How confident the model is in its prediction. |
|
Faxes
|
Faxes.valueArray | array of object |
Array of faxes |
|
Fax
|
Faxes.valueArray.text | string | |
|
Confidence of fax
|
Faxes.valueArray.confidence | float |
How confident the model is in its prediction. |
|
Work phones
|
WorkPhones.valueArray | array of object |
Array of work phones |
|
Work phone
|
WorkPhones.valueArray.text | string | |
|
Confidence of work phone
|
WorkPhones.valueArray.confidence | float |
How confident the model is in its prediction. |
|
Other phones
|
OtherPhones.valueArray | array of object |
Array of other phones |
|
Other phone
|
OtherPhones.valueArray.text | string | |
|
Confidence of other phone
|
OtherPhones.valueArray.confidence | float |
How confident the model is in its prediction. |
ReceiptFields
Receiptfields for 2.1.
| Name | Path | Type | Description |
|---|---|---|---|
|
Receipt type
|
ReceiptType.text | string | |
|
Confidence of receipt type
|
ReceiptType.confidence | float |
How confident the model is in its prediction. |
|
Merchant name
|
MerchantName.text | string | |
|
Confidence of merchant name
|
MerchantName.confidence | float |
How confident the model is in its prediction. |
|
Merchant phone number
|
MerchantPhoneNumber.text | string | |
|
Confidence of merchant phone number
|
MerchantPhoneNumber.confidence | float |
How confident the model is in its prediction. |
|
Merchant address
|
MerchantAddress.text | string | |
|
Confidence of merchant address
|
MerchantAddress.confidence | float |
How confident the model is in its prediction. |
|
Transaction date (text)
|
TransactionDate.text | string |
Returns transaction date as written on the invoice. |
|
Transaction date (date)
|
TransactionDate.valueDate | date |
Formatted as a date. Example: 2019-05-31. |
|
Confidence of transaction date
|
TransactionDate.confidence | float |
How confident the model is in its prediction. |
|
Transaction time (text)
|
TransactionTime.text | string |
Returns transaction time as written on the invoice. |
|
Transaction time (time)
|
TransactionTime.valueDate | time |
Formatted as a date. Example: 2019-05-31. |
|
Confidence of transaction time
|
TransactionTime.confidence | float |
How confident the model is in its prediction. |
|
Total (text)
|
Total.text | string |
Returns total as written on the invoice. |
|
Total (number)
|
Total.valueNumber | number |
Formatted as a number. Example: 1234.98. |
|
Confidence of total
|
Total.confidence | float |
How confident the model is in its prediction. |
|
Subtotal (text)
|
Subtotal.text | string |
Returns subtotal as written on the invoice. |
|
Subtotal (number)
|
Subtotal.valueNumber | number |
Formatted as a number. Example: 1234.98. |
|
Confidence of subtotal
|
Subtotal.confidence | float |
How confident the model is in its prediction. |
|
Tax (text)
|
Tax.text | string |
Returns tax as written on the invoice. |
|
Tax (number)
|
Tax.valueNumber | number |
Formatted as a number. Example: 1234.98. |
|
Confidence of tax
|
Tax.confidence | float |
How confident the model is in its prediction. |
|
Tip (text)
|
Tip.text | string |
Returns tip as written on the invoice. |
|
Tip (number)
|
Tip.valueNumber | number |
Formatted as a number. Example: 1234.98. |
|
Confidence of tip
|
Tip.confidence | float |
How confident the model is in its prediction. |
|
Items
|
Items.valueArray | array of object |
Array of line items |
|
Name
|
Items.valueArray.valueObject.Name.text | string | |
|
Confidence of name
|
Items.valueArray.valueObject.Name.confidence | float |
How confident the model is in its prediction. |
|
Quantity (text)
|
Items.valueArray.valueObject.Quantity.text | string |
Returns quantity as written on the invoice. |
|
Quantity (number)
|
Items.valueArray.valueObject.Quantity.valueNumber | number |
Formatted as a number. Example: 12. |
|
Confidence of quantity
|
Items.valueArray.valueObject.Quantity.confidence | float |
How confident the model is in its prediction. |
|
Price (text)
|
Items.valueArray.valueObject.Price.text | string |
Returns price as written on the invoice. |
|
Price (number)
|
Items.valueArray.valueObject.Price.valueNumber | number |
Formatted as a number. Example: 12. |
|
Confidence of price
|
Items.valueArray.valueObject.Price.confidence | float |
How confident the model is in its prediction. |
|
Total price (text)
|
Items.valueArray.valueObject.TotalPrice.text | string |
Returns total price as written on the invoice. |
|
Total price (number)
|
Items.valueArray.valueObject.TotalPrice.valueNumber | number |
Formatted as a number. Example: 12. |
|
Confidence of total price
|
Items.valueArray.valueObject.TotalPrice.confidence | float |
How confident the model is in its prediction. |
IdFields
ID Document fields for 2.1.
| Name | Path | Type | Description |
|---|---|---|---|
|
Country Region
|
CountryRegion.valueCountryRegion | string | |
|
Confidence of Country Region
|
CountryRegion.confidence | float |
How confident the model is in its prediction. |
|
Date of expiration
|
DateOfExpiration.text | string |
Returns date of expiration as written on the invoice. |
|
Date of expiration (date)
|
DateOfExpiration.valueDate | date |
Formatted as a date. Example: 2019-05-31. |
|
Confidence of date of expiration
|
DateOfExpiration.confidence | float |
How confident the model is in its prediction. |
|
Date of birth (text)
|
DateOfBirth.text | string |
Returns date of birth as written on the invoice. |
|
Date of birth (date)
|
DateOfBirth.valueDate | date |
Formatted as a date. Example: 2019-05-31. |
|
Confidence of date of birth
|
DateOfBirth.confidence | float |
How confident the model is in its prediction. |
|
Document number
|
DocumentNumber.text | string | |
|
Confidence of document number
|
DocumentNumber.confidence | float |
How confident the model is in its prediction. |
|
First name
|
FirstName.text | string | |
|
Confidence of first name
|
FirstName.confidence | float |
How confident the model is in its prediction. |
|
Last name
|
LastName.text | string | |
|
Confidence of last name
|
LastName.confidence | float |
How confident the model is in its prediction. |
|
Nationality
|
Nationality.valueCountryRegion | string | |
|
Confidence of nationality
|
Nationality.confidence | float |
How confident the model is in its prediction. |
|
Sex
|
Sex.text | string | |
|
Confidence of sex
|
Sex.confidence | float |
How confident the model is in its prediction. |
|
Machine readable zone
|
MachineReadableZone.text | string | |
|
Confidence of machine readable zone
|
MachineReadableZone.confidence | float |
How confident the model is in its prediction. |
|
Document type
|
DocumentType.text | string | |
|
Confidence of document type
|
DocumentType.confidence | float |
How confident the model is in its prediction. |
|
Address
|
Address.text | string | |
|
Confidence of address
|
Address.confidence | float |
How confident the model is in its prediction. |
|
Region
|
Region.text | string | |
|
Confidence of region
|
Region.confidence | float |
How confident the model is in its prediction. |
FieldValue
Predicted field value object.
| Name | Path | Type | Description |
|---|---|---|---|
|
type
|
type | FieldValueType |
Semantic data type of the field value. |
|
valueString
|
valueString | string |
String value. |
|
valueDate
|
valueDate | date-time |
Date value. |
|
valueTime
|
valueTime | date-time |
Time value. |
|
valuePhoneNumber
|
valuePhoneNumber | string |
Phone number value. |
|
valueNumber
|
valueNumber | number |
Floating point value. |
|
valueInteger
|
valueInteger | integer |
Integer value. |
|
text
|
text | string | |
|
boundingBox
|
boundingBox | BoundingBox |
Quadrangle bounding box, with coordinates specified relative to the top-left of the original image. The eight numbers represent the four points, clockwise from the top-left corner relative to the text orientation. For image, the (x, y) coordinates are measured in pixels. For PDF, the (x, y) coordinates are measured in inches. |
|
confidence
|
confidence | Confidence |
Confidence value. |
|
elements
|
elements | array of ElementReference |
When includeTextDetails is set to true, a list of references to the text elements constituting this field. |
|
page
|
page | integer |
The 1-based page number in the input document. |
FieldValueType
Confidence
ApiVersion_V30
AnalyzeResultOperation_V30
Status and result of the analyze operation.
| Name | Path | Type | Description |
|---|---|---|---|
|
status
|
status | string |
Operation status. |
|
createdDateTime
|
createdDateTime | date-time |
Date and time (UTC) when the analyze operation was submitted. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | date-time |
Date and time (UTC) when the status was last updated. |
|
error
|
error | Error_V30 |
Error info. |
|
analyzeResult
|
analyzeResult | AnalyzeResult_V30 |
Document analysis result. |
AnalyzeResult_V30
Document analysis result.
| Name | Path | Type | Description |
|---|---|---|---|
|
apiVersion
|
apiVersion | ApiVersion_V30 |
API version. |
|
modelId
|
modelId | ModelId_V30 |
Unique model name. |
|
stringIndexType
|
stringIndexType | StringIndexType_V30 |
Method used to compute string offset and length. |
|
content
|
content | string |
Concatenate string representation of all textual and visual elements in reading order. |
|
pages
|
pages | array of DocumentPage_V30 |
Analyzed pages. |
|
paragraphs
|
paragraphs | array of DocumentParagraph_V30 |
Extracted paragraphs. |
|
tables
|
tables | array of DocumentTable_V30 |
Extracted tables. |
|
keyValuePairs
|
keyValuePairs | array of DocumentKeyValuePair_V30 |
Extracted key-value pairs. |
|
entities
|
entities | array of DocumentEntity_V30 |
Extracted entities. |
|
styles
|
styles | array of DocumentStyle_V30 |
Extracted font styles. |
|
languages
|
languages | array of DocumentLanguage_V30 |
Detected languages. |
|
documents
|
documents | array of Document_V30 |
Extracted documents. |
DocumentPage_V30
Content and layout elements extracted from a page from the input.
| Name | Path | Type | Description |
|---|---|---|---|
|
kind
|
kind | string |
Kind of document page. |
|
pageNumber
|
pageNumber | integer |
1-based page number in the input document. |
|
angle
|
angle | number |
The general orientation of the content in clockwise direction, measured in degrees between (-180, 180]. |
|
width
|
width | number |
The width of the image/PDF in pixels/inches, respectively. |
|
height
|
height | number |
The height of the image/PDF in pixels/inches, respectively. |
|
unit
|
unit | string |
The unit used by the width, height, and polygon properties. For images, the unit is "pixel". For PDF, the unit is "inch". |
|
spans
|
spans | array of DocumentSpan_V30 |
Location of the page in the reading order concatenated content. |
|
words
|
words | array of DocumentWord_V30 |
Extracted words from the page. |
|
selectionMarks
|
selectionMarks | array of DocumentSelectionMark_V30 |
Extracted selection marks from the page. |
|
images
|
images | array of DocumentImage_V30 |
Extracted images from the page. |
|
lines
|
lines | array of DocumentLine_V30 |
Extracted lines from the page, potentially containing both textual and visual elements. |
|
barcodes
|
barcodes | array of DocumentBarcode_V31 |
Extracted barcodes from the page. |
|
formulas
|
formulas | array of DocumentFormula_V31 |
Extracted formulas from the page. |
DocumentWord_V30
A word object consisting of a contiguous sequence of characters. For non-space delimited languages, such as Chinese, Japanese, and Korean, each character is represented as its own word.
| Name | Path | Type | Description |
|---|---|---|---|
|
content
|
content | string |
Text content of the word. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Bounding polygon, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. |
|
span
|
span | DocumentSpan_V30 |
Contiguous region of the concatenated content property, specified as an offset and length. |
|
confidence
|
confidence | Confidence_V30 |
Prediction confidence. |
DocumentSelectionMark_V30
A selection mark object representing check boxes, radio buttons, and other elements indicating a selection.
| Name | Path | Type | Description |
|---|---|---|---|
|
state
|
state | DocumentSelectionMarkState_V30 |
State of the selection mark. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Bounding polygon, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. |
|
span
|
span | DocumentSpan_V30 |
Contiguous region of the concatenated content property, specified as an offset and length. |
|
confidence
|
confidence | Confidence_V30 |
Prediction confidence. |
DocumentImage_V30
An image object detected in the page.
| Name | Path | Type | Description |
|---|---|---|---|
|
polygon
|
polygon | BoundingPolygon_V30 |
Bounding polygon, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. |
|
span
|
span | DocumentSpan_V30 |
Contiguous region of the concatenated content property, specified as an offset and length. |
|
pageRef
|
pageRef | integer |
0-based index of the global pages array that containing the content of the image. |
|
confidence
|
confidence | Confidence_V30 |
Prediction confidence. |
DocumentSelectionMarkState_V30
DocumentStyle_V30
An object representing observed text styles.
| Name | Path | Type | Description |
|---|---|---|---|
|
backgroundColor
|
backgroundColor | string |
Background color in #rrggbb hexadecimal format.. |
|
color
|
color | string |
Foreground color in #rrggbb hexadecimal format. |
|
confidence
|
confidence | Confidence_V30 |
Prediction confidence. |
|
fontStyle
|
fontStyle | string |
Font style. |
|
fontWeight
|
fontWeight | string |
Font weight. |
|
isHandwritten
|
isHandwritten | boolean |
Is content handwritten. |
|
similarFontFamily
|
similarFontFamily | string |
Visually most similar font from among the set of supported font families, with fallback fonts following CSS convention (ex. 'Arial, sans-serif'). |
|
spans
|
spans | array of DocumentSpan_V30 |
Location of the text elements in the concatenated content the style applies to. |
DocumentLanguage_V30
An object representing the detected language for a given text span.
| Name | Path | Type | Description |
|---|---|---|---|
|
locale
|
locale | string |
Detected language. Value may an ISO 639-1 language code (ex. "en", "fr") or BCP 47 language tag (ex. "zh-Hans"). |
|
spans
|
spans | array of DocumentSpan_V30 |
Location of the text elements in the concatenated content the language applies to. |
|
confidence
|
confidence | Confidence_V30 |
Prediction confidence. |
DocumentLine_V30
A content line object consisting of an adjacent sequence of content elements, such as words and selection marks.
| Name | Path | Type | Description |
|---|---|---|---|
|
content
|
content | string |
Concatenated content of the contained elements in reading order. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Bounding polygon, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. |
|
spans
|
spans | array of DocumentSpan_V30 |
Location of the line in the reading order concatenated content. |
DocumentParagraph_V30
A paragraph object consisting with contiguous lines generally with common alignment and spacing.
| Name | Path | Type | Description |
|---|---|---|---|
|
role
|
role | string |
Semantic role of the paragraph. |
|
content
|
content | string |
Concatenated content of the paragraph in reading order. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Bounding regions covering the paragraph. |
|
spans
|
spans | array of DocumentSpan_V30 |
Location of the paragraph in the reading order concatenated content. |
DocumentTable_V30
A table object consisting table cells arranged in a rectangular layout.
| Name | Path | Type | Description |
|---|---|---|---|
|
rowCount
|
rowCount | integer |
Number of rows in the table. |
|
columnCount
|
columnCount | integer |
Number of columns in the table. |
|
cells
|
cells | array of DocumentTableCell_V30 |
Cells contained within the table. |
|
caption
|
caption | DocumentCaption_V30 |
An object representing the location and content of a table caption. |
|
footnotes
|
footnotes | array of DocumentFootnote_V30 |
Footnotes associated with the table. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Bounding regions covering the table. |
|
spans
|
spans | array of DocumentSpan_V30 |
Location of the table in the reading order concatenated content. |
DocumentTableCell_V30
An object representing the location and content of a table cell.
| Name | Path | Type | Description |
|---|---|---|---|
|
kind
|
kind | string |
Table cell kind. |
|
rowIndex
|
rowIndex | integer |
Row index of the cell. |
|
columnIndex
|
columnIndex | integer |
Column index of the cell. |
|
rowSpan
|
rowSpan | integer |
Number of rows spanned by this cell. |
|
columnSpan
|
columnSpan | integer |
Number of columns spanned by this cell. |
|
content
|
content | string |
Concatenated content of the table cell in reading order. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Bounding regions covering the table cell. |
|
spans
|
spans | array of DocumentSpan_V30 |
Location of the table cell in the reading order concatenated content. |
DocumentCaption_V30
An object representing the location and content of a table caption.
| Name | Path | Type | Description |
|---|---|---|---|
|
content
|
content | string |
Table caption content. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Bounding regions covering the table caption. |
|
spans
|
spans | array of DocumentSpan_V30 |
Location of the table caption in the reading order concatenated content. |
DocumentFootnote_V30
An object representing the location and content of a table footnote.
| Name | Path | Type | Description |
|---|---|---|---|
|
content
|
content | string |
Table footnote content. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Bounding regions covering the table footnote. |
|
spans
|
spans | array of DocumentSpan_V30 |
Location of the table footnote in the reading order concatenated content. |
DocumentKeyValuePair_V30
An object representing a form field with distinct field label (key) and field value (may be empty).
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | DocumentKeyValueElement_V30 |
An object representing the field key or value in a key-value pair. |
|
value
|
value | DocumentKeyValueElement_V30 |
An object representing the field key or value in a key-value pair. |
|
confidence
|
confidence | Confidence_V30 |
Prediction confidence. |
DocumentKeyValueElement_V30
An object representing the field key or value in a key-value pair.
| Name | Path | Type | Description |
|---|---|---|---|
|
content
|
content | string |
Concatenated content of the key-value element in reading order. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Bounding regions covering the key-value element. |
|
spans
|
spans | array of DocumentSpan_V30 |
Location of the key-value element in the reading order concatenated content. |
DocumentEntity_V30
An object representing various categories of entities.
| Name | Path | Type | Description |
|---|---|---|---|
|
category
|
category | string |
Entity type. |
|
subCategory
|
subCategory | string |
Entity sub type. |
|
content
|
content | string |
Entity content. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Bounding regions covering the entity. |
|
spans
|
spans | array of DocumentSpan_V30 |
Location of the entity in the reading order concatenated content. |
|
confidence
|
confidence | Confidence_V30 |
Prediction confidence. |
DocumentBarcode_V31
A barcode object.
| Name | Path | Type | Description |
|---|---|---|---|
|
confidence
|
confidence | Confidence_V30 |
Prediction confidence. |
|
kind
|
kind | string |
Barcode kind. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Bounding polygon, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. |
|
span
|
span | DocumentSpan_V30 |
Contiguous region of the concatenated content property, specified as an offset and length. |
|
value
|
value | string |
Barcode value |
DocumentFormula_V31
A formula object.
| Name | Path | Type | Description |
|---|---|---|---|
|
confidence
|
confidence | Confidence_V30 |
Prediction confidence. |
|
kind
|
kind | string |
Formula kind. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Bounding polygon, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. |
|
span
|
span | DocumentSpan_V30 |
Contiguous region of the concatenated content property, specified as an offset and length. |
|
value
|
value | string |
LaTex expression describing the formula. |
Document_V30
An object describing the location and semantic content of a document.
| Name | Path | Type | Description |
|---|---|---|---|
|
docType
|
docType | DocType_V30 |
Document type name. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Bounding regions covering the document. |
|
spans
|
spans | array of DocumentSpan_V30 |
Location of the document in the reading order concatenated content. |
|
fields
|
fields | object |
Dictionary of named field values. |
|
Fields
|
_fields | array of DocumentFieldNameValue_V30 |
Array of fields with fieldName and fieldValue properties. |
|
confidence
|
confidence | Confidence_V30 |
Prediction confidence. |
BoundingPolygon_V30
Bounding polygon, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
number |
BoundingRegion_V30
Bounding polygon on a specific page of the input.
| Name | Path | Type | Description |
|---|---|---|---|
|
pageNumber
|
pageNumber | integer |
1-based page number of page containing the bounding region. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Bounding polygon, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. |
DocumentFieldType_V30
DocumentFieldNameValue_V30
Document field object with field name and its value.
| Name | Path | Type | Description |
|---|---|---|---|
|
Field Name
|
fieldName | string | |
|
fieldValue
|
fieldValue | DocumentField_V30 |
An object representing the content and location of a field value. |
DocumentField_V30
An object representing the content and location of a field value.
| Name | Path | Type | Description |
|---|---|---|---|
|
type
|
type | DocumentFieldType_V30 |
Semantic data type of the field value. |
|
valueString
|
valueString | string |
String value. |
|
valueDate
|
valueDate | date |
Date value in YYYY-MM-DD format (ISO 8601). |
|
valueTime
|
valueTime | time |
Time value in hh:mm:ss format (ISO 8601). |
|
valuePhoneNumber
|
valuePhoneNumber | string |
Phone number value in E.164 format (ex. +19876543210). |
|
valueNumber
|
valueNumber | number |
Floating point value. |
|
valueInteger
|
valueInteger | integer |
Integer value. |
|
valueSelectionMark
|
valueSelectionMark | DocumentSelectionMarkState_V30 |
State of the selection mark. |
|
valueSignature
|
valueSignature | string |
Presence of signature. |
|
valueCountryRegion
|
valueCountryRegion | string |
3-letter country code value (ISO 3166-1 alpha-3). |
|
valueCurrency
|
valueCurrency | CurrencyValue_V30 |
Currency field value. |
|
valueAddress
|
valueAddress | AddressValue_V30 |
Address field value. |
|
valueBoolean
|
valueBoolean | boolean |
Boolean value. |
|
content
|
content | string |
Field content. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Bounding regions covering the field. |
|
spans
|
spans | array of DocumentSpan_V30 |
Location of the field in the reading order concatenated content. |
|
confidence
|
confidence | Confidence_V30 |
Prediction confidence. |
Confidence_V30
DocType_V30
DocumentSpan_V30
Contiguous region of the concatenated content property, specified as an offset and length.
| Name | Path | Type | Description |
|---|---|---|---|
|
offset
|
offset | integer |
Zero-based index of the content represented by the span. |
|
length
|
length | integer |
Number of characters in the content represented by the span. |
StringIndexType_V30
Method used to compute string offset and length.
Method used to compute string offset and length.
ModelId_V30
Error_V30
Error info.
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | string |
Error code. |
|
message
|
message | string |
Error message. |
|
target
|
target | string |
Target of the error. |
|
details
|
details | array of InnerError_V30 |
List of detailed errors. |
|
innererror
|
innererror | InnerError_V30 |
Detailed error. |
InnerError_V30
Detailed error.
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | string |
Error code. |
|
message
|
message | string |
Error message. |
CurrencyValue_V30
Currency field value.
| Name | Path | Type | Description |
|---|---|---|---|
|
amount
|
amount | double |
Currency amount. |
|
currencyCode
|
currencyCode | string |
Resolved currency code (ISO 4217), if any. |
|
currencySymbol
|
currencySymbol | string |
Currency symbol label, if any. |
AddressValue_V30
Address field value.
| Name | Path | Type | Description |
|---|---|---|---|
|
houseNumber
|
houseNumber | string |
House or building number. |
|
poBox
|
poBox | string |
Post office box number. |
|
road
|
road | string |
Street name. |
|
city
|
city | string |
Name of city, town, village, etc. |
|
state
|
state | string |
First-level administrative division. |
|
postalCode
|
postalCode | string |
Postal code used for mail sorting. |
|
countryRegion
|
countryRegion | string |
Country or region. |
|
streetAddress
|
streetAddress | string |
Street-level address, excluding city, state, countryRegion, and postalCode. |
|
cityDistrict
|
cityDistrict | string |
Districts or boroughs within a city, such as Brooklyn in New York City or City of Westminster in London. |
|
house
|
house | string |
Build name, such as World Trade Center. |
|
level
|
level | string |
Floor number, such as 3F. |
|
stateDistrict
|
stateDistrict | string |
Second-level administrative division used in certain locales. |
|
suburb
|
suburb | string |
Unofficial neighborhood name, like Chinatown. |
|
unit
|
unit | string |
Apartment or office number. |