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 52.0 and later.

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.

Important

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 

ApplicationType 

  • Type: picklist

  • Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

  • Description: The application associated with the OCR sample document. Available in API version 54.0 and later.

  • Possible values:

    • EinsteinDocumentReader
    • Industries

DeveloperName 

  • Type: string

  • Properties: Filter, Group, Sort

  • 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.

    1<!-- reuse-break schema="reuse-break/v1" intent="dev_guides/api/objects/sforce_api_objects_recordtype.xml#sforce_api_objects_recordtype/note_set_unique_DeveloperName" partial="sforce-api-objects-recordtype-note-set-unique-developername" element="note" canonical_repo="platform-obj-meta-tool" reason="conref target crossed repo boundary; content duplicated instead of transcluded" -->

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.

Note

DocumentHeight 

  • Type: double
  • Properties: Filter, Nillable, Sort
  • Description: Normalized height of the OCR sample document page.

FullName 

  • Type: string

  • Properties: Create, Group, Nillable

  • Description: Full name of the associated metadata type in Metadata API.

    Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

Language 

  • Type: picklist
  • Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
  • Description: Language of the OCR sample document.

ManageableState 

  • Type: picklist

  • Properties: Filter, Group, Nillable, Restricted picklist, Sort

  • Description: Indicates the manageable state of the specified component that is contained in a package.

  • Possible values:

    • beta—Managed-Beta
    • deleted—Managed-Proposed-Deleted
    • deprecated—Managed-Proposed-Deprecated
    • deprecatedEditable—SecondGen-Installed-Deprecated
    • installed—Managed-Installed
    • installedEditable—SecondGen-Installed-Editable
    • released—Managed-Released
    • unmanaged—Unmanaged

MasterLabel 

  • Type: string
  • Properties: Filter, Group, Sort
  • Description: Label of the OCR sample document.

Metadata 

  • Type: complexvalue
  • Properties: Create, Nillable, Update
  • Description: OCR sample document metadata.

NamespacePrefix 

  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Description: Namespace prefix associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix.