Class: Google::Cloud::Speech::V1::StreamingRecognizeResponse
- Inherits:
-
Object
- Object
- Google::Cloud::Speech::V1::StreamingRecognizeResponse
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/speech/v1/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, and single_utterance
is set to false, then no messages are streamed
back to the client.
Here's an example of a series 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
-
#error ⇒ ::Google::Rpc::Status
If set, returns a google.rpc.Status message that specifies the error for the operation.
-
#results ⇒ ::Array<::Google::Cloud::Speech::V1::StreamingRecognitionResult>
This repeated list contains zero or more results that correspond to consecutive portions of the audio currently being processed.
-
#speech_event_type ⇒ ::Google::Cloud::Speech::V1::StreamingRecognizeResponse::SpeechEventType
Indicates the type of speech event.
-
#total_billed_time ⇒ ::Google::Protobuf::Duration
When available, billed audio seconds for the stream.
Instance Attribute Details
#error ⇒ ::Google::Rpc::Status
Returns If set, returns a google.rpc.Status message that specifies the error for the operation.
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 |
# File 'proto_docs/google/cloud/speech/v1/cloud_speech.rb', line 736 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_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 (although it may subsequently return # additional results). The client should stop sending additional audio # data, half-close the gRPC connection, and wait for any additional results # until the server closes the gRPC connection. This event is only sent if # `single_utterance` was set to `true`, and is not used otherwise. END_OF_SINGLE_UTTERANCE = 1 end end |
#results ⇒ ::Array<::Google::Cloud::Speech::V1::StreamingRecognitionResult>
Returns This repeated list contains zero or more results that
correspond to consecutive portions of the audio currently being processed.
It contains zero or one is_final=true
result (the newly settled portion),
followed by zero or more is_final=false
results (the interim results).
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 |
# File 'proto_docs/google/cloud/speech/v1/cloud_speech.rb', line 736 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_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 (although it may subsequently return # additional results). The client should stop sending additional audio # data, half-close the gRPC connection, and wait for any additional results # until the server closes the gRPC connection. This event is only sent if # `single_utterance` was set to `true`, and is not used otherwise. END_OF_SINGLE_UTTERANCE = 1 end end |
#speech_event_type ⇒ ::Google::Cloud::Speech::V1::StreamingRecognizeResponse::SpeechEventType
Returns Indicates the type of speech event.
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 |
# File 'proto_docs/google/cloud/speech/v1/cloud_speech.rb', line 736 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_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 (although it may subsequently return # additional results). The client should stop sending additional audio # data, half-close the gRPC connection, and wait for any additional results # until the server closes the gRPC connection. This event is only sent if # `single_utterance` was set to `true`, and is not used otherwise. END_OF_SINGLE_UTTERANCE = 1 end end |
#total_billed_time ⇒ ::Google::Protobuf::Duration
Returns When available, billed audio seconds for the stream. Set only if this is the last response in the stream.
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 |
# File 'proto_docs/google/cloud/speech/v1/cloud_speech.rb', line 736 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_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 (although it may subsequently return # additional results). The client should stop sending additional audio # data, half-close the gRPC connection, and wait for any additional results # until the server closes the gRPC connection. This event is only sent if # `single_utterance` was set to `true`, and is not used otherwise. END_OF_SINGLE_UTTERANCE = 1 end end |