Job¶

class oci.ai_language.models.Job(**kwargs)¶

Bases: object

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

Attributes

`LIFECYCLE_STATE_ACCEPTED`	A constant which can be used with the lifecycle_state property of a Job.
`LIFECYCLE_STATE_CANCELED`	A constant which can be used with the lifecycle_state property of a Job.
`LIFECYCLE_STATE_CANCELING`	A constant which can be used with the lifecycle_state property of a Job.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Job.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Job.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Job.
`LIFECYCLE_STATE_IN_PROGRESS`	A constant which can be used with the lifecycle_state property of a Job.
`LIFECYCLE_STATE_SUCCEEDED`	A constant which can be used with the lifecycle_state property of a Job.
`compartment_id`	[Required] Gets the compartment_id of this Job.
`completed_documents`	Gets the completed_documents of this Job.
`created_by`	Gets the created_by of this Job.
`description`	Gets the description of this Job.
`display_name`	Gets the display_name of this Job.
`failed_documents`	Gets the failed_documents of this Job.
`id`	[Required] Gets the id of this Job.
`input_configuration`	Gets the input_configuration of this Job.
`input_location`	[Required] Gets the input_location of this Job.
`lifecycle_details`	Gets the lifecycle_details of this Job.
`lifecycle_state`	Gets the lifecycle_state of this Job.
`model_metadata_details`	[Required] Gets the model_metadata_details of this Job.
`output_location`	[Required] Gets the output_location of this Job.
`pending_documents`	Gets the pending_documents of this Job.
`percent_complete`	Gets the percent_complete of this Job.
`time_accepted`	Gets the time_accepted of this Job.
`time_completed`	Gets the time_completed of this Job.
`time_started`	Gets the time_started of this Job.
`total_documents`	Gets the total_documents of this Job.
`ttl_in_days`	Gets the ttl_in_days of this Job.
`warnings_count`	Gets the warnings_count of this Job.

Methods

__init__(**kwargs) Initializes a new Job object with values from keyword arguments.

LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'¶: A constant which can be used with the lifecycle_state property of a Job. This constant has a value of “ACCEPTED”

LIFECYCLE_STATE_CANCELED = 'CANCELED'¶: A constant which can be used with the lifecycle_state property of a Job. This constant has a value of “CANCELED”

LIFECYCLE_STATE_CANCELING = 'CANCELING'¶: A constant which can be used with the lifecycle_state property of a Job. This constant has a value of “CANCELING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a Job. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a Job. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a Job. This constant has a value of “FAILED”

LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the lifecycle_state property of a Job. This constant has a value of “IN_PROGRESS”

LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'¶: A constant which can be used with the lifecycle_state property of a Job. This constant has a value of “SUCCEEDED”

__init__(**kwargs)¶

Initializes a new Job object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this Job.
display_name (str) – The value to assign to the display_name property of this Job.
description (str) – The value to assign to the description property of this Job.
input_location (oci.ai_language.models.InputLocation) – The value to assign to the input_location property of this Job.
input_configuration (oci.ai_language.models.InputConfiguration) – The value to assign to the input_configuration property of this Job.
model_metadata_details (list[oci.ai_language.models.ModelMetadataDetails]) – The value to assign to the model_metadata_details property of this Job.
compartment_id (str) – The value to assign to the compartment_id property of this Job.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Job. Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “SUCCEEDED”, “FAILED”, “CANCELING”, “CANCELED”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this Job.
percent_complete (int) – The value to assign to the percent_complete property of this Job.
total_documents (int) – The value to assign to the total_documents property of this Job.
pending_documents (int) – The value to assign to the pending_documents property of this Job.
completed_documents (int) – The value to assign to the completed_documents property of this Job.
failed_documents (int) – The value to assign to the failed_documents property of this Job.
warnings_count (int) – The value to assign to the warnings_count property of this Job.
output_location (oci.ai_language.models.ObjectPrefixOutputLocation) – The value to assign to the output_location property of this Job.
ttl_in_days (int) – The value to assign to the ttl_in_days property of this Job.
created_by (str) – The value to assign to the created_by property of this Job.
time_accepted (datetime) – The value to assign to the time_accepted property of this Job.
time_started (datetime) – The value to assign to the time_started property of this Job.
time_completed (datetime) – The value to assign to the time_completed property of this Job.

compartment_id¶

[Required] Gets the compartment_id of this Job. The OCID of the compartment where you want to create the job.

Returns:	The compartment_id of this Job.
Return type:	str

completed_documents¶

Gets the completed_documents of this Job. Number of documents processed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.

Returns:	The completed_documents of this Job.
Return type:	int

created_by¶

Gets the created_by of this Job. The OCID of the user who created the job.

Returns:	The created_by of this Job.
Return type:	str

description¶

Gets the description of this Job. A short description of the job.

Returns:	The description of this Job.
Return type:	str

display_name¶

Gets the display_name of this Job. A user-friendly display name for the job.

Returns:	The display_name of this Job.
Return type:	str

failed_documents¶

Gets the failed_documents of this Job. Number of documents failed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.

Returns:	The failed_documents of this Job.
Return type:	int

id¶

[Required] Gets the id of this Job. The OCID of the job.

Returns:	The id of this Job.
Return type:	str

input_configuration¶

Gets the input_configuration of this Job.

Returns:	The input_configuration of this Job.
Return type:	oci.ai_language.models.InputConfiguration

input_location¶

[Required] Gets the input_location of this Job.

Returns:	The input_location of this Job.
Return type:	oci.ai_language.models.InputLocation

lifecycle_details¶

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

Returns:	The lifecycle_details of this Job.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this Job. The current state of the Job.

Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “SUCCEEDED”, “FAILED”, “CANCELING”, “CANCELED”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this Job.
Return type:	str

model_metadata_details¶

[Required] Gets the model_metadata_details of this Job. 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

Returns:	The model_metadata_details of this Job.
Return type:	list[oci.ai_language.models.ModelMetadataDetails]

output_location¶

[Required] Gets the output_location of this Job.

Returns:	The output_location of this Job.
Return type:	oci.ai_language.models.ObjectPrefixOutputLocation

pending_documents¶

Gets the pending_documents of this Job. Number of documents still to process. For CSV this signifies number of rows and for TXT this signifies number of files.

Returns:	The pending_documents of this Job.
Return type:	int

percent_complete¶

Gets the percent_complete of this Job. How much progress the operation has made, vs the total amount of work that must be performed.

Returns:	The percent_complete of this Job.
Return type:	int

time_accepted¶

Gets the time_accepted of this Job. Job accepted time.

Returns:	The time_accepted of this Job.
Return type:	datetime

time_completed¶

Gets the time_completed of this Job. Job finished time.

Returns:	The time_completed of this Job.
Return type:	datetime

time_started¶

Gets the time_started of this Job. Job started time.

Returns:	The time_started of this Job.
Return type:	datetime

total_documents¶

Gets the total_documents of this Job. Total number of documents given as input for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.

Returns:	The total_documents of this Job.
Return type:	int

ttl_in_days¶

Gets the ttl_in_days of this Job. Time to live duration in days for Job. Job will be available till max 90 days.

Returns:	The ttl_in_days of this Job.
Return type:	int

warnings_count¶

Gets the warnings_count of this Job. warnings count

Returns:	The warnings_count of this Job.
Return type:	int