OcrDocumentScanResult

Represents the contents of a document after optical character recognition (OCR) processing. This object is available in API version 50.0 and later.

Supported Calls

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

Fields

ContentVersionId

Type: reference
Properties: Filter, Group, Nillable, Sort
Description: Unique identifier for the current version of the data.

DocumentRequestId

Type: reference
Properties: Filter, Group, Nillable, Sort
Description: Unique identifier for a document request.

ExtractedValues

Type: textarea
Properties: Nillable
Description: Data extracted from the document. Data type StringPlusClob, maximum length 131072.

This field is encryptable with Salesforce Platform Encryption.
Note

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp for when the current user last viewed a record related to this record.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.

Name

Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: Name of the record.

OcrService

Type: picklist
Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description: Records the service that performed the text extraction.
Possible values:
- AMAZON_TEXTRACT—Amazon Textract
- E.AI

OcrStatus

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Current phase of OCR processing.
Possible values:
- ERROR—Error
- OCR_ENQUEUE—OCR Enqueue
- SUCCESS—Success

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The user who owns the OcrDocumentScanResult record.

PageNumber

Type: int
Properties: Filter, Group, Nillable, Sort
Description: The page number of the scanned document result in the original document that it’s a part of.

Rotation

Type: int
Properties: Filter, Group, Nillable, Sort
Description: Degrees of rotation requested. Can be 0, 90, 180, or 270.

Associated Objects

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.

OcrDocumentScanResultChangeEvent (API version 59.0): Change events are available for the object.