Class StreamingRecognitionResult (1.2.0) 

public sealed class StreamingRecognitionResult : IMessage<StreamingRecognitionResult>, IEquatable<StreamingRecognitionResult>, IDeepCloneable<StreamingRecognitionResult>, IBufferMessage, IMessage

Contains a speech recognition result corresponding to a portion of the audio that is currently being processed or an indication that this is the end of the single requested utterance.

Example:

  1. transcript: "tube"

  2. transcript: "to be a"

  3. transcript: "to be"

  4. transcript: "to be or not to be" is_final: true

  5. transcript: " that's"

  6. transcript: " that is"

  7. message_type: END_OF_SINGLE_UTTERANCE

  8. transcript: " that is the question" is_final: true

Only two of the responses contain final results (#4 and #8 indicated by is_final: true). Concatenating these generates the full transcript: "to be or not to be that is the question".

In each response we populate:

  • for TRANSCRIPT: transcript and possibly is_final.

  • for END_OF_SINGLE_UTTERANCE: only message_type.

Inheritance

Object > StreamingRecognitionResult

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

StreamingRecognitionResult()

public StreamingRecognitionResult()

StreamingRecognitionResult(StreamingRecognitionResult)

public StreamingRecognitionResult(StreamingRecognitionResult other)
Parameter
NameDescription
otherStreamingRecognitionResult

Properties

Confidence

public float Confidence { get; set; }

The Speech confidence between 0.0 and 1.0 for the current portion of audio. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set.

This field is typically only provided if is_final is true and you should not rely on it being accurate or even set.

Property Value
TypeDescription
Single

IsFinal

public bool IsFinal { get; set; }

If false, the StreamingRecognitionResult represents an interim result that may change. If true, the recognizer will not return any further hypotheses about this piece of the audio. May only be populated for message_type = TRANSCRIPT.

Property Value
TypeDescription
Boolean

MessageType

public StreamingRecognitionResult.Types.MessageType MessageType { get; set; }

Type of the result message.

Property Value
TypeDescription
StreamingRecognitionResult.Types.MessageType

SpeechEndOffset

public Duration SpeechEndOffset { get; set; }

Time offset of the end of this Speech recognition result relative to the beginning of the audio. Only populated for message_type = TRANSCRIPT.

Property Value
TypeDescription
Duration

SpeechWordInfo

public RepeatedField<SpeechWordInfo> SpeechWordInfo { get; }

Word-specific information for the words recognized by Speech in [transcript][google.cloud.dialogflow.cx.v3.StreamingRecognitionResult.transcript]. Populated if and only if message_type = TRANSCRIPT and [InputAudioConfig.enable_word_info] is set.

Property Value
TypeDescription
RepeatedField<SpeechWordInfo>

Stability

public float Stability { get; set; }

An estimate of the likelihood that the speech recognizer will not change its guess about this interim recognition result:

  • If the value is unspecified or 0.0, Dialogflow didn't compute the stability. In particular, Dialogflow will only provide stability for TRANSCRIPT results with is_final = false.
  • Otherwise, the value is in (0.0, 1.0] where 0.0 means completely unstable and 1.0 means completely stable.
Property Value
TypeDescription
Single

Transcript

public string Transcript { get; set; }

Transcript text representing the words that the user spoke. Populated if and only if message_type = TRANSCRIPT.

Property Value
TypeDescription
String