Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace DocumentJob

The job details for a batch document analysis.

Properties

compartmentId

compartmentId: string

The OCID of the compartment that starts the job.

Optional displayName

displayName: undefined | string

The document job display name.

Optional documentType

documentType: model.DocumentType

The type of document.

features

features: Array<DocumentFeature>

The list of requested document analysis types.

id

id: string

The job id.

Optional inputLocation

inputLocation: model.ObjectListInlineInputLocation

Optional isZipOutputEnabled

isZipOutputEnabled: undefined | false | true

Whether or not to generate a ZIP file containing the results.

Optional language

language: model.DocumentLanguage

The document language, abbreviated according to ISO 639-2.

Optional lifecycleDetails

lifecycleDetails: LifecycleDetails

The detailed status of FAILED state.

lifecycleState

lifecycleState: LifecycleState

The current state of the batch document job.

outputLocation

outputLocation: OutputLocation

Optional percentComplete

percentComplete: undefined | number

How much progress the operation has made, compared to the total amount of work to be performed. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

timeAccepted

timeAccepted: Date

The job acceptance time.

Optional timeFinished

timeFinished: Date

The job finish time.

Optional timeStarted

timeStarted: Date

The job start time.

Functions

getDeserializedJsonObj

getJsonObj