OcrSampleDocumentField

Represents the details of the field in a document whose value is extracted and mapped to a Salesforce object field. This object is available in API version 52.0 and later.

Supported SOAP API Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules

To use this tooling API object, your Salesforce org must have the AWSTextract1000LimitAddOn license.

Fields

Field Details
CellColumnNumber
Type
int
Properties
Create, Filter, Group, in Nillable, Sort, Update
Description
The column number of the cell storing the OCR sample document field’s value in the OCR sample document page item. Available in API version 56.0 and later.
CellColumnSpanValue
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The number of columns that the cell storing the OCR sample document field’s value must span. Available in API version 56.0 and later.
CellRowNumber
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The row number of the cell storing the OCR sample document field’s value in the OCR sample document page item. Available in API version 56.0 and later.
CellRowSpanValue
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The number of rows that the cell storing the OCR sample document field’s value must span. Available in API version 56.0 and later.
FieldLabelMaxX
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
A normalized coordinate representing the right edge of the bounding box of the key.
FieldLabelMaxY
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
A normalized coordinate representing the bottom edge of the bounding box of the key.
FieldLabelMinX
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
A normalized coordinate representing the left edge of the bounding box of the key.
FieldLabelMinY
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
A normalized coordinate representing the top edge of the bounding box of the key.
IsAutoExtracted
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the OCR sample document field is auto-extracted by the OCR service (true) or not (false). Available in API version 57.0 and later.
The default value is false.
ItemType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The type of item associated with the OCR sample document field. Available in API version 56.0 and later.
Possible value is TABLE.
KeyContent
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Content located in a particular area of the document.
OcrSampleDocumentId
Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the associated OCR sample document.
This is a relationship field.
Relationship Name
OcrSampleDocument
Relationship Type
Lookup
Refers To
OcrSampleDocument
OcrSampleDocumentPageId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the associated OCR sample document page.
This is a relationship field.
Relationship Name
OcrSampleDocumentPage
Relationship Type
Lookup
Refers To
OcrSampleDocumentPage
OcrSampleDocumentPageItemId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the OCR sample document page item with the field. Available in API version 56.0 and later.
This is a relationship field.
Relationship Name
OcrSampleDocumentPageItem
Relationship Type
Lookup
Refers To
OcrSampleDocumentPageItem