Google Cloud Dialogflow Cx V3 Client - Class StreamingRecognitionResult (0.4.1)

Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class StreamingRecognitionResult.

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.

While end-user audio is being processed, Dialogflow sends a series of results. Each result may contain a transcript value. A transcript represents a portion of the utterance. While the recognizer is processing audio, transcript values may be interim values or finalized values. Once a transcript is finalized, the is_final value is set to true and processing continues for the next transcript. If StreamingDetectIntentRequest.query_input.audio.config.single_utterance was true, and the recognizer has completed processing audio, the message_type value is set to `END_OF_SINGLE_UTTERANCE and the following (last) result contains the last finalized transcript. The complete end-user utterance is determined by concatenating the finalized transcript values received for the series of results. In the following example, single utterance is enabled. In the case where single utterance is not enabled, result 7 would not occur.

Num | transcript              | message_type            | is_final
--- | ----------------------- | ----------------------- | --------
1   | "tube"                  | TRANSCRIPT              | false
2   | "to be a"               | TRANSCRIPT              | false
3   | "to be"                 | TRANSCRIPT              | false
4   | "to be or not to be"    | TRANSCRIPT              | true
5   | "that's"                | TRANSCRIPT              | false
6   | "that is                | TRANSCRIPT              | false
7   | unset                   | END_OF_SINGLE_UTTERANCE | unset
8   | " that is the question" | TRANSCRIPT              | true

Concatenating the finalized transcripts with is_final set to true, the complete utterance becomes "to be or not to be that is the question".

Generated from protobuf message google.cloud.dialogflow.cx.v3.StreamingRecognitionResult

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ message_type int

Type of the result message.
↳ transcript string

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

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.
↳ confidence float

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.
↳ stability float

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.
↳ speech_word_info array<Google\Cloud\Dialogflow\Cx\V3\SpeechWordInfo>

Word-specific information for the words recognized by Speech in transcript. Populated if and only if message_type = TRANSCRIPT and [InputAudioConfig.enable_word_info] is set.
↳ speech_end_offset Google\Protobuf\Duration

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

Detected language code for the transcript.

getMessageType

Type of the result message.

Returns
Type Description
int

setMessageType

Type of the result message.

Parameter
Name Description
var int
Returns
Type Description
$this

getTranscript

Transcript text representing the words that the user spoke.

Populated if and only if message_type = TRANSCRIPT.

Returns
Type Description
string

setTranscript

Transcript text representing the words that the user spoke.

Populated if and only if message_type = TRANSCRIPT.

Parameter
Name Description
var string
Returns
Type Description
$this

getIsFinal

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.

Returns
Type Description
bool

setIsFinal

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.

Parameter
Name Description
var bool
Returns
Type Description
$this

getConfidence

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.

Returns
Type Description
float

setConfidence

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.

Parameter
Name Description
var float
Returns
Type Description
$this

getStability

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.

Returns
Type Description
float

setStability

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.

Parameter
Name Description
var float
Returns
Type Description
$this

getSpeechWordInfo

Word-specific information for the words recognized by Speech in transcript.

Populated if and only if message_type = TRANSCRIPT and [InputAudioConfig.enable_word_info] is set.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSpeechWordInfo

Word-specific information for the words recognized by Speech in transcript.

Populated if and only if message_type = TRANSCRIPT and [InputAudioConfig.enable_word_info] is set.

Parameter
Name Description
var array<Google\Cloud\Dialogflow\Cx\V3\SpeechWordInfo>
Returns
Type Description
$this

getSpeechEndOffset

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

Returns
Type Description
Google\Protobuf\Duration|null

hasSpeechEndOffset

clearSpeechEndOffset

setSpeechEndOffset

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

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getLanguageCode

Detected language code for the transcript.

Returns
Type Description
string

setLanguageCode

Detected language code for the transcript.

Parameter
Name Description
var string
Returns
Type Description
$this