Basic implementation of Speech API. #2344

Fematich · 2016-09-18T12:16:34Z

I have made a basic implementation of Speech API.
This currently only supports syncrecognize from the REST-API.

I think I followed all the contribution guidelines:

Documented in both the API and narrative documentation (in docs/).
Fully working on the following CPython versions: 2.7, 3.4, and 3.5 on both UNIX and Windows.
Feature added no new dependencies.

However, this is my first contribution, so in case I missed something, please let me know and I will see how to fix it!

tseaver

Thank you very much for the patch -- it is very well done!

docs/index.rst

@@ -230,3 +238,4 @@ Cloud Storage
  bucket = client.get_bucket('<your-bucket-name>')
  blob = bucket.blob('my-test-file.txt')
  blob.upload_from_string('this is test content!')
+


docs/speech-usage.rst

+
+At this moment we only support one method of the Speech API:
+
+- `syncrecognize`_


docs/speech-usage.rst

+
+- `syncrecognize`_
+
+Synchronous Recognize


docs/speech-usage.rst

+---------------------
+
+The :meth:`~google.cloud.speech.Client.syncrecognize` method
+does speech to text on a file and returns the text


docs/speech-usage.rst

+
+The :meth:`~google.cloud.speech.Client.syncrecognize` method
+does speech to text on a file and returns the text
+as a :class:`list` of tuples dicts (each containing a transcript an a confidence value).


google/cloud/speech/client.py

+        for param_name, param in required_params:
+            if param is None:
+                message = '%r cannot be None' % (param_name)
+                raise ValueError(message)


google/cloud/speech/client.py

+            if param is None:
+                message = '%r cannot be None' % (param_name)
+                raise ValueError(message)
+        config = dict(required_params)


google/cloud/speech/client.py

+                ('maxAlternatives', max_alternatives),
+                ('profanityFilter', profanity_filter)]:
+            if param is not None:
+                config[param_name] = param


unit_tests/speech/test_client.py

+                                                        sample_rate,
+                                                        max_alternatives=2,
+                                                        speech_context=hints)
+        self.assertEqual(speechrecognition_result[0]["transcript"], 'hello')


unit_tests/speech/test_client.py

+        with self.assertRaises(ValueError):
+            client.syncrecognize(None, None, None, None)
+        with self.assertRaises(ValueError):
+            client.syncrecognize(None, "uri", None, None)


…partly updated docs

Fematich · 2016-09-18T23:42:51Z

Thank you for your feedback! I have implemented your suggestions, except for the additional examples with extra arguments in the docs. I will try to finish this tomorrow.

google/cloud/speech/client.py

-                      supported, which must be specified in the following
-                      format: gs://bucket_name/object_name
+        :type content: bytes
+        :param content: Byte stream of audio.


daspecster

Awesome! Thank you!

google/cloud/speech/client.py

+    """Client to bundle configuration needed for API requests.
+
+    :type project: str
+    :param project: the project which the client acts on behalf of. Will be


google/cloud/speech/client.py

+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Basic client for Google Cloud Speech API."""


docs/index.rst

@@ -229,4 +237,4 @@ Cloud Storage
  client = storage.Client()
  bucket = client.get_bucket('<your-bucket-name>')
  blob = bucket.blob('my-test-file.txt')
-  blob.upload_from_string('this is test content!')
+  blob.upload_from_string('this is test content!')


docs/speech-usage.rst

+  .. code-block:: python
+
+     >>> alternatives = client.sync_recognize(None,"gs://my-bucket/recording.flac",
+     ...                 "FLAC", 16000, max_alternatives=2):


docs/speech-usage.rst

+     >>> for alternative in alternatives:
+     ...     print('=' * 20)
+     ...     print('   transcript: %s' % (alternative["transcript"],))
+     ...     print('   confidence: %s' % (alternative["confidence"],))


docs/speech-usage.rst

+     ...     print('   confidence: %s' % (alternative["confidence"],))
+     ====================
+              transcript: Hello, this is a test
+              confidence: 0.81


google/cloud/speech/__init__.py

+
+"""Google Cloud Speech API wrapper."""
+
+from google.cloud.speech.client import Client, Encoding


unit_tests/speech/test_client.py

+        response = client.sync_recognize(_AUDIO_CONTENT,
+                                         encoding,
+                                         self.SAMPLE_RATE,
+                                         language_code="EN",


unit_tests/speech/test_client.py

+
+        self.assertEqual(REQUEST,
+                         client.connection._requested[0]['data'])
+        self.assertEqual(response[0]["transcript"], 'hello')


unit_tests/speech/test_client.py

+            },
+            "audio": {
+                "content": _B64_AUDIO_CONTENT
+            }


unit_tests/speech/test_client.py

+
+        self.assertEqual(REQUEST,
+                         client.connection._requested[0]['data'])
+        self.assertEqual(response[0]["transcript"], 'hello')


unit_tests/speech/test_client.py

+
+class _Credentials(object):
+
+    _scopes = ('https://www.googleapis.com/auth/cloud-platform')


dhermes · 2016-09-19T16:38:05Z

@Fematich Really great work! Especially impressed that you have Travis 100% green on your first try!

Fematich · 2016-09-20T22:59:14Z

I have updated the code (included source_uri again and updated formatting/unit_tests).
I still have to expand speech-usage.rst and the more comprehensive checking of the contents of client.connection._requested and response

google/cloud/speech/client.py

+
+        :type source_uri: str
+        :param source_uri: URI that points to a file that contains audio
+                      data bytes as specified in RecognitionConfig.


google/cloud/speech/client.py

+                    between 0 and 1.
+        """
+
+        if (content is None) and (source_uri is None):


google/cloud/speech/client.py

+            raise ValueError('content and source_uri cannot be both equal to\
+                             None')
+
+        if (content is not None) and (source_uri is not None):


google/cloud/speech/client.py

+        """
+
+        if (content is None) and (source_uri is None):
+            raise ValueError('content and source_uri cannot be both equal to\


google/cloud/speech/client.py

+                             None')
+
+        if (content is not None) and (source_uri is not None):
+            raise ValueError('content and source_uri cannot be both different from\


google/cloud/speech/client.py

+        if sample_rate is None:
+            raise ValueError('sample_rate cannot be None')
+
+        if content is not None:


unit_tests/speech/_fixtures.py

+}
+
+SYNC_RECOGNIZE_EMPTY_RESPONSE = {
+    'results': []


unit_tests/speech/test_client.py

+
+import unittest
+
+_AUDIO_SOURCE_URI = 'gs://sample-bucket/sample-recording.flac'


tseaver · 2016-09-21T14:46:13Z

@Fematich Thanks for addressing my review issues. I'll let @dhermes finish the review and merge. Thanks again for your work!

dhermes · 2016-09-21T17:22:07Z

I'm going to merge as-is. I'll send a PR addressing most of my concerns. Remaining issues outside of that PR will be:

dhermes · 2016-09-21T17:29:06Z

@Fematich Thanks for your great work! We decided to go ahead and merge to speed up the process.

We'd like to get this library feature-complete ASAP so we didn't want the review cycle to slow us down on getting the first chunks in. From here, a person working on this library full-time will take it to the finish line. You were great!

Fematich · 2016-09-21T18:15:19Z

Thank you it was a pleasure :-)!

Review cleanup for PR #2344.

Updates from #2344 for speech API.

Updates from googleapis#2344 for speech API.

Fematich and others added 5 commits September 17, 2016 20:20

First basic implementation of Speech API

4920223

unit_test + pep8 + start documentation

dce33a7

Added Speech API to index of docs

bdf141a

Fully tested basic implementation of Speech API

2a4a6b8

Delete build.zip

a542b6d

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Sep 18, 2016

tseaver added the api: speech Issues related to the Speech-to-Text API. label Sep 18, 2016

tseaver suggested changes Sep 18, 2016

View reviewed changes

Fematich added 2 commits September 19, 2016 01:24

sync_recognize rename, drop source_uri support, update unit_test and …

a5f9c0b

…partly updated docs

resolve newlines at end of files (commit from Windows vs. Linux)

c64e5ff

tseaver reviewed Sep 18, 2016

View reviewed changes

daspecster reviewed Sep 19, 2016

View reviewed changes

dhermes suggested changes Sep 19, 2016

View reviewed changes

included source_uri again and updated formatting/unit_tests

988b7d6

dhermes reviewed Sep 20, 2016

View reviewed changes

google/cloud/speech/client.py

:type source_uri: str

:param source_uri: URI that points to a file that contains audio

data bytes as specified in RecognitionConfig.

This comment was marked as spam.

Sign in to view

dhermes reviewed Sep 21, 2016

View reviewed changes

google/cloud/speech/client.py

between 0 and 1.

"""

if (content is None) and (source_uri is None):

This comment was marked as spam.

Sign in to view

dhermes reviewed Sep 21, 2016

View reviewed changes

google/cloud/speech/client.py

raise ValueError('content and source_uri cannot be both equal to\

None')

if (content is not None) and (source_uri is not None):

This comment was marked as spam.

Sign in to view

dhermes reviewed Sep 21, 2016

View reviewed changes

google/cloud/speech/client.py

"""

if (content is None) and (source_uri is None):

raise ValueError('content and source_uri cannot be both equal to\

This comment was marked as spam.

Sign in to view

dhermes reviewed Sep 21, 2016

View reviewed changes

google/cloud/speech/client.py

None')

if (content is not None) and (source_uri is not None):

raise ValueError('content and source_uri cannot be both different from\

This comment was marked as spam.

Sign in to view

dhermes reviewed Sep 21, 2016

View reviewed changes

unit_tests/speech/_fixtures.py

}

SYNC_RECOGNIZE_EMPTY_RESPONSE = {

'results': []

This comment was marked as spam.

Sign in to view

dhermes reviewed Sep 21, 2016

View reviewed changes

unit_tests/speech/test_client.py

import unittest

_AUDIO_SOURCE_URI = 'gs://sample-bucket/sample-recording.flac'

This comment was marked as spam.

Sign in to view

tseaver approved these changes Sep 21, 2016

View reviewed changes

dhermes approved these changes Sep 21, 2016

View reviewed changes

dhermes merged commit ddee548 into googleapis:master Sep 21, 2016

dhermes added a commit to dhermes/google-cloud-python that referenced this pull request Sep 21, 2016

Review cleanup for PR googleapis#2344.

29dc08a

dhermes added a commit that referenced this pull request Sep 21, 2016

Merge pull request #2376 from dhermes/Fematich-fixup

1f223f2

Review cleanup for PR #2344.

dhermes mentioned this pull request Sep 29, 2016

Manually cut releases of each package #2441

Closed

daspecster added a commit to daspecster/google-cloud-python that referenced this pull request Oct 4, 2016

Updates from googleapis#2344 for speech API.

8a35c54

daspecster mentioned this pull request Oct 4, 2016

Updates from #2344 for speech API. #2495

Merged

daspecster added a commit that referenced this pull request Oct 6, 2016

Merge pull request #2495 from daspecster/cleanup-speech

fb10016

Updates from #2344 for speech API.

dhermes mentioned this pull request Nov 14, 2016

Upgrading core to version to 0.21.0. #2733

Merged

dhermes mentioned this pull request Dec 9, 2016

Update versions for mega-release. #2846

Merged

richkadel pushed a commit to richkadel/google-cloud-python that referenced this pull request May 6, 2017

Merge pull request googleapis#2495 from daspecster/cleanup-speech

db307dc

Updates from googleapis#2344 for speech API.

atulep pushed a commit that referenced this pull request Apr 3, 2023

Updates from #2344 for speech API.

a88c995

atulep pushed a commit that referenced this pull request Apr 18, 2023

Updates from #2344 for speech API.

aff38f5

parthea pushed a commit that referenced this pull request Oct 22, 2023

Updates from #2344 for speech API.

f970915


		At this moment we only support one method of the Speech API:

		- `syncrecognize`_


		"""Google Cloud Speech API wrapper."""

		from google.cloud.speech.client import Client, Encoding


		class _Credentials(object):

		_scopes = ('https://www.googleapis.com/auth/cloud-platform')


		import unittest

		_AUDIO_SOURCE_URI = 'gs://sample-bucket/sample-recording.flac'

Basic implementation of Speech API. #2344

Basic implementation of Speech API. #2344

Conversation

Fematich commented Sep 18, 2016

tseaver left a comment

Choose a reason for hiding this comment

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

Fematich commented Sep 18, 2016

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

daspecster left a comment

Choose a reason for hiding this comment

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

dhermes commented Sep 19, 2016

Fematich commented Sep 20, 2016

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

tseaver commented Sep 21, 2016

dhermes commented Sep 21, 2016

dhermes commented Sep 21, 2016

Fematich commented Sep 21, 2016