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 document. This object is available in API version 55.0 and later.

Supported Calls

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

Fields

ApplicationType

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The application associated with the OCR sample document.
Default value: Industries
Possible values:
- EinsteinDocumentReader
- Industries

ContentAssetId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: ID of the content asset associated with the OCR sample document.

This field is a relationship field.
Relationship Name: ContentAsset
Relationship Type: Lookup
Refers To: ContentAsset

DeveloperName

Type: string
Properties: Create, Filter, Group, Sort, Update
Description: The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization.

When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record.

DocumentHeight

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The normalized height of the document page assuming 1.0 as the fixed width for all the documents.

DocumentSignature

Type: textarea
Properties: Create, Nillable, Update
Description: A signature created from the set of keys and their bounding boxes which uniquely identifies the document. This can be used to classify a given document in a user workflow into one of the several specific samples associated with a single template. Such classification is necessary for supporting key-less values in non-fixed documents.

DocumentTypeId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of the document type associated with the OCR sample document.

This field is a relationship field.
Relationship Name: DocumentType
Relationship Type: Lookup
Refers To: DocumentType

Language

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The combined language and locale ISO code, which controls the language of the OCR sample document.

MasterLabel

Type: string
Properties: Create, Filter, Group, Sort, Update
Description: The label for the OCR sample document. This display value is the internal label that doesn’t get translated.

NamespacePrefix

Type: string
Properties: Create, Filter, Group, Sort, Update
Description: For managed packages, this field is the namespace prefix assigned to the package. For unmanaged packages, this field is blank.