Oracle Cloud Infrastructure Documentation

AI Speech Common Types

DBMS_CLOUD_OCI_AI_SPEECH_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;

DBMS_CLOUD_OCI_AI_SPEECH_AUDIO_FORMAT_DETAILS_T Type

Audio format details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_audio_format_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  format varchar2(32767),
  number_of_channels number,
  encoding varchar2(32767),
  sample_rate_in_hz number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_audio_format_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_audio_format_details_t (
    format varchar2,
    number_of_channels number,
    encoding varchar2,
    sample_rate_in_hz number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

format

(optional) Input file format. Example - WAV.

number_of_channels

(optional) Input file number of channels.

encoding

(optional) Input file encoding. Example - PCM.

sample_rate_in_hz

(optional) Input file sampleRate. Example - 16000

DBMS_CLOUD_OCI_AI_SPEECH_CHANGE_TRANSCRIPTION_JOB_COMPARTMENT_DETAILS_T Type

Details for changing the compartment of a transcription job.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_change_transcription_job_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_change_transcription_job_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_change_transcription_job_compartment_details_t (
    compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment where the resource should be moved.

DBMS_CLOUD_OCI_AI_SPEECH_DIARIZATION_T Type

Speaker diarization is a combination of speaker segmentation and speaker clustering. Provide diarization details to enable this feature.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_diarization_t FORCE AUTHID CURRENT_USER IS OBJECT (
  is_diarization_enabled number,
  number_of_speakers number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_diarization_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_diarization_t (
    is_diarization_enabled number,
    number_of_speakers number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

is_diarization_enabled

(optional) Set true to enable Speaker diarization and tag transcription with speaker tags. By default this is disabled.

number_of_speakers

(optional) Number of speakers in the audio provided. By default service will auto detect all speakers in audio file

DBMS_CLOUD_OCI_AI_SPEECH_TRANSCRIPTION_SETTINGS_T Type

Processes to perform on the generated transcription.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_transcription_settings_t FORCE AUTHID CURRENT_USER IS OBJECT (
  diarization dbms_cloud_oci_ai_speech_diarization_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_transcription_settings_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_transcription_settings_t (
    diarization dbms_cloud_oci_ai_speech_diarization_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

diarization

(optional)

DBMS_CLOUD_OCI_AI_SPEECH_TRANSCRIPTION_MODEL_DETAILS_T Type

Model details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_transcription_model_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  domain varchar2(32767),
  language_code varchar2(32767),
  transcription_settings dbms_cloud_oci_ai_speech_transcription_settings_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_transcription_model_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_transcription_model_details_t (
    domain varchar2,
    language_code varchar2,
    transcription_settings dbms_cloud_oci_ai_speech_transcription_settings_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

domain

(optional) Domain for input files.

Allowed values are: 'GENERIC'

language_code

(optional) 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

Allowed values are: 'en-US', 'es-ES', 'pt-BR', 'en-GB', 'en-AU', 'en-IN', 'hi-IN', 'fr-FR', 'de-DE', 'it-IT'

transcription_settings

(optional)

DBMS_CLOUD_OCI_AI_SPEECH_TRANSCRIPTION_FILTER_T Type

Transcription Filter.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_transcription_filter_t FORCE AUTHID CURRENT_USER IS OBJECT (
  l_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_transcription_filter_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_transcription_filter_t (
    l_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

l_type

(required) The type of filters.

Allowed values are: 'PROFANITY'

DBMS_CLOUD_OCI_AI_SPEECH_TRANSCRIPTION_FILTER_TBL Type

Nested table type of dbms_cloud_oci_ai_speech_transcription_filter_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_transcription_filter_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_speech_transcription_filter_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_AI_SPEECH_TRANSCRIPTION_NORMALIZATION_T Type

Information to Normalize generated transcript.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_transcription_normalization_t FORCE AUTHID CURRENT_USER IS OBJECT (
  is_punctuation_enabled number,
  filters dbms_cloud_oci_ai_speech_transcription_filter_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_transcription_normalization_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_transcription_normalization_t (
    is_punctuation_enabled number,
    filters dbms_cloud_oci_ai_speech_transcription_filter_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

is_punctuation_enabled

(optional) Whether to add punctuation in the generated transcription. Enabled by default.

filters

(optional) List of filters.

DBMS_CLOUD_OCI_AI_SPEECH_INPUT_LOCATION_T Type

The location of the input(s).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_input_location_t FORCE AUTHID CURRENT_USER IS OBJECT (
  location_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_input_location_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_input_location_t (
    location_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

location_type

(required) The type of input location.

Allowed values are: 'OBJECT_LIST_INLINE_INPUT_LOCATION', 'OBJECT_LIST_FILE_INPUT_LOCATION'

DBMS_CLOUD_OCI_AI_SPEECH_OUTPUT_LOCATION_T Type

OCI Object Storage Location.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_output_location_t FORCE AUTHID CURRENT_USER IS OBJECT (
  namespace_name varchar2(32767),
  bucket_name varchar2(32767),
  prefix varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_output_location_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_output_location_t (
    namespace_name varchar2,
    bucket_name varchar2,
    prefix varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

namespace_name

(required) Object Storage namespace.

bucket_name

(required) Object Storage bucket name.

prefix

(required) Object Storage folder name.

DBMS_CLOUD_OCI_AI_SPEECH_CREATE_TRANSCRIPTION_JOB_DETAILS_T Type

The information about new Transcription Job.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_create_transcription_job_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  description varchar2(32767),
  additional_transcription_formats dbms_cloud_oci_ai_speech_varchar2_tbl,
  model_details dbms_cloud_oci_ai_speech_transcription_model_details_t,
  normalization dbms_cloud_oci_ai_speech_transcription_normalization_t,
  input_location dbms_cloud_oci_ai_speech_input_location_t,
  output_location dbms_cloud_oci_ai_speech_output_location_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_create_transcription_job_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_create_transcription_job_details_t (
    display_name varchar2,
    compartment_id varchar2,
    description varchar2,
    additional_transcription_formats dbms_cloud_oci_ai_speech_varchar2_tbl,
    model_details dbms_cloud_oci_ai_speech_transcription_model_details_t,
    normalization dbms_cloud_oci_ai_speech_transcription_normalization_t,
    input_location dbms_cloud_oci_ai_speech_input_location_t,
    output_location dbms_cloud_oci_ai_speech_output_location_t,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) A user-friendly display name for the job.

compartment_id

(required) The OCID of the compartment where you want to create the job.

description

(optional) A short description of the job.

additional_transcription_formats

(optional) Transcription Format. By default, the JSON format is used.

Allowed values are: 'SRT'

model_details

(optional)

normalization

(optional)

input_location

(required)

output_location

(required)

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`.

defined_tags

(optional) 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\"}}`.

DBMS_CLOUD_OCI_AI_SPEECH_ERROR_T Type

Error Information.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_error_t (
    code varchar2,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A short error code that defines the error, meant for programmatic parsing.

message

(required) A human-readable error string.

DBMS_CLOUD_OCI_AI_SPEECH_OBJECT_LOCATION_T Type

A location in Object Storage that is uniquely identified by namespace name, bucket name and object name.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_object_location_t FORCE AUTHID CURRENT_USER IS OBJECT (
  namespace_name varchar2(32767),
  bucket_name varchar2(32767),
  object_names dbms_cloud_oci_ai_speech_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_object_location_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_object_location_t (
    namespace_name varchar2,
    bucket_name varchar2,
    object_names dbms_cloud_oci_ai_speech_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

namespace_name

(required) Object Storage namespace name.

bucket_name

(required) Object Storage bucket name.

object_names

(required) Object Storage object names.

DBMS_CLOUD_OCI_AI_SPEECH_OBJECT_LIST_FILE_INPUT_LOCATION_T Type

Use this locationType when passing the location of the object storage in the request (where the WAV file is stored).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_object_list_file_input_location_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_speech_input_location_t (
  object_location dbms_cloud_oci_ai_speech_object_location_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_object_list_file_input_location_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_object_list_file_input_location_t (
    location_type varchar2,
    object_location dbms_cloud_oci_ai_speech_object_location_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_ai_speech_object_list_file_input_location_t is a subtype of the dbms_cloud_oci_ai_speech_input_location_t type.

Fields

Field Description

object_location

(required)

DBMS_CLOUD_OCI_AI_SPEECH_OBJECT_LOCATION_TBL Type

Nested table type of dbms_cloud_oci_ai_speech_object_location_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_object_location_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_speech_object_location_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_AI_SPEECH_OBJECT_LIST_INLINE_INPUT_LOCATION_T Type

Use this locationType when passing the WAV file name in the request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_object_list_inline_input_location_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_speech_input_location_t (
  object_locations dbms_cloud_oci_ai_speech_object_location_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_object_list_inline_input_location_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_object_list_inline_input_location_t (
    location_type varchar2,
    object_locations dbms_cloud_oci_ai_speech_object_location_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_ai_speech_object_list_inline_input_location_t is a subtype of the dbms_cloud_oci_ai_speech_input_location_t type.

Fields

Field Description

object_locations

(required) A list of ObjectLocations.

DBMS_CLOUD_OCI_AI_SPEECH_PROFANITY_TRANSCRIPTION_FILTER_T Type

Profanity transcription filter to recognize profane words.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_profanity_transcription_filter_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_speech_transcription_filter_t (
  l_mode varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_profanity_transcription_filter_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_profanity_transcription_filter_t (
    l_type varchar2,
    l_mode varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_ai_speech_profanity_transcription_filter_t is a subtype of the dbms_cloud_oci_ai_speech_transcription_filter_t type.

Fields

Field Description

l_mode

(required) - `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.

Allowed values are: 'MASK', 'REMOVE', 'TAG'

DBMS_CLOUD_OCI_AI_SPEECH_TRANSCRIPTION_JOB_T Type

Description of Transcription Job.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_transcription_job_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  description varchar2(32767),
  model_details dbms_cloud_oci_ai_speech_transcription_model_details_t,
  normalization dbms_cloud_oci_ai_speech_transcription_normalization_t,
  time_accepted timestamp with time zone,
  time_started timestamp with time zone,
  time_finished timestamp with time zone,
  total_tasks number,
  outstanding_tasks number,
  successful_tasks number,
  ttl_in_days number,
  percent_complete number,
  input_location dbms_cloud_oci_ai_speech_input_location_t,
  output_location dbms_cloud_oci_ai_speech_output_location_t,
  created_by varchar2(32767),
  additional_transcription_formats dbms_cloud_oci_ai_speech_varchar2_tbl,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_transcription_job_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_transcription_job_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    description varchar2,
    model_details dbms_cloud_oci_ai_speech_transcription_model_details_t,
    normalization dbms_cloud_oci_ai_speech_transcription_normalization_t,
    time_accepted timestamp with time zone,
    time_started timestamp with time zone,
    time_finished timestamp with time zone,
    total_tasks number,
    outstanding_tasks number,
    successful_tasks number,
    ttl_in_days number,
    percent_complete number,
    input_location dbms_cloud_oci_ai_speech_input_location_t,
    output_location dbms_cloud_oci_ai_speech_output_location_t,
    created_by varchar2,
    additional_transcription_formats dbms_cloud_oci_ai_speech_varchar2_tbl,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the job.

display_name

(optional) A user-friendly display name for the job.

compartment_id

(required) The OCID of the compartment where you want to create the job.

description

(optional) A short description of the job.

model_details

(required)

normalization

(optional)

time_accepted

(optional) Job accepted time.

time_started

(optional) Job started time.

time_finished

(optional) Job finished time.

total_tasks

(optional) Total tasks in a job.

outstanding_tasks

(optional) Total outstanding tasks in a job.

successful_tasks

(optional) Total successful tasks in a job.

ttl_in_days

(optional) Time to live duration in days for Job. Job will be available till max 90 days.

percent_complete

(optional) How much progress the operation has made, vs the total amount of work that must be performed.

input_location

(required)

output_location

(required)

created_by

(optional) The OCID of the user who created the job.

additional_transcription_formats

(optional) Transcription format. JSON format will always be provided in addition to any formats in this list.

Allowed values are: 'SRT'

lifecycle_state

(optional) The current state of the Job.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'SUCCEEDED', 'FAILED', 'CANCELING', 'CANCELED'

lifecycle_details

(optional) A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`.

defined_tags

(optional) 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\"}}`.

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`.

DBMS_CLOUD_OCI_AI_SPEECH_TRANSCRIPTION_JOB_SUMMARY_T Type

Summary of the Transcription Job.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_transcription_job_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  created_by varchar2(32767),
  percent_complete number,
  time_accepted timestamp with time zone,
  time_started timestamp with time zone,
  time_finished timestamp with time zone,
  total_tasks number,
  outstanding_tasks number,
  successful_tasks number,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_transcription_job_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_transcription_job_summary_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    created_by varchar2,
    percent_complete number,
    time_accepted timestamp with time zone,
    time_started timestamp with time zone,
    time_finished timestamp with time zone,
    total_tasks number,
    outstanding_tasks number,
    successful_tasks number,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the job.

display_name

(required) A user-friendly display name for the job.

compartment_id

(required) The OCID of the compartment where you want to create the job.

created_by

(optional) The OCID of the user who created the job.

percent_complete

(optional) How much progress the operation has made, vs the total amount of work that must be performed.

time_accepted

(optional) Job accepted time.

time_started

(optional) Job started time.

time_finished

(optional) Job finished time.

total_tasks

(optional) Total number of tasks in a job.

outstanding_tasks

(optional) Total outstanding tasks in a job.

successful_tasks

(optional) Total successful tasks in a job.

lifecycle_state

(optional) The current state of the Speech Job.

lifecycle_details

(optional) A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`.

defined_tags

(optional) 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\"}}`.

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`.

DBMS_CLOUD_OCI_AI_SPEECH_TRANSCRIPTION_JOB_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_ai_speech_transcription_job_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_transcription_job_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_speech_transcription_job_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_AI_SPEECH_TRANSCRIPTION_JOB_COLLECTION_T Type

Results of a Transcription Job search. Contains both TranscriptionJobSummary items and other information, such as metadata.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_transcription_job_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_ai_speech_transcription_job_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_transcription_job_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_transcription_job_collection_t (
    items dbms_cloud_oci_ai_speech_transcription_job_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of transcription jobs.

DBMS_CLOUD_OCI_AI_SPEECH_TRANSCRIPTION_TASK_T Type

Description of Transcription Task.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_transcription_task_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  time_started timestamp with time zone,
  time_finished timestamp with time zone,
  percent_complete number,
  ttl_in_days number,
  model_details dbms_cloud_oci_ai_speech_transcription_model_details_t,
  audio_format_details dbms_cloud_oci_ai_speech_audio_format_details_t,
  file_size_in_bytes number,
  file_duration_in_seconds number,
  processing_duration_in_seconds number,
  input_location dbms_cloud_oci_ai_speech_object_location_t,
  output_location dbms_cloud_oci_ai_speech_object_location_t,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_transcription_task_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_transcription_task_t (
    id varchar2,
    display_name varchar2,
    time_started timestamp with time zone,
    time_finished timestamp with time zone,
    percent_complete number,
    ttl_in_days number,
    model_details dbms_cloud_oci_ai_speech_transcription_model_details_t,
    audio_format_details dbms_cloud_oci_ai_speech_audio_format_details_t,
    file_size_in_bytes number,
    file_duration_in_seconds number,
    processing_duration_in_seconds number,
    input_location dbms_cloud_oci_ai_speech_object_location_t,
    output_location dbms_cloud_oci_ai_speech_object_location_t,
    lifecycle_state varchar2,
    lifecycle_details varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the task.

display_name

(optional) A user-friendly display name for the task.

time_started

(optional) Task started time.

time_finished

(optional) Task finished time.

percent_complete

(optional) How much progress the operation has made, vs the total amount of work that must be performed.

ttl_in_days

(optional) Time to live duration in days for tasks. Task will be available till max 90 days.

model_details

(optional)

audio_format_details

(optional)

file_size_in_bytes

(optional) Size of input file in Bytes.

file_duration_in_seconds

(optional) Duration of input file in Seconds.

processing_duration_in_seconds

(optional) Task proccessing duration, which excludes waiting time in the system.

input_location

(optional)

output_location

(optional)

lifecycle_state

(optional) The current state of the Task.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'SUCCEEDED', 'FAILED', 'CANCELED'

lifecycle_details

(optional) A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

DBMS_CLOUD_OCI_AI_SPEECH_TRANSCRIPTION_TASK_SUMMARY_T Type

Summary of the Transcription Task.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_transcription_task_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  percent_complete number,
  file_size_in_bytes number,
  file_duration_in_seconds number,
  processing_duration_in_seconds number,
  time_started timestamp with time zone,
  time_finished timestamp with time zone,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_transcription_task_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_transcription_task_summary_t (
    id varchar2,
    display_name varchar2,
    percent_complete number,
    file_size_in_bytes number,
    file_duration_in_seconds number,
    processing_duration_in_seconds number,
    time_started timestamp with time zone,
    time_finished timestamp with time zone,
    lifecycle_state varchar2,
    lifecycle_details varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the task.

display_name

(required) A user-friendly display name for the task.

percent_complete

(optional) How much progress the operation has made, vs the total amount of work that must be performed.

file_size_in_bytes

(optional) Size of input file in Bytes.

file_duration_in_seconds

(optional) Duration of input file in Seconds.

processing_duration_in_seconds

(optional) Task proccessing duration, which excludes waiting time in the system.

time_started

(optional) Task started time

time_finished

(optional) Job finished time

lifecycle_state

(optional) The current state of the Speech Job.

lifecycle_details

(optional) A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

DBMS_CLOUD_OCI_AI_SPEECH_TRANSCRIPTION_TASK_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_ai_speech_transcription_task_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_transcription_task_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_speech_transcription_task_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_AI_SPEECH_TRANSCRIPTION_TASK_COLLECTION_T Type

Results of a Transcription Task search. Contains both TranscriptionTaskSummary items and other information, such as metadata.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_transcription_task_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_ai_speech_transcription_task_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_transcription_task_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_transcription_task_collection_t (
    items dbms_cloud_oci_ai_speech_transcription_task_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of Transcription Task.

DBMS_CLOUD_OCI_AI_SPEECH_UPDATE_TRANSCRIPTION_JOB_DETAILS_T Type

The information to be updated.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_speech_update_transcription_job_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  description varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_update_transcription_job_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_speech_update_transcription_job_details_t (
    display_name varchar2,
    description varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) A user-friendly display name for the job.

description

(optional) A short description of the job.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`.

defined_tags

(optional) 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\"}}`.