DocumentExtractionRequest

Represents a request to extract documents. This object is available in API version 65.0 and later.

Supported Calls

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

Fields

ContentDocumentId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: ID of the document.

This field is a relationship field.
Relationship Name: ContentDocument
Refers To: ContentDocument

ExtractedClauseCount

Type: int
Properties: Filter, Group, Nillable, Sort
Description: The number of clauses extracted during the extraction review process.

ExtractionReferenceId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: ID of the extraction reference associated with the record.

This field is a polymorphic relationship field.
Relationship Name: ExtractionReference
Refers To: AINaturalLangProcessRslt

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

Name

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

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: ID of the owner of this document.

This field is a polymorphic relationship field.
Relationship Name: Owner
Refers To: Group, User

PageSelection

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The pages of the document to extract clauses from.

ServiceType

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the category for the type of service being provided.
Possible values:
- EinsteinGPTService
- OpenAIComplianceClauseExtraction

Status

Type: picklist
Properties: Create, Filter, Group, Restricted picklist, Sort, Update
Description: Specifies the document clause extraction review status.
Possible values:
- ExtractionFailed
- ExtractionFailedInternalServerError
- ExtractionFailedReviewRequired
- ExtractionFailedSetupConfigError
- ExtractionInProgress
- PostSaveCompleted
- PostSaveFailed
- PostSaveInProgress
- PostTransformFailed
- PostTransformInProgress
- ReviewCompleted
- ReviewExpired
- ReviewInProgress
- ReviewNotStarted
- SaveCompleted
- SaveFailed
- SaveFailedInternalServerError
- SaveInProgress
- SaveFailedReviewRequired
- SaveFailedSetupConfigError
- ValidationCompleted
- ValidationFailed
- ValidationInProgress

StatusReason

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The reason for the record’s current status.

UsageType

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the usage type of the document extraction request.
Possible values:
- ComplianceClauseExtraction—Compliance Clause Extraction
- CompliancePolicyClauseExtraction—Compliance Policy Clause Extraction
- RegulationClauseExtraction—Regulation Clause Extraction

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.

DocumentExtractionRequestChangeEvent: Change events are available for the object.
DocumentExtractionRequestFeed: Feed tracking is available for the object.
DocumentExtractionRequestHistory: History is available for tracked fields of the object.
DocumentExtractionRequestShare: Sharing is available for the object.