# Cloud Speech-to-Text V1 API - Class Google::Cloud::Speech::V1::StreamingRecognizeResponse (v1.8.0)

1.8.0 (latest) 1.7.1 1.6.0 1.5.1 1.4.0 1.3.0 1.2.1 1.1.0 1.0.1 0.17.0 0.16.2 0.15.0 0.14.0 0.13.1 0.12.1 0.11.0 0.10.2 0.9.0 0.8.0 0.7.3 Reference documentation and code samples for the Cloud Speech-to-Text V1 API class Google::Cloud::Speech::V1::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 `StreamingRecognizeResponse`s 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:

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

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

- The specific `stability` and `confidence` values shown above are only for
  illustrative purposes. Actual values may vary.

- In each response, only one of these fields will be set:
  `error`,
  `speech_event_type`, or
  one or more (repeated) `results`.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #error

    def error() -> ::Google::Rpc::Status

**Returns**

- ([::Google::Rpc::Status](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1/latest/Google-Rpc-Status)) --- If set, returns a [google.rpc.Status](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1/latest/Google-Rpc-Status "Google::Rpc::Status (class)") message that specifies the error for the operation.

### #error=

    def error=(value) -> ::Google::Rpc::Status

**Parameter**

- **value** ([::Google::Rpc::Status](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1/latest/Google-Rpc-Status)) --- If set, returns a [google.rpc.Status](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1/latest/Google-Rpc-Status "Google::Rpc::Status (class)") message that specifies the error for the operation.
**Returns**

- ([::Google::Rpc::Status](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1/latest/Google-Rpc-Status)) --- If set, returns a [google.rpc.Status](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1/latest/Google-Rpc-Status "Google::Rpc::Status (class)") message that specifies the error for the operation.

### #request_id

    def request_id() -> ::Integer

**Returns**

- (::Integer) --- The ID associated with the request. This is a unique ID specific only to the given request.

### #request_id=

    def request_id=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- The ID associated with the request. This is a unique ID specific only to the given request.
**Returns**

- (::Integer) --- The ID associated with the request. This is a unique ID specific only to the given request.

### #results

    def results() -> ::Array<::Google::Cloud::Speech::V1::StreamingRecognitionResult>

**Returns**

- (::Array\<[::Google::Cloud::Speech::V1::StreamingRecognitionResult](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1/latest/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).

### #results=

    def results=(value) -> ::Array<::Google::Cloud::Speech::V1::StreamingRecognitionResult>

**Parameter**

- **value** (::Array\<[::Google::Cloud::Speech::V1::StreamingRecognitionResult](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1/latest/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).
**Returns**

- (::Array\<[::Google::Cloud::Speech::V1::StreamingRecognitionResult](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1/latest/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_adaptation_info

    def speech_adaptation_info() -> ::Google::Cloud::Speech::V1::SpeechAdaptationInfo

**Returns**

- ([::Google::Cloud::Speech::V1::SpeechAdaptationInfo](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1/latest/Google-Cloud-Speech-V1-SpeechAdaptationInfo)) --- Provides information on adaptation behavior in response

### #speech_adaptation_info=

    def speech_adaptation_info=(value) -> ::Google::Cloud::Speech::V1::SpeechAdaptationInfo

**Parameter**

- **value** ([::Google::Cloud::Speech::V1::SpeechAdaptationInfo](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1/latest/Google-Cloud-Speech-V1-SpeechAdaptationInfo)) --- Provides information on adaptation behavior in response
**Returns**

- ([::Google::Cloud::Speech::V1::SpeechAdaptationInfo](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1/latest/Google-Cloud-Speech-V1-SpeechAdaptationInfo)) --- Provides information on adaptation behavior in response

### #speech_event_time

    def speech_event_time() -> ::Google::Protobuf::Duration

**Returns**

- ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1/latest/Google-Protobuf-Duration)) --- Time offset between the beginning of the audio and event emission.

### #speech_event_time=

    def speech_event_time=(value) -> ::Google::Protobuf::Duration

**Parameter**

- **value** ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1/latest/Google-Protobuf-Duration)) --- Time offset between the beginning of the audio and event emission.
**Returns**

- ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1/latest/Google-Protobuf-Duration)) --- Time offset between the beginning of the audio and event emission.

### #speech_event_type

    def speech_event_type() -> ::Google::Cloud::Speech::V1::StreamingRecognizeResponse::SpeechEventType

**Returns**

- ([::Google::Cloud::Speech::V1::StreamingRecognizeResponse::SpeechEventType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1/latest/Google-Cloud-Speech-V1-StreamingRecognizeResponse-SpeechEventType)) --- Indicates the type of speech event.

### #speech_event_type=

    def speech_event_type=(value) -> ::Google::Cloud::Speech::V1::StreamingRecognizeResponse::SpeechEventType

**Parameter**

- **value** ([::Google::Cloud::Speech::V1::StreamingRecognizeResponse::SpeechEventType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1/latest/Google-Cloud-Speech-V1-StreamingRecognizeResponse-SpeechEventType)) --- Indicates the type of speech event.
**Returns**

- ([::Google::Cloud::Speech::V1::StreamingRecognizeResponse::SpeechEventType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1/latest/Google-Cloud-Speech-V1-StreamingRecognizeResponse-SpeechEventType)) --- Indicates the type of speech event.

### #total_billed_time

    def total_billed_time() -> ::Google::Protobuf::Duration

**Returns**

- ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1/latest/Google-Protobuf-Duration)) --- When available, billed audio seconds for the stream. Set only if this is the last response in the stream.

### #total_billed_time=

    def total_billed_time=(value) -> ::Google::Protobuf::Duration

**Parameter**

- **value** ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1/latest/Google-Protobuf-Duration)) --- When available, billed audio seconds for the stream. Set only if this is the last response in the stream.
**Returns**

- ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1/latest/Google-Protobuf-Duration)) --- When available, billed audio seconds for the stream. Set only if this is the last response in the stream.