ibm_watson 2.0.2 → 2.1.3

data/lib/ibm_watson/text_to_speech_v1.rb

@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-# IBM OpenAPI SDK Code Generator Version: 3.19.0-be3b4618-20201113-200858
+# IBM OpenAPI SDK Code Generator Version: 3.38.0-07189efd-20210827-205025
 #
 # The IBM Watson™ Text to Speech service provides APIs that use IBM's
 # speech-synthesis capabilities to synthesize text into natural-sounding speech in a
@@ -33,8 +33,15 @@
 # that, when combined, sound like the word. A phonetic translation is based on the SSML
 # phoneme format for representing a word. You can specify a phonetic translation in
 # standard International Phonetic Alphabet (IPA) representation or in the proprietary IBM
-# Symbolic Phonetic Representation (SPR). The Arabic, Chinese, Dutch, and Korean languages
-# support only IPA.
+# Symbolic Phonetic Representation (SPR).
+#
+# The service also offers a Tune by Example feature that lets you define custom prompts.
+# You can also define speaker models to improve the quality of your custom prompts. The
+# service support custom prompts only for US English custom models and voices.
+#
+# **IBM Cloud®.** The Arabic, Chinese, Dutch, Australian English, and Korean languages
+# and voices are supported only for IBM Cloud. For phonetic translation, they support only
+# IPA, not SPR.
 
 require "concurrent"
 require "erb"
@@ -42,7 +49,6 @@ require "json"
 require "ibm_cloud_sdk_core"
 require_relative "./common.rb"
 
-# Module for the Watson APIs
 module IBMWatson
   ##
   # The Text to Speech V1 service.
@@ -83,8 +89,8 @@ module IBMWatson
     # Lists all voices available for use with the service. The information includes the
     #   name, language, gender, and other details about the voice. The ordering of the
     #   list of voices can change from call to call; do not rely on an alphabetized or
-    #   static list of voices. To see information about a specific voice, use the **Get a
-    #   voice** method.
+    #   static list of voices. To see information about a specific voice, use the [Get a
+    #   voice](#getvoice).
     #
     #   **See also:** [Listing all available
     #   voices](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices#listVoices).
@@ -112,12 +118,42 @@ module IBMWatson
     # Gets information about the specified voice. The information includes the name,
     #   language, gender, and other details about the voice. Specify a customization ID to
     #   obtain information for a custom model that is defined for the language of the
-    #   specified voice. To list information about all available voices, use the **List
-    #   voices** method.
+    #   specified voice. To list information about all available voices, use the [List
+    #   voices](#listvoices) method.
     #
     #   **See also:** [Listing a specific
     #   voice](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices#listVoice).
-    # @param voice [String] The voice for which information is to be returned.
+    #
+    #
+    #   ### Important voice updates for IBM Cloud
+    #
+    #    The service's voices underwent significant change on 2 December 2020.
+    #   * The Arabic, Chinese, Dutch, Australian English, and Korean voices are now neural
+    #   instead of concatenative.
+    #   * The `ar-AR_OmarVoice` voice is deprecated. Use `ar-MS_OmarVoice` voice instead.
+    #   * The `ar-AR` language identifier cannot be used to create a custom model. Use the
+    #   `ar-MS` identifier instead.
+    #   * The standard concatenative voices for the following languages are now
+    #   deprecated: Brazilian Portuguese, United Kingdom and United States English,
+    #   French, German, Italian, Japanese, and Spanish (all dialects).
+    #   * The features expressive SSML, voice transformation SSML, and use of the `volume`
+    #   attribute of the `<prosody>` element are deprecated and are not supported with any
+    #   of the service's neural voices.
+    #   * All of the service's voices are now customizable and generally available (GA)
+    #   for production use.
+    #
+    #   The deprecated voices and features will continue to function for at least one year
+    #   but might be removed at a future date. You are encouraged to migrate to the
+    #   equivalent neural voices at your earliest convenience. For more information about
+    #   all voice updates, see the [2 December 2020 service
+    #   update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#December2020)
+    #   in the release notes for IBM Cloud.
+    # @param voice [String] The voice for which information is to be returned. For more information about
+    #   specifying a voice, see **Important voice updates for IBM Cloud** in the method
+    #   description.
+    #
+    #   **IBM Cloud:** The Arabic, Chinese, Dutch, Australian English, and Korean
+    #   languages and voices are supported only for IBM Cloud.
     # @param customization_id [String] The customization ID (GUID) of a custom model for which information is to be
     #   returned. You must make the request with credentials for the instance of the
     #   service that owns the custom model. Omit the parameter to see information about
@@ -209,9 +245,33 @@ module IBMWatson
     #   The default sampling rate is 22,050 Hz.
     #
     #   For more information about specifying an audio format, including additional
-    #   details about some of the formats, see [Audio
-    #   formats](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-audioFormats#audioFormats).
+    #   details about some of the formats, see [Using audio
+    #   formats](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-audio-formats).
+    #
+    #
+    #   ### Important voice updates for IBM Cloud
+    #
+    #    The service's voices underwent significant change on 2 December 2020.
+    #   * The Arabic, Chinese, Dutch, Australian English, and Korean voices are now neural
+    #   instead of concatenative.
+    #   * The `ar-AR_OmarVoice` voice is deprecated. Use `ar-MS_OmarVoice` voice instead.
+    #   * The `ar-AR` language identifier cannot be used to create a custom model. Use the
+    #   `ar-MS` identifier instead.
+    #   * The standard concatenative voices for the following languages are now
+    #   deprecated: Brazilian Portuguese, United Kingdom and United States English,
+    #   French, German, Italian, Japanese, and Spanish (all dialects).
+    #   * The features expressive SSML, voice transformation SSML, and use of the `volume`
+    #   attribute of the `<prosody>` element are deprecated and are not supported with any
+    #   of the service's neural voices.
+    #   * All of the service's voices are now customizable and generally available (GA)
+    #   for production use.
     #
+    #   The deprecated voices and features will continue to function for at least one year
+    #   but might be removed at a future date. You are encouraged to migrate to the
+    #   equivalent neural voices at your earliest convenience. For more information about
+    #   all voice updates, see the [2 December 2020 service
+    #   update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#December2020)
+    #   in the release notes for IBM Cloud.
     #
     #   ### Warning messages
     #
@@ -226,7 +286,14 @@ module IBMWatson
     #   the `accept` parameter to specify the audio format. For more information about
     #   specifying an audio format, see **Audio formats (accept types)** in the method
     #   description.
-    # @param voice [String] The voice to use for synthesis.
+    # @param voice [String] The voice to use for synthesis. For more information about specifying a voice, see
+    #   **Important voice updates for IBM Cloud** in the method description.
+    #
+    #   **IBM Cloud:** The Arabic, Chinese, Dutch, Australian English, and Korean
+    #   languages and voices are supported only for IBM Cloud.
+    #
+    #   **See also:** See also [Using languages and
+    #   voices](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices).
     # @param customization_id [String] The customization ID (GUID) of a custom model to use for the synthesis. If a
     #   custom model is specified, it works only if it matches the language of the
     #   indicated voice. You must make the request with credentials for the instance of
@@ -277,13 +344,42 @@ module IBMWatson
     #
     #   **See also:** [Querying a word from a
     #   language](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWords#cuWordsQueryLanguage).
+    #
+    #
+    #   ### Important voice updates for IBM Cloud
+    #
+    #    The service's voices underwent significant change on 2 December 2020.
+    #   * The Arabic, Chinese, Dutch, Australian English, and Korean voices are now neural
+    #   instead of concatenative.
+    #   * The `ar-AR_OmarVoice` voice is deprecated. Use `ar-MS_OmarVoice` voice instead.
+    #   * The `ar-AR` language identifier cannot be used to create a custom model. Use the
+    #   `ar-MS` identifier instead.
+    #   * The standard concatenative voices for the following languages are now
+    #   deprecated: Brazilian Portuguese, United Kingdom and United States English,
+    #   French, German, Italian, Japanese, and Spanish (all dialects).
+    #   * The features expressive SSML, voice transformation SSML, and use of the `volume`
+    #   attribute of the `<prosody>` element are deprecated and are not supported with any
+    #   of the service's neural voices.
+    #   * All of the service's voices are now customizable and generally available (GA)
+    #   for production use.
+    #
+    #   The deprecated voices and features will continue to function for at least one year
+    #   but might be removed at a future date. You are encouraged to migrate to the
+    #   equivalent neural voices at your earliest convenience. For more information about
+    #   all voice updates, see the [2 December 2020 service
+    #   update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#December2020)
+    #   in the release notes for IBM Cloud.
     # @param text [String] The word for which the pronunciation is requested.
     # @param voice [String] A voice that specifies the language in which the pronunciation is to be returned.
     #   All voices for the same language (for example, `en-US`) return the same
-    #   translation.
+    #   translation. For more information about specifying a voice, see **Important voice
+    #   updates for IBM Cloud** in the method description.
+    #
+    #   **IBM Cloud:** The Arabic, Chinese, Dutch, Australian English, and Korean
+    #   languages and voices are supported only for IBM Cloud.
     # @param format [String] The phoneme format in which to return the pronunciation. The Arabic, Chinese,
-    #   Dutch, and Korean languages support only IPA. Omit the parameter to obtain the
-    #   pronunciation in the default format.
+    #   Dutch, Australian English, and Korean languages support only IPA. Omit the
+    #   parameter to obtain the pronunciation in the default format.
     # @param customization_id [String] The customization ID (GUID) of a custom model for which the pronunciation is to be
     #   returned. The language of a specified custom model must match the language of the
     #   specified voice. If the word is not defined in the specified custom model, the
@@ -332,11 +428,40 @@ module IBMWatson
     #
     #   **See also:** [Creating a custom
     #   model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customModels#cuModelsCreate).
+    #
+    #
+    #   ### Important voice updates for IBM Cloud
+    #
+    #    The service's voices underwent significant change on 2 December 2020.
+    #   * The Arabic, Chinese, Dutch, Australian English, and Korean voices are now neural
+    #   instead of concatenative.
+    #   * The `ar-AR_OmarVoice` voice is deprecated. Use `ar-MS_OmarVoice` voice instead.
+    #   * The `ar-AR` language identifier cannot be used to create a custom model. Use the
+    #   `ar-MS` identifier instead.
+    #   * The standard concatenative voices for the following languages are now
+    #   deprecated: Brazilian Portuguese, United Kingdom and United States English,
+    #   French, German, Italian, Japanese, and Spanish (all dialects).
+    #   * The features expressive SSML, voice transformation SSML, and use of the `volume`
+    #   attribute of the `<prosody>` element are deprecated and are not supported with any
+    #   of the service's neural voices.
+    #   * All of the service's voices are now customizable and generally available (GA)
+    #   for production use.
+    #
+    #   The deprecated voices and features will continue to function for at least one year
+    #   but might be removed at a future date. You are encouraged to migrate to the
+    #   equivalent neural voices at your earliest convenience. For more information about
+    #   all voice updates, see the [2 December 2020 service
+    #   update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#December2020)
+    #   in the release notes for IBM Cloud.
     # @param name [String] The name of the new custom model.
     # @param language [String] The language of the new custom model. You create a custom model for a specific
-    #   language, not for a specific voice. A custom model can be used with any voice,
-    #   standard or neural, for its specified language. Omit the parameter to use the the
-    #   default language, `en-US`.
+    #   language, not for a specific voice. A custom model can be used with any voice for
+    #   its specified language. Omit the parameter to use the the default language,
+    #   `en-US`. **Note:** The `ar-AR` language identifier cannot be used to create a
+    #   custom model. Use the `ar-MS` identifier instead.
+    #
+    #   **IBM Cloud:** The Arabic, Chinese, Dutch, Australian English, and Korean
+    #   languages and voices are supported only for IBM Cloud.
     # @param description [String] A description of the new custom model. Specifying a description is recommended.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def create_custom_model(name:, language: nil, description: nil)
@@ -370,10 +495,10 @@ module IBMWatson
     # List custom models.
     # Lists metadata such as the name and description for all custom models that are
     #   owned by an instance of the service. Specify a language to list the custom models
-    #   for that language only. To see the words in addition to the metadata for a
-    #   specific custom model, use the **List a custom model** method. You must use
-    #   credentials for the instance of the service that owns a model to list information
-    #   about it.
+    #   for that language only. To see the words and prompts in addition to the metadata
+    #   for a specific custom model, use the [Get a custom model](#getcustommodel) method.
+    #   You must use credentials for the instance of the service that owns a model to list
+    #   information about it.
     #
     #   **See also:** [Querying all custom
     #   models](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customModels#cuModelsQueryAll).
@@ -473,8 +598,9 @@ module IBMWatson
     # Get a custom model.
     # Gets all information about a specified custom model. In addition to metadata such
     #   as the name and description of the custom model, the output includes the words and
-    #   their translations as defined in the model. To see just the metadata for a model,
-    #   use the **List custom models** method.
+    #   their translations that are defined for the model, as well as any prompts that are
+    #   defined for the model. To see just the metadata for a model, use the [List custom
+    #   models](#listcustommodels) method.
     #
     #   **See also:** [Querying a custom
     #   model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customModels#cuModelsQuery).
@@ -565,14 +691,14 @@ module IBMWatson
     #   customization](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customIntro#customIntro).
     # @param customization_id [String] The customization ID (GUID) of the custom model. You must make the request with
     #   credentials for the instance of the service that owns the custom model.
-    # @param words [Array[Word]] The **Add custom words** method accepts an array of `Word` objects. Each object
-    #   provides a word that is to be added or updated for the custom model and the word's
-    #   translation.
-    #
-    #   The **List custom words** method returns an array of `Word` objects. Each object
-    #   shows a word and its translation from the custom model. The words are listed in
-    #   alphabetical order, with uppercase letters listed before lowercase letters. The
-    #   array is empty if the custom model contains no words.
+    # @param words [Array[Word]] The [Add custom words](#addwords) method accepts an array of `Word` objects. Each
+    #   object provides a word that is to be added or updated for the custom model and the
+    #   word's translation.
+    #
+    #   The [List custom words](#listwords) method returns an array of `Word` objects.
+    #   Each object shows a word and its translation from the custom model. The words are
+    #   listed in alphabetical order, with uppercase letters listed before lowercase
+    #   letters. The array is empty if the custom model contains no words.
     # @return [nil]
     def add_words(customization_id:, words:)
       raise ArgumentError.new("customization_id must be provided") if customization_id.nil?
@@ -666,9 +792,9 @@ module IBMWatson
     # @param word [String] The word that is to be added or updated for the custom model.
     # @param translation [String] The phonetic or sounds-like translation for the word. A phonetic translation is
     #   based on the SSML format for representing the phonetic string of a word either as
-    #   an IPA translation or as an IBM SPR translation. The Arabic, Chinese, Dutch, and
-    #   Korean languages support only IPA. A sounds-like is one or more words that, when
-    #   combined, sound like the word.
+    #   an IPA translation or as an IBM SPR translation. The Arabic, Chinese, Dutch,
+    #   Australian English, and Korean languages support only IPA. A sounds-like is one or
+    #   more words that, when combined, sound like the word.
     # @param part_of_speech [String] **Japanese only.** The part of speech for the word. The service uses the value to
     #   produce the correct intonation for the word. You can create only a single entry,
     #   with or without a single part of speech, for any word; you cannot create multiple
@@ -772,6 +898,462 @@ module IBMWatson
       nil
     end
     #########################
+    # Custom prompts
+    #########################
+
+    ##
+    # @!method list_custom_prompts(customization_id:)
+    # List custom prompts.
+    # Lists information about all custom prompts that are defined for a custom model.
+    #   The information includes the prompt ID, prompt text, status, and optional speaker
+    #   ID for each prompt of the custom model. You must use credentials for the instance
+    #   of the service that owns the custom model. The same information about all of the
+    #   prompts for a custom model is also provided by the [Get a custom
+    #   model](#getcustommodel) method. That method provides complete details about a
+    #   specified custom model, including its language, owner, custom words, and more.
+    #   Custom prompts are supported only for use with US English custom models and
+    #   voices.
+    #
+    #   **See also:** [Listing custom
+    #   prompts](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-custom-prompts#tbe-custom-prompts-list).
+    # @param customization_id [String] The customization ID (GUID) of the custom model. You must make the request with
+    #   credentials for the instance of the service that owns the custom model.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def list_custom_prompts(customization_id:)
+      raise ArgumentError.new("customization_id must be provided") if customization_id.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("text_to_speech", "V1", "list_custom_prompts")
+      headers.merge!(sdk_headers)
+
+      method_url = "/v1/customizations/%s/prompts" % [ERB::Util.url_encode(customization_id)]
+
+      response = request(
+        method: "GET",
+        url: method_url,
+        headers: headers,
+        accept_json: true
+      )
+      response
+    end
+
+    ##
+    # @!method add_custom_prompt(customization_id:, prompt_id:, metadata:, file:)
+    # Add a custom prompt.
+    # Adds a custom prompt to a custom model. A prompt is defined by the text that is to
+    #   be spoken, the audio for that text, a unique user-specified ID for the prompt, and
+    #   an optional speaker ID. The information is used to generate prosodic data that is
+    #   not visible to the user. This data is used by the service to produce the
+    #   synthesized audio upon request. You must use credentials for the instance of the
+    #   service that owns a custom model to add a prompt to it. You can add a maximum of
+    #   1000 custom prompts to a single custom model.
+    #
+    #   You are recommended to assign meaningful values for prompt IDs. For example, use
+    #   `goodbye` to identify a prompt that speaks a farewell message. Prompt IDs must be
+    #   unique within a given custom model. You cannot define two prompts with the same
+    #   name for the same custom model. If you provide the ID of an existing prompt, the
+    #   previously uploaded prompt is replaced by the new information. The existing prompt
+    #   is reprocessed by using the new text and audio and, if provided, new speaker
+    #   model, and the prosody data associated with the prompt is updated.
+    #
+    #   The quality of a prompt is undefined if the language of a prompt does not match
+    #   the language of its custom model. This is consistent with any text or SSML that is
+    #   specified for a speech synthesis request. The service makes a best-effort attempt
+    #   to render the specified text for the prompt; it does not validate that the
+    #   language of the text matches the language of the model.
+    #
+    #   Adding a prompt is an asynchronous operation. Although it accepts less audio than
+    #   speaker enrollment, the service must align the audio with the provided text. The
+    #   time that it takes to process a prompt depends on the prompt itself. The
+    #   processing time for a reasonably sized prompt generally matches the length of the
+    #   audio (for example, it takes 20 seconds to process a 20-second prompt).
+    #
+    #   For shorter prompts, you can wait for a reasonable amount of time and then check
+    #   the status of the prompt with the [Get a custom prompt](#getcustomprompt) method.
+    #   For longer prompts, consider using that method to poll the service every few
+    #   seconds to determine when the prompt becomes available. No prompt can be used for
+    #   speech synthesis if it is in the `processing` or `failed` state. Only prompts that
+    #   are in the `available` state can be used for speech synthesis.
+    #
+    #   When it processes a request, the service attempts to align the text and the audio
+    #   that are provided for the prompt. The text that is passed with a prompt must match
+    #   the spoken audio as closely as possible. Optimally, the text and audio match
+    #   exactly. The service does its best to align the specified text with the audio, and
+    #   it can often compensate for mismatches between the two. But if the service cannot
+    #   effectively align the text and the audio, possibly because the magnitude of
+    #   mismatches between the two is too great, processing of the prompt fails.
+    #
+    #   ### Evaluating a prompt
+    #
+    #    Always listen to and evaluate a prompt to determine its quality before using it
+    #   in production. To evaluate a prompt, include only the single prompt in a speech
+    #   synthesis request by using the following SSML extension, in this case for a prompt
+    #   whose ID is `goodbye`:
+    #
+    #   `<ibm:prompt id="goodbye"/>`
+    #
+    #   In some cases, you might need to rerecord and resubmit a prompt as many as five
+    #   times to address the following possible problems:
+    #   * The service might fail to detect a mismatch between the prompts text and audio.
+    #   The longer the prompt, the greater the chance for misalignment between its text
+    #   and audio. Therefore, multiple shorter prompts are preferable to a single long
+    #   prompt.
+    #   * The text of a prompt might include a word that the service does not recognize.
+    #   In this case, you can create a custom word and pronunciation pair to tell the
+    #   service how to pronounce the word. You must then re-create the prompt.
+    #   * The quality of the input audio might be insufficient or the services processing
+    #   of the audio might fail to detect the intended prosody. Submitting new audio for
+    #   the prompt can correct these issues.
+    #
+    #   If a prompt that is created without a speaker ID does not adequately reflect the
+    #   intended prosody, enrolling the speaker and providing a speaker ID for the prompt
+    #   is one recommended means of potentially improving the quality of the prompt. This
+    #   is especially important for shorter prompts such as "good-bye" or "thank you,"
+    #   where less audio data makes it more difficult to match the prosody of the speaker.
+    #   Custom prompts are supported only for use with US English custom models and
+    #   voices.
+    #
+    #   **See also:**
+    #   * [Add a custom
+    #   prompt](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-create#tbe-create-add-prompt)
+    #   * [Evaluate a custom
+    #   prompt](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-create#tbe-create-evaluate-prompt)
+    #   * [Rules for creating custom
+    #   prompts](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-rules#tbe-rules-prompts).
+    # @param customization_id [String] The customization ID (GUID) of the custom model. You must make the request with
+    #   credentials for the instance of the service that owns the custom model.
+    # @param prompt_id [String] The identifier of the prompt that is to be added to the custom model:
+    #   * Include a maximum of 49 characters in the ID.
+    #   * Include only alphanumeric characters and `_` (underscores) in the ID.
+    #   * Do not include XML sensitive characters (double quotes, single quotes,
+    #   ampersands, angle brackets, and slashes) in the ID.
+    #   * To add a new prompt, the ID must be unique for the specified custom model.
+    #   Otherwise, the new information for the prompt overwrites the existing prompt that
+    #   has that ID.
+    # @param metadata [PromptMetadata] Information about the prompt that is to be added to a custom model. The following
+    #   example of a `PromptMetadata` object includes both the required prompt text and an
+    #   optional speaker model ID:
+    #
+    #   `{ "prompt_text": "Thank you and good-bye!", "speaker_id":
+    #   "823068b2-ed4e-11ea-b6e0-7b6456aa95cc" }`.
+    # @param file [File] An audio file that speaks the text of the prompt with intonation and prosody that
+    #   matches how you would like the prompt to be spoken.
+    #   * The prompt audio must be in WAV format and must have a minimum sampling rate of
+    #   16 kHz. The service accepts audio with higher sampling rates. The service
+    #   transcodes all audio to 16 kHz before processing it.
+    #   * The length of the prompt audio is limited to 30 seconds.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def add_custom_prompt(customization_id:, prompt_id:, metadata:, file:)
+      raise ArgumentError.new("customization_id must be provided") if customization_id.nil?
+
+      raise ArgumentError.new("prompt_id must be provided") if prompt_id.nil?
+
+      raise ArgumentError.new("metadata must be provided") if metadata.nil?
+
+      raise ArgumentError.new("file must be provided") if file.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("text_to_speech", "V1", "add_custom_prompt")
+      headers.merge!(sdk_headers)
+
+      form_data = {}
+
+      form_data[:metadata] = HTTP::FormData::Part.new(metadata.to_s, content_type: "application/json")
+
+      unless file.instance_of?(StringIO) || file.instance_of?(File)
+        file = file.respond_to?(:to_json) ? StringIO.new(file.to_json) : StringIO.new(file)
+      end
+      form_data[:file] = HTTP::FormData::File.new(file, content_type: "audio/wav", filename: file.respond_to?(:path) ? file.path : nil)
+
+      method_url = "/v1/customizations/%s/prompts/%s" % [ERB::Util.url_encode(customization_id), ERB::Util.url_encode(prompt_id)]
+
+      response = request(
+        method: "POST",
+        url: method_url,
+        headers: headers,
+        form: form_data,
+        accept_json: true
+      )
+      response
+    end
+
+    ##
+    # @!method get_custom_prompt(customization_id:, prompt_id:)
+    # Get a custom prompt.
+    # Gets information about a specified custom prompt for a specified custom model. The
+    #   information includes the prompt ID, prompt text, status, and optional speaker ID
+    #   for each prompt of the custom model. You must use credentials for the instance of
+    #   the service that owns the custom model. Custom prompts are supported only for use
+    #   with US English custom models and voices.
+    #
+    #   **See also:** [Listing custom
+    #   prompts](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-custom-prompts#tbe-custom-prompts-list).
+    # @param customization_id [String] The customization ID (GUID) of the custom model. You must make the request with
+    #   credentials for the instance of the service that owns the custom model.
+    # @param prompt_id [String] The identifier (name) of the prompt.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def get_custom_prompt(customization_id:, prompt_id:)
+      raise ArgumentError.new("customization_id must be provided") if customization_id.nil?
+
+      raise ArgumentError.new("prompt_id must be provided") if prompt_id.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("text_to_speech", "V1", "get_custom_prompt")
+      headers.merge!(sdk_headers)
+
+      method_url = "/v1/customizations/%s/prompts/%s" % [ERB::Util.url_encode(customization_id), ERB::Util.url_encode(prompt_id)]
+
+      response = request(
+        method: "GET",
+        url: method_url,
+        headers: headers,
+        accept_json: true
+      )
+      response
+    end
+
+    ##
+    # @!method delete_custom_prompt(customization_id:, prompt_id:)
+    # Delete a custom prompt.
+    # Deletes an existing custom prompt from a custom model. The service deletes the
+    #   prompt with the specified ID. You must use credentials for the instance of the
+    #   service that owns the custom model from which the prompt is to be deleted.
+    #
+    #   **Caution:** Deleting a custom prompt elicits a 400 response code from synthesis
+    #   requests that attempt to use the prompt. Make sure that you do not attempt to use
+    #   a deleted prompt in a production application. Custom prompts are supported only
+    #   for use with US English custom models and voices.
+    #
+    #   **See also:** [Deleting a custom
+    #   prompt](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-custom-prompts#tbe-custom-prompts-delete).
+    # @param customization_id [String] The customization ID (GUID) of the custom model. You must make the request with
+    #   credentials for the instance of the service that owns the custom model.
+    # @param prompt_id [String] The identifier (name) of the prompt that is to be deleted.
+    # @return [nil]
+    def delete_custom_prompt(customization_id:, prompt_id:)
+      raise ArgumentError.new("customization_id must be provided") if customization_id.nil?
+
+      raise ArgumentError.new("prompt_id must be provided") if prompt_id.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("text_to_speech", "V1", "delete_custom_prompt")
+      headers.merge!(sdk_headers)
+
+      method_url = "/v1/customizations/%s/prompts/%s" % [ERB::Util.url_encode(customization_id), ERB::Util.url_encode(prompt_id)]
+
+      request(
+        method: "DELETE",
+        url: method_url,
+        headers: headers,
+        accept_json: false
+      )
+      nil
+    end
+    #########################
+    # Speaker models
+    #########################
+
+    ##
+    # @!method list_speaker_models
+    # List speaker models.
+    # Lists information about all speaker models that are defined for a service
+    #   instance. The information includes the speaker ID and speaker name of each defined
+    #   speaker. You must use credentials for the instance of a service to list its
+    #   speakers. Speaker models and the custom prompts with which they are used are
+    #   supported only for use with US English custom models and voices.
+    #
+    #   **See also:** [Listing speaker
+    #   models](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-speaker-models#tbe-speaker-models-list).
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def list_speaker_models
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("text_to_speech", "V1", "list_speaker_models")
+      headers.merge!(sdk_headers)
+
+      method_url = "/v1/speakers"
+
+      response = request(
+        method: "GET",
+        url: method_url,
+        headers: headers,
+        accept_json: true
+      )
+      response
+    end
+
+    ##
+    # @!method create_speaker_model(speaker_name:, audio:)
+    # Create a speaker model.
+    # Creates a new speaker model, which is an optional enrollment token for users who
+    #   are to add prompts to custom models. A speaker model contains information about a
+    #   user's voice. The service extracts this information from a WAV audio sample that
+    #   you pass as the body of the request. Associating a speaker model with a prompt is
+    #   optional, but the information that is extracted from the speaker model helps the
+    #   service learn about the speaker's voice.
+    #
+    #   A speaker model can make an appreciable difference in the quality of prompts,
+    #   especially short prompts with relatively little audio, that are associated with
+    #   that speaker. A speaker model can help the service produce a prompt with more
+    #   confidence; the lack of a speaker model can potentially compromise the quality of
+    #   a prompt.
+    #
+    #   The gender of the speaker who creates a speaker model does not need to match the
+    #   gender of a voice that is used with prompts that are associated with that speaker
+    #   model. For example, a speaker model that is created by a male speaker can be
+    #   associated with prompts that are spoken by female voices.
+    #
+    #   You create a speaker model for a given instance of the service. The new speaker
+    #   model is owned by the service instance whose credentials are used to create it.
+    #   That same speaker can then be used to create prompts for all custom models within
+    #   that service instance. No language is associated with a speaker model, but each
+    #   custom model has a single specified language. You can add prompts only to US
+    #   English models.
+    #
+    #   You specify a name for the speaker when you create it. The name must be unique
+    #   among all speaker names for the owning service instance. To re-create a speaker
+    #   model for an existing speaker name, you must first delete the existing speaker
+    #   model that has that name.
+    #
+    #   Speaker enrollment is a synchronous operation. Although it accepts more audio data
+    #   than a prompt, the process of adding a speaker is very fast. The service simply
+    #   extracts information about the speakers voice from the audio. Unlike prompts,
+    #   speaker models neither need nor accept a transcription of the audio. When the call
+    #   returns, the audio is fully processed and the speaker enrollment is complete.
+    #
+    #   The service returns a speaker ID with the request. A speaker ID is globally unique
+    #   identifier (GUID) that you use to identify the speaker in subsequent requests to
+    #   the service. Speaker models and the custom prompts with which they are used are
+    #   supported only for use with US English custom models and voices.
+    #
+    #   **See also:**
+    #   * [Create a speaker
+    #   model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-create#tbe-create-speaker-model)
+    #   * [Rules for creating speaker
+    #   models](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-rules#tbe-rules-speakers).
+    # @param speaker_name [String] The name of the speaker that is to be added to the service instance.
+    #   * Include a maximum of 49 characters in the name.
+    #   * Include only alphanumeric characters and `_` (underscores) in the name.
+    #   * Do not include XML sensitive characters (double quotes, single quotes,
+    #   ampersands, angle brackets, and slashes) in the name.
+    #   * Do not use the name of an existing speaker that is already defined for the
+    #   service instance.
+    # @param audio [File] An enrollment audio file that contains a sample of the speakers voice.
+    #   * The enrollment audio must be in WAV format and must have a minimum sampling rate
+    #   of 16 kHz. The service accepts audio with higher sampling rates. It transcodes all
+    #   audio to 16 kHz before processing it.
+    #   * The length of the enrollment audio is limited to 1 minute. Speaking one or two
+    #   paragraphs of text that include five to ten sentences is recommended.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def create_speaker_model(speaker_name:, audio:)
+      raise ArgumentError.new("speaker_name must be provided") if speaker_name.nil?
+
+      raise ArgumentError.new("audio must be provided") if audio.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("text_to_speech", "V1", "create_speaker_model")
+      headers.merge!(sdk_headers)
+
+      params = {
+        "speaker_name" => speaker_name
+      }
+
+      data = audio
+      headers["Content-Type"] = "audio/wav"
+
+      method_url = "/v1/speakers"
+
+      response = request(
+        method: "POST",
+        url: method_url,
+        headers: headers,
+        params: params,
+        data: data,
+        accept_json: true
+      )
+      response
+    end
+
+    ##
+    # @!method get_speaker_model(speaker_id:)
+    # Get a speaker model.
+    # Gets information about all prompts that are defined by a specified speaker for all
+    #   custom models that are owned by a service instance. The information is grouped by
+    #   the customization IDs of the custom models. For each custom model, the information
+    #   lists information about each prompt that is defined for that custom model by the
+    #   speaker. You must use credentials for the instance of the service that owns a
+    #   speaker model to list its prompts. Speaker models and the custom prompts with
+    #   which they are used are supported only for use with US English custom models and
+    #   voices.
+    #
+    #   **See also:** [Listing the custom prompts for a speaker
+    #   model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-speaker-models#tbe-speaker-models-list-prompts).
+    # @param speaker_id [String] The speaker ID (GUID) of the speaker model. You must make the request with service
+    #   credentials for the instance of the service that owns the speaker model.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def get_speaker_model(speaker_id:)
+      raise ArgumentError.new("speaker_id must be provided") if speaker_id.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("text_to_speech", "V1", "get_speaker_model")
+      headers.merge!(sdk_headers)
+
+      method_url = "/v1/speakers/%s" % [ERB::Util.url_encode(speaker_id)]
+
+      response = request(
+        method: "GET",
+        url: method_url,
+        headers: headers,
+        accept_json: true
+      )
+      response
+    end
+
+    ##
+    # @!method delete_speaker_model(speaker_id:)
+    # Delete a speaker model.
+    # Deletes an existing speaker model from the service instance. The service deletes
+    #   the enrolled speaker with the specified speaker ID. You must use credentials for
+    #   the instance of the service that owns a speaker model to delete the speaker.
+    #
+    #   Any prompts that are associated with the deleted speaker are not affected by the
+    #   speaker's deletion. The prosodic data that defines the quality of a prompt is
+    #   established when the prompt is created. A prompt is static and remains unaffected
+    #   by deletion of its associated speaker. However, the prompt cannot be resubmitted
+    #   or updated with its original speaker once that speaker is deleted. Speaker models
+    #   and the custom prompts with which they are used are supported only for use with US
+    #   English custom models and voices.
+    #
+    #   **See also:** [Deleting a speaker
+    #   model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-speaker-models#tbe-speaker-models-delete).
+    # @param speaker_id [String] The speaker ID (GUID) of the speaker model. You must make the request with service
+    #   credentials for the instance of the service that owns the speaker model.
+    # @return [nil]
+    def delete_speaker_model(speaker_id:)
+      raise ArgumentError.new("speaker_id must be provided") if speaker_id.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("text_to_speech", "V1", "delete_speaker_model")
+      headers.merge!(sdk_headers)
+
+      method_url = "/v1/speakers/%s" % [ERB::Util.url_encode(speaker_id)]
+
+      request(
+        method: "DELETE",
+        url: method_url,
+        headers: headers,
+        accept_json: false
+      )
+      nil
+    end
+    #########################
     # User data
     #########################