Skip to content

Commit c393092

Browse files
committed
fix: correct comments
fix: correct comments
1 parent 4965e35 commit c393092

1 file changed

Lines changed: 29 additions & 46 deletions

File tree

lib/ibm_watson/speech_to_text_v1.rb

Lines changed: 29 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -277,14 +277,8 @@ def get_model(model_id:)
277277
# @param keywords [Array[String]] An array of keyword strings to spot in the audio. Each keyword string can include
278278
# one or more string tokens. Keywords are spotted only in the final results, not in
279279
# interim hypotheses. If you specify any keywords, you must also specify a keywords
280-
# threshold. Omit the parameter or specify an empty array if you do not need to spot
281-
# keywords.
282-
#
283-
# You can spot a maximum of 1000 keywords with a single request. A single keyword
284-
# can have a maximum length of 1024 characters, though the maximum effective length
285-
# for double-byte languages might be shorter. Keywords are case-insensitive.
286-
#
287-
# See [Keyword
280+
# threshold. You can spot a maximum of 1000 keywords. Omit the parameter or specify
281+
# an empty array if you do not need to spot keywords. See [Keyword
288282
# spotting](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#keyword_spotting).
289283
# @param keywords_threshold [Float] A confidence value that is the lower bound for spotting a keyword. A word is
290284
# considered to match a keyword if its confidence is greater than or equal to the
@@ -909,14 +903,8 @@ def unregister_callback(callback_url:)
909903
# @param keywords [Array[String]] An array of keyword strings to spot in the audio. Each keyword string can include
910904
# one or more string tokens. Keywords are spotted only in the final results, not in
911905
# interim hypotheses. If you specify any keywords, you must also specify a keywords
912-
# threshold. Omit the parameter or specify an empty array if you do not need to spot
913-
# keywords.
914-
#
915-
# You can spot a maximum of 1000 keywords with a single request. A single keyword
916-
# can have a maximum length of 1024 characters, though the maximum effective length
917-
# for double-byte languages might be shorter. Keywords are case-insensitive.
918-
#
919-
# See [Keyword
906+
# threshold. You can spot a maximum of 1000 keywords. Omit the parameter or specify
907+
# an empty array if you do not need to spot keywords. See [Keyword
920908
# spotting](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#keyword_spotting).
921909
# @param keywords_threshold [Float] A confidence value that is the lower bound for spotting a keyword. A word is
922910
# considered to match a keyword if its confidence is greater than or equal to the
@@ -1612,10 +1600,10 @@ def list_corpora(customization_id:)
16121600
#
16131601
# The call returns an HTTP 201 response code if the corpus is valid. The service
16141602
# then asynchronously processes the contents of the corpus and automatically
1615-
# extracts new words that it finds. This operation can take on the order of minutes
1616-
# to complete depending on the total number of words and the number of new words in
1617-
# the corpus, as well as the current load on the service. You cannot submit requests
1618-
# to add additional resources to the custom model or to train the model until the
1603+
# extracts new words that it finds. This can take on the order of a minute or two to
1604+
# complete depending on the total number of words and the number of new words in the
1605+
# corpus, as well as the current load on the service. You cannot submit requests to
1606+
# add additional resources to the custom model or to train the model until the
16191607
# service's analysis of the corpus for the current request completes. Use the **List
16201608
# a corpus** method to check the status of the analysis.
16211609
#
@@ -2160,12 +2148,12 @@ def list_grammars(customization_id:)
21602148
#
21612149
# The call returns an HTTP 201 response code if the grammar is valid. The service
21622150
# then asynchronously processes the contents of the grammar and automatically
2163-
# extracts new words that it finds. This operation can take a few seconds or minutes
2164-
# to complete depending on the size and complexity of the grammar, as well as the
2165-
# current load on the service. You cannot submit requests to add additional
2166-
# resources to the custom model or to train the model until the service's analysis
2167-
# of the grammar for the current request completes. Use the **Get a grammar** method
2168-
# to check the status of the analysis.
2151+
# extracts new words that it finds. This can take a few seconds to complete
2152+
# depending on the size and complexity of the grammar, as well as the current load
2153+
# on the service. You cannot submit requests to add additional resources to the
2154+
# custom model or to train the model until the service's analysis of the grammar for
2155+
# the current request completes. Use the **Get a grammar** method to check the
2156+
# status of the analysis.
21692157
#
21702158
# The service populates the model's words resource with any word that is recognized
21712159
# by the grammar that is not found in the model's base vocabulary. These are
@@ -2512,7 +2500,7 @@ def delete_acoustic_model(customization_id:)
25122500
# to complete depending on the total amount of audio data on which the custom
25132501
# acoustic model is being trained and the current load on the service. Typically,
25142502
# training a custom acoustic model takes approximately two to four times the length
2515-
# of its audio data. The actual time depends on the model being trained and the
2503+
# of its audio data. The range of time depends on the model being trained and the
25162504
# nature of the audio, such as whether the audio is clean or noisy. The method
25172505
# returns an HTTP 200 response code to indicate that the training process has begun.
25182506
#
@@ -2531,9 +2519,8 @@ def delete_acoustic_model(customization_id:)
25312519
# Train with a custom language model if you have verbatim transcriptions of the
25322520
# audio files that you have added to the custom model or you have either corpora
25332521
# (text files) or a list of words that are relevant to the contents of the audio
2534-
# files. For training to succeed, both of the custom models must be based on the
2535-
# same version of the same base model, and the custom language model must be fully
2536-
# trained and available.
2522+
# files. Both of the custom models must be based on the same version of the same
2523+
# base model for training to succeed.
25372524
#
25382525
# **See also:**
25392526
# * [Train the custom acoustic
@@ -2549,9 +2536,6 @@ def delete_acoustic_model(customization_id:)
25492536
# another training request or a request to add audio resources to the model.
25502537
# * The custom model contains less than 10 minutes or more than 200 hours of audio
25512538
# data.
2552-
# * You passed a custom language model with the `custom_language_model_id` query
2553-
# parameter that is not in the available state. A custom language model must be
2554-
# fully trained and available to be used to train a custom acoustic model.
25552539
# * You passed an incompatible custom language model with the
25562540
# `custom_language_model_id` query parameter. Both custom models must be based on
25572541
# the same version of the same base model.
@@ -2567,8 +2551,8 @@ def delete_acoustic_model(customization_id:)
25672551
# been trained with verbatim transcriptions of the audio resources or that contains
25682552
# words that are relevant to the contents of the audio resources. The custom
25692553
# language model must be based on the same version of the same base model as the
2570-
# custom acoustic model, and the custom language model must be fully trained and
2571-
# available. The credentials specified with the request must own both custom models.
2554+
# custom acoustic model. The credentials specified with the request must own both
2555+
# custom models.
25722556
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
25732557
def train_acoustic_model(customization_id:, custom_language_model_id: nil)
25742558
raise ArgumentError.new("customization_id must be provided") if customization_id.nil?
@@ -2666,9 +2650,8 @@ def reset_acoustic_model(customization_id:)
26662650
# service that owns the custom model.
26672651
# @param custom_language_model_id [String] If the custom acoustic model was trained with a custom language model, the
26682652
# customization ID (GUID) of that custom language model. The custom language model
2669-
# must be upgraded before the custom acoustic model can be upgraded. The custom
2670-
# language model must be fully trained and available. The credentials specified with
2671-
# the request must own both custom models.
2653+
# must be upgraded before the custom acoustic model can be upgraded. The credentials
2654+
# specified with the request must own both custom models.
26722655
# @param force [Boolean] If `true`, forces the upgrade of a custom acoustic model for which no input data
26732656
# has been modified since it was last trained. Use this parameter only to force the
26742657
# upgrade of a custom acoustic model that is trained with a custom language model,
@@ -2763,14 +2746,14 @@ def list_audio(customization_id:)
27632746
# same name as an existing audio resource, set the `allow_overwrite` parameter to
27642747
# `true`; otherwise, the request fails.
27652748
#
2766-
# The method is asynchronous. It can take several seconds or minutes to complete
2767-
# depending on the duration of the audio and, in the case of an archive file, the
2768-
# total number of audio files being processed. The service returns a 201 response
2769-
# code if the audio is valid. It then asynchronously analyzes the contents of the
2770-
# audio file or files and automatically extracts information about the audio such as
2771-
# its length, sampling rate, and encoding. You cannot submit requests to train or
2772-
# upgrade the model until the service's analysis of all audio resources for current
2773-
# requests completes.
2749+
# The method is asynchronous. It can take several seconds to complete depending on
2750+
# the duration of the audio and, in the case of an archive file, the total number of
2751+
# audio files being processed. The service returns a 201 response code if the audio
2752+
# is valid. It then asynchronously analyzes the contents of the audio file or files
2753+
# and automatically extracts information about the audio such as its length,
2754+
# sampling rate, and encoding. You cannot submit requests to train or upgrade the
2755+
# model until the service's analysis of all audio resources for current requests
2756+
# completes.
27742757
#
27752758
# To determine the status of the service's analysis of the audio, use the **Get an
27762759
# audio resource** method to poll the status of the audio. The method accepts the

0 commit comments

Comments
 (0)