OcrDocumentScanResult

Represents the details of the information extracted from the document. This object is available in API version 55.0 and later.

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

The ContentDocument sharing rule is applicable to all the related OcrDocumentScanResult.

Users can access OcrDocumentScanResult only when you share the related ContentDocument.

  • Type: reference

  • Properties: Filter, Group, Sort

  • Description: ID of the content document associated with the OCR document scan result.

    This field is a relationship field.

  • Relationship Name: ContentDocument

  • Relationship Type: Lookup

  • Refers To: ContentDocument

  • Type: reference

  • Properties: Filter, Group, Sort

  • Description: ID of the content document associated with the OCR document scan result.

    This field is a relationship field.

  • Relationship Name: ContentDocument

  • Relationship Type: Lookup

  • Refers To: ContentDocument

  • Type: string
  • Properties: Create, Nillable, Update
  • Description: The document type of the OCRed document. It can be null if the document type for the associated Content Document is managed externally, such as through a Document Checklist Item. The document type is required when the document is specified as a blob or a URL.
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: The message with information about the failure of OCR API calls during extraction.
  • Type: textarea
  • Properties: Nillable
  • Description: A JSON string from the OCR service’s response containing data extracted from items in the document. Available in API version 56.0 and later.

  • Type: textarea

  • Properties: Nillable

  • Description: The information extracted from the document.

    This field is encryptable with Salesforce Platform Encryption.

  • Type: textarea
  • Properties: Nillable
  • Description: A JSON string from the OCR service response containing data extracted from the document in a raw format.
  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp when the current user last accessed this record, a record related to this record, or a list view.
  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it.
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Name of the OCR document scan result.

  • Type: picklist

  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update

  • Description: The name of the OCR service that extracts information from the document and maps it to the Salesforce object.

  • Possible values:

    • AMAZON_TEXTRACT
    • AMAZON_TEXTRACT_ANALYZED_ID—Available in API version 57.0 and later.
    • PDF_DOCX_EXTRACT_TEXT

  • Type: picklist

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

  • Description: Status of the extraction and mapping of information from the document field.

  • Possible values:

    • ERROR
    • OCR_ENQUEUE
    • SUCCESS
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort
  • Description: The number of the page in the document in which the extracted value is available.
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Description: Angle of the document at which it’s scanned.

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

OcrDocumentScanResultFeed

Feed tracking is available for the object.

OcrDocumentScanResultHistory

History is available for tracked fields of the object.