OcrSampleDocument
Represents the details of a sample document or a document type that’s used as a reference while extracting and mapping information from a customer form.This type extends the Metadata metadata type and inherits its fullName field.
Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.
The OcrSampleDocument type doesn’t need to represent a real sample document. It can also be an abstract document that represents all documents of the same DocumentType. In such cases, the contentAsset and documentHeight fields are null.
OcrSampleDocument components have the suffix .ocrSampleDocument and are stored in the ocrSampleDocuments folder.
OcrTemplate components are available in API version 55.0 and later.
To use this metadata type, your Salesforce org must have the AWSTextract1000LimitAddOn or IntelligentDocumentReaderAddOn license.
- Field Type: string
- Description: The ID of the OCR sample document asset.
This field is null if the OcrSampleDocument is an abstract document representing the DocumentType.
- Field Type: double
- Description: The normalized height of the OCR sample document page.
This field is null if the OcrSampleDocument is an abstract document representing the DocumentType.
- Field Type: string
- Description: Required. The type of the OCR sample document.
- Field Type: string
- Description: Required. The label for the OCR sample document.
- Field Type: OcrSampleDocumentField[]
- Description: The details of the field in a form whose value is extracted and mapped to a Salesforce object field.
- Field Type: OcrSampleDocumentPage[]
- Description: A collection of fields that define a page in the OCR sample document.
Represents the details of the field in a form whose value is extracted and mapped to a Salesforce object field.
- Field Type: int
- Description: The column number in the item with the cell storing this field’s value. Available in API version 56.0 and later.
- Field Type: int
- Description: The number of columns that span the cell storing this field’s value. Available in API version 56.0 and later.
- Field Type: int
- Description: The row number in the item with the cell storing this field’s value. Available in API version 56.0 and later.
- Field Type: int
- Description: The number of rows that span the cell storing this field’s value. Available in API version 56.0 and later.
- Field Type: double
- Description: A normalized coordinate representing the right edge of the bounding box of the key.
- Field Type: double
- Description: A normalized coordinate representing the bottom edge of the bounding box of the key.
- Field Type: double
- Description: A normalized coordinate representing the left edge of the bounding box of the key.
- Field Type: double
- Description: A normalized coordinate representing the top edge of the bounding box of the key.
- Field Type: string
- Description: Name of the referred field value. Available in API version 56.0 and later.
- Field Type: boolean
- Description: Indicates whether the key is automatically extracted (
true) or not (false). Available in API version 57.0 and later.
This field helps to distinguish auto-extracted keys from manual ones.
- Field Type: string
- Description: The content in a particular area of the form, representing the field that is extracted by OCR.
- Field Type: string
- Description: Required. The associated OCR sample document used as a reference while extracting and mapping information from a customer form.
- Field Type: string
- Description: A reference to a page of the OCR sample document that contains the key.
This field is null if the OcrSampleDocument is an abstract document representing the DocumentType.
- Field Type: OcrSampleDocumentPageItem[]
- Description: A reference to the item on the sample document page containing this field’s value. Available in API version 56.0 and later.
Represents a collection of fields that define a page in the OCR sample document. This type exists only if the OcrSampleDocument is a real sample document and not an abstract document representing the DocumentType.
- Field Type: string
- Description: Required. The associated OCR sample document used as a reference while extracting and mapping information from a customer form.
- Field Type: OcrSampleDocumentPageItem[]
- Description: The collection of page items with the associated OCR sample document page. Available in API version 56.0 and later.
- Field Type: double
- Description: The normalized height of the OCR sample document page.
- Field Type: integer
- Description: Required. The page number of the page in the associated OCR sample document.
Represents a foreign key reference to the item on the sample document page containing a value for the page item.
- Field Type: boolean
- Description: Indicates whether the OCR sample document page item has a header (
true) or not (false). Available in API version 56.0 and later. - Default value:
false
- Field Type: int
- Description: Required. The sequence number of the item on an OCR sample document page with multiple items. Available in API version 56.0 and later.
- Field Type: string
- Description: The title of the OCR sample document page item. Available in API version 56.0 and later.
- Field Type: ItemType (enumeration of type string)
- Description: Required. Specifies the type of OCR sample document page item. Valid value is
TABLE. Available in API version 56.0 and later.
The following is an example of a OcrSampleDocument component.
The following is an example package.xml that references the previous definition.
This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.