Class: Google::Cloud::Speech::V2::StreamingRecognizeResponse
- Inherits:
-
Object
- Object
- Google::Cloud::Speech::V2::StreamingRecognizeResponse
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/speech/v2/cloud_speech.rb
Overview
StreamingRecognizeResponse
is the only message returned to the client by
StreamingRecognize
. A series of zero or more StreamingRecognizeResponse
messages are streamed back to the client. If there is no recognizable
audio then no messages are streamed back to the client.
Here are some examples of StreamingRecognizeResponse
s that might
be returned while processing audio:
results { alternatives { transcript: "tube" } stability: 0.01 }
results { alternatives { transcript: "to be a" } stability: 0.01 }
results { alternatives { transcript: "to be" } stability: 0.9 } results { alternatives { transcript: " or not to be" } stability: 0.01 }
results { alternatives { transcript: "to be or not to be" confidence: 0.92 } alternatives { transcript: "to bee or not to bee" } is_final: true }
results { alternatives { transcript: " that's" } stability: 0.01 }
results { alternatives { transcript: " that is" } stability: 0.9 } results { alternatives { transcript: " the question" } stability: 0.01 }
results { alternatives { transcript: " that is the question" confidence: 0.98 } alternatives { transcript: " that was the question" } is_final: true }
Notes:
Only two of the above responses #4 and #7 contain final results; they are indicated by
is_final: true
. Concatenating these together generates the full transcript: "to be or not to be that is the question".The others contain interim
results
. #3 and #6 contain two interimresults
: the first portion has a high stability and is less likely to change; the second portion has a low stability and is very likely to change. A UI designer might choose to show only high stabilityresults
.The specific
stability
andconfidence
values shown above are only for illustrative purposes. Actual values may vary.In each response, only one of these fields will be set:
error
,speech_event_type
, or one or more (repeated)results
.
Defined Under Namespace
Modules: SpeechEventType
Instance Attribute Summary collapse
-
#metadata ⇒ ::Google::Cloud::Speech::V2::RecognitionResponseMetadata
Metadata about the recognition.
-
#results ⇒ ::Array<::Google::Cloud::Speech::V2::StreamingRecognitionResult>
This repeated list contains zero or more results that correspond to consecutive portions of the audio currently being processed.
-
#speech_event_offset ⇒ ::Google::Protobuf::Duration
Time offset between the beginning of the audio and event emission.
-
#speech_event_type ⇒ ::Google::Cloud::Speech::V2::StreamingRecognizeResponse::SpeechEventType
Indicates the type of speech event.
Instance Attribute Details
#metadata ⇒ ::Google::Cloud::Speech::V2::RecognitionResponseMetadata
Returns Metadata about the recognition.
1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 |
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1287 class StreamingRecognizeResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Indicates the type of speech event. module SpeechEventType # No speech event specified. SPEECH_EVENT_TYPE_UNSPECIFIED = 0 # This event indicates that the server has detected the end of the user's # speech utterance and expects no additional speech. Therefore, the server # will not process additional audio and will close the gRPC bidirectional # stream. This event is only sent if there was a force cutoff due to # silence being detected early. This event is only available through the # `latest_short` {::Google::Cloud::Speech::V2::Recognizer#model model}. END_OF_SINGLE_UTTERANCE = 1 # This event indicates that the server has detected the beginning of human # voice activity in the stream. This event can be returned multiple times # if speech starts and stops repeatedly throughout the stream. This event # is only sent if `voice_activity_events` is set to true. SPEECH_ACTIVITY_BEGIN = 2 # This event indicates that the server has detected the end of human voice # activity in the stream. This event can be returned multiple times if # speech starts and stops repeatedly throughout the stream. This event is # only sent if `voice_activity_events` is set to true. SPEECH_ACTIVITY_END = 3 end end |
#results ⇒ ::Array<::Google::Cloud::Speech::V2::StreamingRecognitionResult>
1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 |
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1287 class StreamingRecognizeResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Indicates the type of speech event. module SpeechEventType # No speech event specified. SPEECH_EVENT_TYPE_UNSPECIFIED = 0 # This event indicates that the server has detected the end of the user's # speech utterance and expects no additional speech. Therefore, the server # will not process additional audio and will close the gRPC bidirectional # stream. This event is only sent if there was a force cutoff due to # silence being detected early. This event is only available through the # `latest_short` {::Google::Cloud::Speech::V2::Recognizer#model model}. END_OF_SINGLE_UTTERANCE = 1 # This event indicates that the server has detected the beginning of human # voice activity in the stream. This event can be returned multiple times # if speech starts and stops repeatedly throughout the stream. This event # is only sent if `voice_activity_events` is set to true. SPEECH_ACTIVITY_BEGIN = 2 # This event indicates that the server has detected the end of human voice # activity in the stream. This event can be returned multiple times if # speech starts and stops repeatedly throughout the stream. This event is # only sent if `voice_activity_events` is set to true. SPEECH_ACTIVITY_END = 3 end end |
#speech_event_offset ⇒ ::Google::Protobuf::Duration
Returns Time offset between the beginning of the audio and event emission.
1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 |
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1287 class StreamingRecognizeResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Indicates the type of speech event. module SpeechEventType # No speech event specified. SPEECH_EVENT_TYPE_UNSPECIFIED = 0 # This event indicates that the server has detected the end of the user's # speech utterance and expects no additional speech. Therefore, the server # will not process additional audio and will close the gRPC bidirectional # stream. This event is only sent if there was a force cutoff due to # silence being detected early. This event is only available through the # `latest_short` {::Google::Cloud::Speech::V2::Recognizer#model model}. END_OF_SINGLE_UTTERANCE = 1 # This event indicates that the server has detected the beginning of human # voice activity in the stream. This event can be returned multiple times # if speech starts and stops repeatedly throughout the stream. This event # is only sent if `voice_activity_events` is set to true. SPEECH_ACTIVITY_BEGIN = 2 # This event indicates that the server has detected the end of human voice # activity in the stream. This event can be returned multiple times if # speech starts and stops repeatedly throughout the stream. This event is # only sent if `voice_activity_events` is set to true. SPEECH_ACTIVITY_END = 3 end end |
#speech_event_type ⇒ ::Google::Cloud::Speech::V2::StreamingRecognizeResponse::SpeechEventType
Returns Indicates the type of speech event.
1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 |
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1287 class StreamingRecognizeResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Indicates the type of speech event. module SpeechEventType # No speech event specified. SPEECH_EVENT_TYPE_UNSPECIFIED = 0 # This event indicates that the server has detected the end of the user's # speech utterance and expects no additional speech. Therefore, the server # will not process additional audio and will close the gRPC bidirectional # stream. This event is only sent if there was a force cutoff due to # silence being detected early. This event is only available through the # `latest_short` {::Google::Cloud::Speech::V2::Recognizer#model model}. END_OF_SINGLE_UTTERANCE = 1 # This event indicates that the server has detected the beginning of human # voice activity in the stream. This event can be returned multiple times # if speech starts and stops repeatedly throughout the stream. This event # is only sent if `voice_activity_events` is set to true. SPEECH_ACTIVITY_BEGIN = 2 # This event indicates that the server has detected the end of human voice # activity in the stream. This event can be returned multiple times if # speech starts and stops repeatedly throughout the stream. This event is # only sent if `voice_activity_events` is set to true. SPEECH_ACTIVITY_END = 3 end end |