Cloud Speech V2 Client - Class StreamingRecognitionResult (1.9.1)

Reference documentation and code samples for the Cloud Speech V2 Client class StreamingRecognitionResult.

A streaming speech recognition result corresponding to a portion of the audio that is currently being processed.

Generated from protobuf message google.cloud.speech.v2.StreamingRecognitionResult

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ alternatives
array< Google\Cloud\Speech\V2\SpeechRecognitionAlternative >

May contain one or more recognition hypotheses. These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer.

↳ is_final
bool

If false , this StreamingRecognitionResult represents an interim result that may change. If true , this is the final time the speech service will return this particular StreamingRecognitionResult , the recognizer will not return any further hypotheses for this portion of the transcript and corresponding audio.

↳ stability
float

An estimate of the likelihood that the recognizer will not change its guess about this interim result. Values range from 0.0 (completely unstable) to 1.0 (completely stable). This field is only provided for interim results ( is_final = false ). The default of 0.0 is a sentinel value indicating stability was not set.

↳ result_end_offset
Google\Protobuf\Duration

Time offset of the end of this result relative to the beginning of the audio.

↳ channel_tag
int

For multi-channel audio, this is the channel number corresponding to the recognized result for the audio from that channel. For audio_channel_count = N , its output values can range from 1 to N .

↳ language_code
string

Output only. The BCP-47 language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio.

getAlternatives

May contain one or more recognition hypotheses. These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer.

Returns
Type
Description

setAlternatives

May contain one or more recognition hypotheses. These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer.

Parameter
Name
Description
Returns
Type
Description
$this

getIsFinal

If false , this StreamingRecognitionResult represents an interim result that may change. If true , this is the final time the speech service will return this particular StreamingRecognitionResult , the recognizer will not return any further hypotheses for this portion of the transcript and corresponding audio.

Returns
Type
Description
bool

setIsFinal

If false , this StreamingRecognitionResult represents an interim result that may change. If true , this is the final time the speech service will return this particular StreamingRecognitionResult , the recognizer will not return any further hypotheses for this portion of the transcript and corresponding audio.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getStability

An estimate of the likelihood that the recognizer will not change its guess about this interim result. Values range from 0.0 (completely unstable) to 1.0 (completely stable). This field is only provided for interim results ( is_final = false ).

The default of 0.0 is a sentinel value indicating stability was not set.

Returns
Type
Description
float

setStability

An estimate of the likelihood that the recognizer will not change its guess about this interim result. Values range from 0.0 (completely unstable) to 1.0 (completely stable). This field is only provided for interim results ( is_final = false ).

The default of 0.0 is a sentinel value indicating stability was not set.

Parameter
Name
Description
var
float
Returns
Type
Description
$this

getResultEndOffset

Time offset of the end of this result relative to the beginning of the audio.

Returns
Type
Description

hasResultEndOffset

clearResultEndOffset

setResultEndOffset

Time offset of the end of this result relative to the beginning of the audio.

Parameter
Name
Description
Returns
Type
Description
$this

getChannelTag

For multi-channel audio, this is the channel number corresponding to the recognized result for the audio from that channel.

For audio_channel_count = N , its output values can range from 1 to N .

Returns
Type
Description
int

setChannelTag

For multi-channel audio, this is the channel number corresponding to the recognized result for the audio from that channel.

For audio_channel_count = N , its output values can range from 1 to N .

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getLanguageCode

Output only. The BCP-47 language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio.

Returns
Type
Description
string

setLanguageCode

Output only. The BCP-47 language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio.

Parameter
Name
Description
var
string
Returns
Type
Description
$this