Cloud Speech-to-Text V1 API - Class Google::Cloud::Speech::V1::StreamingRecognizeResponse (v0.17.0)

Reference documentation and code samples for the Cloud Speech-to-Text V1 API class Google::Cloud::Speech::V1::StreamingRecognizeResponse.

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 StreamingRecognizeResponses that might be returned while processing audio:

  1. results { alternatives { transcript: "tube" } stability: 0.01 }

  2. results { alternatives { transcript: "to be a" } stability: 0.01 }

  3. results { alternatives { transcript: "to be" } stability: 0.9 } results { alternatives { transcript: " or not to be" } stability: 0.01 }

  4. results { alternatives { transcript: "to be or not to be" confidence: 0.92 } alternatives { transcript: "to bee or not to bee" } is_final: true }

  5. results { alternatives { transcript: " that's" } stability: 0.01 }

  6. results { alternatives { transcript: " that is" } stability: 0.9 } results { alternatives { transcript: " the question" } stability: 0.01 }

  7. 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 interim results: 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 stability results.

  • The specific stability and confidence 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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#error

def error() -> ::Google::Rpc::Status
Returns

#error=

def error=(value) -> ::Google::Rpc::Status
Parameter
Returns

#request_id

def request_id() -> ::Integer
Returns
  • (::Integer) — The ID associated with the request. This is a unique ID specific only to the given request.

#request_id=

def request_id=(value) -> ::Integer
Parameter
  • value (::Integer) — The ID associated with the request. This is a unique ID specific only to the given request.
Returns
  • (::Integer) — The ID associated with the request. This is a unique ID specific only to the given request.

#results

def results() -> ::Array<::Google::Cloud::Speech::V1::StreamingRecognitionResult>
Returns
  • (::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. 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).

#results=

def results=(value) -> ::Array<::Google::Cloud::Speech::V1::StreamingRecognitionResult>
Parameter
  • value (::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. 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).
Returns
  • (::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. 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).

#speech_adaptation_info

def speech_adaptation_info() -> ::Google::Cloud::Speech::V1::SpeechAdaptationInfo
Returns

#speech_adaptation_info=

def speech_adaptation_info=(value) -> ::Google::Cloud::Speech::V1::SpeechAdaptationInfo
Parameter
Returns

#speech_event_time

def speech_event_time() -> ::Google::Protobuf::Duration
Returns

#speech_event_time=

def speech_event_time=(value) -> ::Google::Protobuf::Duration
Parameter
Returns

#speech_event_type

def speech_event_type() -> ::Google::Cloud::Speech::V1::StreamingRecognizeResponse::SpeechEventType
Returns

#speech_event_type=

def speech_event_type=(value) -> ::Google::Cloud::Speech::V1::StreamingRecognizeResponse::SpeechEventType
Parameter
Returns

#total_billed_time

def total_billed_time() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) — When available, billed audio seconds for the stream. Set only if this is the last response in the stream.

#total_billed_time=

def total_billed_time=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) — When available, billed audio seconds for the stream. Set only if this is the last response in the stream.
Returns
  • (::Google::Protobuf::Duration) — When available, billed audio seconds for the stream. Set only if this is the last response in the stream.