Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Job

Job details which contain input document details on which prediction need to run, features (which and all language services ) need to run and where to store results

Enumerations

Properties

Functions

Properties

compartmentId

compartmentId: string

The OCID of the compartment where you want to create the job.

Optional completedDocuments

completedDocuments: undefined | number

Number of documents processed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional createdBy

createdBy: undefined | string

The OCID of the user who created the job.

Optional description

description: undefined | string

A short description of the job.

Optional displayName

displayName: undefined | string

A user-friendly display name for the job.

Optional failedDocuments

failedDocuments: undefined | number

Number of documents failed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

id

id: string

The OCID of the job.

Optional inputConfiguration

inputConfiguration: model.InputConfiguration

inputLocation

inputLocation: ObjectStoragePrefixLocation | ObjectStorageFileNameLocation

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Optional lifecycleState

lifecycleState: LifecycleState

The current state of the Job.

modelMetadataDetails

modelMetadataDetails: Array<ModelMetadataDetails>

training model details For this release only one model is allowed to be input here. One of the three modelType, ModelId, endpointId should be given other wise error will be thrown from API

outputLocation

outputLocation: ObjectPrefixOutputLocation

Optional pendingDocuments

pendingDocuments: undefined | number

Number of documents still to process. For CSV this signifies number of rows and for TXT this signifies number of files. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional percentComplete

percentComplete: undefined | number

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

Optional timeAccepted

timeAccepted: Date

Job accepted time.

Optional timeCompleted

timeCompleted: Date

Job finished time.

Optional timeStarted

timeStarted: Date

Job started time.

Optional totalDocuments

totalDocuments: undefined | number

Total number of documents given as input for prediction. For CSV this signifies number of rows and for TXT this signifies number of files. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional ttlInDays

ttlInDays: undefined | number

Time to live duration in days for Job. Job will be available till max 90 days. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional warningsCount

warningsCount: undefined | number

warnings count Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Job): object

getJsonObj

  • getJsonObj(obj: Job): object