Merge pull request #393 from watson-developer-cloud/codegen/speech-to-text

Regenerate speech to text

Author: germanattanasio

test/unit/test_speech_to_text_v1.py

@@ -119,7 +119,7 @@ def test_recognitions():
     with open(
             os.path.join(os.path.dirname(__file__), '../../resources/speech.wav'),
             'rb') as audio_file:
-        speech_to_text.create_job(audio=audio_file)
+        speech_to_text.create_job(audio=audio_file, content_type='audio/basic')
     assert responses.calls[2].response.json() == {'status': 'waiting'}
 
     speech_to_text.delete_job('jobid')

watson_developer_cloud/speech_to_text_v1.py

@@ -72,7 +72,7 @@ def __init__(self, url=default_url, username=None, password=None):
             use_vcap_services=True)
 
     #########################
-    # models
+    # Models
     #########################
 
     def get_model(self, model_id):
@@ -113,7 +113,7 @@ def models(self):
         return self.list_models
 
     #########################
-    # recognize
+    # Sessionless
     #########################
 
     def recognize(self,
@@ -123,7 +123,7 @@ def recognize(self,
                   customization_weight=None,
                   version=None,
                   audio=None,
-                  content_type='audio/basic',
+                  content_type=None,
                   inactivity_timeout=None,
                   keywords=None,
                   keywords_threshold=None,
@@ -277,7 +277,7 @@ def recognize_with_websocket(self,
                                               headers)
 
     #########################
-    # asynchronous
+    # Asynchronous
     #########################
 
     def check_job(self, id):
@@ -307,12 +307,12 @@ def check_jobs(self):
 
     def create_job(self,
                    audio,
-                   content_type='audio/basic',
+                   content_type,
+                   model=None,
                    callback_url=None,
                    events=None,
                    user_token=None,
                    results_ttl=None,
-                   model=None,
                    customization_id=None,
                    acoustic_customization_id=None,
                    customization_weight=None,
@@ -332,11 +332,11 @@ def create_job(self,
 
         :param str audio: Audio to transcribe in the format specified by the `Content-Type` header.
         :param str content_type: The type of the input: audio/basic, audio/flac, audio/l16, audio/mp3, audio/mpeg, audio/mulaw, audio/ogg, audio/ogg;codecs=opus, audio/ogg;codecs=vorbis, audio/wav, audio/webm, audio/webm;codecs=opus, or audio/webm;codecs=vorbis.
+        :param str model: The identifier of the model to be used for the recognition request. (Use `GET /v1/models` for a list of available models.).
         :param str callback_url: A URL to which callback notifications are to be sent. The URL must already be successfully white-listed by using the `POST /v1/register_callback` method. Omit the parameter to poll the service for job completion and results. You can include the same callback URL with any number of job creation requests. Use the `user_token` query parameter to specify a unique user-specified string with each job to differentiate the callback notifications for the jobs.
         :param str events: If the job includes a callback URL, a comma-separated list of notification events to which to subscribe. Valid events are: `recognitions.started` generates a callback notification when the service begins to process the job. `recognitions.completed` generates a callback notification when the job is complete; you must use the `GET /v1/recognitions/{id}` method to retrieve the results before they time out or are deleted. `recognitions.completed_with_results` generates a callback notification when the job is complete; the notification includes the results of the request. `recognitions.failed` generates a callback notification if the service experiences an error while processing the job. Omit the parameter to subscribe to the default events: `recognitions.started`, `recognitions.completed`, and `recognitions.failed`. The `recognitions.completed` and `recognitions.completed_with_results` events are incompatible; you can specify only of the two events. If the job does not include a callback URL, omit the parameter.
         :param str user_token: If the job includes a callback URL, a user-specified string that the service is to include with each callback notification for the job; the token allows the user to maintain an internal mapping between jobs and notification events. If the job does not include a callback URL, omit the parameter.
         :param int results_ttl: The number of minutes for which the results are to be available after the job has finished. If not delivered via a callback, the results must be retrieved within this time. Omit the parameter to use a time to live of one week. The parameter is valid with or without a callback URL.
-        :param str model: The identifier of the model to be used for the recognition request. (Use `GET /v1/models` for a list of available models.).
         :param str customization_id: The GUID of a custom language model that is to be used with the request. The base model of the specified custom language model must match the model specified with the `model` parameter. You must make the request with service credentials created for the instance of the service that owns the custom model. By default, no custom language model is used.
         :param str acoustic_customization_id: The GUID of a custom acoustic model that is to be used with the request. The base model of the specified custom acoustic model must match the model specified with the `model` parameter. You must make the request with service credentials created for the instance of the service that owns the custom model. By default, no custom acoustic model is used.
         :param float customization_weight: If you specify a `customization_id` with the request, you can use the `customization_weight` parameter to tell the service how much weight to give to words from the custom language model compared to those from the base model for speech recognition.   Specify a value between 0.0 and 1.0. Unless a different customization weight was specified for the custom model when it was trained, the default value is 0.3. A customization weight that you specify overrides a weight that was specified when the custom model was trained.   The default value yields the best performance in general. Assign a higher value if your audio makes frequent use of OOV words from the custom model. Use caution when setting the weight: a higher value can improve the accuracy of phrases from the custom model's domain, but it can negatively affect  performance on non-domain phrases.
@@ -358,13 +358,15 @@ def create_job(self,
             raise ValueError('audio must be provided')
         if content_type is None:
             raise ValueError('content_type must be provided')
-        headers = {'Content-Type': content_type}
+        headers = {
+            'Content-Type': content_type
+        }
         params = {
+            'model': model,
             'callback_url': callback_url,
             'events': events,
             'user_token': user_token,
             'results_ttl': results_ttl,
-            'model': model,
             'customization_id': customization_id,
             'acoustic_customization_id': acoustic_customization_id,
             'customization_weight': customization_weight,
@@ -447,7 +449,7 @@ def unregister_callback(self, callback_url):
         return None
 
     #########################
-    # customLanguageModels
+    # Custom language models
     #########################
 
     def create_language_model(self,
@@ -631,7 +633,7 @@ def upgrade_language_model(self, customization_id):
         return None
 
     #########################
-    # customCorpora
+    # Custom corpora
     #########################
 
     def add_corpus(self,
@@ -734,7 +736,7 @@ def list_corpora(self, customization_id):
         return response
 
     #########################
-    # customWords
+    # Custom words
     #########################
 
     def add_word(self,
@@ -785,7 +787,7 @@ def add_words(self, customization_id, words):
             raise ValueError('customization_id must be provided')
         if words is None:
             raise ValueError('words must be provided')
-        words = [self._convert_model(x) for x in words]
+        words = [self._convert_model(x, CustomWord) for x in words]
         data = {'words': words}
         url = '/v1/customizations/{0}/words'.format(
             *self._encode_path_vars(customization_id))
@@ -1031,14 +1033,14 @@ def upgrade_acoustic_model(self,
         return None
 
     #########################
-    # customAudioResources
+    # Custom audio resources
     #########################
 
     def add_audio(self,
                   customization_id,
                   audio_name,
                   audio_resource,
-                  content_type='application/zip',
+                  content_type,
                   contained_content_type=None,
                   allow_overwrite=None):
         """
@@ -2382,6 +2384,8 @@ def _from_dict(cls, _dict):
             raise ValueError(
                 'Required property \'confidence\' not present in SpeakerLabelsResult JSON'
             )
+        if 'final_results' in _dict:
+            args['final_results'] = _dict['final_results']
         if 'final' in _dict:
             args['final_results'] = _dict['final']
         else:
@@ -2696,6 +2700,8 @@ def __init__(self,
     def _from_dict(cls, _dict):
         """Initialize a SpeechRecognitionResult object from a json dictionary."""
         args = {}
+        if 'final_results' in _dict:
+            args['final_results'] = _dict['final_results']
         if 'final' in _dict:
             args['final_results'] = _dict['final']
         else: