Struct StreamingRecognizeResponse 

#[non_exhaustive]
pub struct StreamingRecognizeResponse {
    pub results: Vec<StreamingRecognitionResult>,
    pub speech_event_type: SpeechEventType,
    pub speech_event_offset: Option<Duration>,
    pub metadata: Option<RecognitionResponseMetadata>,
    /* private fields */
}

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 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 (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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: SpeechEventType

Indicates the type of speech event.

speech_event_offset: Option<Duration>

Time offset between the beginning of the audio and event emission.

metadata: Option<RecognitionResponseMetadata>

Metadata about the recognition.

Implementations

impl StreamingRecognizeResponse

pub fn new() -> Self

pub fn set_results<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<StreamingRecognitionResult>,

Sets the value of results.

Example

use google_cloud_speech_v2::model::StreamingRecognitionResult;
let x = StreamingRecognizeResponse::new()
    .set_results([
        StreamingRecognitionResult::default()/* use setters */,
        StreamingRecognitionResult::default()/* use (different) setters */,
    ]);

pub fn set_speech_event_type<T: Into<SpeechEventType>>(self, v: T) -> Self

Sets the value of speech_event_type.

Example

use google_cloud_speech_v2::model::streaming_recognize_response::SpeechEventType;
let x0 = StreamingRecognizeResponse::new().set_speech_event_type(SpeechEventType::EndOfSingleUtterance);
let x1 = StreamingRecognizeResponse::new().set_speech_event_type(SpeechEventType::SpeechActivityBegin);
let x2 = StreamingRecognizeResponse::new().set_speech_event_type(SpeechEventType::SpeechActivityEnd);

pub fn set_speech_event_offset<T>(self, v: T) -> Self

where T: Into<Duration>,

Sets the value of speech_event_offset.

Example

use wkt::Duration;
let x = StreamingRecognizeResponse::new().set_speech_event_offset(Duration::default()/* use setters */);

pub fn set_or_clear_speech_event_offset<T>(self, v: Option<T>) -> Self

where T: Into<Duration>,

Sets or clears the value of speech_event_offset.

Example

use wkt::Duration;
let x = StreamingRecognizeResponse::new().set_or_clear_speech_event_offset(Some(Duration::default()/* use setters */));
let x = StreamingRecognizeResponse::new().set_or_clear_speech_event_offset(None::<Duration>);

pub fn set_metadata<T>(self, v: T) -> Self

where T: Into<RecognitionResponseMetadata>,

Sets the value of metadata.

Example

use google_cloud_speech_v2::model::RecognitionResponseMetadata;
let x = StreamingRecognizeResponse::new().set_metadata(RecognitionResponseMetadata::default()/* use setters */);

pub fn set_or_clear_metadata<T>(self, v: Option<T>) -> Self

where T: Into<RecognitionResponseMetadata>,

Sets or clears the value of metadata.

Example

use google_cloud_speech_v2::model::RecognitionResponseMetadata;
let x = StreamingRecognizeResponse::new().set_or_clear_metadata(Some(RecognitionResponseMetadata::default()/* use setters */));
let x = StreamingRecognizeResponse::new().set_or_clear_metadata(None::<RecognitionResponseMetadata>);

Trait Implementations

impl Clone for StreamingRecognizeResponse

fn clone(&self) -> StreamingRecognizeResponse

Returns a duplicate 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 typename() -> &'static str

The typename of this message.

impl PartialEq for StreamingRecognizeResponse

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StreamingRecognizeResponse