Cloud Speech V2 Client - Class StreamingRecognitionResult (1.7.0)

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

Generated from protobuf field repeated .google.cloud.speech.v2.SpeechRecognitionAlternative alternatives = 1;

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

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.

Generated from protobuf field repeated .google.cloud.speech.v2.SpeechRecognitionAlternative alternatives = 1;

Parameter
NameDescription
var array<Google\Cloud\Speech\V2\SpeechRecognitionAlternative>
Returns
TypeDescription
$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.

Generated from protobuf field bool is_final = 2;

Returns
TypeDescription
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.

Generated from protobuf field bool is_final = 2;

Parameter
NameDescription
var bool
Returns
TypeDescription
$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.

Generated from protobuf field float stability = 3;

Returns
TypeDescription
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.

Generated from protobuf field float stability = 3;

Parameter
NameDescription
var float
Returns
TypeDescription
$this

getResultEndOffset

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

Generated from protobuf field .google.protobuf.Duration result_end_offset = 4;

Returns
TypeDescription
Google\Protobuf\Duration|null

hasResultEndOffset

clearResultEndOffset

setResultEndOffset

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

Generated from protobuf field .google.protobuf.Duration result_end_offset = 4;

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$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.

Generated from protobuf field int32 channel_tag = 5;

Returns
TypeDescription
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.

Generated from protobuf field int32 channel_tag = 5;

Parameter
NameDescription
var int
Returns
TypeDescription
$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.

Generated from protobuf field string language_code = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
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.

Generated from protobuf field string language_code = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
var string
Returns
TypeDescription
$this