ibm_watson 2.1.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.31.0-902c9336-20210504-161156
+# 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,12 +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, Australian English,
-# 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"
@@ -86,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).
@@ -115,14 +118,14 @@ 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).
     #
     #
-    #   ### Important voice updates
+    #   ### 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
@@ -144,9 +147,13 @@ module IBMWatson
     #   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.
+    #   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** in the method description.
+    #   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
@@ -238,11 +245,11 @@ 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
+    #   ### 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
@@ -264,7 +271,7 @@ module IBMWatson
     #   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.
+    #   in the release notes for IBM Cloud.
     #
     #   ### Warning messages
     #
@@ -280,7 +287,13 @@ module IBMWatson
     #   specifying an audio format, see **Audio formats (accept types)** in the method
     #   description.
     # @param voice [String] The voice to use for synthesis. For more information about specifying a voice, see
-    #   **Important voice updates** in the method description.
+    #   **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
@@ -333,7 +346,7 @@ module IBMWatson
     #   language](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWords#cuWordsQueryLanguage).
     #
     #
-    #   ### Important voice updates
+    #   ### 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
@@ -355,12 +368,15 @@ module IBMWatson
     #   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.
+    #   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. For more information about specifying a voice, see **Important voice
-    #   updates** in the method description.
+    #   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, Australian English, and Korean languages support only IPA. Omit the
     #   parameter to obtain the pronunciation in the default format.
@@ -414,7 +430,7 @@ module IBMWatson
     #   model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customModels#cuModelsCreate).
     #
     #
-    #   ### Important voice updates
+    #   ### 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
@@ -436,13 +452,16 @@ module IBMWatson
     #   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.
+    #   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 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)
@@ -477,9 +496,9 @@ module IBMWatson
     # 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 and prompts in addition to the metadata
-    #   for a specific custom model, use the **Get a custom model** method. You must use
-    #   credentials for the instance of the service that owns a model to list information
-    #   about it.
+    #   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).
@@ -580,8 +599,8 @@ module IBMWatson
     # 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 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** method.
+    #   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).
@@ -672,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?
@@ -889,12 +908,11 @@ module IBMWatson
     #   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** method.
-    #   That method provides complete details about a specified custom model, including
-    #   its language, owner, custom words, and more.
-    #
-    #   **Beta:** Custom prompts are beta functionality that is supported only for use
-    #   with US English custom models and voices.
+    #   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).
@@ -952,11 +970,11 @@ module IBMWatson
     #   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** 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.
+    #   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
@@ -993,10 +1011,8 @@ module IBMWatson
     #   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.
-    #
-    #
-    #   **Beta:** Custom prompts are beta functionality that is supported only for use
-    #   with US English custom models and voices.
+    #   Custom prompts are supported only for use with US English custom models and
+    #   voices.
     #
     #   **See also:**
     #   * [Add a custom
@@ -1069,9 +1085,7 @@ module IBMWatson
     # 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.
-    #
-    #   **Beta:** Custom prompts are beta functionality that is supported only for use
+    #   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
@@ -1110,10 +1124,8 @@ module IBMWatson
     #
     #   **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.
-    #
-    #   **Beta:** Custom prompts are beta functionality that is supported only for use
-    #   with US English custom models and voices.
+    #   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).
@@ -1151,11 +1163,8 @@ module IBMWatson
     # 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.
-    #
-    #   **Beta:** Speaker models and the custom prompts with which they are used are beta
-    #   functionality that is supported only for use with US English custom models and
-    #   voices.
+    #   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).
@@ -1218,11 +1227,8 @@ module IBMWatson
     #
     #   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.
-    #
-    #   **Beta:** Speaker models and the custom prompts with which they are used are beta
-    #   functionality that is supported only for use with US English custom models and
-    #   voices.
+    #   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
@@ -1281,10 +1287,8 @@ module IBMWatson
     #   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.
-    #
-    #   **Beta:** Speaker models and the custom prompts with which they are used are beta
-    #   functionality that is supported only for use with US English custom models and
+    #   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
@@ -1322,11 +1326,9 @@ module IBMWatson
     #   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.
-    #
-    #   **Beta:** Speaker models and the custom prompts with which they are used are beta
-    #   functionality that is supported only for use with US English custom models and
-    #   voices.
+    #   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).

data/lib/ibm_watson/tone_analyzer_v3.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.31.0-902c9336-20210504-161156
+# IBM OpenAPI SDK Code Generator Version: 3.38.0-07189efd-20210827-205025
 #
 # The IBM Watson™ Tone Analyzer service uses linguistic analysis to detect
 # emotional and language tones in written text. The service can analyze tone at both the

data/lib/ibm_watson/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IBMWatson
-  VERSION = "2.1.2"
+  VERSION = "2.1.3"
 end

data/lib/ibm_watson/visual_recognition_v3.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.31.0-902c9336-20210504-161156
+# IBM OpenAPI SDK Code Generator Version: 3.38.0-07189efd-20210827-205025
 #
 # IBM Watson™ Visual Recognition is discontinued. Existing instances are supported
 # until 1 December 2021, but as of 7 January 2021, you can't create instances. Any

data/lib/ibm_watson/visual_recognition_v4.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.31.0-902c9336-20210504-161156
+# IBM OpenAPI SDK Code Generator Version: 3.38.0-07189efd-20210827-205025
 #
 # IBM Watson™ Visual Recognition is discontinued. Existing instances are supported
 # until 1 December 2021, but as of 7 January 2021, you can't create instances. Any

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibm_watson
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.3
 platform: ruby
 authors:
 - Max Nussbaum
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-24 00:00:00.000000000 Z
+date: 2021-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby