Add Speech Streaming usage documentation. #2483

daspecster · 2016-10-03T18:57:40Z

Speech streaming has some implications to it that I think could be good to talk about.

What kind of inputs should we support or is just a file correct for now?
Should a context manager be used outside of the client or in the client.stream_recognize() method itself?
If interum_results is True, should we yield the results as we receive them?

daspecster · 2016-10-06T22:49:33Z

@tseaver @dhermes LMK if you have any feedback for this. I updated it with the changes from #2495.

dhermes

My nits aren't really with these docs, they are with the implementation. WDYT?

docs/speech-usage.rst

+
+    >>> results = client.stream_recognize('hello.flac', 'FLAC', 44100,
+    ...                                   interim_results=True)
+    >>> print results


docs/speech-usage.rst

+    0.96976006031
+
+For continuous speech containing more than one word, the ``single_utterance``
+option should be disabled.


docs/speech-usage.rst

+
+    >>> from google.cloud import speech
+    >>> client = speech.Client()
+    >>> results = client.stream_recognize('hello.flac', 'FLAC', 44100)


docs/speech-usage.rst

+    >>> results[2].alternatives[0].transcript
+    hello
+    >>> results[2].alternatives[0].confidence
+    0.96976006031


docs/speech-usage.rst

+        }
+        is_final: true
+    }
+    ]


docs/speech-usage.rst

@@ -97,6 +97,7 @@ Great Britian.
     transcript: Hello, this is one test
     confidence: 0

+


docs/speech-usage.rst

+    >>> sample = client.sample(source_uri='gs://my-bucket/recording.flac',
+    ...                        encoding=Encoding.FLAC,
+    ...                        sample_rate=44100)
+    >>> results = client.stream_recognize(sample, single_utterance=False)


docs/speech-usage.rst

+    ...                        encoding=Encoding.FLAC,
+    ...                        sample_rate=44100)
+    >>> results = client.stream_recognize(sample, interim_results=True)
+    >>> print results[0].alternatives.transcript


daspecster · 2016-10-10T20:19:58Z

I'm going to close this and make a new PR with the whole shebang.

daspecster added docs api: speech Issues related to the Speech-to-Text API. labels Oct 3, 2016

daspecster assigned tseaver and dhermes Oct 3, 2016

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

daspecster added 2 commits October 6, 2016 17:17

Add Speech Streaming usage documentation.

1671e4c

Update per cleanup changes.

4456756

daspecster force-pushed the speech-streaming branch from d301917 to 4456756 Compare October 6, 2016 21:29

dhermes reviewed Oct 7, 2016

View reviewed changes

daspecster mentioned this pull request Oct 7, 2016

Move speech methods to Sample. #2516

Closed

daspecster closed this Oct 10, 2016

theacodes unassigned dhermes Sep 28, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Speech Streaming usage documentation. #2483

Add Speech Streaming usage documentation. #2483

daspecster commented Oct 3, 2016

daspecster commented Oct 6, 2016

dhermes left a 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.

daspecster commented Oct 10, 2016

		@@ -97,6 +97,7 @@ Great Britian.
		transcript: Hello, this is one test
		confidence: 0

Add Speech Streaming usage documentation. #2483

Add Speech Streaming usage documentation. #2483

Conversation

daspecster commented Oct 3, 2016

daspecster commented Oct 6, 2016

dhermes 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.

daspecster commented Oct 10, 2016