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 50.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. Available in API version 54.0 and later.

  • 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

  • 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: Create, Filter, Nillable, Sort, Update
  • Description: The normalized height of the document page assuming 1.0 as the fixed width for all the documents. Available in API version 52.0 and later.

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.