ibm_watson 1.2.0 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # (C) Copyright IBM Corp. 2020.
3
+ # (C) Copyright IBM Corp. 2018, 2020.
4
4
  #
5
5
  # Licensed under the Apache License, Version 2.0 (the "License");
6
6
  # you may not use this file except in compliance with the License.
@@ -77,11 +77,11 @@ module IBMWatson
77
77
  # responses. It also maintains the state of the conversation. A session persists
78
78
  # until it is deleted, or until it times out because of inactivity. (For more
79
79
  # information, see the
80
- # [documentation](https://cloud.ibm.com/docs/services/assistant?topic=assistant-assistant-settings).
80
+ # [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-assistant-settings).
81
81
  # @param assistant_id [String] Unique identifier of the assistant. To find the assistant ID in the Watson
82
82
  # Assistant user interface, open the assistant settings and click **API Details**.
83
83
  # For information about creating assistants, see the
84
- # [documentation](https://cloud.ibm.com/docs/services/assistant?topic=assistant-assistant-add#assistant-add-task).
84
+ # [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-assistant-add#assistant-add-task).
85
85
  #
86
86
  # **Note:** Currently, the v2 API does not support creating assistants.
87
87
  # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
@@ -114,11 +114,11 @@ module IBMWatson
114
114
  # Delete session.
115
115
  # Deletes a session explicitly before it times out. (For more information about the
116
116
  # session inactivity timeout, see the
117
- # [documentation](https://cloud.ibm.com/docs/services/assistant?topic=assistant-assistant-settings)).
117
+ # [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-assistant-settings)).
118
118
  # @param assistant_id [String] Unique identifier of the assistant. To find the assistant ID in the Watson
119
119
  # Assistant user interface, open the assistant settings and click **API Details**.
120
120
  # For information about creating assistants, see the
121
- # [documentation](https://cloud.ibm.com/docs/services/assistant?topic=assistant-assistant-add#assistant-add-task).
121
+ # [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-assistant-add#assistant-add-task).
122
122
  #
123
123
  # **Note:** Currently, the v2 API does not support creating assistants.
124
124
  # @param session_id [String] Unique identifier of the session.
@@ -161,7 +161,7 @@ module IBMWatson
161
161
  # @param assistant_id [String] Unique identifier of the assistant. To find the assistant ID in the Watson
162
162
  # Assistant user interface, open the assistant settings and click **API Details**.
163
163
  # For information about creating assistants, see the
164
- # [documentation](https://cloud.ibm.com/docs/services/assistant?topic=assistant-assistant-add#assistant-add-task).
164
+ # [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-assistant-add#assistant-add-task).
165
165
  #
166
166
  # **Note:** Currently, the v2 API does not support creating assistants.
167
167
  # @param session_id [String] Unique identifier of the session.
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # (C) Copyright IBM Corp. 2020.
3
+ # (C) Copyright IBM Corp. 2018, 2020.
4
4
  #
5
5
  # Licensed under the Apache License, Version 2.0 (the "License");
6
6
  # you may not use this file except in compliance with the License.
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # (C) Copyright IBM Corp. 2020.
3
+ # (C) Copyright IBM Corp. 2018, 2020.
4
4
  #
5
5
  # Licensed under the Apache License, Version 2.0 (the "License");
6
6
  # you may not use this file except in compliance with the License.
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # (C) Copyright IBM Corp. 2020.
3
+ # (C) Copyright IBM Corp. 2019, 2020.
4
4
  #
5
5
  # Licensed under the Apache License, Version 2.0 (the "License");
6
6
  # you may not use this file except in compliance with the License.
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # (C) Copyright IBM Corp. 2020.
3
+ # (C) Copyright IBM Corp. 2018, 2020.
4
4
  #
5
5
  # Licensed under the Apache License, Version 2.0 (the "License");
6
6
  # you may not use this file except in compliance with the License.
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # (C) Copyright IBM Corp. 2020.
3
+ # (C) Copyright IBM Corp. 2018, 2020.
4
4
  #
5
5
  # Licensed under the Apache License, Version 2.0 (the "License");
6
6
  # you may not use this file except in compliance with the License.
@@ -141,7 +141,7 @@ module IBMWatson
141
141
  # (`pt`), and Spanish (`es`).
142
142
  # @param training_data [File] Training data in CSV format. Each text value must have at least one class. The
143
143
  # data can include up to 3,000 classes and 20,000 records. For details, see [Data
144
- # preparation](https://cloud.ibm.com/docs/services/natural-language-classifier?topic=natural-language-classifier-using-your-data).
144
+ # preparation](https://cloud.ibm.com/docs/natural-language-classifier?topic=natural-language-classifier-using-your-data).
145
145
  # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
146
146
  def create_classifier(training_metadata:, training_data:)
147
147
  raise ArgumentError.new("training_metadata must be provided") if training_metadata.nil?
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # (C) Copyright IBM Corp. 2020.
3
+ # (C) Copyright IBM Corp. 2018, 2020.
4
4
  #
5
5
  # Licensed under the Apache License, Version 2.0 (the "License");
6
6
  # you may not use this file except in compliance with the License.
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # (C) Copyright IBM Corp. 2020.
3
+ # (C) Copyright IBM Corp. 2018, 2020.
4
4
  #
5
5
  # Licensed under the Apache License, Version 2.0 (the "License");
6
6
  # you may not use this file except in compliance with the License.
@@ -26,9 +26,9 @@
26
26
  # is timestamped, can report temporal behavior.
27
27
  # * For information about the meaning of the models that the service uses to describe
28
28
  # personality characteristics, see [Personality
29
- # models](https://cloud.ibm.com/docs/services/personality-insights?topic=personality-insights-models#models).
29
+ # models](https://cloud.ibm.com/docs/personality-insights?topic=personality-insights-models#models).
30
30
  # * For information about the meaning of the consumption preferences, see [Consumption
31
- # preferences](https://cloud.ibm.com/docs/services/personality-insights?topic=personality-insights-preferences#preferences).
31
+ # preferences](https://cloud.ibm.com/docs/personality-insights?topic=personality-insights-preferences#preferences).
32
32
  #
33
33
  #
34
34
  # **Note:** Request logging is disabled for the Personality Insights service. Regardless
@@ -95,9 +95,9 @@ module IBMWatson
95
95
  #
96
96
  # **See also:**
97
97
  # * [Requesting a
98
- # profile](https://cloud.ibm.com/docs/services/personality-insights?topic=personality-insights-input#input)
98
+ # profile](https://cloud.ibm.com/docs/personality-insights?topic=personality-insights-input#input)
99
99
  # * [Providing sufficient
100
- # input](https://cloud.ibm.com/docs/services/personality-insights?topic=personality-insights-input#sufficient)
100
+ # input](https://cloud.ibm.com/docs/personality-insights?topic=personality-insights-input#sufficient)
101
101
  #
102
102
  #
103
103
  # ### Content types
@@ -115,7 +115,7 @@ module IBMWatson
115
115
  # `Content-Type: text/plain;charset=utf-8`.
116
116
  #
117
117
  # **See also:** [Specifying request and response
118
- # formats](https://cloud.ibm.com/docs/services/personality-insights?topic=personality-insights-input#formats)
118
+ # formats](https://cloud.ibm.com/docs/personality-insights?topic=personality-insights-input#formats)
119
119
  #
120
120
  #
121
121
  # ### Accept types
@@ -127,12 +127,12 @@ module IBMWatson
127
127
  #
128
128
  # **See also:**
129
129
  # * [Understanding a JSON
130
- # profile](https://cloud.ibm.com/docs/services/personality-insights?topic=personality-insights-output#output)
130
+ # profile](https://cloud.ibm.com/docs/personality-insights?topic=personality-insights-output#output)
131
131
  # * [Understanding a CSV
132
- # profile](https://cloud.ibm.com/docs/services/personality-insights?topic=personality-insights-outputCSV#outputCSV).
132
+ # profile](https://cloud.ibm.com/docs/personality-insights?topic=personality-insights-outputCSV#outputCSV).
133
133
  # @param content [Content] A maximum of 20 MB of content to analyze, though the service requires much less
134
134
  # text; for more information, see [Providing sufficient
135
- # input](https://cloud.ibm.com/docs/services/personality-insights?topic=personality-insights-input#sufficient).
135
+ # input](https://cloud.ibm.com/docs/personality-insights?topic=personality-insights-input#sufficient).
136
136
  # For JSON input, provide an object of type `Content`.
137
137
  # @param accept [String] The type of the response. For more information, see **Accept types** in the method
138
138
  # description.
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # (C) Copyright IBM Corp. 2020.
3
+ # (C) Copyright IBM Corp. 2018, 2020.
4
4
  #
5
5
  # Licensed under the Apache License, Version 2.0 (the "License");
6
6
  # you may not use this file except in compliance with the License.
@@ -81,7 +81,7 @@ module IBMWatson
81
81
  # among other things.
82
82
  #
83
83
  # **See also:** [Languages and
84
- # models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-models#models).
84
+ # models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models#models).
85
85
  # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
86
86
  def list_models
87
87
  headers = {
@@ -108,7 +108,7 @@ module IBMWatson
108
108
  # sampling rate in Hertz, among other things.
109
109
  #
110
110
  # **See also:** [Languages and
111
- # models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-models#models).
111
+ # models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models#models).
112
112
  # @param model_id [String] The identifier of the model in the form of its name from the output of the **Get a
113
113
  # model** method.
114
114
  # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
@@ -146,7 +146,7 @@ module IBMWatson
146
146
  # upload the file for the request.)
147
147
  #
148
148
  # **See also:** [Making a basic HTTP
149
- # request](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-http#HTTP-basic).
149
+ # request](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-http#HTTP-basic).
150
150
  #
151
151
  #
152
152
  # ### Streaming mode
@@ -161,9 +161,9 @@ module IBMWatson
161
161
  #
162
162
  # **See also:**
163
163
  # * [Audio
164
- # transmission](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-input#transmission)
164
+ # transmission](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#transmission)
165
165
  # *
166
- # [Timeouts](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-input#timeouts)
166
+ # [Timeouts](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#timeouts)
167
167
  #
168
168
  #
169
169
  # ### Audio formats (content types)
@@ -203,7 +203,7 @@ module IBMWatson
203
203
  # fails.
204
204
  #
205
205
  # **See also:** [Audio
206
- # formats](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-audio-formats#audio-formats).
206
+ # formats](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-audio-formats#audio-formats).
207
207
  #
208
208
  #
209
209
  # ### Multipart speech recognition
@@ -222,19 +222,19 @@ module IBMWatson
222
222
  # want to spot a very large number of keywords.
223
223
  #
224
224
  # **See also:** [Making a multipart HTTP
225
- # request](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-http#HTTP-multi).
225
+ # request](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-http#HTTP-multi).
226
226
  # @param audio [String] The audio to transcribe.
227
227
  # @param content_type [String] The format (MIME type) of the audio. For more information about specifying an
228
228
  # audio format, see **Audio formats (content types)** in the method description.
229
229
  # @param model [String] The identifier of the model that is to be used for the recognition request. See
230
230
  # [Languages and
231
- # models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-models#models).
231
+ # models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models#models).
232
232
  # @param language_customization_id [String] The customization ID (GUID) of a custom language model that is to be used with the
233
233
  # recognition request. The base model of the specified custom language model must
234
234
  # match the model specified with the `model` parameter. You must make the request
235
235
  # with credentials for the instance of the service that owns the custom model. By
236
236
  # default, no custom language model is used. See [Custom
237
- # models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-input#custom-input).
237
+ # models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#custom-input).
238
238
  #
239
239
  #
240
240
  # **Note:** Use this parameter instead of the deprecated `customization_id`
@@ -244,13 +244,13 @@ module IBMWatson
244
244
  # match the model specified with the `model` parameter. You must make the request
245
245
  # with credentials for the instance of the service that owns the custom model. By
246
246
  # default, no custom acoustic model is used. See [Custom
247
- # models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-input#custom-input).
247
+ # models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#custom-input).
248
248
  # @param base_model_version [String] The version of the specified base model that is to be used with the recognition
249
249
  # request. Multiple versions of a base model can exist when a model is updated for
250
250
  # internal improvements. The parameter is intended primarily for use with custom
251
251
  # models that have been upgraded for a new base model. The default value depends on
252
252
  # whether the parameter is used with or without a custom model. See [Base model
253
- # version](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-input#version).
253
+ # version](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#version).
254
254
  # @param customization_weight [Float] If you specify the customization ID (GUID) of a custom language model with the
255
255
  # recognition request, the customization weight tells the service how much weight to
256
256
  # give to words from the custom language model compared to those from the base model
@@ -268,45 +268,45 @@ module IBMWatson
268
268
  # phrases.
269
269
  #
270
270
  # See [Custom
271
- # models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-input#custom-input).
271
+ # models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#custom-input).
272
272
  # @param inactivity_timeout [Fixnum] The time in seconds after which, if only silence (no speech) is detected in
273
273
  # streaming audio, the connection is closed with a 400 error. The parameter is
274
274
  # useful for stopping audio submission from a live microphone when a user simply
275
275
  # walks away. Use `-1` for infinity. See [Inactivity
276
- # timeout](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-input#timeouts-inactivity).
276
+ # timeout](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#timeouts-inactivity).
277
277
  # @param keywords [Array[String]] An array of keyword strings to spot in the audio. Each keyword string can include
278
278
  # one or more string tokens. Keywords are spotted only in the final results, not in
279
279
  # interim hypotheses. If you specify any keywords, you must also specify a keywords
280
280
  # threshold. You can spot a maximum of 1000 keywords. Omit the parameter or specify
281
281
  # an empty array if you do not need to spot keywords. See [Keyword
282
- # spotting](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#keyword_spotting).
282
+ # spotting](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#keyword_spotting).
283
283
  # @param keywords_threshold [Float] A confidence value that is the lower bound for spotting a keyword. A word is
284
284
  # considered to match a keyword if its confidence is greater than or equal to the
285
285
  # threshold. Specify a probability between 0.0 and 1.0. If you specify a threshold,
286
286
  # you must also specify one or more keywords. The service performs no keyword
287
287
  # spotting if you omit either parameter. See [Keyword
288
- # spotting](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#keyword_spotting).
288
+ # spotting](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#keyword_spotting).
289
289
  # @param max_alternatives [Fixnum] The maximum number of alternative transcripts that the service is to return. By
290
290
  # default, the service returns a single transcript. If you specify a value of `0`,
291
291
  # the service uses the default value, `1`. See [Maximum
292
- # alternatives](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#max_alternatives).
292
+ # alternatives](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#max_alternatives).
293
293
  # @param word_alternatives_threshold [Float] A confidence value that is the lower bound for identifying a hypothesis as a
294
294
  # possible word alternative (also known as "Confusion Networks"). An alternative
295
295
  # word is considered if its confidence is greater than or equal to the threshold.
296
296
  # Specify a probability between 0.0 and 1.0. By default, the service computes no
297
297
  # alternative words. See [Word
298
- # alternatives](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#word_alternatives).
298
+ # alternatives](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#word_alternatives).
299
299
  # @param word_confidence [Boolean] If `true`, the service returns a confidence measure in the range of 0.0 to 1.0 for
300
300
  # each word. By default, the service returns no word confidence scores. See [Word
301
- # confidence](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#word_confidence).
301
+ # confidence](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#word_confidence).
302
302
  # @param timestamps [Boolean] If `true`, the service returns time alignment for each word. By default, no
303
303
  # timestamps are returned. See [Word
304
- # timestamps](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#word_timestamps).
304
+ # timestamps](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#word_timestamps).
305
305
  # @param profanity_filter [Boolean] If `true`, the service filters profanity from all output except for keyword
306
306
  # results by replacing inappropriate words with a series of asterisks. Set the
307
307
  # parameter to `false` to return results with no censoring. Applies to US English
308
308
  # transcription only. See [Profanity
309
- # filtering](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#profanity_filter).
309
+ # filtering](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#profanity_filter).
310
310
  # @param smart_formatting [Boolean] If `true`, the service converts dates, times, series of digits and numbers, phone
311
311
  # numbers, currency values, and internet addresses into more readable, conventional
312
312
  # representations in the final transcript of a recognition request. For US English,
@@ -316,7 +316,7 @@ module IBMWatson
316
316
  # **Note:** Applies to US English, Japanese, and Spanish transcription only.
317
317
  #
318
318
  # See [Smart
319
- # formatting](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#smart_formatting).
319
+ # formatting](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#smart_formatting).
320
320
  # @param speaker_labels [Boolean] If `true`, the response includes labels that identify which words were spoken by
321
321
  # which participants in a multi-person exchange. By default, the service returns no
322
322
  # speaker labels. Setting `speaker_labels` to `true` forces the `timestamps`
@@ -330,7 +330,7 @@ module IBMWatson
330
330
  # `true`.
331
331
  #
332
332
  # See [Speaker
333
- # labels](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#speaker_labels).
333
+ # labels](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#speaker_labels).
334
334
  # @param customization_id [String] **Deprecated.** Use the `language_customization_id` parameter to specify the
335
335
  # customization ID (GUID) of a custom language model that is to be used with the
336
336
  # recognition request. Do not specify both parameters with a request.
@@ -339,7 +339,7 @@ module IBMWatson
339
339
  # specify the name of the custom language model for which the grammar is defined.
340
340
  # The service recognizes only strings that are recognized by the specified grammar;
341
341
  # it does not recognize other custom words from the model's words resource. See
342
- # [Grammars](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-input#grammars-input).
342
+ # [Grammars](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#grammars-input).
343
343
  # @param redaction [Boolean] If `true`, the service redacts, or masks, numeric data from final transcripts. The
344
344
  # feature redacts any number that has three or more consecutive digits by replacing
345
345
  # each digit with an `X` character. It is intended to redact sensitive numeric data,
@@ -354,13 +354,13 @@ module IBMWatson
354
354
  # **Note:** Applies to US English, Japanese, and Korean transcription only.
355
355
  #
356
356
  # See [Numeric
357
- # redaction](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#redaction).
357
+ # redaction](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#redaction).
358
358
  # @param audio_metrics [Boolean] If `true`, requests detailed information about the signal characteristics of the
359
359
  # input audio. The service returns audio metrics with the final transcription
360
360
  # results. By default, the service returns no audio metrics.
361
361
  #
362
362
  # See [Audio
363
- # metrics](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-metrics#audio_metrics).
363
+ # metrics](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-metrics#audio_metrics).
364
364
  # @param end_of_phrase_silence_time [Float] If `true`, specifies the duration of the pause interval at which the service
365
365
  # splits a transcript into multiple final results. If the service detects pauses or
366
366
  # extended silence before it reaches the end of the audio stream, its response can
@@ -377,7 +377,7 @@ module IBMWatson
377
377
  # Chinese is 0.6 seconds.
378
378
  #
379
379
  # See [End of phrase silence
380
- # time](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#silence_time).
380
+ # time](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#silence_time).
381
381
  # @param split_transcript_at_phrase_end [Boolean] If `true`, directs the service to split the transcript into multiple final results
382
382
  # based on semantic features of the input, for example, at the conclusion of
383
383
  # meaningful phrases such as sentences. The service bases its understanding of
@@ -387,7 +387,7 @@ module IBMWatson
387
387
  # interval.
388
388
  #
389
389
  # See [Split transcript at phrase
390
- # end](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#split_transcript).
390
+ # end](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#split_transcript).
391
391
  # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
392
392
  def recognize(audio:, content_type: nil, model: nil, language_customization_id: nil, acoustic_customization_id: nil, base_model_version: nil, customization_weight: nil, inactivity_timeout: nil, keywords: nil, keywords_threshold: nil, max_alternatives: nil, word_alternatives_threshold: nil, word_confidence: nil, timestamps: nil, profanity_filter: nil, smart_formatting: nil, speaker_labels: nil, customization_id: nil, grammar_name: nil, redaction: nil, audio_metrics: nil, end_of_phrase_silence_time: nil, split_transcript_at_phrase_end: nil)
393
393
  raise ArgumentError.new("audio must be provided") if audio.nil?
@@ -643,7 +643,7 @@ module IBMWatson
643
643
  # a one-hour span of time.
644
644
  #
645
645
  # **See also:** [Registering a callback
646
- # URL](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-async#register).
646
+ # URL](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-async#register).
647
647
  # @param callback_url [String] An HTTP or HTTPS URL to which callback notifications are to be sent. To be
648
648
  # white-listed, the URL must successfully echo the challenge string during URL
649
649
  # verification. During verification, the client can also check the signature that
@@ -688,7 +688,7 @@ module IBMWatson
688
688
  # URL can no longer be used with asynchronous recognition requests.
689
689
  #
690
690
  # **See also:** [Unregistering a callback
691
- # URL](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-async#unregister).
691
+ # URL](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-async#unregister).
692
692
  # @param callback_url [String] The callback URL that is to be unregistered.
693
693
  # @return [nil]
694
694
  def unregister_callback(callback_url:)
@@ -756,7 +756,7 @@ module IBMWatson
756
756
  # option to upload the file for the request.)
757
757
  #
758
758
  # **See also:** [Creating a
759
- # job](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-async#create).
759
+ # job](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-async#create).
760
760
  #
761
761
  #
762
762
  # ### Streaming mode
@@ -771,9 +771,9 @@ module IBMWatson
771
771
  #
772
772
  # **See also:**
773
773
  # * [Audio
774
- # transmission](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-input#transmission)
774
+ # transmission](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#transmission)
775
775
  # *
776
- # [Timeouts](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-input#timeouts)
776
+ # [Timeouts](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#timeouts)
777
777
  #
778
778
  #
779
779
  # ### Audio formats (content types)
@@ -813,13 +813,13 @@ module IBMWatson
813
813
  # fails.
814
814
  #
815
815
  # **See also:** [Audio
816
- # formats](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-audio-formats#audio-formats).
816
+ # formats](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-audio-formats#audio-formats).
817
817
  # @param audio [String] The audio to transcribe.
818
818
  # @param content_type [String] The format (MIME type) of the audio. For more information about specifying an
819
819
  # audio format, see **Audio formats (content types)** in the method description.
820
820
  # @param model [String] The identifier of the model that is to be used for the recognition request. See
821
821
  # [Languages and
822
- # models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-models#models).
822
+ # models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models#models).
823
823
  # @param callback_url [String] A URL to which callback notifications are to be sent. The URL must already be
824
824
  # successfully white-listed by using the **Register a callback** method. You can
825
825
  # include the same callback URL with any number of job creation requests. Omit the
@@ -859,7 +859,7 @@ module IBMWatson
859
859
  # match the model specified with the `model` parameter. You must make the request
860
860
  # with credentials for the instance of the service that owns the custom model. By
861
861
  # default, no custom language model is used. See [Custom
862
- # models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-input#custom-input).
862
+ # models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#custom-input).
863
863
  #
864
864
  #
865
865
  # **Note:** Use this parameter instead of the deprecated `customization_id`
@@ -869,13 +869,13 @@ module IBMWatson
869
869
  # match the model specified with the `model` parameter. You must make the request
870
870
  # with credentials for the instance of the service that owns the custom model. By
871
871
  # default, no custom acoustic model is used. See [Custom
872
- # models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-input#custom-input).
872
+ # models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#custom-input).
873
873
  # @param base_model_version [String] The version of the specified base model that is to be used with the recognition
874
874
  # request. Multiple versions of a base model can exist when a model is updated for
875
875
  # internal improvements. The parameter is intended primarily for use with custom
876
876
  # models that have been upgraded for a new base model. The default value depends on
877
877
  # whether the parameter is used with or without a custom model. See [Base model
878
- # version](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-input#version).
878
+ # version](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#version).
879
879
  # @param customization_weight [Float] If you specify the customization ID (GUID) of a custom language model with the
880
880
  # recognition request, the customization weight tells the service how much weight to
881
881
  # give to words from the custom language model compared to those from the base model
@@ -893,45 +893,45 @@ module IBMWatson
893
893
  # phrases.
894
894
  #
895
895
  # See [Custom
896
- # models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-input#custom-input).
896
+ # models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#custom-input).
897
897
  # @param inactivity_timeout [Fixnum] The time in seconds after which, if only silence (no speech) is detected in
898
898
  # streaming audio, the connection is closed with a 400 error. The parameter is
899
899
  # useful for stopping audio submission from a live microphone when a user simply
900
900
  # walks away. Use `-1` for infinity. See [Inactivity
901
- # timeout](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-input#timeouts-inactivity).
901
+ # timeout](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#timeouts-inactivity).
902
902
  # @param keywords [Array[String]] An array of keyword strings to spot in the audio. Each keyword string can include
903
903
  # one or more string tokens. Keywords are spotted only in the final results, not in
904
904
  # interim hypotheses. If you specify any keywords, you must also specify a keywords
905
905
  # threshold. You can spot a maximum of 1000 keywords. Omit the parameter or specify
906
906
  # an empty array if you do not need to spot keywords. See [Keyword
907
- # spotting](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#keyword_spotting).
907
+ # spotting](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#keyword_spotting).
908
908
  # @param keywords_threshold [Float] A confidence value that is the lower bound for spotting a keyword. A word is
909
909
  # considered to match a keyword if its confidence is greater than or equal to the
910
910
  # threshold. Specify a probability between 0.0 and 1.0. If you specify a threshold,
911
911
  # you must also specify one or more keywords. The service performs no keyword
912
912
  # spotting if you omit either parameter. See [Keyword
913
- # spotting](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#keyword_spotting).
913
+ # spotting](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#keyword_spotting).
914
914
  # @param max_alternatives [Fixnum] The maximum number of alternative transcripts that the service is to return. By
915
915
  # default, the service returns a single transcript. If you specify a value of `0`,
916
916
  # the service uses the default value, `1`. See [Maximum
917
- # alternatives](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#max_alternatives).
917
+ # alternatives](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#max_alternatives).
918
918
  # @param word_alternatives_threshold [Float] A confidence value that is the lower bound for identifying a hypothesis as a
919
919
  # possible word alternative (also known as "Confusion Networks"). An alternative
920
920
  # word is considered if its confidence is greater than or equal to the threshold.
921
921
  # Specify a probability between 0.0 and 1.0. By default, the service computes no
922
922
  # alternative words. See [Word
923
- # alternatives](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#word_alternatives).
923
+ # alternatives](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#word_alternatives).
924
924
  # @param word_confidence [Boolean] If `true`, the service returns a confidence measure in the range of 0.0 to 1.0 for
925
925
  # each word. By default, the service returns no word confidence scores. See [Word
926
- # confidence](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#word_confidence).
926
+ # confidence](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#word_confidence).
927
927
  # @param timestamps [Boolean] If `true`, the service returns time alignment for each word. By default, no
928
928
  # timestamps are returned. See [Word
929
- # timestamps](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#word_timestamps).
929
+ # timestamps](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#word_timestamps).
930
930
  # @param profanity_filter [Boolean] If `true`, the service filters profanity from all output except for keyword
931
931
  # results by replacing inappropriate words with a series of asterisks. Set the
932
932
  # parameter to `false` to return results with no censoring. Applies to US English
933
933
  # transcription only. See [Profanity
934
- # filtering](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#profanity_filter).
934
+ # filtering](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#profanity_filter).
935
935
  # @param smart_formatting [Boolean] If `true`, the service converts dates, times, series of digits and numbers, phone
936
936
  # numbers, currency values, and internet addresses into more readable, conventional
937
937
  # representations in the final transcript of a recognition request. For US English,
@@ -941,7 +941,7 @@ module IBMWatson
941
941
  # **Note:** Applies to US English, Japanese, and Spanish transcription only.
942
942
  #
943
943
  # See [Smart
944
- # formatting](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#smart_formatting).
944
+ # formatting](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#smart_formatting).
945
945
  # @param speaker_labels [Boolean] If `true`, the response includes labels that identify which words were spoken by
946
946
  # which participants in a multi-person exchange. By default, the service returns no
947
947
  # speaker labels. Setting `speaker_labels` to `true` forces the `timestamps`
@@ -955,7 +955,7 @@ module IBMWatson
955
955
  # `true`.
956
956
  #
957
957
  # See [Speaker
958
- # labels](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#speaker_labels).
958
+ # labels](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#speaker_labels).
959
959
  # @param customization_id [String] **Deprecated.** Use the `language_customization_id` parameter to specify the
960
960
  # customization ID (GUID) of a custom language model that is to be used with the
961
961
  # recognition request. Do not specify both parameters with a request.
@@ -964,7 +964,7 @@ module IBMWatson
964
964
  # specify the name of the custom language model for which the grammar is defined.
965
965
  # The service recognizes only strings that are recognized by the specified grammar;
966
966
  # it does not recognize other custom words from the model's words resource. See
967
- # [Grammars](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-input#grammars-input).
967
+ # [Grammars](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#grammars-input).
968
968
  # @param redaction [Boolean] If `true`, the service redacts, or masks, numeric data from final transcripts. The
969
969
  # feature redacts any number that has three or more consecutive digits by replacing
970
970
  # each digit with an `X` character. It is intended to redact sensitive numeric data,
@@ -979,7 +979,7 @@ module IBMWatson
979
979
  # **Note:** Applies to US English, Japanese, and Korean transcription only.
980
980
  #
981
981
  # See [Numeric
982
- # redaction](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#redaction).
982
+ # redaction](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#redaction).
983
983
  # @param processing_metrics [Boolean] If `true`, requests processing metrics about the service's transcription of the
984
984
  # input audio. The service returns processing metrics at the interval specified by
985
985
  # the `processing_metrics_interval` parameter. It also returns processing metrics
@@ -987,7 +987,7 @@ module IBMWatson
987
987
  # the service returns no processing metrics.
988
988
  #
989
989
  # See [Processing
990
- # metrics](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-metrics#processing_metrics).
990
+ # metrics](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-metrics#processing_metrics).
991
991
  # @param processing_metrics_interval [Float] Specifies the interval in real wall-clock seconds at which the service is to
992
992
  # return processing metrics. The parameter is ignored unless the
993
993
  # `processing_metrics` parameter is set to `true`.
@@ -1001,13 +1001,13 @@ module IBMWatson
1001
1001
  # the service returns processing metrics only for transcription events.
1002
1002
  #
1003
1003
  # See [Processing
1004
- # metrics](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-metrics#processing_metrics).
1004
+ # metrics](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-metrics#processing_metrics).
1005
1005
  # @param audio_metrics [Boolean] If `true`, requests detailed information about the signal characteristics of the
1006
1006
  # input audio. The service returns audio metrics with the final transcription
1007
1007
  # results. By default, the service returns no audio metrics.
1008
1008
  #
1009
1009
  # See [Audio
1010
- # metrics](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-metrics#audio_metrics).
1010
+ # metrics](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-metrics#audio_metrics).
1011
1011
  # @param end_of_phrase_silence_time [Float] If `true`, specifies the duration of the pause interval at which the service
1012
1012
  # splits a transcript into multiple final results. If the service detects pauses or
1013
1013
  # extended silence before it reaches the end of the audio stream, its response can
@@ -1024,7 +1024,7 @@ module IBMWatson
1024
1024
  # Chinese is 0.6 seconds.
1025
1025
  #
1026
1026
  # See [End of phrase silence
1027
- # time](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#silence_time).
1027
+ # time](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#silence_time).
1028
1028
  # @param split_transcript_at_phrase_end [Boolean] If `true`, directs the service to split the transcript into multiple final results
1029
1029
  # based on semantic features of the input, for example, at the conclusion of
1030
1030
  # meaningful phrases such as sentences. The service bases its understanding of
@@ -1034,7 +1034,7 @@ module IBMWatson
1034
1034
  # interval.
1035
1035
  #
1036
1036
  # See [Split transcript at phrase
1037
- # end](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#split_transcript).
1037
+ # end](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#split_transcript).
1038
1038
  # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
1039
1039
  def create_job(audio:, content_type: nil, model: nil, callback_url: nil, events: nil, user_token: nil, results_ttl: nil, language_customization_id: nil, acoustic_customization_id: nil, base_model_version: nil, customization_weight: nil, inactivity_timeout: nil, keywords: nil, keywords_threshold: nil, max_alternatives: nil, word_alternatives_threshold: nil, word_confidence: nil, timestamps: nil, profanity_filter: nil, smart_formatting: nil, speaker_labels: nil, customization_id: nil, grammar_name: nil, redaction: nil, processing_metrics: nil, processing_metrics_interval: nil, audio_metrics: nil, end_of_phrase_silence_time: nil, split_transcript_at_phrase_end: nil)
1040
1040
  raise ArgumentError.new("audio must be provided") if audio.nil?
@@ -1104,7 +1104,7 @@ module IBMWatson
1104
1104
  # first.
1105
1105
  #
1106
1106
  # **See also:** [Checking the status of the latest
1107
- # jobs](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-async#jobs).
1107
+ # jobs](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-async#jobs).
1108
1108
  # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
1109
1109
  def check_jobs
1110
1110
  headers = {
@@ -1139,7 +1139,7 @@ module IBMWatson
1139
1139
  # recent jobs associated with the calling credentials.
1140
1140
  #
1141
1141
  # **See also:** [Checking the status and retrieving the results of a
1142
- # job](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-async#job).
1142
+ # job](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-async#job).
1143
1143
  # @param id [String] The identifier of the asynchronous job that is to be used for the request. You
1144
1144
  # must make the request with credentials for the instance of the service that owns
1145
1145
  # the job.
@@ -1173,7 +1173,7 @@ module IBMWatson
1173
1173
  # owns a job to delete it.
1174
1174
  #
1175
1175
  # **See also:** [Deleting a
1176
- # job](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-async#delete-async).
1176
+ # job](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-async#delete-async).
1177
1177
  # @param id [String] The identifier of the asynchronous job that is to be used for the request. You
1178
1178
  # must make the request with credentials for the instance of the service that owns
1179
1179
  # the job.
@@ -1214,7 +1214,7 @@ module IBMWatson
1214
1214
  # below the limit.
1215
1215
  #
1216
1216
  # **See also:** [Create a custom language
1217
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-languageCreate#createModel-language).
1217
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageCreate#createModel-language).
1218
1218
  # @param name [String] A user-defined name for the new custom language model. Use a name that is unique
1219
1219
  # among all custom language models that you own. Use a localized name that matches
1220
1220
  # the language of the custom model. Use a name that describes the domain of the
@@ -1226,7 +1226,7 @@ module IBMWatson
1226
1226
  # To determine whether a base model supports language model customization, use the
1227
1227
  # **Get a model** method and check that the attribute `custom_language_model` is set
1228
1228
  # to `true`. You can also refer to [Language support for
1229
- # customization](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-customization#languageSupport).
1229
+ # customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-customization#languageSupport).
1230
1230
  # @param dialect [String] The dialect of the specified language that is to be used with the custom language
1231
1231
  # model. For most languages, the dialect matches the language of the base model by
1232
1232
  # default. For example, `en-US` is used for either of the US English language
@@ -1288,7 +1288,7 @@ module IBMWatson
1288
1288
  # a model to list information about it.
1289
1289
  #
1290
1290
  # **See also:** [Listing custom language
1291
- # models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageLanguageModels#listModels-language).
1291
+ # models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageLanguageModels#listModels-language).
1292
1292
  # @param language [String] The identifier of the language for which custom language or custom acoustic models
1293
1293
  # are to be returned (for example, `en-US`). Omit the parameter to see all custom
1294
1294
  # language or custom acoustic models that are owned by the requesting credentials.
@@ -1322,7 +1322,7 @@ module IBMWatson
1322
1322
  # for the instance of the service that owns a model to list information about it.
1323
1323
  #
1324
1324
  # **See also:** [Listing custom language
1325
- # models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageLanguageModels#listModels-language).
1325
+ # models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageLanguageModels#listModels-language).
1326
1326
  # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
1327
1327
  # the request. You must make the request with credentials for the instance of the
1328
1328
  # service that owns the custom model.
@@ -1355,7 +1355,7 @@ module IBMWatson
1355
1355
  # owns a model to delete it.
1356
1356
  #
1357
1357
  # **See also:** [Deleting a custom language
1358
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageLanguageModels#deleteModel-language).
1358
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageLanguageModels#deleteModel-language).
1359
1359
  # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
1360
1360
  # the request. You must make the request with credentials for the instance of the
1361
1361
  # service that owns the custom model.
@@ -1403,7 +1403,7 @@ module IBMWatson
1403
1403
  # requests to add new resources until the existing request completes.
1404
1404
  #
1405
1405
  # **See also:** [Train the custom language
1406
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-languageCreate#trainModel-language).
1406
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageCreate#trainModel-language).
1407
1407
  #
1408
1408
  #
1409
1409
  # ### Training failures
@@ -1479,7 +1479,7 @@ module IBMWatson
1479
1479
  # it.
1480
1480
  #
1481
1481
  # **See also:** [Resetting a custom language
1482
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageLanguageModels#resetModel-language).
1482
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageLanguageModels#resetModel-language).
1483
1483
  # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
1484
1484
  # the request. You must make the request with credentials for the instance of the
1485
1485
  # service that owns the custom model.
@@ -1523,7 +1523,7 @@ module IBMWatson
1523
1523
  # subsequent requests for the model until the upgrade completes.
1524
1524
  #
1525
1525
  # **See also:** [Upgrading a custom language
1526
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-customUpgrade#upgradeLanguage).
1526
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-customUpgrade#upgradeLanguage).
1527
1527
  # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
1528
1528
  # the request. You must make the request with credentials for the instance of the
1529
1529
  # service that owns the custom model.
@@ -1559,7 +1559,7 @@ module IBMWatson
1559
1559
  # that owns a model to list its corpora.
1560
1560
  #
1561
1561
  # **See also:** [Listing corpora for a custom language
1562
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageCorpora#listCorpora).
1562
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageCorpora#listCorpora).
1563
1563
  # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
1564
1564
  # the request. You must make the request with credentials for the instance of the
1565
1565
  # service that owns the custom model.
@@ -1628,9 +1628,9 @@ module IBMWatson
1628
1628
  #
1629
1629
  # **See also:**
1630
1630
  # * [Working with
1631
- # corpora](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-corporaWords#workingCorpora)
1631
+ # corpora](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#workingCorpora)
1632
1632
  # * [Add a corpus to the custom language
1633
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-languageCreate#addCorpus).
1633
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageCreate#addCorpus).
1634
1634
  # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
1635
1635
  # the request. You must make the request with credentials for the instance of the
1636
1636
  # service that owns the custom model.
@@ -1656,7 +1656,7 @@ module IBMWatson
1656
1656
  # Make sure that you know the character encoding of the file. You must use that
1657
1657
  # encoding when working with the words in the custom language model. For more
1658
1658
  # information, see [Character
1659
- # encoding](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-corporaWords#charEncoding).
1659
+ # encoding](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#charEncoding).
1660
1660
  #
1661
1661
  #
1662
1662
  # With the `curl` command, use the `--data-binary` option to upload the file for the
@@ -1710,7 +1710,7 @@ module IBMWatson
1710
1710
  # that owns a model to list its corpora.
1711
1711
  #
1712
1712
  # **See also:** [Listing corpora for a custom language
1713
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageCorpora#listCorpora).
1713
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageCorpora#listCorpora).
1714
1714
  # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
1715
1715
  # the request. You must make the request with credentials for the instance of the
1716
1716
  # service that owns the custom model.
@@ -1750,7 +1750,7 @@ module IBMWatson
1750
1750
  # corpora.
1751
1751
  #
1752
1752
  # **See also:** [Deleting a corpus from a custom language
1753
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageCorpora#deleteCorpus).
1753
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageCorpora#deleteCorpus).
1754
1754
  # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
1755
1755
  # the request. You must make the request with credentials for the instance of the
1756
1756
  # service that owns the custom model.
@@ -1792,7 +1792,7 @@ module IBMWatson
1792
1792
  # service that owns a model to list information about its words.
1793
1793
  #
1794
1794
  # **See also:** [Listing words from a custom language
1795
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageWords#listWords).
1795
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageWords#listWords).
1796
1796
  # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
1797
1797
  # the request. You must make the request with credentials for the instance of the
1798
1798
  # service that owns the custom model.
@@ -1890,9 +1890,9 @@ module IBMWatson
1890
1890
  #
1891
1891
  # **See also:**
1892
1892
  # * [Working with custom
1893
- # words](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-corporaWords#workingWords)
1893
+ # words](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#workingWords)
1894
1894
  # * [Add words to the custom language
1895
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-languageCreate#addWords).
1895
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageCreate#addWords).
1896
1896
  # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
1897
1897
  # the request. You must make the request with credentials for the instance of the
1898
1898
  # service that owns the custom model.
@@ -1961,9 +1961,9 @@ module IBMWatson
1961
1961
  #
1962
1962
  # **See also:**
1963
1963
  # * [Working with custom
1964
- # words](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-corporaWords#workingWords)
1964
+ # words](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#workingWords)
1965
1965
  # * [Add words to the custom language
1966
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-languageCreate#addWords).
1966
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageCreate#addWords).
1967
1967
  # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
1968
1968
  # the request. You must make the request with credentials for the instance of the
1969
1969
  # service that owns the custom model.
@@ -1971,7 +1971,7 @@ module IBMWatson
1971
1971
  # not include spaces in the word. Use a `-` (dash) or `_` (underscore) to connect
1972
1972
  # the tokens of compound words. URL-encode the word if it includes non-ASCII
1973
1973
  # characters. For more information, see [Character
1974
- # encoding](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-corporaWords#charEncoding).
1974
+ # encoding](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#charEncoding).
1975
1975
  # @param word [String] For the **Add custom words** method, you must specify the custom word that is to
1976
1976
  # be added to or updated in the custom model. Do not include spaces in the word. Use
1977
1977
  # a `-` (dash) or `_` (underscore) to connect the tokens of compound words.
@@ -2029,13 +2029,13 @@ module IBMWatson
2029
2029
  # about its words.
2030
2030
  #
2031
2031
  # **See also:** [Listing words from a custom language
2032
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageWords#listWords).
2032
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageWords#listWords).
2033
2033
  # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
2034
2034
  # the request. You must make the request with credentials for the instance of the
2035
2035
  # service that owns the custom model.
2036
2036
  # @param word_name [String] The custom word that is to be read from the custom language model. URL-encode the
2037
2037
  # word if it includes non-ASCII characters. For more information, see [Character
2038
- # encoding](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-corporaWords#charEncoding).
2038
+ # encoding](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#charEncoding).
2039
2039
  # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
2040
2040
  def get_word(customization_id:, word_name:)
2041
2041
  raise ArgumentError.new("customization_id must be provided") if customization_id.nil?
@@ -2070,13 +2070,13 @@ module IBMWatson
2070
2070
  # instance of the service that owns a model to delete its words.
2071
2071
  #
2072
2072
  # **See also:** [Deleting a word from a custom language
2073
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageWords#deleteWord).
2073
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageWords#deleteWord).
2074
2074
  # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
2075
2075
  # the request. You must make the request with credentials for the instance of the
2076
2076
  # service that owns the custom model.
2077
2077
  # @param word_name [String] The custom word that is to be deleted from the custom language model. URL-encode
2078
2078
  # the word if it includes non-ASCII characters. For more information, see [Character
2079
- # encoding](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-corporaWords#charEncoding).
2079
+ # encoding](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#charEncoding).
2080
2080
  # @return [nil]
2081
2081
  def delete_word(customization_id:, word_name:)
2082
2082
  raise ArgumentError.new("customization_id must be provided") if customization_id.nil?
@@ -2111,7 +2111,7 @@ module IBMWatson
2111
2111
  # model to list its grammars.
2112
2112
  #
2113
2113
  # **See also:** [Listing grammars from a custom language
2114
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageGrammars#listGrammars).
2114
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageGrammars#listGrammars).
2115
2115
  # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
2116
2116
  # the request. You must make the request with credentials for the instance of the
2117
2117
  # service that owns the custom model.
@@ -2175,9 +2175,9 @@ module IBMWatson
2175
2175
  #
2176
2176
  # **See also:**
2177
2177
  # * [Understanding
2178
- # grammars](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-grammarUnderstand#grammarUnderstand)
2178
+ # grammars](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-grammarUnderstand#grammarUnderstand)
2179
2179
  # * [Add a grammar to the custom language
2180
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-grammarAdd#addGrammar).
2180
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-grammarAdd#addGrammar).
2181
2181
  # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
2182
2182
  # the request. You must make the request with credentials for the instance of the
2183
2183
  # service that owns the custom model.
@@ -2257,7 +2257,7 @@ module IBMWatson
2257
2257
  # model to list its grammars.
2258
2258
  #
2259
2259
  # **See also:** [Listing grammars from a custom language
2260
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageGrammars#listGrammars).
2260
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageGrammars#listGrammars).
2261
2261
  # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
2262
2262
  # the request. You must make the request with credentials for the instance of the
2263
2263
  # service that owns the custom model.
@@ -2296,7 +2296,7 @@ module IBMWatson
2296
2296
  # for the instance of the service that owns a model to delete its grammar.
2297
2297
  #
2298
2298
  # **See also:** [Deleting a grammar from a custom language
2299
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageGrammars#deleteGrammar).
2299
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageGrammars#deleteGrammar).
2300
2300
  # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
2301
2301
  # the request. You must make the request with credentials for the instance of the
2302
2302
  # service that owns the custom model.
@@ -2340,7 +2340,7 @@ module IBMWatson
2340
2340
  # below the limit.
2341
2341
  #
2342
2342
  # **See also:** [Create a custom acoustic
2343
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-acoustic#createModel-acoustic).
2343
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-acoustic#createModel-acoustic).
2344
2344
  # @param name [String] A user-defined name for the new custom acoustic model. Use a name that is unique
2345
2345
  # among all custom acoustic models that you own. Use a localized name that matches
2346
2346
  # the language of the custom model. Use a name that describes the acoustic
@@ -2352,7 +2352,7 @@ module IBMWatson
2352
2352
  #
2353
2353
  # To determine whether a base model supports acoustic model customization, refer to
2354
2354
  # [Language support for
2355
- # customization](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-customization#languageSupport).
2355
+ # customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-customization#languageSupport).
2356
2356
  # @param description [String] A description of the new custom acoustic model. Use a localized description that
2357
2357
  # matches the language of the custom model.
2358
2358
  # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
@@ -2394,7 +2394,7 @@ module IBMWatson
2394
2394
  # a model to list information about it.
2395
2395
  #
2396
2396
  # **See also:** [Listing custom acoustic
2397
- # models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAcousticModels#listModels-acoustic).
2397
+ # models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAcousticModels#listModels-acoustic).
2398
2398
  # @param language [String] The identifier of the language for which custom language or custom acoustic models
2399
2399
  # are to be returned (for example, `en-US`). Omit the parameter to see all custom
2400
2400
  # language or custom acoustic models that are owned by the requesting credentials.
@@ -2428,7 +2428,7 @@ module IBMWatson
2428
2428
  # for the instance of the service that owns a model to list information about it.
2429
2429
  #
2430
2430
  # **See also:** [Listing custom acoustic
2431
- # models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAcousticModels#listModels-acoustic).
2431
+ # models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAcousticModels#listModels-acoustic).
2432
2432
  # @param customization_id [String] The customization ID (GUID) of the custom acoustic model that is to be used for
2433
2433
  # the request. You must make the request with credentials for the instance of the
2434
2434
  # service that owns the custom model.
@@ -2461,7 +2461,7 @@ module IBMWatson
2461
2461
  # model to delete it.
2462
2462
  #
2463
2463
  # **See also:** [Deleting a custom acoustic
2464
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAcousticModels#deleteModel-acoustic).
2464
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAcousticModels#deleteModel-acoustic).
2465
2465
  # @param customization_id [String] The customization ID (GUID) of the custom acoustic model that is to be used for
2466
2466
  # the request. You must make the request with credentials for the instance of the
2467
2467
  # service that owns the custom model.
@@ -2523,9 +2523,9 @@ module IBMWatson
2523
2523
  #
2524
2524
  # **See also:**
2525
2525
  # * [Train the custom acoustic
2526
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-acoustic#trainModel-acoustic)
2526
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-acoustic#trainModel-acoustic)
2527
2527
  # * [Using custom acoustic and custom language models
2528
- # together](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-useBoth#useBoth)
2528
+ # together](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-useBoth#useBoth)
2529
2529
  #
2530
2530
  #
2531
2531
  # ### Training failures
@@ -2590,7 +2590,7 @@ module IBMWatson
2590
2590
  # owns a model to reset it.
2591
2591
  #
2592
2592
  # **See also:** [Resetting a custom acoustic
2593
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAcousticModels#resetModel-acoustic).
2593
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAcousticModels#resetModel-acoustic).
2594
2594
  # @param customization_id [String] The customization ID (GUID) of the custom acoustic model that is to be used for
2595
2595
  # the request. You must make the request with credentials for the instance of the
2596
2596
  # service that owns the custom model.
@@ -2643,7 +2643,7 @@ module IBMWatson
2643
2643
  # acoustic model was not trained with a custom language model.
2644
2644
  #
2645
2645
  # **See also:** [Upgrading a custom acoustic
2646
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-customUpgrade#upgradeAcoustic).
2646
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-customUpgrade#upgradeAcoustic).
2647
2647
  # @param customization_id [String] The customization ID (GUID) of the custom acoustic model that is to be used for
2648
2648
  # the request. You must make the request with credentials for the instance of the
2649
2649
  # service that owns the custom model.
@@ -2656,7 +2656,7 @@ module IBMWatson
2656
2656
  # upgrade of a custom acoustic model that is trained with a custom language model,
2657
2657
  # and only if you receive a 400 response code and the message `No input data
2658
2658
  # modified since last training`. See [Upgrading a custom acoustic
2659
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-customUpgrade#upgradeAcoustic).
2659
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-customUpgrade#upgradeAcoustic).
2660
2660
  # @return [nil]
2661
2661
  def upgrade_acoustic_model(customization_id:, custom_language_model_id: nil, force: nil)
2662
2662
  raise ArgumentError.new("customization_id must be provided") if customization_id.nil?
@@ -2697,7 +2697,7 @@ module IBMWatson
2697
2697
  # the instance of the service that owns a model to list its audio resources.
2698
2698
  #
2699
2699
  # **See also:** [Listing audio resources for a custom acoustic
2700
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAudio#listAudio).
2700
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAudio#listAudio).
2701
2701
  # @param customization_id [String] The customization ID (GUID) of the custom acoustic model that is to be used for
2702
2702
  # the request. You must make the request with credentials for the instance of the
2703
2703
  # service that owns the custom model.
@@ -2761,7 +2761,7 @@ module IBMWatson
2761
2761
  # every few seconds until it becomes `ok`.
2762
2762
  #
2763
2763
  # **See also:** [Add audio to the custom acoustic
2764
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-acoustic#addAudio).
2764
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-acoustic#addAudio).
2765
2765
  #
2766
2766
  #
2767
2767
  # ### Content types for audio-type resources
@@ -2795,7 +2795,7 @@ module IBMWatson
2795
2795
  # service labels the audio file as `invalid`.
2796
2796
  #
2797
2797
  # **See also:** [Audio
2798
- # formats](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-audio-formats#audio-formats).
2798
+ # formats](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-audio-formats#audio-formats).
2799
2799
  #
2800
2800
  #
2801
2801
  # ### Content types for archive-type resources
@@ -2931,7 +2931,7 @@ module IBMWatson
2931
2931
  # its audio resources.
2932
2932
  #
2933
2933
  # **See also:** [Listing audio resources for a custom acoustic
2934
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAudio#listAudio).
2934
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAudio#listAudio).
2935
2935
  # @param customization_id [String] The customization ID (GUID) of the custom acoustic model that is to be used for
2936
2936
  # the request. You must make the request with credentials for the instance of the
2937
2937
  # service that owns the custom model.
@@ -2972,7 +2972,7 @@ module IBMWatson
2972
2972
  # service that owns a model to delete its audio resources.
2973
2973
  #
2974
2974
  # **See also:** [Deleting an audio resource from a custom acoustic
2975
- # model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAudio#deleteAudio).
2975
+ # model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAudio#deleteAudio).
2976
2976
  # @param customization_id [String] The customization ID (GUID) of the custom acoustic model that is to be used for
2977
2977
  # the request. You must make the request with credentials for the instance of the
2978
2978
  # service that owns the custom model.
@@ -3015,7 +3015,7 @@ module IBMWatson
3015
3015
  # with a request that passes the data.
3016
3016
  #
3017
3017
  # **See also:** [Information
3018
- # security](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-information-security#information-security).
3018
+ # security](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-information-security#information-security).
3019
3019
  # @param customer_id [String] The customer ID for which all data is to be deleted.
3020
3020
  # @return [nil]
3021
3021
  def delete_user_data(customer_id:)