openapi: 3.2.0 info: description: The OCI Speech Service harnesses the power of spoken language by allowing developers to easily convert file-based data containing human speech into highly accurate text transcriptions. title: Speech AI Service Speech API version: '20220101' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/3307ec96a711363413aaa9d52287a8ba05676b811185290f2f7e6fcdf70f8ed0.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Speech API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/3307ec96a711363413aaa9d52287a8ba05676b811185290f2f7e6fcdf70f8ed0.yaml what: the harvested document for Speech API servers: - url: https://$SWAGGER_HOST_URL/20220101 tags: - name: AIServiceSpeech paths: /actions/realtimeSessionToken: post: description: 'Returns an authentication token to the user. ' operationId: CreateRealtimeSessionToken parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A token is created and returned. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RealtimeSessionToken' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a session and sends a token so that users can authenticate themselves. An alternate way to authenticate is by skipping this endpoint and directly using the credentials in the SDK. tags: - AIServiceSpeech x-related-resource: '#/definitions/RealtimeSessionToken' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateRealtimeSessionTokenDetails' description: An object containing the compartment ID for authorization purposes. required: true /actions/synthesizeSpeech: post: description: 'Creates an audio for the given input text based on other input parameters like language, voice type, etc. ' operationId: SynthesizeSpeech parameters: - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The TTS audio has been created successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: audio/mpeg: schema: format: binary type: string audio/ogg: schema: format: binary type: string audio/pcm: schema: format: binary type: string audio/json: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates an audio for the given input text. tags: - AIServiceSpeech x-related-resource: '#/definitions/SynthesizeSpeech' requestBody: content: application/json: schema: $ref: '#/components/schemas/SynthesizeSpeechDetails' description: The request to be sent to the TTS service to get required inference audio. required: true /customizations: get: description: 'Returns a list of Customizations. ' operationId: ListCustomizations parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CustomizationLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/CustomizationIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of CustomizationSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CustomizationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all Customizations in a compartment tags: - AIServiceSpeech x-related-resource: '#/definitions/Customization' post: description: 'Creates a new Customization. ' operationId: CreateCustomization parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The new Customization is created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Customization' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Customization tags: - AIServiceSpeech x-related-resource: '#/definitions/Customization' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCustomizationDetails' description: Details for the new Customization. required: true /customizations/{customizationId}: delete: description: Delete Customization and its metadata from tenancy. operationId: DeleteCustomization parameters: - $ref: '#/components/parameters/CustomizationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The Customization metadata will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Delete Customization and its metadata from tenancy. tags: - AIServiceSpeech x-related-resource: '#/definitions/Customization' get: description: Gets a Customization by identifier operationId: GetCustomization parameters: - $ref: '#/components/parameters/CustomizationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves a Customization with the given id headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Customization' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Customization tags: - AIServiceSpeech x-related-resource: '#/definitions/Customization' put: description: Updates a Customization by identifier operationId: UpdateCustomization parameters: - $ref: '#/components/parameters/CustomizationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updated the request. The Customization is updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Customization' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Customization identified by the id tags: - AIServiceSpeech x-related-resource: '#/definitions/Customization' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCustomizationDetails' description: The information to be updated. required: true /customizations/{customizationId}/actions/changeCompartment: post: description: Moves a Customization resource into a different compartment. operationId: ChangeCustomizationCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/CustomizationIdPathParam' responses: 204: description: The Customization was successfully moved to the specified compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: ChangeCustomizationCompartment tags: - AIServiceSpeech x-related-resource: '#/definitions/Customization' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCustomizationCompartmentDetails' description: Details for changing the compartment of a Customization. required: true /transcriptionJobs: get: description: 'Returns a list of Transcription Jobs. ' operationId: ListTranscriptionJobs parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/TranscriptionJobLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/IdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of TranscriptionJobSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TranscriptionJobCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all Transcription Jobs in a compartment tags: - AIServiceSpeech x-related-resource: '#/definitions/TranscriptionJob' post: description: 'Creates a new Transcription Job. ' operationId: CreateTranscriptionJob parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Transcription Job is created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TranscriptionJob' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Transcription Job tags: - AIServiceSpeech x-related-resource: '#/definitions/TranscriptionJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTranscriptionJobDetails' description: Details for the new Transcription Job. required: true /transcriptionJobs/{transcriptionJobId}: delete: description: Delete API cleans job, tasks and the related metadata. However the generated transcriptions in customer tenancy will not be deleted. operationId: DeleteTranscriptionJob parameters: - $ref: '#/components/parameters/TranscriptionJobIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The transcription Job metadata will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Delete API cleans job, tasks and the related metadata. However the generated transcriptions in customer tenancy will not be deleted. tags: - AIServiceSpeech x-related-resource: '#/definitions/TranscriptionJob' get: description: Gets a Transcription Job by identifier operationId: GetTranscriptionJob parameters: - $ref: '#/components/parameters/TranscriptionJobIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Transcription Job with the given id headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TranscriptionJob' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Transcription Job tags: - AIServiceSpeech x-related-resource: '#/definitions/TranscriptionJob' put: description: Updates the Transcription Job operationId: UpdateTranscriptionJob parameters: - $ref: '#/components/parameters/TranscriptionJobIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updated the request. The Transcription Job is updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TranscriptionJob' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Transcription Job identified by the id tags: - AIServiceSpeech x-related-resource: '#/definitions/TranscriptionJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTranscriptionJobDetails' description: The information to be updated. required: true /transcriptionJobs/{transcriptionJobId}/actions/cancel: post: description: Canceling the job cancels all the tasks under it. operationId: CancelTranscriptionJob parameters: - $ref: '#/components/parameters/TranscriptionJobIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The transcription Job resource will be canceled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Canceling the job cancels all the tasks under it. tags: - AIServiceSpeech x-related-resource: '#/definitions/TranscriptionJob' /transcriptionJobs/{transcriptionJobId}/actions/changeCompartment: post: description: Moves a transcription Job resource into a different compartment. operationId: ChangeTranscriptionJobCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/TranscriptionJobIdPathParam' responses: 204: description: The transcription Job was successfully moved to the specified compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: ChangeTranscriptionJobCompartment tags: - AIServiceSpeech x-related-resource: '#/definitions/TranscriptionJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeTranscriptionJobCompartmentDetails' description: Details for changing the compartment of a transcription Job. required: true /transcriptionJobs/{transcriptionJobId}/transcriptionTasks: get: description: 'Returns a list of Transcription Tasks. ' operationId: ListTranscriptionTasks parameters: - $ref: '#/components/parameters/TranscriptionJobIdPathParam' - $ref: '#/components/parameters/TranscriptionTaskLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/IdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of TranscriptionTaskSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TranscriptionTaskCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all Transcription Task in Transcription Job tags: - AIServiceSpeech x-related-resource: '#/definitions/TranscriptionTask' /transcriptionJobs/{transcriptionJobId}/transcriptionTasks/{transcriptionTaskId}: get: description: Gets a Transcription Task by identifier operationId: GetTranscriptionTask parameters: - $ref: '#/components/parameters/TranscriptionJobIdPathParam' - $ref: '#/components/parameters/TranscriptionTaskIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Transcription Task with the given id headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TranscriptionTask' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Transcription Task tags: - AIServiceSpeech x-related-resource: '#/definitions/TranscriptionTask' /transcriptionJobs/{transcriptionJobId}/transcriptionTasks/{transcriptionTaskId}/actions/cancel: post: description: Cancel Transcription Task operationId: CancelTranscriptionTask parameters: - $ref: '#/components/parameters/TranscriptionJobIdPathParam' - $ref: '#/components/parameters/TranscriptionTaskIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The Transcription Task was canceled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Cancel Transcription Task. tags: - AIServiceSpeech x-related-resource: '#/definitions/TranscriptionTask' /voices: get: description: 'Returns a list of speakers available to the user to choose from based on language code and voice type provided. ' operationId: ListVoices parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ModelNameQueryParam' - $ref: '#/components/parameters/LanguageCodeQueryParam' - $ref: '#/components/parameters/VoiceNameQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: An object containing a list of voices available for the given language and voice type. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VoiceCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of speakers available tags: - AIServiceSpeech x-related-resource: '#/definitions/Voice' components: schemas: TranscriptionJobCollection: description: Results of a Transcription Job search. Contains both TranscriptionJobSummary items and other information, such as metadata. properties: items: description: List of transcription jobs. items: $ref: '#/components/schemas/TranscriptionJobSummary' type: array required: - items type: object CustomizationSummary: description: Summary of the Customization. properties: alias: description: Customization Summary Alias maxLength: 255 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: '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"}}`. ' type: object displayName: description: A user-friendly display name for the job. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`. ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the Speech Job. type: string x-obmcs-enumref: '#/definitions/Customization/lifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. ' type: object timeCreated: description: Customization Created time. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: Customization Updated time. An RFC3339 formatted datetime string. format: date-time type: string required: - id - displayName - compartmentId type: object VoiceSummary: description: Details related to the voice available for the given language code and voice type. properties: description: description: A small description of the voice like its language and voice type. type: string displayName: description: A user-friendly display name of the language for the user. type: string gender: description: Gender of the speaker. enum: - MALE - FEMALE type: string isDefaultVoice: description: Whether this voice id is default voice used for inference. type: boolean languageCode: description: An abbreviated notation of region to which the language and accent of the speaker belongs to. type: string languageDescription: description: A description of region to which the language and accent of the speaker belongs to. type: string sampleRateInHertz: description: The sample rate of the speaker in Hertz. type: integer supportedModels: description: Models the particular speaker is aligned to. items: type: string type: array voiceId: description: Unique Id of the voice. type: string wordsPerMinute: description: The number of words the speaker can narrate per minute. It signifies the speed of the speech produced by the speaker. type: integer required: - voiceId - displayName - gender - sampleRateInHertz - wordsPerMinute type: object Customization: description: Description of a Customization. properties: alias: description: Customization Details Alias maxLength: 255 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: '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"}}`. ' type: object description: description: A short description of the job. type: string displayName: description: A user-friendly display name for the job. maxLength: 255 minLength: 1 type: string entities: description: array of referenced entities items: $ref: '#/components/schemas/CustomizationReferencedEntities' type: array freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`. ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the Job. enum: - DELETING - DELETED - FAILED - UPDATING - ACTIVE - CREATING type: string modelDetails: $ref: '#/components/schemas/CustomizationModelDetails' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. ' type: object timeCreated: description: Customization Created time. An RFC3339 formatted datetime string. format: date-time maxLength: 255 minLength: 1 type: string timeUpdated: description: Customization Updated time. An RFC3339 formatted datetime string. format: date-time type: string trainingDataset: $ref: '#/components/schemas/CustomizationDatasetDetails' required: - id - compartmentId - modelDetails type: object Error: description: Error Information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message OutputLocation: description: OCI Object Storage Location. properties: bucketName: description: Object Storage bucket name. maxLength: 256 minLength: 1 type: string namespaceName: description: Object Storage namespace. maxLength: 1024 minLength: 1 type: string prefix: description: Object Storage folder name. maxLength: 1024 minLength: 1 type: string required: - namespaceName - bucketName - prefix type: object TtsConfiguration: default: modelFamily: ORACLE description: Speech configuration for TTS API. discriminator: propertyName: modelFamily properties: modelFamily: description: 'The class of models to use for speech generation. The available model families are: - ORACLE ' enum: - ORACLE type: string required: - modelFamily type: object RealtimeSessionToken: description: The response from the realtime session token endpoint that creates the auth token to be used with the realtime speech service. properties: compartmentId: description: Compartment ID that was used to create the token. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: '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"}}`. ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`. ' type: object sessionId: description: The session ID this token corresponds to. Provided for convenience, the session ID is already present in the JWT token. type: string token: description: The session token (JWT) to be consumed by the websocket server. The token contains the session/tenant ID, as well as the expiry time. type: string required: - token - sessionId - compartmentId type: object CustomizationDatasetDetails: description: Customization Training Dataset discriminator: propertyName: datasetType properties: datasetType: description: Possible data sets enum: - OBJECT_STORAGE - ENTITY_LIST maxLength: 25 minLength: 1 type: string required: - datasetType type: object VoiceCollection: description: Results of the voices available as speaker Ids for given language code and voice type combination. properties: items: description: List of Voices available for user to select from. items: $ref: '#/components/schemas/VoiceSummary' maxItems: 10 minItems: 0 type: array required: - items type: object InputLocation: description: The location of the input(s). discriminator: propertyName: locationType properties: locationType: description: 'The type of input location. ' enum: - OBJECT_LIST_INLINE_INPUT_LOCATION - OBJECT_LIST_FILE_INPUT_LOCATION type: string required: - locationType type: object CustomizationReferencedEntities: description: Entities referenced by top level customization. properties: alias: description: Alias of default referenced Customization for given entityType maxLength: 255 minLength: 1 type: string entityType: description: Customization Entity Type maxLength: 25 minLength: 1 type: string id: description: Customization Id of default referenced Customization for given entityType maxLength: 255 minLength: 1 type: string type: object TranscriptionTask: description: Description of Transcription Task. properties: audioFormatDetails: $ref: '#/components/schemas/AudioFormatDetails' displayName: description: A user-friendly display name for the task. type: string fileDurationInSeconds: description: Duration of input file in Seconds. type: integer fileSizeInBytes: description: Size of input file in Bytes. type: integer id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the task. type: string inputLocation: $ref: '#/components/schemas/ObjectLocation' lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the Task. enum: - ACCEPTED - IN_PROGRESS - SUCCEEDED - FAILED - CANCELED type: string modelDetails: $ref: '#/components/schemas/TranscriptionModelDetails' outputLocation: $ref: '#/components/schemas/ObjectLocation' percentComplete: description: How much progress the operation has made, vs the total amount of work that must be performed. maximum: 100 minimum: 0 type: integer processingDurationInSeconds: description: Task proccessing duration, which excludes waiting time in the system. type: integer timeFinished: description: Task finished time. format: date-time type: string timeStarted: description: Task started time. format: date-time type: string ttlInDays: description: Time to live duration in days for tasks. Task will be available till max 90 days. type: integer required: - id type: object CreateCustomizationDetails: description: The information about the new Customization. properties: alias: description: Customization Details Alias maxLength: 255 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: '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"}}`. ' type: object description: description: A short description of the job. maxLength: 255 type: string displayName: description: A user-friendly display name for the job. maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`. ' type: object modelDetails: $ref: '#/components/schemas/CustomizationModelDetails' trainingDataset: $ref: '#/components/schemas/CustomizationDatasetDetails' required: - compartmentId - modelDetails - trainingDataset type: object TranscriptionSettings: default: diarization: isDiarizationEnabled: false description: Processes to perform on the generated transcription. properties: additionalSettings: additionalProperties: type: string description: Simple key-value pair for setting model specific properties. For more details, refer the documentation. type: object diarization: $ref: '#/components/schemas/Diarization' type: object SynthesizeSpeechDetails: description: Input JSON to get audio inference from TTS Service. properties: audioConfig: $ref: '#/components/schemas/TtsAudioConfig' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where the user has access to call `SpeechSynthesize` api. But default user access will be checked at tenancy level. maxLength: 255 minLength: 1 type: string configuration: $ref: '#/components/schemas/TtsConfiguration' isStreamEnabled: default: false description: "If set to true, response will be sent in the chunked transfer-encoding and audio chunks \nare sent back as and when they are ready. If set to false, response will be sent only once \nthe entire audio is generated.\n" type: boolean text: description: The text input to get the inference audio from TTS Service. maxLength: 10000 minLength: 1 type: string required: - text type: object CreateTranscriptionJobDetails: description: The information about new Transcription Job. properties: additionalTranscriptionFormats: description: Transcription Format. By default, the JSON format is used. items: enum: - SRT type: string minItems: 1 type: array compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: '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"}}`. ' type: object description: description: A short description of the job. maxLength: 255 type: string displayName: description: A user-friendly display name for the job. maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`. ' type: object inputLocation: $ref: '#/components/schemas/InputLocation' modelDetails: $ref: '#/components/schemas/TranscriptionModelDetails' normalization: $ref: '#/components/schemas/TranscriptionNormalization' outputLocation: $ref: '#/components/schemas/OutputLocation' required: - compartmentId - inputLocation - outputLocation type: object ChangeTranscriptionJobCompartmentDetails: description: Details for changing the compartment of a transcription job. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object CreateRealtimeSessionTokenDetails: description: Request sent to the realtime authentication endpoint in order to obtain the auth token. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: '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"}}`. ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`. ' type: object required: - compartmentId type: object ObjectLocation: description: A location in Object Storage that is uniquely identified by namespace name, bucket name and object name. properties: bucketName: description: Object Storage bucket name. maxLength: 256 minLength: 1 type: string namespaceName: description: Object Storage namespace name. maxLength: 1024 minLength: 1 type: string objectNames: description: Object Storage object names. items: type: string minItems: 1 type: array required: - namespaceName - bucketName - objectNames type: object Diarization: description: Speaker diarization is a combination of speaker segmentation and speaker clustering. Provide diarization details to enable this feature. properties: isDiarizationEnabled: default: false description: Set true to enable Speaker diarization and tag transcription with speaker tags. By default this is disabled. type: boolean numberOfSpeakers: description: Number of speakers in the audio provided. By default service will auto detect all speakers in audio file maximum: 16 minimum: 2 type: integer x-default-description: 'null' type: object UpdateCustomizationDetails: description: The information to be updated. properties: alias: description: Customization Details Alias maxLength: 255 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: '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"}}`. ' type: object description: description: A short description of the customization. maxLength: 255 minLength: 1 type: string displayName: description: A user-friendly display name for the customization. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`. ' type: object modelDetails: $ref: '#/components/schemas/CustomizationModelDetails' trainingDataset: $ref: '#/components/schemas/CustomizationDatasetDetails' type: object TranscriptionFilter: description: Transcription Filter. discriminator: propertyName: type properties: type: description: 'The type of filters. ' enum: - PROFANITY type: string required: - type type: object TranscriptionTaskCollection: description: Results of a Transcription Task search. Contains both TranscriptionTaskSummary items and other information, such as metadata. properties: items: description: List of Transcription Task. items: $ref: '#/components/schemas/TranscriptionTaskSummary' type: array required: - items type: object AudioFormatDetails: description: Audio format details. properties: encoding: description: Input file encoding. Example - PCM. type: string format: description: Input file format. Example - WAV. type: string numberOfChannels: description: Input file number of channels. type: integer sampleRateInHz: description: Input file sampleRate. Example - 16000 type: integer type: object TranscriptionJobSummary: description: Summary of the Transcription Job. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job. type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the job. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: '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"}}`. ' type: object displayName: description: A user-friendly display name for the job. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`. ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the Speech Job. type: string x-obmcs-enumref: '#/definitions/TranscriptionJob/lifecycleState' outstandingTasks: description: Total outstanding tasks in a job. type: integer percentComplete: description: How much progress the operation has made, vs the total amount of work that must be performed. maximum: 100 minimum: 0 type: integer successfulTasks: description: Total successful tasks in a job. type: integer systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. ' type: object timeAccepted: description: Job accepted time. format: date-time type: string timeFinished: description: Job finished time. format: date-time type: string timeStarted: description: Job started time. format: date-time type: string totalTasks: description: Total number of tasks in a job. type: integer required: - id - displayName - compartmentId type: object CustomizationModelDetails: description: Details of the base ASR model to train a Customization for. properties: domain: default: GENERIC description: Domain of the ASR model enum: - GENERIC - MEDICAL type: string languageCode: description: '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 ' format: x-obmcs-human-language type: string ChangeCustomizationCompartmentDetails: description: Details for changing the compartment of a Customization. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object TranscriptionNormalization: description: Information to Normalize generated transcript. properties: filters: description: List of filters. items: $ref: '#/components/schemas/TranscriptionFilter' type: array isPunctuationEnabled: default: true description: Whether to add punctuation in the generated transcription. Enabled by default. type: boolean TtsAudioConfig: description: "Use this schema to specify handling of audio response. \nIf audioConfig is not provided, raw response is handed over for the user to handle.\n" discriminator: propertyName: configType properties: configType: description: 'The audio config type to use for handling the audio output. Supported config types are: - BASE_AUDIO_CONFIG ' enum: - BASE_AUDIO_CONFIG type: string required: - configType type: object TranscriptionJob: description: Description of Transcription Job. properties: additionalTranscriptionFormats: description: Transcription format. JSON format will always be provided in addition to any formats in this list. items: enum: - SRT type: string minItems: 1 type: array compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job. type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the job. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: '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"}}`. ' type: object description: description: A short description of the job. type: string displayName: description: A user-friendly display name for the job. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`. ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job. type: string inputLocation: $ref: '#/components/schemas/InputLocation' lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the Job. enum: - ACCEPTED - IN_PROGRESS - SUCCEEDED - FAILED - CANCELING - CANCELED type: string modelDetails: $ref: '#/components/schemas/TranscriptionModelDetails' normalization: $ref: '#/components/schemas/TranscriptionNormalization' outputLocation: $ref: '#/components/schemas/OutputLocation' outstandingTasks: description: Total outstanding tasks in a job. type: integer percentComplete: description: How much progress the operation has made, vs the total amount of work that must be performed. maximum: 100 minimum: 0 type: integer successfulTasks: description: Total successful tasks in a job. type: integer systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. ' type: object timeAccepted: description: Job accepted time. format: date-time type: string timeFinished: description: Job finished time. format: date-time type: string timeStarted: description: Job started time. format: date-time type: string totalTasks: description: Total tasks in a job. type: integer ttlInDays: description: Time to live duration in days for Job. Job will be available till max 90 days. type: integer required: - id - compartmentId - modelDetails - inputLocation - outputLocation type: object UpdateTranscriptionJobDetails: description: The information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: '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"}}`. ' type: object description: description: A short description of the job. maxLength: 255 minLength: 1 type: string displayName: description: A user-friendly display name for the job. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`. ' type: object type: object CustomizationCollection: description: Results of a Customization search. Contains both CustomizationSummary items and other information, such as metadata. properties: items: description: List of Customization training jobs. items: $ref: '#/components/schemas/CustomizationSummary' type: array required: - items type: object TranscriptionModelDetails: description: Model details. properties: domain: default: GENERIC description: Domain for input files. enum: - GENERIC type: string languageCode: default: en-US description: '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 ' enum: - en-US - es-ES - pt-BR - en-GB - en-AU - en-IN - hi-IN - fr-FR - de-DE - it-IT - auto - af - ar - az - be - bg - bs - ca - cs - cy - da - de - el - en - es - et - fa - fi - fr - gl - he - hi - hr - hu - hy - id - is - it - ja - kk - kn - ko - lt - lv - mi - mk - mr - ms - ne - nl - 'no' - pl - pt - ro - ru - sk - sl - sr - sv - sw - ta - th - tl - tr - uk - ur - vi - zh type: string modelType: default: ORACLE description: 'Select a model to use for generating transcriptions. Currently supported models are: - ORACLE - WHISPER_MEDIUM - WHISPER_LARGE_V2 (upon service request) - WHISPER_LARGE_V3T ' type: string transcriptionSettings: $ref: '#/components/schemas/TranscriptionSettings' TranscriptionTaskSummary: description: Summary of the Transcription Task. properties: displayName: description: A user-friendly display name for the task. maximum: 255 minimum: 1 type: string fileDurationInSeconds: description: Duration of input file in Seconds. type: integer fileSizeInBytes: description: Size of input file in Bytes. type: integer id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the task. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the Speech Job. type: string x-obmcs-enumref: '#/definitions/TranscriptionTask/lifecycleState' percentComplete: description: How much progress the operation has made, vs the total amount of work that must be performed. maximum: 100 minimum: 0 type: integer processingDurationInSeconds: description: Task proccessing duration, which excludes waiting time in the system. type: integer timeFinished: description: Job finished time format: date-time type: string timeStarted: description: Task started time format: date-time type: string required: - id - displayName type: object parameters: IdentifierQueryParam: description: Unique identifier(OCID). in: query name: id x-default-description: 'null' schema: type: string SortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated PaginationTokenQueryParam: description: A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. in: query name: page x-default-description: 'null' schema: type: string minLength: 1 TranscriptionTaskLifecycleStateQueryParam: description: A filter to return only resources whose lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/TranscriptionTask/lifecycleState' schema: type: string VoiceNameQueryParam: description: The name of the speaker voice in which the user wants tts inference to be. in: query name: displayName required: false x-default-description: 'null' schema: type: string TranscriptionJobLifecycleStateQueryParam: description: A filter to return only resources whose lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/TranscriptionJob/lifecycleState' schema: type: string ModelNameQueryParam: description: The model name to filter voices for given model name. in: query name: modelName required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/TtsOracleModelDetails/modelName' schema: type: string IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string CompartmentIdQueryParam: description: The ID of the compartment in which to list resources. in: query name: compartmentId x-default-description: 'null' schema: type: string CustomizationLifecycleStateQueryParam: description: A filter to return only resources whose lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Customization/lifecycleState' schema: type: string PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 TranscriptionJobIdPathParam: description: Unique Transcription Job identifier. in: path name: transcriptionJobId required: true schema: type: string SortOrderQueryParam: description: The sort order to use, either 'ASC' or 'DESC'. in: query name: sortOrder x-default-description: 'The default value depends upon `sortBy`, and in general is ''DESC'' when sorting by time and ''ASC'' otherwise. ' x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC TranscriptionTaskIdPathParam: description: Unique Transcription Task identifier. in: path name: transcriptionTaskId required: true schema: type: string RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 CustomizationIdPathParam: description: Unique Customization training Job identifier. in: path name: customizationId required: true schema: type: string CustomizationIdentifierQueryParam: description: Unique identifier(OCID). in: query name: id required: false x-default-description: 'null' schema: type: string DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string LanguageCodeQueryParam: description: The Code or Id of the language to filter voices for given language code. in: query name: languageCode required: false x-default-description: 'null' schema: type: string responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: '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"}}`. ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`. ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. ' type: object x-splat-stuff: x-customizationAudit: resourceNameExpression: downstream.getOr404('speech-01-prod','GetCustomization',request.resourceId).displayName x-customizationResource: targetCompartmentId: downstream.getOr404('speech-01-prod','GetCustomization',request.resourceId).compartmentId x-customizationResourceAlias: resourceOcid: 'request.resourceId.startsWith(''ocid'') ? request.resourceId : downstream.getOr404(''speech-01-prod'',''GetCustomization'',request.resourceId).id' x-transcriptionJobAudit: resourceNameExpression: downstream.getOr404('speech-01-prod','GetTranscriptionJob',request.resourceId).displayName x-transcriptionJobResource: targetCompartmentId: downstream.getOr404('speech-01-prod','GetTranscriptionJob',request.resourceId).compartmentId x-oracle-package: com.oracle.pic.ocas.speech