oracle.oci.oci_ai_speech_transcription_job_actions – Perform actions on a TranscriptionJob resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.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_job_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a TranscriptionJob resource in Oracle Cloud Infrastructure

  • For action=cancel, canceling the job cancels all the tasks under it.

  • For action=change_compartment, moves a transcription Job resource into a different compartment.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • cancel
  • change_compartment
The action to perform on the TranscriptionJob.
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.
compartment_id
string
The OCID of the compartment where the resource should be moved.
Required for action=change_compartment.
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.
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.
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.

aliases: id

Examples

- name: Perform action cancel on transcription_job
  oci_ai_speech_transcription_job_actions:
    # required
    transcription_job_id: "ocid1.transcriptionjob.oc1..xxxxxxEXAMPLExxxxxx"
    action: cancel

- name: Perform action change_compartment on transcription_job
  oci_ai_speech_transcription_job_actions:
    # required
    transcription_job_id: "ocid1.transcriptionjob.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    action: change_compartment

Return Values

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

Key Returned Description
transcription_job
complex
on success
Details of the TranscriptionJob resource acted upon by the current operation

Sample:
{'additional_transcription_formats': [], 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'created_by': 'created_by_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'input_location': {'location_type': 'OBJECT_LIST_INLINE_INPUT_LOCATION', 'object_location': {'bucket_name': 'bucket_name_example', 'namespace_name': 'namespace_name_example', 'object_names': []}, 'object_locations': [{'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'}, 'normalization': {'filters': [{'mode': 'MASK', 'type': 'PROFANITY'}], 'is_punctuation_enabled': True}, 'output_location': {'bucket_name': 'bucket_name_example', 'namespace_name': 'namespace_name_example', 'prefix': 'prefix_example'}, 'outstanding_tasks': 56, 'percent_complete': 56, 'successful_tasks': 56, 'system_tags': {}, 'time_accepted': '2013-10-20T19:20:30+01:00', 'time_finished': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00', 'total_tasks': 56, 'ttl_in_days': 56}
 
additional_transcription_formats
list / elements=string
on success
Transcription format. JSON format will always be provided in addition to any formats in this list.

 
compartment_id
string
on success
The OCID of the compartment where you want to create the job.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
created_by
string
on success
The OCID of the user who created the job.

Sample:
created_by_example
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
description
string
on success
A short description of the job.

Sample:
description_example
 
display_name
string
on success
A user-friendly display name for the job.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the job.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
input_location
complex
on success

   
location_type
string
on success
The type of input location.

Sample:
OBJECT_LIST_INLINE_INPUT_LOCATION
   
object_location
complex
on success

     
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.

   
object_locations
complex
on success
A list of ObjectLocations.

     
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 Job.

Sample:
ACCEPTED
 
model_details
complex
on success

   
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
 
normalization
complex
on success

   
filters
complex
on success
List of filters.

     
mode
string
on success
- `MASK`: Will mask detected profanity in transcription. - `REMOVE`: Will replace profane word with * in transcription. - `TAG`: Will tag profane word as profanity but will show actual word.

Sample:
MASK
     
type
string
on success
The type of filters.

Sample:
PROFANITY
   
is_punctuation_enabled
boolean
on success
Whether to add punctuation in the generated transcription. Enabled by default.

Sample:
True
 
output_location
complex
on success

   
bucket_name
string
on success
Object Storage bucket name.

Sample:
bucket_name_example
   
namespace_name
string
on success
Object Storage namespace.

Sample:
namespace_name_example
   
prefix
string
on success
Object Storage folder name.

Sample:
prefix_example
 
outstanding_tasks
integer
on success
Total outstanding tasks in a job.

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

Sample:
56
 
successful_tasks
integer
on success
Total successful tasks in a job.

Sample:
56
 
system_tags
dictionary
on success
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

 
time_accepted
string
on success
Job accepted time.

Sample:
2013-10-20T19:20:30+01:00
 
time_finished
string
on success
Job finished time.

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

Sample:
2013-10-20T19:20:30+01:00
 
total_tasks
integer
on success
Total tasks in a job.

Sample:
56
 
ttl_in_days
integer
on success
Time to live duration in days for Job. Job will be available till max 90 days.

Sample:
56


Authors

  • Oracle (@oracle)