TranscriptionJob

class oci.ai_speech.models.TranscriptionJob(**kwargs)

Bases: object

Description of Transcription Job.

Attributes:

ADDITIONAL_TRANSCRIPTION_FORMATS_SRT

A constant which can be used with the additional_transcription_formats property of a TranscriptionJob.

LIFECYCLE_STATE_ACCEPTED

A constant which can be used with the lifecycle_state property of a TranscriptionJob.

LIFECYCLE_STATE_CANCELED

A constant which can be used with the lifecycle_state property of a TranscriptionJob.

LIFECYCLE_STATE_CANCELING

A constant which can be used with the lifecycle_state property of a TranscriptionJob.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a TranscriptionJob.

LIFECYCLE_STATE_IN_PROGRESS

A constant which can be used with the lifecycle_state property of a TranscriptionJob.

LIFECYCLE_STATE_SUCCEEDED

A constant which can be used with the lifecycle_state property of a TranscriptionJob.

additional_transcription_formats

Gets the additional_transcription_formats of this TranscriptionJob.

compartment_id

[Required] Gets the compartment_id of this TranscriptionJob.

created_by

Gets the created_by of this TranscriptionJob.

defined_tags

Gets the defined_tags of this TranscriptionJob.

description

Gets the description of this TranscriptionJob.

display_name

Gets the display_name of this TranscriptionJob.

freeform_tags

Gets the freeform_tags of this TranscriptionJob.

id

[Required] Gets the id of this TranscriptionJob.

input_location

[Required] Gets the input_location of this TranscriptionJob.

lifecycle_details

Gets the lifecycle_details of this TranscriptionJob.

lifecycle_state

Gets the lifecycle_state of this TranscriptionJob.

model_details

[Required] Gets the model_details of this TranscriptionJob.

normalization

Gets the normalization of this TranscriptionJob.

output_location

[Required] Gets the output_location of this TranscriptionJob.

outstanding_tasks

Gets the outstanding_tasks of this TranscriptionJob.

percent_complete

Gets the percent_complete of this TranscriptionJob.

successful_tasks

Gets the successful_tasks of this TranscriptionJob.

system_tags

Gets the system_tags of this TranscriptionJob.

time_accepted

Gets the time_accepted of this TranscriptionJob.

time_finished

Gets the time_finished of this TranscriptionJob.

time_started

Gets the time_started of this TranscriptionJob.

total_tasks

Gets the total_tasks of this TranscriptionJob.

ttl_in_days

Gets the ttl_in_days of this TranscriptionJob.

Methods:

__init__(**kwargs)

Initializes a new TranscriptionJob object with values from keyword arguments.

ADDITIONAL_TRANSCRIPTION_FORMATS_SRT = 'SRT'

A constant which can be used with the additional_transcription_formats property of a TranscriptionJob. This constant has a value of “SRT”

LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'

A constant which can be used with the lifecycle_state property of a TranscriptionJob. This constant has a value of “ACCEPTED”

LIFECYCLE_STATE_CANCELED = 'CANCELED'

A constant which can be used with the lifecycle_state property of a TranscriptionJob. This constant has a value of “CANCELED”

LIFECYCLE_STATE_CANCELING = 'CANCELING'

A constant which can be used with the lifecycle_state property of a TranscriptionJob. This constant has a value of “CANCELING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a TranscriptionJob. 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 TranscriptionJob. 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 TranscriptionJob. This constant has a value of “SUCCEEDED”

__init__(**kwargs)

Initializes a new TranscriptionJob 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 TranscriptionJob.

  • display_name (str) – The value to assign to the display_name property of this TranscriptionJob.

  • compartment_id (str) – The value to assign to the compartment_id property of this TranscriptionJob.

  • description (str) – The value to assign to the description property of this TranscriptionJob.

  • model_details (oci.ai_speech.models.TranscriptionModelDetails) – The value to assign to the model_details property of this TranscriptionJob.

  • normalization (oci.ai_speech.models.TranscriptionNormalization) – The value to assign to the normalization property of this TranscriptionJob.

  • time_accepted (datetime) – The value to assign to the time_accepted property of this TranscriptionJob.

  • time_started (datetime) – The value to assign to the time_started property of this TranscriptionJob.

  • time_finished (datetime) – The value to assign to the time_finished property of this TranscriptionJob.

  • total_tasks (int) – The value to assign to the total_tasks property of this TranscriptionJob.

  • outstanding_tasks (int) – The value to assign to the outstanding_tasks property of this TranscriptionJob.

  • successful_tasks (int) – The value to assign to the successful_tasks property of this TranscriptionJob.

  • ttl_in_days (int) – The value to assign to the ttl_in_days property of this TranscriptionJob.

  • percent_complete (int) – The value to assign to the percent_complete property of this TranscriptionJob.

  • input_location (oci.ai_speech.models.InputLocation) – The value to assign to the input_location property of this TranscriptionJob.

  • output_location (oci.ai_speech.models.OutputLocation) – The value to assign to the output_location property of this TranscriptionJob.

  • created_by (str) – The value to assign to the created_by property of this TranscriptionJob.

  • additional_transcription_formats (list[str]) – The value to assign to the additional_transcription_formats property of this TranscriptionJob. Allowed values for items in this list are: “SRT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this TranscriptionJob. Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “SUCCEEDED”, “FAILED”, “CANCELING”, “CANCELED”, ‘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 TranscriptionJob.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this TranscriptionJob.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this TranscriptionJob.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this TranscriptionJob.

property additional_transcription_formats

Gets the additional_transcription_formats of this TranscriptionJob. Transcription format. JSON format will always be provided in addition to any formats in this list.

Allowed values for items in this list are: “SRT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The additional_transcription_formats of this TranscriptionJob.

Return type

list[str]

property compartment_id

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

Returns

The compartment_id of this TranscriptionJob.

Return type

str

property created_by

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

Returns

The created_by of this TranscriptionJob.

Return type

str

property defined_tags

Gets the defined_tags of this TranscriptionJob. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace-1”: {“bar-key-1”: “value-1”, “bar-key-2”: “value-2”}, “foo-namespace-2”: {“bar-key-1”: “value-1”, “bar-key-2”: “value-2”}}.

Returns

The defined_tags of this TranscriptionJob.

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this TranscriptionJob.

Return type

str

property display_name

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

Returns

The display_name of this TranscriptionJob.

Return type

str

property freeform_tags

Gets the freeform_tags of this TranscriptionJob. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}.

Returns

The freeform_tags of this TranscriptionJob.

Return type

dict(str, str)

property id

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

Returns

The id of this TranscriptionJob.

Return type

str

property input_location

[Required] Gets the input_location of this TranscriptionJob.

Returns

The input_location of this TranscriptionJob.

Return type

oci.ai_speech.models.InputLocation

property lifecycle_details

Gets the lifecycle_details of this TranscriptionJob. 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 TranscriptionJob.

Return type

str

property lifecycle_state

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

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

Returns

The lifecycle_state of this TranscriptionJob.

Return type

str

property model_details

[Required] Gets the model_details of this TranscriptionJob.

Returns

The model_details of this TranscriptionJob.

Return type

oci.ai_speech.models.TranscriptionModelDetails

property normalization

Gets the normalization of this TranscriptionJob.

Returns

The normalization of this TranscriptionJob.

Return type

oci.ai_speech.models.TranscriptionNormalization

property output_location

[Required] Gets the output_location of this TranscriptionJob.

Returns

The output_location of this TranscriptionJob.

Return type

oci.ai_speech.models.OutputLocation

property outstanding_tasks

Gets the outstanding_tasks of this TranscriptionJob. Total outstanding tasks in a job.

Returns

The outstanding_tasks of this TranscriptionJob.

Return type

int

property percent_complete

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

Returns

The percent_complete of this TranscriptionJob.

Return type

int

property successful_tasks

Gets the successful_tasks of this TranscriptionJob. Total successful tasks in a job.

Returns

The successful_tasks of this TranscriptionJob.

Return type

int

property system_tags

Gets the system_tags of this TranscriptionJob. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}.

Returns

The system_tags of this TranscriptionJob.

Return type

dict(str, dict(str, object))

property time_accepted

Gets the time_accepted of this TranscriptionJob. Job accepted time.

Returns

The time_accepted of this TranscriptionJob.

Return type

datetime

property time_finished

Gets the time_finished of this TranscriptionJob. Job finished time.

Returns

The time_finished of this TranscriptionJob.

Return type

datetime

property time_started

Gets the time_started of this TranscriptionJob. Job started time.

Returns

The time_started of this TranscriptionJob.

Return type

datetime

property total_tasks

Gets the total_tasks of this TranscriptionJob. Total tasks in a job.

Returns

The total_tasks of this TranscriptionJob.

Return type

int

property ttl_in_days

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

Returns

The ttl_in_days of this TranscriptionJob.

Return type

int