ibm_watson 1.6.0 → 2.0.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
@@ -13,7 +13,9 @@
13
13
  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
14
  # See the License for the specific language governing permissions and
15
15
  # limitations under the License.
16
-
16
+ #
17
+ # IBM OpenAPI SDK Code Generator Version: 3.17.0-8d569e8f-20201030-142059
18
+ #
17
19
  # IBM Watson™ Natural Language Classifier uses machine learning algorithms to
18
20
  # return the top matching predefined classes for short text input. You create and train a
19
21
  # classifier to connect predefined classes to example texts so that the service can apply
@@ -13,7 +13,9 @@
13
13
  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
14
  # See the License for the specific language governing permissions and
15
15
  # limitations under the License.
16
-
16
+ #
17
+ # IBM OpenAPI SDK Code Generator Version: 3.17.0-8d569e8f-20201030-142059
18
+ #
17
19
  # Analyze various features of text content at scale. Provide text, raw HTML, or a public
18
20
  # URL and IBM Watson Natural Language Understanding will give you results for the features
19
21
  # you request. The service cleans HTML content before analysis by default, so the results
@@ -38,21 +40,14 @@ module IBMWatson
38
40
  include Concurrent::Async
39
41
  DEFAULT_SERVICE_NAME = "natural_language_understanding"
40
42
  DEFAULT_SERVICE_URL = "https://api.us-south.natural-language-understanding.watson.cloud.ibm.com"
43
+ attr_accessor :version
41
44
  ##
42
45
  # @!method initialize(args)
43
46
  # Construct a new client for the Natural Language Understanding service.
44
47
  #
45
48
  # @param args [Hash] The args to initialize with
46
- # @option args version [String] The API version date to use with the service, in
47
- # "YYYY-MM-DD" format. Whenever the API is changed in a backwards
48
- # incompatible way, a new minor version of the API is released.
49
- # The service uses the API version for the date you specify, or
50
- # the most recent version before that date. Note that you should
51
- # not programmatically specify the current date at runtime, in
52
- # case the API has been updated since your application's release.
53
- # Instead, specify a version date that is compatible with your
54
- # application, and don't change it until your application is
55
- # ready for a later version.
49
+ # @option args version [String] Release date of the API version you want to use. Specify dates in YYYY-MM-DD
50
+ # format. The current version is `2020-08-01`.
56
51
  # @option args service_url [String] The base service URL to use when contacting the service.
57
52
  # The base service_url may differ between IBM Cloud regions.
58
53
  # @option args authenticator [Object] The Authenticator instance to be configured for this service.
@@ -61,10 +56,10 @@ module IBMWatson
61
56
  def initialize(args = {})
62
57
  @__async_initialized__ = false
63
58
  defaults = {}
64
- defaults[:version] = nil
65
59
  defaults[:service_url] = DEFAULT_SERVICE_URL
66
60
  defaults[:service_name] = DEFAULT_SERVICE_NAME
67
61
  defaults[:authenticator] = nil
62
+ defaults[:version] = nil
68
63
  user_service_url = args[:service_url] unless args[:service_url].nil?
69
64
  args = defaults.merge(args)
70
65
  @version = args[:version]
@@ -92,7 +87,8 @@ module IBMWatson
92
87
  # - Relations
93
88
  # - Semantic roles
94
89
  # - Sentiment
95
- # - Syntax.
90
+ # - Syntax
91
+ # - Summarization (Experimental)
96
92
  #
97
93
  # If a language for the input text is not specified with the `language` parameter,
98
94
  # the service [automatically detects the
@@ -121,6 +117,8 @@ module IBMWatson
121
117
  # @param limit_text_characters [Fixnum] Sets the maximum number of characters that are processed by the service.
122
118
  # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
123
119
  def analyze(features:, text: nil, html: nil, url: nil, clean: nil, xpath: nil, fallback_to_raw: nil, return_analyzed_text: nil, language: nil, limit_text_characters: nil)
120
+ raise ArgumentError.new("version must be provided") if version.nil?
121
+
124
122
  raise ArgumentError.new("features must be provided") if features.nil?
125
123
 
126
124
  headers = {
@@ -169,6 +167,8 @@ module IBMWatson
169
167
  # that are deployed to your Natural Language Understanding service.
170
168
  # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
171
169
  def list_models
170
+ raise ArgumentError.new("version must be provided") if version.nil?
171
+
172
172
  headers = {
173
173
  }
174
174
  sdk_headers = Common.new.get_sdk_headers("natural-language-understanding", "V1", "list_models")
@@ -197,6 +197,8 @@ module IBMWatson
197
197
  # @param model_id [String] Model ID of the model to delete.
198
198
  # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
199
199
  def delete_model(model_id:)
200
+ raise ArgumentError.new("version must be provided") if version.nil?
201
+
200
202
  raise ArgumentError.new("model_id must be provided") if model_id.nil?
201
203
 
202
204
  headers = {
@@ -13,7 +13,9 @@
13
13
  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
14
  # See the License for the specific language governing permissions and
15
15
  # limitations under the License.
16
-
16
+ #
17
+ # IBM OpenAPI SDK Code Generator Version: 3.17.0-8d569e8f-20201030-142059
18
+ #
17
19
  # The IBM Watson™ Personality Insights service enables applications to derive
18
20
  # insights from social media, enterprise data, or other digital communications. The
19
21
  # service uses linguistic analytics to infer individuals' intrinsic personality
@@ -49,33 +51,31 @@ module IBMWatson
49
51
  include Concurrent::Async
50
52
  DEFAULT_SERVICE_NAME = "personality_insights"
51
53
  DEFAULT_SERVICE_URL = "https://api.us-south.personality-insights.watson.cloud.ibm.com"
54
+ attr_accessor :version
52
55
  ##
53
56
  # @!method initialize(args)
54
57
  # Construct a new client for the Personality Insights service.
55
58
  #
56
59
  # @param args [Hash] The args to initialize with
57
- # @option args version [String] The API version date to use with the service, in
58
- # "YYYY-MM-DD" format. Whenever the API is changed in a backwards
59
- # incompatible way, a new minor version of the API is released.
60
- # The service uses the API version for the date you specify, or
61
- # the most recent version before that date. Note that you should
62
- # not programmatically specify the current date at runtime, in
63
- # case the API has been updated since your application's release.
64
- # Instead, specify a version date that is compatible with your
65
- # application, and don't change it until your application is
66
- # ready for a later version.
60
+ # @option args version [String] Release date of the version of the API you want to use. Specify dates in
61
+ # YYYY-MM-DD format. The current version is `2017-10-13`.
67
62
  # @option args service_url [String] The base service URL to use when contacting the service.
68
63
  # The base service_url may differ between IBM Cloud regions.
69
64
  # @option args authenticator [Object] The Authenticator instance to be configured for this service.
70
65
  # @option args service_name [String] The name of the service to configure. Will be used as the key to load
71
66
  # any external configuration, if applicable.
67
+ #
68
+ # @deprecated On 1 December 2021, Personality Insights will no longer be available.
69
+ # Consider migrating to Watson Natural Language Understanding.
70
+ # For more information, see [Personality Insights Deprecation](https://github.com/watson-developer-cloud/ruby-sdk/tree/master#personality-insights-deprecation).
72
71
  def initialize(args = {})
72
+ warn "On 1 December 2021, Personality Insights will no longer be available. For more information, see the README."
73
73
  @__async_initialized__ = false
74
74
  defaults = {}
75
- defaults[:version] = nil
76
75
  defaults[:service_url] = DEFAULT_SERVICE_URL
77
76
  defaults[:service_name] = DEFAULT_SERVICE_NAME
78
77
  defaults[:authenticator] = nil
78
+ defaults[:version] = nil
79
79
  user_service_url = args[:service_url] unless args[:service_url].nil?
80
80
  args = defaults.merge(args)
81
81
  @version = args[:version]
@@ -170,6 +170,8 @@ module IBMWatson
170
170
  # default, no consumption preferences are returned.
171
171
  # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
172
172
  def profile(content:, accept:, content_type: nil, content_language: nil, accept_language: nil, raw_scores: nil, csv_headers: nil, consumption_preferences: nil)
173
+ raise ArgumentError.new("version must be provided") if version.nil?
174
+
173
175
  raise ArgumentError.new("content must be provided") if content.nil?
174
176
 
175
177
  raise ArgumentError.new("accept must be provided") if accept.nil?
@@ -13,7 +13,9 @@
13
13
  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
14
  # See the License for the specific language governing permissions and
15
15
  # limitations under the License.
16
-
16
+ #
17
+ # IBM OpenAPI SDK Code Generator Version: 3.17.0-8d569e8f-20201030-142059
18
+ #
17
19
  # The IBM Watson™ Speech to Text service provides APIs that use IBM's
18
20
  # speech-recognition capabilities to produce transcripts of spoken audio. The service can
19
21
  # transcribe speech from various languages and audio formats. In addition to basic
@@ -230,7 +232,7 @@ module IBMWatson
230
232
  #
231
233
  # **See also:** [Making a multipart HTTP
232
234
  # request](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-http#HTTP-multi).
233
- # @param audio [String] The audio to transcribe.
235
+ # @param audio [File] The audio to transcribe.
234
236
  # @param content_type [String] The format (MIME type) of the audio. For more information about specifying an
235
237
  # audio format, see **Audio formats (content types)** in the method description.
236
238
  # @param model [String] The identifier of the model that is to be used for the recognition request. See
@@ -883,7 +885,7 @@ module IBMWatson
883
885
  #
884
886
  # **See also:** [Audio
885
887
  # formats](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-audio-formats#audio-formats).
886
- # @param audio [String] The audio to transcribe.
888
+ # @param audio [File] The audio to transcribe.
887
889
  # @param content_type [String] The format (MIME type) of the audio. For more information about specifying an
888
890
  # audio format, see **Audio formats (content types)** in the method description.
889
891
  # @param model [String] The identifier of the model that is to be used for the recognition request. See
@@ -1391,9 +1393,11 @@ module IBMWatson
1391
1393
  # models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageLanguageModels#listModels-language).
1392
1394
  # @param language [String] The identifier of the language for which custom language or custom acoustic models
1393
1395
  # are to be returned. Omit the parameter to see all custom language or custom
1394
- # acoustic models that are owned by the requesting credentials. **Note:** The
1395
- # `ar-AR` (Modern Standard Arabic) and `zh-CN` (Mandarin Chinese) languages are not
1396
- # available for language model customization.
1396
+ # acoustic models that are owned by the requesting credentials.
1397
+ #
1398
+ # To determine the languages for which customization is available, see [Language
1399
+ # support for
1400
+ # customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-customization#languageSupport).
1397
1401
  # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
1398
1402
  def list_language_models(language: nil)
1399
1403
  headers = {
@@ -2513,9 +2517,11 @@ module IBMWatson
2513
2517
  # models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAcousticModels#listModels-acoustic).
2514
2518
  # @param language [String] The identifier of the language for which custom language or custom acoustic models
2515
2519
  # are to be returned. Omit the parameter to see all custom language or custom
2516
- # acoustic models that are owned by the requesting credentials. **Note:** The
2517
- # `ar-AR` (Modern Standard Arabic) and `zh-CN` (Mandarin Chinese) languages are not
2518
- # available for language model customization.
2520
+ # acoustic models that are owned by the requesting credentials.
2521
+ #
2522
+ # To determine the languages for which customization is available, see [Language
2523
+ # support for
2524
+ # customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-customization#languageSupport).
2519
2525
  # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
2520
2526
  def list_acoustic_models(language: nil)
2521
2527
  headers = {
@@ -2613,14 +2619,14 @@ module IBMWatson
2613
2619
  # it. You must use credentials for the instance of the service that owns a model to
2614
2620
  # train it.
2615
2621
  #
2616
- # The training method is asynchronous. It can take on the order of minutes or hours
2617
- # to complete depending on the total amount of audio data on which the custom
2618
- # acoustic model is being trained and the current load on the service. Typically,
2619
- # training a custom acoustic model takes approximately two to four times the length
2620
- # of its audio data. The actual time depends on the model being trained and the
2621
- # nature of the audio, such as whether the audio is clean or noisy. The method
2622
- # returns an HTTP 200 response code to indicate that the training process has begun.
2623
- #
2622
+ # The training method is asynchronous. Training time depends on the cumulative
2623
+ # amount of audio data that the custom acoustic model contains and the current load
2624
+ # on the service. When you train or retrain a model, the service uses all of the
2625
+ # model's audio data in the training. Training a custom acoustic model takes
2626
+ # approximately as long as the length of its cumulative audio data. For example, it
2627
+ # takes approximately 2 hours to train a model that contains a total of 2 hours of
2628
+ # audio. The method returns an HTTP 200 response code to indicate that the training
2629
+ # process has begun.
2624
2630
  #
2625
2631
  # You can monitor the status of the training by using the **Get a custom acoustic
2626
2632
  # model** method to poll the model's status. Use a loop to check the status once a
@@ -2964,7 +2970,7 @@ module IBMWatson
2964
2970
  # used, their use is strongly discouraged.)
2965
2971
  # * Do not use the name of an audio resource that has already been added to the
2966
2972
  # custom model.
2967
- # @param audio_resource [String] The audio resource that is to be added to the custom acoustic model, an individual
2973
+ # @param audio_resource [File] The audio resource that is to be added to the custom acoustic model, an individual
2968
2974
  # audio file or an archive file.
2969
2975
  #
2970
2976
  # With the `curl` command, use the `--data-binary` option to upload the file for the
@@ -13,7 +13,9 @@
13
13
  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
14
  # See the License for the specific language governing permissions and
15
15
  # limitations under the License.
16
-
16
+ #
17
+ # IBM OpenAPI SDK Code Generator Version: 3.17.0-8d569e8f-20201030-142059
18
+ #
17
19
  # The IBM Watson™ Text to Speech service provides APIs that use IBM's
18
20
  # speech-synthesis capabilities to synthesize text into natural-sounding speech in a
19
21
  # variety of languages, dialects, and voices. The service supports at least one male or
@@ -109,14 +111,14 @@ module IBMWatson
109
111
  # Get a voice.
110
112
  # Gets information about the specified voice. The information includes the name,
111
113
  # language, gender, and other details about the voice. Specify a customization ID to
112
- # obtain information for a custom voice model that is defined for the language of
113
- # the specified voice. To list information about all available voices, use the
114
- # **List voices** method.
114
+ # obtain information for a custom model that is defined for the language of the
115
+ # specified voice. To list information about all available voices, use the **List
116
+ # voices** method.
115
117
  #
116
118
  # **See also:** [Listing a specific
117
119
  # voice](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices#listVoice).
118
120
  # @param voice [String] The voice for which information is to be returned.
119
- # @param customization_id [String] The customization ID (GUID) of a custom voice model for which information is to be
121
+ # @param customization_id [String] The customization ID (GUID) of a custom model for which information is to be
120
122
  # returned. You must make the request with credentials for the instance of the
121
123
  # service that owns the custom model. Omit the parameter to see information about
122
124
  # the specified voice with no customization.
@@ -225,8 +227,8 @@ module IBMWatson
225
227
  # specifying an audio format, see **Audio formats (accept types)** in the method
226
228
  # description.
227
229
  # @param voice [String] The voice to use for synthesis.
228
- # @param customization_id [String] The customization ID (GUID) of a custom voice model to use for the synthesis. If a
229
- # custom voice model is specified, it works only if it matches the language of the
230
+ # @param customization_id [String] The customization ID (GUID) of a custom model to use for the synthesis. If a
231
+ # custom model is specified, it works only if it matches the language of the
230
232
  # indicated voice. You must make the request with credentials for the instance of
231
233
  # the service that owns the custom model. Omit the parameter to use the specified
232
234
  # voice with no customization.
@@ -271,9 +273,7 @@ module IBMWatson
271
273
  # Gets the phonetic pronunciation for the specified word. You can request the
272
274
  # pronunciation for a specific format. You can also request the pronunciation for a
273
275
  # specific voice to see the default translation for the language of that voice or
274
- # for a specific custom voice model to see the translation for that voice model.
275
- #
276
- # **Note:** This method is currently a beta release.
276
+ # for a specific custom model to see the translation for that model.
277
277
  #
278
278
  # **See also:** [Querying a word from a
279
279
  # language](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWords#cuWordsQueryLanguage).
@@ -284,13 +284,13 @@ module IBMWatson
284
284
  # @param format [String] The phoneme format in which to return the pronunciation. The Arabic, Chinese,
285
285
  # Dutch, and Korean languages support only IPA. Omit the parameter to obtain the
286
286
  # pronunciation in the default format.
287
- # @param customization_id [String] The customization ID (GUID) of a custom voice model for which the pronunciation is
288
- # to be returned. The language of a specified custom model must match the language
289
- # of the specified voice. If the word is not defined in the specified custom model,
290
- # the service returns the default translation for the custom model's language. You
291
- # must make the request with credentials for the instance of the service that owns
292
- # the custom model. Omit the parameter to see the translation for the specified
293
- # voice with no customization.
287
+ # @param customization_id [String] The customization ID (GUID) of a custom model for which the pronunciation is to be
288
+ # returned. The language of a specified custom model must match the language of the
289
+ # specified voice. If the word is not defined in the specified custom model, the
290
+ # service returns the default translation for the custom model's language. You must
291
+ # make the request with credentials for the instance of the service that owns the
292
+ # custom model. Omit the parameter to see the translation for the specified voice
293
+ # with no customization.
294
294
  # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
295
295
  def get_pronunciation(text:, voice: nil, format: nil, customization_id: nil)
296
296
  raise ArgumentError.new("text must be provided") if text.nil?
@@ -323,31 +323,28 @@ module IBMWatson
323
323
  #########################
324
324
 
325
325
  ##
326
- # @!method create_voice_model(name:, language: nil, description: nil)
326
+ # @!method create_custom_model(name:, language: nil, description: nil)
327
327
  # Create a custom model.
328
- # Creates a new empty custom voice model. You must specify a name for the new custom
328
+ # Creates a new empty custom model. You must specify a name for the new custom
329
329
  # model. You can optionally specify the language and a description for the new
330
330
  # model. The model is owned by the instance of the service whose credentials are
331
331
  # used to create it.
332
332
  #
333
- # **Note:** This method is currently a beta release.
334
- #
335
333
  # **See also:** [Creating a custom
336
334
  # model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customModels#cuModelsCreate).
337
- # @param name [String] The name of the new custom voice model.
338
- # @param language [String] The language of the new custom voice model. You create a custom voice model for a
339
- # specific language, not for a specific voice. A custom model can be used with any
340
- # voice, standard or neural, for its specified language. Omit the parameter to use
341
- # the the default language, `en-US`.
342
- # @param description [String] A description of the new custom voice model. Specifying a description is
343
- # recommended.
335
+ # @param name [String] The name of the new custom model.
336
+ # @param language [String] The language of the new custom model. You create a custom model for a specific
337
+ # language, not for a specific voice. A custom model can be used with any voice,
338
+ # standard or neural, for its specified language. Omit the parameter to use the the
339
+ # default language, `en-US`.
340
+ # @param description [String] A description of the new custom model. Specifying a description is recommended.
344
341
  # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
345
- def create_voice_model(name:, language: nil, description: nil)
342
+ def create_custom_model(name:, language: nil, description: nil)
346
343
  raise ArgumentError.new("name must be provided") if name.nil?
347
344
 
348
345
  headers = {
349
346
  }
350
- sdk_headers = Common.new.get_sdk_headers("text_to_speech", "V1", "create_voice_model")
347
+ sdk_headers = Common.new.get_sdk_headers("text_to_speech", "V1", "create_custom_model")
351
348
  headers.merge!(sdk_headers)
352
349
 
353
350
  data = {
@@ -369,27 +366,25 @@ module IBMWatson
369
366
  end
370
367
 
371
368
  ##
372
- # @!method list_voice_models(language: nil)
369
+ # @!method list_custom_models(language: nil)
373
370
  # List custom models.
374
- # Lists metadata such as the name and description for all custom voice models that
375
- # are owned by an instance of the service. Specify a language to list the voice
376
- # models for that language only. To see the words in addition to the metadata for a
377
- # specific voice model, use the **List a custom model** method. You must use
371
+ # Lists metadata such as the name and description for all custom models that are
372
+ # owned by an instance of the service. Specify a language to list the custom models
373
+ # for that language only. To see the words in addition to the metadata for a
374
+ # specific custom model, use the **List a custom model** method. You must use
378
375
  # credentials for the instance of the service that owns a model to list information
379
376
  # about it.
380
377
  #
381
- # **Note:** This method is currently a beta release.
382
- #
383
378
  # **See also:** [Querying all custom
384
379
  # models](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customModels#cuModelsQueryAll).
385
- # @param language [String] The language for which custom voice models that are owned by the requesting
386
- # credentials are to be returned. Omit the parameter to see all custom voice models
387
- # that are owned by the requester.
380
+ # @param language [String] The language for which custom models that are owned by the requesting credentials
381
+ # are to be returned. Omit the parameter to see all custom models that are owned by
382
+ # the requester.
388
383
  # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
389
- def list_voice_models(language: nil)
384
+ def list_custom_models(language: nil)
390
385
  headers = {
391
386
  }
392
- sdk_headers = Common.new.get_sdk_headers("text_to_speech", "V1", "list_voice_models")
387
+ sdk_headers = Common.new.get_sdk_headers("text_to_speech", "V1", "list_custom_models")
393
388
  headers.merge!(sdk_headers)
394
389
 
395
390
  params = {
@@ -409,14 +404,14 @@ module IBMWatson
409
404
  end
410
405
 
411
406
  ##
412
- # @!method update_voice_model(customization_id:, name: nil, description: nil, words: nil)
407
+ # @!method update_custom_model(customization_id:, name: nil, description: nil, words: nil)
413
408
  # Update a custom model.
414
- # Updates information for the specified custom voice model. You can update metadata
415
- # such as the name and description of the voice model. You can also update the words
416
- # in the model and their translations. Adding a new translation for a word that
417
- # already exists in a custom model overwrites the word's existing translation. A
418
- # custom model can contain no more than 20,000 entries. You must use credentials for
419
- # the instance of the service that owns a model to update it.
409
+ # Updates information for the specified custom model. You can update metadata such
410
+ # as the name and description of the model. You can also update the words in the
411
+ # model and their translations. Adding a new translation for a word that already
412
+ # exists in a custom model overwrites the word's existing translation. A custom
413
+ # model can contain no more than 20,000 entries. You must use credentials for the
414
+ # instance of the service that owns a model to update it.
420
415
  #
421
416
  # You can define sounds-like or phonetic translations for words. A sounds-like
422
417
  # translation consists of one or more words that, when combined, sound like the
@@ -432,8 +427,6 @@ module IBMWatson
432
427
  # <code>&lt;phoneme alphabet="ibm"
433
428
  # ph="1gAstroEntxrYFXs"&gt;&lt;/phoneme&gt;</code>
434
429
  #
435
- # **Note:** This method is currently a beta release.
436
- #
437
430
  # **See also:**
438
431
  # * [Updating a custom
439
432
  # model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customModels#cuModelsUpdate)
@@ -441,20 +434,20 @@ module IBMWatson
441
434
  # model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWords#cuJapaneseAdd)
442
435
  # * [Understanding
443
436
  # customization](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customIntro#customIntro).
444
- # @param customization_id [String] The customization ID (GUID) of the custom voice model. You must make the request
445
- # with credentials for the instance of the service that owns the custom model.
446
- # @param name [String] A new name for the custom voice model.
447
- # @param description [String] A new description for the custom voice model.
437
+ # @param customization_id [String] The customization ID (GUID) of the custom model. You must make the request with
438
+ # credentials for the instance of the service that owns the custom model.
439
+ # @param name [String] A new name for the custom model.
440
+ # @param description [String] A new description for the custom model.
448
441
  # @param words [Array[Word]] An array of `Word` objects that provides the words and their translations that are
449
- # to be added or updated for the custom voice model. Pass an empty array to make no
442
+ # to be added or updated for the custom model. Pass an empty array to make no
450
443
  # additions or updates.
451
444
  # @return [nil]
452
- def update_voice_model(customization_id:, name: nil, description: nil, words: nil)
445
+ def update_custom_model(customization_id:, name: nil, description: nil, words: nil)
453
446
  raise ArgumentError.new("customization_id must be provided") if customization_id.nil?
454
447
 
455
448
  headers = {
456
449
  }
457
- sdk_headers = Common.new.get_sdk_headers("text_to_speech", "V1", "update_voice_model")
450
+ sdk_headers = Common.new.get_sdk_headers("text_to_speech", "V1", "update_custom_model")
458
451
  headers.merge!(sdk_headers)
459
452
 
460
453
  data = {
@@ -476,26 +469,24 @@ module IBMWatson
476
469
  end
477
470
 
478
471
  ##
479
- # @!method get_voice_model(customization_id:)
472
+ # @!method get_custom_model(customization_id:)
480
473
  # Get a custom model.
481
- # Gets all information about a specified custom voice model. In addition to metadata
482
- # such as the name and description of the voice model, the output includes the words
483
- # and their translations as defined in the model. To see just the metadata for a
484
- # voice model, use the **List custom models** method.
485
- #
486
- # **Note:** This method is currently a beta release.
474
+ # Gets all information about a specified custom model. In addition to metadata such
475
+ # as the name and description of the custom model, the output includes the words and
476
+ # their translations as defined in the model. To see just the metadata for a model,
477
+ # use the **List custom models** method.
487
478
  #
488
479
  # **See also:** [Querying a custom
489
480
  # model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customModels#cuModelsQuery).
490
- # @param customization_id [String] The customization ID (GUID) of the custom voice model. You must make the request
491
- # with credentials for the instance of the service that owns the custom model.
481
+ # @param customization_id [String] The customization ID (GUID) of the custom model. You must make the request with
482
+ # credentials for the instance of the service that owns the custom model.
492
483
  # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
493
- def get_voice_model(customization_id:)
484
+ def get_custom_model(customization_id:)
494
485
  raise ArgumentError.new("customization_id must be provided") if customization_id.nil?
495
486
 
496
487
  headers = {
497
488
  }
498
- sdk_headers = Common.new.get_sdk_headers("text_to_speech", "V1", "get_voice_model")
489
+ sdk_headers = Common.new.get_sdk_headers("text_to_speech", "V1", "get_custom_model")
499
490
  headers.merge!(sdk_headers)
500
491
 
501
492
  method_url = "/v1/customizations/%s" % [ERB::Util.url_encode(customization_id)]
@@ -510,24 +501,22 @@ module IBMWatson
510
501
  end
511
502
 
512
503
  ##
513
- # @!method delete_voice_model(customization_id:)
504
+ # @!method delete_custom_model(customization_id:)
514
505
  # Delete a custom model.
515
- # Deletes the specified custom voice model. You must use credentials for the
516
- # instance of the service that owns a model to delete it.
517
- #
518
- # **Note:** This method is currently a beta release.
506
+ # Deletes the specified custom model. You must use credentials for the instance of
507
+ # the service that owns a model to delete it.
519
508
  #
520
509
  # **See also:** [Deleting a custom
521
510
  # model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customModels#cuModelsDelete).
522
- # @param customization_id [String] The customization ID (GUID) of the custom voice model. You must make the request
523
- # with credentials for the instance of the service that owns the custom model.
511
+ # @param customization_id [String] The customization ID (GUID) of the custom model. You must make the request with
512
+ # credentials for the instance of the service that owns the custom model.
524
513
  # @return [nil]
525
- def delete_voice_model(customization_id:)
514
+ def delete_custom_model(customization_id:)
526
515
  raise ArgumentError.new("customization_id must be provided") if customization_id.nil?
527
516
 
528
517
  headers = {
529
518
  }
530
- sdk_headers = Common.new.get_sdk_headers("text_to_speech", "V1", "delete_voice_model")
519
+ sdk_headers = Common.new.get_sdk_headers("text_to_speech", "V1", "delete_custom_model")
531
520
  headers.merge!(sdk_headers)
532
521
 
533
522
  method_url = "/v1/customizations/%s" % [ERB::Util.url_encode(customization_id)]
@@ -547,7 +536,7 @@ module IBMWatson
547
536
  ##
548
537
  # @!method add_words(customization_id:, words:)
549
538
  # Add custom words.
550
- # Adds one or more words and their translations to the specified custom voice model.
539
+ # Adds one or more words and their translations to the specified custom model.
551
540
  # Adding a new translation for a word that already exists in a custom model
552
541
  # overwrites the word's existing translation. A custom model can contain no more
553
542
  # than 20,000 entries. You must use credentials for the instance of the service that
@@ -567,8 +556,6 @@ module IBMWatson
567
556
  # <code>&lt;phoneme alphabet="ibm"
568
557
  # ph="1gAstroEntxrYFXs"&gt;&lt;/phoneme&gt;</code>
569
558
  #
570
- # **Note:** This method is currently a beta release.
571
- #
572
559
  # **See also:**
573
560
  # * [Adding multiple words to a custom
574
561
  # model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWords#cuWordsAdd)
@@ -576,15 +563,15 @@ module IBMWatson
576
563
  # model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWords#cuJapaneseAdd)
577
564
  # * [Understanding
578
565
  # customization](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customIntro#customIntro).
579
- # @param customization_id [String] The customization ID (GUID) of the custom voice model. You must make the request
580
- # with credentials for the instance of the service that owns the custom model.
566
+ # @param customization_id [String] The customization ID (GUID) of the custom model. You must make the request with
567
+ # credentials for the instance of the service that owns the custom model.
581
568
  # @param words [Array[Word]] The **Add custom words** method accepts an array of `Word` objects. Each object
582
- # provides a word that is to be added or updated for the custom voice model and the
583
- # word's translation.
569
+ # provides a word that is to be added or updated for the custom model and the word's
570
+ # translation.
584
571
  #
585
572
  # The **List custom words** method returns an array of `Word` objects. Each object
586
- # shows a word and its translation from the custom voice model. The words are listed
587
- # in alphabetical order, with uppercase letters listed before lowercase letters. The
573
+ # shows a word and its translation from the custom model. The words are listed in
574
+ # alphabetical order, with uppercase letters listed before lowercase letters. The
588
575
  # array is empty if the custom model contains no words.
589
576
  # @return [nil]
590
577
  def add_words(customization_id:, words:)
@@ -616,17 +603,14 @@ module IBMWatson
616
603
  ##
617
604
  # @!method list_words(customization_id:)
618
605
  # List custom words.
619
- # Lists all of the words and their translations for the specified custom voice
620
- # model. The output shows the translations as they are defined in the model. You
621
- # must use credentials for the instance of the service that owns a model to list its
622
- # words.
623
- #
624
- # **Note:** This method is currently a beta release.
606
+ # Lists all of the words and their translations for the specified custom model. The
607
+ # output shows the translations as they are defined in the model. You must use
608
+ # credentials for the instance of the service that owns a model to list its words.
625
609
  #
626
610
  # **See also:** [Querying all words from a custom
627
611
  # model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWords#cuWordsQueryModel).
628
- # @param customization_id [String] The customization ID (GUID) of the custom voice model. You must make the request
629
- # with credentials for the instance of the service that owns the custom model.
612
+ # @param customization_id [String] The customization ID (GUID) of the custom model. You must make the request with
613
+ # credentials for the instance of the service that owns the custom model.
630
614
  # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
631
615
  def list_words(customization_id:)
632
616
  raise ArgumentError.new("customization_id must be provided") if customization_id.nil?
@@ -650,11 +634,11 @@ module IBMWatson
650
634
  ##
651
635
  # @!method add_word(customization_id:, word:, translation:, part_of_speech: nil)
652
636
  # Add a custom word.
653
- # Adds a single word and its translation to the specified custom voice model. Adding
654
- # a new translation for a word that already exists in a custom model overwrites the
655
- # word's existing translation. A custom model can contain no more than 20,000
656
- # entries. You must use credentials for the instance of the service that owns a
657
- # model to add a word to it.
637
+ # Adds a single word and its translation to the specified custom model. Adding a new
638
+ # translation for a word that already exists in a custom model overwrites the word's
639
+ # existing translation. A custom model can contain no more than 20,000 entries. You
640
+ # must use credentials for the instance of the service that owns a model to add a
641
+ # word to it.
658
642
  #
659
643
  # You can define sounds-like or phonetic translations for words. A sounds-like
660
644
  # translation consists of one or more words that, when combined, sound like the
@@ -670,8 +654,6 @@ module IBMWatson
670
654
  # <code>&lt;phoneme alphabet="ibm"
671
655
  # ph="1gAstroEntxrYFXs"&gt;&lt;/phoneme&gt;</code>
672
656
  #
673
- # **Note:** This method is currently a beta release.
674
- #
675
657
  # **See also:**
676
658
  # * [Adding a single word to a custom
677
659
  # model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWords#cuWordAdd)
@@ -679,9 +661,9 @@ module IBMWatson
679
661
  # model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWords#cuJapaneseAdd)
680
662
  # * [Understanding
681
663
  # customization](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customIntro#customIntro).
682
- # @param customization_id [String] The customization ID (GUID) of the custom voice model. You must make the request
683
- # with credentials for the instance of the service that owns the custom model.
684
- # @param word [String] The word that is to be added or updated for the custom voice model.
664
+ # @param customization_id [String] The customization ID (GUID) of the custom model. You must make the request with
665
+ # credentials for the instance of the service that owns the custom model.
666
+ # @param word [String] The word that is to be added or updated for the custom model.
685
667
  # @param translation [String] The phonetic or sounds-like translation for the word. A phonetic translation is
686
668
  # based on the SSML format for representing the phonetic string of a word either as
687
669
  # an IPA translation or as an IBM SPR translation. The Arabic, Chinese, Dutch, and
@@ -730,13 +712,11 @@ module IBMWatson
730
712
  # shows the translation as it is defined in the model. You must use credentials for
731
713
  # the instance of the service that owns a model to list its words.
732
714
  #
733
- # **Note:** This method is currently a beta release.
734
- #
735
715
  # **See also:** [Querying a single word from a custom
736
716
  # model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWords#cuWordQueryModel).
737
- # @param customization_id [String] The customization ID (GUID) of the custom voice model. You must make the request
738
- # with credentials for the instance of the service that owns the custom model.
739
- # @param word [String] The word that is to be queried from the custom voice model.
717
+ # @param customization_id [String] The customization ID (GUID) of the custom model. You must make the request with
718
+ # credentials for the instance of the service that owns the custom model.
719
+ # @param word [String] The word that is to be queried from the custom model.
740
720
  # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
741
721
  def get_word(customization_id:, word:)
742
722
  raise ArgumentError.new("customization_id must be provided") if customization_id.nil?
@@ -762,17 +742,14 @@ module IBMWatson
762
742
  ##
763
743
  # @!method delete_word(customization_id:, word:)
764
744
  # Delete a custom word.
765
- # Deletes a single word from the specified custom voice model. You must use
766
- # credentials for the instance of the service that owns a model to delete its words.
767
- #
768
- #
769
- # **Note:** This method is currently a beta release.
745
+ # Deletes a single word from the specified custom model. You must use credentials
746
+ # for the instance of the service that owns a model to delete its words.
770
747
  #
771
748
  # **See also:** [Deleting a word from a custom
772
749
  # model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWords#cuWordDelete).
773
- # @param customization_id [String] The customization ID (GUID) of the custom voice model. You must make the request
774
- # with credentials for the instance of the service that owns the custom model.
775
- # @param word [String] The word that is to be deleted from the custom voice model.
750
+ # @param customization_id [String] The customization ID (GUID) of the custom model. You must make the request with
751
+ # credentials for the instance of the service that owns the custom model.
752
+ # @param word [String] The word that is to be deleted from the custom model.
776
753
  # @return [nil]
777
754
  def delete_word(customization_id:, word:)
778
755
  raise ArgumentError.new("customization_id must be provided") if customization_id.nil?
@@ -811,7 +788,7 @@ module IBMWatson
811
788
  #
812
789
  # **Note:** If you delete an instance of the service from the service console, all
813
790
  # data associated with that service instance is automatically deleted. This includes
814
- # all custom voice models and word/translation pairs, and all data related to speech
791
+ # all custom models and word/translation pairs, and all data related to speech
815
792
  # synthesis requests.
816
793
  #
817
794
  # **See also:** [Information