aispeech.oracle.com/v1beta1¶
APIVersion: aispeech.oracle.com/v1beta1
This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.
Packages¶
No customer-visible package currently exposes aispeech.oracle.com/v1beta1.
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| TranscriptionJob | Namespaced | Sample | - |
TranscriptionJob¶
Manage OCI AI Speech transcription jobs.
Plural:transcriptionjobsScope:NamespacedAPIVersion:aispeech.oracle.com/v1beta1Sample: Sample (config/samples/aispeech_v1beta1_transcriptionjob.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
TranscriptionJobSpec defines the desired state of TranscriptionJob.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
additionalTranscriptionFormats |
Transcription Format. By default, the JSON format is used. | list[string] |
No | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job. | string |
Yes | - | - |
definedTags |
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"}}. |
map[string, map[string, string]] |
No | - | - |
description |
A short description of the job. | string |
No | - | - |
displayName |
A user-friendly display name for the job. | string |
No | - | - |
freeformTags |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}. |
map[string, string] |
No | - | - |
inputLocation |
TranscriptionJobInputLocation defines nested fields for TranscriptionJob.InputLocation. | object |
Yes | - | - |
modelDetails |
TranscriptionJobModelDetails defines nested fields for TranscriptionJob.ModelDetails. | object |
No | - | - |
normalization |
TranscriptionJobNormalization defines nested fields for TranscriptionJob.Normalization. | object |
No | - | - |
outputLocation |
TranscriptionJobOutputLocation defines nested fields for TranscriptionJob.OutputLocation. | object |
Yes | - | - |
Spec.inputLocation¶
TranscriptionJobInputLocation defines nested fields for TranscriptionJob.InputLocation.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
locationType |
- | string |
No | - | - |
objectLocation |
TranscriptionJobInputLocationObjectLocation defines nested fields for TranscriptionJob.InputLocation.ObjectLocation. | object |
No | - | - |
objectLocations |
A list of ObjectLocations. | list[object] |
No | - | - |
Spec.inputLocation.objectLocation¶
TranscriptionJobInputLocationObjectLocation defines nested fields for TranscriptionJob.InputLocation.ObjectLocation.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketName |
Object Storage bucket name. | string |
Yes | - | - |
namespaceName |
Object Storage namespace name. | string |
Yes | - | - |
objectNames |
Object Storage object names. | list[string] |
Yes | - | - |
Spec.inputLocation.objectLocations[]¶
TranscriptionJobInputLocationObjectLocation defines nested fields for TranscriptionJob.InputLocation.ObjectLocation.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketName |
Object Storage bucket name. | string |
Yes | - | - |
namespaceName |
Object Storage namespace name. | string |
Yes | - | - |
objectNames |
Object Storage object names. | list[string] |
Yes | - | - |
Spec.modelDetails¶
TranscriptionJobModelDetails defines nested fields for TranscriptionJob.ModelDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
domain |
Domain for input files. | string |
No | - | - |
languageCode |
Oracle supported language codes are (Oracle models are locale specific). - en-US: English - United States (default) - 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 Whisper supported language codes are (Whisper models are locale agnostic). - auto: Auto-detect language - af: Afrikaans - ar: Arabic - az: Azerbaijani - be: Belarusian - bg: Bulgarian - bs: Bosnian - ca: Catalan - cs: Czech - cy: Welsh - da: Danish - de: German - el: Greek - en: English (default) - es: Spanish - et: Estonian - fa: Persian - fi: Finnish - fr: French - gl: Galician - he: Hebrew - hi: Hindi - hr: Croatian - hu: Hungarian - hy: Armenian - id: Indonesian - is: Icelandic - it: Italian - ja: Japanese - kk: Kazakh - kn: Kannada - ko: Korean - lt: Lithuanian - lv: Latvian - mi: Maori - mk: Macedonian - mr: Marathi - ms: Malay - ne: Nepali - nl: Dutch - no: Norwegian - pl: Polish - pt: Portuguese - ro: Romanian - ru: Russian - sk: Slovak - sl: Slovenian - sr: Serbian - sv: Swedish - sw: Swahili - ta: Tamil - th: Thai - tl: Tagalog - tr: Turkish - uk: Ukrainian - ur: Urdu - vi: Vietnamese - zh: Chinese | string |
No | - | - |
modelType |
Select a model to use for generating transcriptions. Currently supported models are: - ORACLE - WHISPER_MEDIUM - WHISPER_LARGE_V2 (upon service request) | string |
No | - | - |
transcriptionSettings |
TranscriptionJobModelDetailsTranscriptionSettings defines nested fields for TranscriptionJob.ModelDetails.TranscriptionSettings. | object |
No | - | - |
Spec.modelDetails.transcriptionSettings¶
TranscriptionJobModelDetailsTranscriptionSettings defines nested fields for TranscriptionJob.ModelDetails.TranscriptionSettings.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
additionalSettings |
Simple key-value pair for setting model specific properties. For more details, refer the documentation. | map[string, string] |
No | - | - |
diarization |
TranscriptionJobModelDetailsTranscriptionSettingsDiarization defines nested fields for TranscriptionJob.ModelDetails.TranscriptionSettings.Diarization. | object |
No | - | - |
Spec.modelDetails.transcriptionSettings.diarization¶
TranscriptionJobModelDetailsTranscriptionSettingsDiarization defines nested fields for TranscriptionJob.ModelDetails.TranscriptionSettings.Diarization.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isDiarizationEnabled |
Set true to enable Speaker diarization and tag transcription with speaker tags. By default this is disabled. | boolean |
No | - | - |
numberOfSpeakers |
Number of speakers in the audio provided. By default service will auto detect all speakers in audio file | integer |
No | - | - |
Spec.normalization¶
TranscriptionJobNormalization defines nested fields for TranscriptionJob.Normalization.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
filters |
List of filters. | list[object] |
No | - | - |
isPunctuationEnabled |
Whether to add punctuation in the generated transcription. Enabled by default. | boolean |
No | - | - |
Spec.normalization.filters[]¶
TranscriptionJobNormalizationFilter defines nested fields for TranscriptionJob.Normalization.Filter.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
mode |
- 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. |
string |
No | - | - |
type |
- | string |
No | - | - |
Spec.outputLocation¶
TranscriptionJobOutputLocation defines nested fields for TranscriptionJob.OutputLocation.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketName |
Object Storage bucket name. | string |
Yes | - | - |
namespaceName |
Object Storage namespace. | string |
Yes | - | - |
prefix |
Object Storage folder name. | string |
Yes | - | - |
Status¶
TranscriptionJobStatus defines the observed state of TranscriptionJob.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
additionalTranscriptionFormats |
Transcription format. JSON format will always be provided in addition to any formats in this list. | list[string] |
No | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job. | string |
No | - | - |
createdBy |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the job. | string |
No | - | - |
definedTags |
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"}}. |
map[string, map[string, string]] |
No | - | - |
description |
A short description of the job. | string |
No | - | - |
displayName |
A user-friendly display name for the job. | string |
No | - | - |
freeformTags |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}. |
map[string, string] |
No | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job. | string |
No | - | - |
inputLocation |
TranscriptionJobInputLocation defines nested fields for TranscriptionJob.InputLocation. | object |
No | - | - |
lifecycleDetails |
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. | string |
No | - | - |
lifecycleState |
The current state of the Job. | string |
No | - | - |
modelDetails |
TranscriptionJobModelDetails defines nested fields for TranscriptionJob.ModelDetails. | object |
No | - | - |
normalization |
TranscriptionJobNormalization defines nested fields for TranscriptionJob.Normalization. | object |
No | - | - |
outputLocation |
TranscriptionJobOutputLocation defines nested fields for TranscriptionJob.OutputLocation. | object |
No | - | - |
outstandingTasks |
Total outstanding tasks in a job. | integer |
No | - | - |
percentComplete |
How much progress the operation has made, vs the total amount of work that must be performed. | integer |
No | - | - |
status |
- | object |
Yes | - | - |
successfulTasks |
Total successful tasks in a job. | integer |
No | - | - |
systemTags |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}. |
map[string, map[string, string]] |
No | - | - |
timeAccepted |
Job accepted time. | string |
No | - | - |
timeFinished |
Job finished time. | string |
No | - | - |
timeStarted |
Job started time. | string |
No | - | - |
totalTasks |
Total tasks in a job. | integer |
No | - | - |
ttlInDays |
Time to live duration in days for Job. Job will be available till max 90 days. | integer |
No | - | - |
Status.inputLocation¶
Back to TranscriptionJob status
TranscriptionJobInputLocation defines nested fields for TranscriptionJob.InputLocation.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
locationType |
- | string |
No | - | - |
objectLocation |
TranscriptionJobInputLocationObjectLocation defines nested fields for TranscriptionJob.InputLocation.ObjectLocation. | object |
No | - | - |
objectLocations |
A list of ObjectLocations. | list[object] |
No | - | - |
Status.inputLocation.objectLocation¶
Back to TranscriptionJob status
TranscriptionJobInputLocationObjectLocation defines nested fields for TranscriptionJob.InputLocation.ObjectLocation.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketName |
Object Storage bucket name. | string |
Yes | - | - |
namespaceName |
Object Storage namespace name. | string |
Yes | - | - |
objectNames |
Object Storage object names. | list[string] |
Yes | - | - |
Status.inputLocation.objectLocations[]¶
Back to TranscriptionJob status
TranscriptionJobInputLocationObjectLocation defines nested fields for TranscriptionJob.InputLocation.ObjectLocation.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketName |
Object Storage bucket name. | string |
Yes | - | - |
namespaceName |
Object Storage namespace name. | string |
Yes | - | - |
objectNames |
Object Storage object names. | list[string] |
Yes | - | - |
Status.modelDetails¶
Back to TranscriptionJob status
TranscriptionJobModelDetails defines nested fields for TranscriptionJob.ModelDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
domain |
Domain for input files. | string |
No | - | - |
languageCode |
Oracle supported language codes are (Oracle models are locale specific). - en-US: English - United States (default) - 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 Whisper supported language codes are (Whisper models are locale agnostic). - auto: Auto-detect language - af: Afrikaans - ar: Arabic - az: Azerbaijani - be: Belarusian - bg: Bulgarian - bs: Bosnian - ca: Catalan - cs: Czech - cy: Welsh - da: Danish - de: German - el: Greek - en: English (default) - es: Spanish - et: Estonian - fa: Persian - fi: Finnish - fr: French - gl: Galician - he: Hebrew - hi: Hindi - hr: Croatian - hu: Hungarian - hy: Armenian - id: Indonesian - is: Icelandic - it: Italian - ja: Japanese - kk: Kazakh - kn: Kannada - ko: Korean - lt: Lithuanian - lv: Latvian - mi: Maori - mk: Macedonian - mr: Marathi - ms: Malay - ne: Nepali - nl: Dutch - no: Norwegian - pl: Polish - pt: Portuguese - ro: Romanian - ru: Russian - sk: Slovak - sl: Slovenian - sr: Serbian - sv: Swedish - sw: Swahili - ta: Tamil - th: Thai - tl: Tagalog - tr: Turkish - uk: Ukrainian - ur: Urdu - vi: Vietnamese - zh: Chinese | string |
No | - | - |
modelType |
Select a model to use for generating transcriptions. Currently supported models are: - ORACLE - WHISPER_MEDIUM - WHISPER_LARGE_V2 (upon service request) | string |
No | - | - |
transcriptionSettings |
TranscriptionJobModelDetailsTranscriptionSettings defines nested fields for TranscriptionJob.ModelDetails.TranscriptionSettings. | object |
No | - | - |
Status.modelDetails.transcriptionSettings¶
Back to TranscriptionJob status
TranscriptionJobModelDetailsTranscriptionSettings defines nested fields for TranscriptionJob.ModelDetails.TranscriptionSettings.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
additionalSettings |
Simple key-value pair for setting model specific properties. For more details, refer the documentation. | map[string, string] |
No | - | - |
diarization |
TranscriptionJobModelDetailsTranscriptionSettingsDiarization defines nested fields for TranscriptionJob.ModelDetails.TranscriptionSettings.Diarization. | object |
No | - | - |
Status.modelDetails.transcriptionSettings.diarization¶
Back to TranscriptionJob status
TranscriptionJobModelDetailsTranscriptionSettingsDiarization defines nested fields for TranscriptionJob.ModelDetails.TranscriptionSettings.Diarization.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isDiarizationEnabled |
Set true to enable Speaker diarization and tag transcription with speaker tags. By default this is disabled. | boolean |
No | - | - |
numberOfSpeakers |
Number of speakers in the audio provided. By default service will auto detect all speakers in audio file | integer |
No | - | - |
Status.normalization¶
Back to TranscriptionJob status
TranscriptionJobNormalization defines nested fields for TranscriptionJob.Normalization.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
filters |
List of filters. | list[object] |
No | - | - |
isPunctuationEnabled |
Whether to add punctuation in the generated transcription. Enabled by default. | boolean |
No | - | - |
Status.normalization.filters[]¶
Back to TranscriptionJob status
TranscriptionJobNormalizationFilter defines nested fields for TranscriptionJob.Normalization.Filter.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
mode |
- 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. |
string |
No | - | - |
type |
- | string |
No | - | - |
Status.outputLocation¶
Back to TranscriptionJob status
TranscriptionJobOutputLocation defines nested fields for TranscriptionJob.OutputLocation.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketName |
Object Storage bucket name. | string |
Yes | - | - |
namespaceName |
Object Storage namespace. | string |
Yes | - | - |
prefix |
Object Storage folder name. | string |
Yes | - | - |
Status.status¶
Back to TranscriptionJob status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Back to TranscriptionJob status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
Back to TranscriptionJob status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
Back to TranscriptionJob status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |