Merge branch 'master' of github.com:watson-developer-cloud/python-sdk

Author: jsstylos

test/test_speech_to_text_v1.py

@@ -141,3 +141,76 @@ def test_custom_corpora():
                                  corpus_name='corpus')
 
     assert len(responses.calls) == 4
+
+@responses.activate
+def test_custom_words():
+    words_url = 'https://stream.watsonplatform.net/speech-to-text/api/v1/customizations/{0}/words'
+    word_url = 'https://stream.watsonplatform.net/speech-to-text/api/v1/customizations/{0}/words/{1}'
+
+    responses.add(responses.POST, word_url.format('custid','IEEE'),
+                 body='{"get response": "yep"}',
+                 status=200,
+                 content_type='application/json')
+
+    responses.add(responses.DELETE, word_url.format('custid', 'IEEE'),
+                  body='{"get response": "yep"}',
+                  status=200,
+                  content_type='application/json')
+
+    responses.add(responses.GET, word_url.format('custid', 'IEEE'),
+                  body='{"get response": "yep"}',
+                  status=200,
+                  content_type='application/json')
+
+    responses.add(responses.POST, words_url.format('custid'),
+                 body='{"get response": "yep"}',
+                 status=200,
+                 content_type='application/json')
+
+    responses.add(responses.GET, words_url.format('custid'),
+                 body='{"get response": "yep"}',
+                 status=200,
+                 content_type='application/json')
+
+    speech_to_text = watson_developer_cloud.SpeechToTextV1(
+    username="username", password="password")
+
+    custom_word = speech_to_text.CustomWord(word="IEEE",
+                                            sounds_like=["i triple e"],
+                                            display_as="IEEE")
+
+
+    speech_to_text.add_custom_word(customization_id='custid',
+                                   custom_word=custom_word)
+
+    speech_to_text.delete_custom_word(customization_id='custid',
+                                      custom_word=custom_word)
+
+    speech_to_text.delete_custom_word(customization_id='custid',
+                                      custom_word='IEEE')
+
+    custom_words = [custom_word, custom_word, custom_word]
+    speech_to_text.add_custom_words(customization_id='custid',
+                                    custom_words=custom_words)
+
+    speech_to_text.get_custom_word(customization_id='custid',
+                                   custom_word="IEEE")
+
+    speech_to_text.get_custom_word(customization_id='custid',
+                                   custom_word=custom_word)
+
+    speech_to_text.list_custom_words(customization_id='custid')
+    speech_to_text.list_custom_words(customization_id='custid', sort='alphabetical')
+    with pytest.raises(KeyError) as keyerror:
+        speech_to_text.list_custom_words(customization_id='custid', sort='badsort')
+    assert 'sort must be alphabetical or count' in str(keyerror.value)
+
+    speech_to_text.list_custom_words(customization_id='custid', word_type='all')
+
+    with pytest.raises(KeyError) as keyerror:
+        speech_to_text.list_custom_words(customization_id='custid', word_type='badwordtype')
+    assert 'word type must be all, user, or corpora' in str(keyerror.value)
+
+    assert len(responses.calls) == 9
+
+

watson_developer_cloud/speech_to_text_v1.py

@@ -19,6 +19,7 @@
 from .watson_developer_cloud_service import WatsonDeveloperCloudService
 import json
 
+
 class SpeechToTextV1(WatsonDeveloperCloudService):
     default_url = "https://stream.watsonplatform.net/speech-to-text/api"
 
@@ -136,3 +137,92 @@ def delete_corpus(self, customization_id, corpus_name):
                             url=url.format(customization_id,
                                            corpus_name),
                             accept_json=True)
+
+    class CustomWord(object):
+        def __init__(self, word=None, sounds_like=None, display_as=None):
+            self._word = word
+            self._sounds_like = sounds_like
+            self._display_as = display_as
+
+        @property
+        def word(self):
+            return self._word
+
+        @property
+        def sounds_like(self):
+            return self._sounds_like
+
+        @property
+        def display_as(self):
+            return self._display_as
+
+        def __dict__(self):
+            return {'word': self.word,
+                    'sounds_like': self.sounds_like,
+                    'display_as': self.display_as}
+
+    def add_custom_words(self, customization_id, custom_words):
+        url = '/v1/customizations/{0}/words'
+        payload = {'words': [x.__dict__() for x in custom_words]}
+        return self.request(method='POST',
+                            url=url.format(customization_id),
+                            data=json.dumps(payload),
+                            headers={'content-type': 'application/json'},
+                            accept_json=True)
+
+    def add_custom_word(self, customization_id, custom_word):
+        url = '/v1/customizations/{0}/words/{1}'
+
+        custom_word_fragment = {'sounds_like': custom_word.sounds_like,
+                                'display_as': custom_word.display_as}
+        return self.request(method='POST',
+                            url=url.format(customization_id,
+                                           custom_word.word),
+                            data=json.dumps(custom_word_fragment),
+                            headers={'content-type': 'application/json'},
+                            accept_json=True)
+
+    def list_custom_words(self, customization_id, word_type=None, sort=None):
+        url = '/v1/customizations/{0}/words'
+        qs = {}
+
+        if word_type:
+            if word_type in ['all', 'user', 'corpora']:
+                qs['word_type'] = word_type
+            else:
+                raise KeyError('word type must be all, user, or corpora')
+
+        if sort:
+            if sort in ['alphabetical', 'count']:
+                qs['sort'] = sort
+            else:
+                raise KeyError('sort must be alphabetical or count')
+
+        return self.request(method='GET',
+                            url=url.format(customization_id),
+                            params=qs,
+                            accept_json=True)
+
+    def get_custom_word(self, customization_id, custom_word):
+        url = '/v1/customizations/{0}/words/{1}'
+        word = None
+        if isinstance(custom_word, str):
+            word = custom_word
+        else:
+            word = custom_word.word
+
+        return self.request(method='GET',
+                            url=url.format(customization_id, word),
+                            accept_json=True)
+
+    def delete_custom_word(self, customization_id, custom_word):
+        url = '/v1/customizations/{0}/words/{1}'
+        word = None
+        if isinstance(custom_word, str):
+            word = custom_word
+        else:
+            word = custom_word.word
+
+        return self.request(method='DELETE',
+                            url=url.format(customization_id, word),
+                            accept_json=True)