TranscriptionTask¶

class oci.ai_speech.models.TranscriptionTask(**kwargs)¶

Bases: object

Description of Transcription Task.

Attributes

`LIFECYCLE_STATE_ACCEPTED`	A constant which can be used with the lifecycle_state property of a TranscriptionTask.
`LIFECYCLE_STATE_CANCELED`	A constant which can be used with the lifecycle_state property of a TranscriptionTask.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a TranscriptionTask.
`LIFECYCLE_STATE_IN_PROGRESS`	A constant which can be used with the lifecycle_state property of a TranscriptionTask.
`LIFECYCLE_STATE_SUCCEEDED`	A constant which can be used with the lifecycle_state property of a TranscriptionTask.
`audio_format_details`	Gets the audio_format_details of this TranscriptionTask.
`display_name`	Gets the display_name of this TranscriptionTask.
`file_duration_in_seconds`	Gets the file_duration_in_seconds of this TranscriptionTask.
`file_size_in_bytes`	Gets the file_size_in_bytes of this TranscriptionTask.
`id`	[Required] Gets the id of this TranscriptionTask.
`input_location`	Gets the input_location of this TranscriptionTask.
`lifecycle_details`	Gets the lifecycle_details of this TranscriptionTask.
`lifecycle_state`	Gets the lifecycle_state of this TranscriptionTask.
`model_details`	Gets the model_details of this TranscriptionTask.
`output_location`	Gets the output_location of this TranscriptionTask.
`percent_complete`	Gets the percent_complete of this TranscriptionTask.
`processing_duration_in_seconds`	Gets the processing_duration_in_seconds of this TranscriptionTask.
`time_finished`	Gets the time_finished of this TranscriptionTask.
`time_started`	Gets the time_started of this TranscriptionTask.
`ttl_in_days`	Gets the ttl_in_days of this TranscriptionTask.

Methods

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

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

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

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a TranscriptionTask. 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 TranscriptionTask. 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 TranscriptionTask. This constant has a value of “SUCCEEDED”

__init__(**kwargs)¶

Initializes a new TranscriptionTask 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 TranscriptionTask.
display_name (str) – The value to assign to the display_name property of this TranscriptionTask.
time_started (datetime) – The value to assign to the time_started property of this TranscriptionTask.
time_finished (datetime) – The value to assign to the time_finished property of this TranscriptionTask.
percent_complete (int) – The value to assign to the percent_complete property of this TranscriptionTask.
ttl_in_days (int) – The value to assign to the ttl_in_days property of this TranscriptionTask.
model_details (oci.ai_speech.models.TranscriptionModelDetails) – The value to assign to the model_details property of this TranscriptionTask.
audio_format_details (oci.ai_speech.models.AudioFormatDetails) – The value to assign to the audio_format_details property of this TranscriptionTask.
file_size_in_bytes (int) – The value to assign to the file_size_in_bytes property of this TranscriptionTask.
file_duration_in_seconds (int) – The value to assign to the file_duration_in_seconds property of this TranscriptionTask.
processing_duration_in_seconds (int) – The value to assign to the processing_duration_in_seconds property of this TranscriptionTask.
input_location (oci.ai_speech.models.ObjectLocation) – The value to assign to the input_location property of this TranscriptionTask.
output_location (oci.ai_speech.models.ObjectLocation) – The value to assign to the output_location property of this TranscriptionTask.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this TranscriptionTask. Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “SUCCEEDED”, “FAILED”, “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 TranscriptionTask.

audio_format_details¶

Gets the audio_format_details of this TranscriptionTask.

Returns:	The audio_format_details of this TranscriptionTask.
Return type:	oci.ai_speech.models.AudioFormatDetails

display_name¶

Gets the display_name of this TranscriptionTask. A user-friendly display name for the task.

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

file_duration_in_seconds¶

Gets the file_duration_in_seconds of this TranscriptionTask. Duration of input file in Seconds.

Returns:	The file_duration_in_seconds of this TranscriptionTask.
Return type:	int

file_size_in_bytes¶

Gets the file_size_in_bytes of this TranscriptionTask. Size of input file in Bytes.

Returns:	The file_size_in_bytes of this TranscriptionTask.
Return type:	int

id¶

[Required] Gets the id of this TranscriptionTask. The OCID of the task.

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

input_location¶

Gets the input_location of this TranscriptionTask.

Returns:	The input_location of this TranscriptionTask.
Return type:	oci.ai_speech.models.ObjectLocation

lifecycle_details¶

Gets the lifecycle_details of this TranscriptionTask. 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 TranscriptionTask.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this TranscriptionTask. The current state of the Task.

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

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

model_details¶

Gets the model_details of this TranscriptionTask.

Returns:	The model_details of this TranscriptionTask.
Return type:	oci.ai_speech.models.TranscriptionModelDetails

output_location¶

Gets the output_location of this TranscriptionTask.

Returns:	The output_location of this TranscriptionTask.
Return type:	oci.ai_speech.models.ObjectLocation

percent_complete¶

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

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

processing_duration_in_seconds¶

Gets the processing_duration_in_seconds of this TranscriptionTask. Task proccessing duration, which excludes waiting time in the system.

Returns:	The processing_duration_in_seconds of this TranscriptionTask.
Return type:	int

time_finished¶

Gets the time_finished of this TranscriptionTask. Task finished time.

Returns:	The time_finished of this TranscriptionTask.
Return type:	datetime

time_started¶

Gets the time_started of this TranscriptionTask. Task started time.

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

ttl_in_days¶

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

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