oracle.oci.oci_ai_speech_transcription_task_facts – Fetches details about one or multiple TranscriptionTask resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_ai_speech_transcription_task_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple TranscriptionTask resources in Oracle Cloud Infrastructure

  • Returns a list of Transcription Tasks.

  • If transcription_task_id is specified, the details of a single TranscriptionTask will be returned.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
display_name
string
A filter to return only resources that match the entire display name given.

aliases: name
lifecycle_state
string
    Choices:
  • ACCEPTED
  • IN_PROGRESS
  • SUCCEEDED
  • FAILED
  • CANCELED
A filter to return only resources whose lifecycleState matches the given lifecycleState.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
sort_by
string
    Choices:
  • timeCreated
  • displayName
The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'ASC' or 'DESC'.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
transcription_job_id
string / required
Unique Transcription Job identifier.
transcription_task_id
string
Unique Transcription Task identifier.
Required to get a specific transcription_task.

aliases: id

Examples

- name: Get a specific transcription_task
  oci_ai_speech_transcription_task_facts:
    # required
    transcription_task_id: "ocid1.transcriptiontask.oc1..xxxxxxEXAMPLExxxxxx"
    transcription_job_id: "ocid1.transcriptionjob.oc1..xxxxxxEXAMPLExxxxxx"

- name: List transcription_tasks
  oci_ai_speech_transcription_task_facts:
    # required
    transcription_job_id: "ocid1.transcriptionjob.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    lifecycle_state: ACCEPTED
    display_name: display_name_example
    sort_order: ASC
    sort_by: timeCreated

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
transcription_tasks
complex
on success
List of TranscriptionTask resources

Sample:
[{'audio_format_details': {'encoding': 'encoding_example', 'format': 'format_example', 'number_of_channels': 56, 'sample_rate_in_hz': 56}, 'display_name': 'display_name_example', 'file_duration_in_seconds': 56, 'file_size_in_bytes': 56, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'input_location': {'bucket_name': 'bucket_name_example', 'namespace_name': 'namespace_name_example', 'object_names': []}, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'ACCEPTED', 'model_details': {'domain': 'GENERIC', 'language_code': 'en-US'}, 'output_location': {'bucket_name': 'bucket_name_example', 'namespace_name': 'namespace_name_example', 'object_names': []}, 'percent_complete': 56, 'processing_duration_in_seconds': 56, 'time_finished': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00', 'ttl_in_days': 56}]
 
audio_format_details
complex
on success
Returned for get operation

   
encoding
string
on success
Input file encoding. Example - PCM.

Sample:
encoding_example
   
format
string
on success
Input file format. Example - WAV.

Sample:
format_example
   
number_of_channels
integer
on success
Input file number of channels.

Sample:
56
   
sample_rate_in_hz
integer
on success
Input file sampleRate. Example - 16000

Sample:
56
 
display_name
string
on success
A user-friendly display name for the task.

Sample:
display_name_example
 
file_duration_in_seconds
integer
on success
Duration of input file in Seconds.

Sample:
56
 
file_size_in_bytes
integer
on success
Size of input file in Bytes.

Sample:
56
 
id
string
on success
The OCID of the task.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
input_location
complex
on success
Returned for get operation

   
bucket_name
string
on success
Object Storage bucket name.

Sample:
bucket_name_example
   
namespace_name
string
on success
Object Storage namespace name.

Sample:
namespace_name_example
   
object_names
list / elements=string
on success
Object Storage object names.

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

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the Task.

Sample:
ACCEPTED
 
model_details
complex
on success
Returned for get operation

   
domain
string
on success
Domain for input files.

Sample:
GENERIC
   
language_code
string
on success
Locale value as per given in [https://datatracker.ietf.org/doc/html/rfc5646]. - en-US: English - United States - es-ES: Spanish - Spain - pt-BR: Portuguese - Brazil - en-GB: English - Great Britain - en-AU: English - Australia - en-IN: English - India - hi-IN: Hindi - India - fr-FR: French - France - de-DE: German - Germany - it-IT: Italian - Italy

Sample:
en-US
 
output_location
complex
on success
Returned for get operation

   
bucket_name
string
on success
Object Storage bucket name.

Sample:
bucket_name_example
   
namespace_name
string
on success
Object Storage namespace name.

Sample:
namespace_name_example
   
object_names
list / elements=string
on success
Object Storage object names.

 
percent_complete
integer
on success
How much progress the operation has made, vs the total amount of work that must be performed.

Sample:
56
 
processing_duration_in_seconds
integer
on success
Task proccessing duration, which excludes waiting time in the system.

Sample:
56
 
time_finished
string
on success
Task finished time.

Sample:
2013-10-20T19:20:30+01:00
 
time_started
string
on success
Task started time.

Sample:
2013-10-20T19:20:30+01:00
 
ttl_in_days
integer
on success
Time to live duration in days for tasks. Task will be available till max 90 days.
Returned for get operation

Sample:
56


Authors

  • Oracle (@oracle)