Cloud Speech V1 Client - Class StreamingRecognizeResponse (1.7.0)

Reference documentation and code samples for the Cloud Speech V1 Client class StreamingRecognizeResponse.

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, and single_utterance is set to false, then no messages are streamed back to the client.

Here's an example of a series 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:
  8. 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".
  9. 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.
  10. The specific stability and confidence values shown above are only for illustrative purposes. Actual values may vary.
  11. In each response, only one of these fields will be set: error, speech_event_type, or one or more (repeated) results.

Generated from protobuf message google.cloud.speech.v1.StreamingRecognizeResponse

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ error Google\Rpc\Status

If set, returns a google.rpc.Status message that specifies the error for the operation.

↳ results array<Google\Cloud\Speech\V1\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 int

Indicates the type of speech event.

↳ total_billed_time Google\Protobuf\Duration

When available, billed audio seconds for the stream. Set only if this is the last response in the stream.

getError

If set, returns a google.rpc.Status message that specifies the error for the operation.

Generated from protobuf field .google.rpc.Status error = 1;

Returns
TypeDescription
Google\Rpc\Status|null

hasError

clearError

setError

If set, returns a google.rpc.Status message that specifies the error for the operation.

Generated from protobuf field .google.rpc.Status error = 1;

Parameter
NameDescription
var Google\Rpc\Status
Returns
TypeDescription
$this

getResults

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

Generated from protobuf field repeated .google.cloud.speech.v1.StreamingRecognitionResult results = 2;

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setResults

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

Generated from protobuf field repeated .google.cloud.speech.v1.StreamingRecognitionResult results = 2;

Parameter
NameDescription
var array<Google\Cloud\Speech\V1\StreamingRecognitionResult>
Returns
TypeDescription
$this

getSpeechEventType

Indicates the type of speech event.

Generated from protobuf field .google.cloud.speech.v1.StreamingRecognizeResponse.SpeechEventType speech_event_type = 4;

Returns
TypeDescription
int

setSpeechEventType

Indicates the type of speech event.

Generated from protobuf field .google.cloud.speech.v1.StreamingRecognizeResponse.SpeechEventType speech_event_type = 4;

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getTotalBilledTime

When available, billed audio seconds for the stream.

Set only if this is the last response in the stream.

Generated from protobuf field .google.protobuf.Duration total_billed_time = 5;

Returns
TypeDescription
Google\Protobuf\Duration|null

hasTotalBilledTime

clearTotalBilledTime

setTotalBilledTime

When available, billed audio seconds for the stream.

Set only if this is the last response in the stream.

Generated from protobuf field .google.protobuf.Duration total_billed_time = 5;

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this