chore(stt): regenerate speech to text

ehdsouza · ehdsouza · commit 6b2f7dae747f · 2019-07-23T15:02:21.000-04:00
diff --git a/ibm_watson/speech_to_text_v1.py b/ibm_watson/speech_to_text_v1.py
@@ -1249,8 +1249,9 @@ def train_language_model(self,
         * No training data have been added to the custom model.
         * The custom model contains one or more invalid corpora, grammars, or words (for
         example, a custom word has an invalid sounds-like pronunciation). You can correct
-        the invalid resources. The model must contain at least one valid resource for training
-        to succeed.
+        the invalid resources or set the `strict` parameter to `false` to exclude the
+        invalid resources from the training. The model must contain at least one valid
+        resource for training to succeed.
 
         :param str customization_id: The customization ID (GUID) of the custom language
         model that is to be used for the request. You must make the request with
@@ -1481,11 +1482,17 @@ def add_corpus(self,
         Use a localized name that matches the language of the custom model and reflects
         the contents of the corpus.
         * Include a maximum of 128 characters in the name.
-        * Do not include spaces, slashes, or backslashes in the name.
+        * Do not use characters that need to be URL-encoded. For example, do not use
+        spaces, slashes, backslashes, colons, ampersands, double quotes, plus signs,
+        equals signs, questions marks, and so on in the name. (The service does not
+        prevent the use of these characters. But because they must be URL-encoded wherever
+        used, their use is strongly discouraged.)
         * Do not use the name of an existing corpus or grammar that is already defined for
         the custom model.
         * Do not use the name `user`, which is reserved by the service to denote custom
         words that are added or modified by the user.
+        * Do not use the name `base_lm` or `default_lm`. Both names are reserved for
+        future use by the service.
         :param file corpus_file: A plain text file that contains the training data for the
         corpus. Encode the file in UTF-8 if it contains non-ASCII characters; the service
         assumes UTF-8 encoding if it encounters non-ASCII characters.
@@ -1644,7 +1651,7 @@ def list_words(self, customization_id, word_type=None, sort=None, **kwargs):
         descending order. By default, words are sorted in ascending alphabetical order.
         For alphabetical ordering, the lexicographical precedence is numeric values,
         uppercase letters, and lowercase letters. For count ordering, values with the same
-        count are ordered alphabetically. With the `curl` command, URL encode the `+`
+        count are ordered alphabetically. With the `curl` command, URL-encode the `+`
         symbol as `%2B`.
         :param dict headers: A `dict` containing the request headers
         :return: A `DetailedResponse` containing the result, headers and HTTP status code.
@@ -2032,11 +2039,17 @@ def add_grammar(self,
         model. Use a localized name that matches the language of the custom model and
         reflects the contents of the grammar.
         * Include a maximum of 128 characters in the name.
-        * Do not include spaces, slashes, or backslashes in the name.
+        * Do not use characters that need to be URL-encoded. For example, do not use
+        spaces, slashes, backslashes, colons, ampersands, double quotes, plus signs,
+        equals signs, questions marks, and so on in the name. (The service does not
+        prevent the use of these characters. But because they must be URL-encoded wherever
+        used, their use is strongly discouraged.)
         * Do not use the name of an existing grammar or corpus that is already defined for
         the custom model.
         * Do not use the name `user`, which is reserved by the service to denote custom
         words that are added or modified by the user.
+        * Do not use the name `base_lm` or `default_lm`. Both names are reserved for
+        future use by the service.
         :param str grammar_file: A plain text file that contains the grammar in the format
         specified by the `Content-Type` header. Encode the file in UTF-8 (ASCII is a
         subset of UTF-8). Using any other encoding can lead to issues when compiling the
@@ -2360,8 +2373,10 @@ def train_acoustic_model(self,
         model** method to poll the model's status. Use a loop to check the status once a
         minute. The method returns an `AcousticModel` object that includes `status` and
         `progress` fields. A status of `available` indicates that the custom model is
-        trained and ready to use. The service cannot accept subsequent training requests,
-        or requests to add new audio resources, until the existing request completes.
+        trained and ready to use. The service cannot train a model while it is handling
+        another request for the model. The service cannot accept subsequent training
+        requests, or requests to add new audio resources, until the existing training
+        request completes.
         You can use the optional `custom_language_model_id` parameter to specify the GUID
         of a separately created custom language model that is to be used during training.
         Train with a custom language model if you have verbatim transcriptions of the
@@ -2384,7 +2399,8 @@ def train_acoustic_model(self,
         `custom_language_model_id` query parameter. Both custom models must be based on
         the same version of the same base model.
         * The custom model contains one or more invalid audio resources. You can correct
-        the invalid audio resources. The model must contain at least one valid
+        the invalid audio resources or set the `strict` parameter to `false` to exclude
+        the invalid resources from the training. The model must contain at least one valid
         resource for training to succeed.
 
         :param str customization_id: The customization ID (GUID) of the custom acoustic
@@ -2412,9 +2428,7 @@ def train_acoustic_model(self,
                                       'train_acoustic_model')
         headers.update(sdk_headers)
 
-        params = {
-            'custom_language_model_id': custom_language_model_id
-        }
+        params = {'custom_language_model_id': custom_language_model_id}
 
         url = '/v1/acoustic_customizations/{0}/train'.format(
             *self._encode_path_vars(customization_id))
@@ -2433,8 +2447,11 @@ def reset_acoustic_model(self, customization_id, **kwargs):
         Resets a custom acoustic model by removing all audio resources from the model.
         Resetting a custom acoustic model initializes the model to its state when it was
         first created. Metadata such as the name and language of the model are preserved,
-        but the model's audio resources are removed and must be re-created. You must use
-        credentials for the instance of the service that owns a model to reset it.
+        but the model's audio resources are removed and must be re-created. The service
+        cannot reset a model while it is handling another request for the model. The
+        service cannot accept subsequent requests for the model until the existing reset
+        request completes. You must use credentials for the instance of the service that
+        owns a model to reset it.
         **See also:** [Resetting a custom acoustic
         model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAcousticModels#resetModel-acoustic).
 
@@ -2483,8 +2500,10 @@ def upgrade_acoustic_model(self,
         returns an `AcousticModel` object that includes `status` and `progress` fields.
         Use a loop to check the status once a minute. While it is being upgraded, the
         custom model has the status `upgrading`. When the upgrade is complete, the model
-        resumes the status that it had prior to upgrade. The service cannot accept
-        subsequent requests for the model until the upgrade completes.
+        resumes the status that it had prior to upgrade. The service cannot upgrade a
+        model while it is handling another request for the model. The service cannot
+        accept subsequent requests for the model until the existing upgrade request
+        completes.
         If the custom acoustic model was trained with a separately created custom language
         model, you must use the `custom_language_model_id` parameter to specify the GUID
         of that custom language model. The custom language model must be upgraded before
@@ -2600,21 +2619,21 @@ def add_audio(self,
         efficient than adding each file individually. You can add audio resources in any
         format that the service supports for speech recognition.
         You can use this method to add any number of audio resources to a custom model by
-        calling the method once for each audio or archive file. But the addition of one
-        audio resource must be fully complete before you can add another. You must add a
-        minimum of 10 minutes and a maximum of 200 hours of audio that includes speech,
-        not just silence, to a custom acoustic model before you can train it. No audio
-        resource, audio- or archive-type, can be larger than 100 MB. To add an audio
-        resource that has the same name as an existing audio resource, set the
-        `allow_overwrite` parameter to `true`; otherwise, the request fails.
+        calling the method once for each audio or archive file. You can add multiple
+        different audio resources at the same time. You must add a minimum of 10 minutes
+        and a maximum of 200 hours of audio that includes speech, not just silence, to a
+        custom acoustic model before you can train it. No audio resource, audio- or
+        archive-type, can be larger than 100 MB. To add an audio resource that has the
+        same name as an existing audio resource, set the `allow_overwrite` parameter to
+        `true`; otherwise, the request fails.
         The method is asynchronous. It can take several seconds to complete depending on
         the duration of the audio and, in the case of an archive file, the total number of
         audio files being processed. The service returns a 201 response code if the audio
         is valid. It then asynchronously analyzes the contents of the audio file or files
         and automatically extracts information about the audio such as its length,
-        sampling rate, and encoding. You cannot submit requests to add additional audio
-        resources to a custom acoustic model, or to train the model, until the service's
-        analysis of all audio files for the current request completes.
+        sampling rate, and encoding. You cannot submit requests to train or upgrade the
+        model until the service's analysis of all audio resources for current requests
+        completes.
         To determine the status of the service's analysis of the audio, use the **Get an
         audio resource** method to poll the status of the audio. The method accepts the
         customization ID of the custom model and the name of the audio resource, and it
@@ -2671,13 +2690,9 @@ def add_audio(self,
         have the same format.
         Do not use the `Contained-Content-Type` header when adding an audio-type resource.
         ### Naming restrictions for embedded audio files
-         The name of an audio file that is embedded within an archive-type resource must
-        meet the following restrictions:
-        * Include a maximum of 128 characters in the file name; this includes the file
-        extension.
-        * Do not include spaces, slashes, or backslashes in the file name.
-        * Do not use the name of an audio file that has already been added to the custom
-        model as part of an archive-type resource.
+         The name of an audio file that is contained in an archive-type resource can
+        include a maximum of 128 characters. This includes the file extension and all
+        elements of the name (for example, slashes).
 
         :param str customization_id: The customization ID (GUID) of the custom acoustic
         model that is to be used for the request. You must make the request with
@@ -2686,7 +2701,11 @@ def add_audio(self,
         model. Use a localized name that matches the language of the custom model and
         reflects the contents of the resource.
         * Include a maximum of 128 characters in the name.
-        * Do not include spaces, slashes, or backslashes in the name.
+        * Do not use characters that need to be URL-encoded. For example, do not use
+        spaces, slashes, backslashes, colons, ampersands, double quotes, plus signs,
+        equals signs, questions marks, and so on in the name. (The service does not
+        prevent the use of these characters. But because they must be URL-encoded wherever
+        used, their use is strongly discouraged.)
         * Do not use the name of an audio resource that has already been added to the
         custom model.
         :param file audio_resource: The audio resource that is to be added to the custom
@@ -2808,12 +2827,13 @@ def delete_audio(self, customization_id, audio_name, **kwargs):
         Delete an audio resource.
 
         Deletes an existing audio resource from a custom acoustic model. Deleting an
-        archive-type audio resource removes the entire archive of files; the current
-        interface does not allow deletion of individual files from an archive resource.
+        archive-type audio resource removes the entire archive of files. The service does
+        not allow deletion of individual files from an archive resource.
         Removing an audio resource does not affect the custom model until you train the
         model on its updated data by using the **Train a custom acoustic model** method.
-        You must use credentials for the instance of the service that owns a model to
-        delete its audio resources.
+        You can delete an existing audio resource from a model while a different resource
+        is being added to the model. You must use credentials for the instance of the
+        service that owns a model to delete its audio resources.
         **See also:** [Deleting an audio resource from a custom acoustic
         model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAudio#deleteAudio).
 
@@ -2905,6 +2925,10 @@ class AcousticModel(object):
     :attr str created: (optional) The date and time in Coordinated Universal Time (UTC) at
     which the custom acoustic model was created. The value is provided in full ISO 8601
     format (`YYYY-MM-DDThh:mm:ss.sTZD`).
+    :attr str updated: (optional) The date and time in Coordinated Universal Time (UTC) at
+    which the custom acoustic model was last modified. The `created` and `updated` fields
+    are equal when an acoustic model is first added but has yet to be updated. The value
+    is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
     :attr str language: (optional) The language identifier of the custom acoustic model
     (for example, `en-US`).
     :attr list[str] versions: (optional) A list of the available versions of the custom
