Struct gcp_client::google::cloud::speech::v1::StreamingRecognizeResponse

pub struct StreamingRecognizeResponse {
    pub error: Option<Status>,
    pub results: Vec<StreamingRecognitionResult>,
    pub speech_event_type: i32,
}

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

Fields

error: Option<Status>

If set, returns a [google.rpc.Status][google.rpc.Status] message that specifies the error for the operation.

results: Vec<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_event_type: i32

Indicates the type of speech event.

Implementations

impl StreamingRecognizeResponse

pub fn speech_event_type(&self) -> SpeechEventType

Returns the enum value of speech_event_type, or the default if the field is set to an invalid enum value.

pub fn set_speech_event_type(&mut self, value: SpeechEventType)

Sets speech_event_type to the provided enum value.

Trait Implementations

impl Clone for StreamingRecognizeResponse

fn clone(&self) -> StreamingRecognizeResponse

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StreamingRecognizeResponse

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for StreamingRecognizeResponse

fn default() -> StreamingRecognizeResponse

Returns the "default value" for a type.

impl Message for StreamingRecognizeResponse

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<StreamingRecognizeResponse> for StreamingRecognizeResponse

fn eq(&self, other: &StreamingRecognizeResponse) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &StreamingRecognizeResponse) -> bool

This method tests for !=.

impl StructuralPartialEq for StreamingRecognizeResponse