package google.cloud.speech.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

Service that implements Google Cloud Speech API.

• rpc SyncRecognize (SyncRecognizeRequest, SyncRecognizeResponse)

  cloud_speech.proto:32

  Perform synchronous speech-recognition: receive results after all audio has been sent and processed.

  message SyncRecognizeRequest

  cloud_speech.proto:54

  `SyncRecognizeRequest` is the top-level message sent by the client for the `SyncRecognize` method.

  • optional RecognitionConfig config = 1

    [Required] The `config` message provides information to the recognizer that specifies how to process the request.

  • optional RecognitionAudio audio = 2

    [Required] The audio data to be recognized.

  message SyncRecognizeResponse

  cloud_speech.proto:232

  `SyncRecognizeResponse` is the only message returned to the client by `SyncRecognize`. It contains the result as zero or more sequential `RecognizeResponse` messages.

  • repeated SpeechRecognitionResult results = 2

    [Output-only] Sequential list of transcription results corresponding to sequential portions of audio.

• rpc AsyncRecognize (AsyncRecognizeRequest, longrunning.Operation)

  cloud_speech.proto:40

  Perform asynchronous speech-recognition: receive results via the google.longrunning.Operations interface. `Operation.response` returns `AsyncRecognizeResponse`.

  message AsyncRecognizeRequest

  cloud_speech.proto:65

  `AsyncRecognizeRequest` is the top-level message sent by the client for the `AsyncRecognize` method.

  • optional RecognitionConfig config = 1

    [Required] The `config` message provides information to the recognizer that specifies how to process the request.

  • optional RecognitionAudio audio = 2

    [Required] The audio data to be recognized.

• rpc StreamingRecognize (stream StreamingRecognizeRequest, stream StreamingRecognizeResponse)

  cloud_speech.proto:48

  Perform bidirectional streaming speech-recognition: receive results while sending audio. This method is only available via the gRPC API (not REST).

  message StreamingRecognizeRequest

  cloud_speech.proto:79

  `StreamingRecognizeRequest` is the top-level message sent by the client for the `StreamingRecognize`. Multiple `StreamingRecognizeRequest` messages are sent. The first message must contain a `streaming_config` message and must not contain `audio` data. All subsequent messages must contain `audio` data and must not contain a `streaming_config` message.

  • oneof streaming_request

    • StreamingRecognitionConfig streaming_config = 1

      The `streaming_config` message provides information to the recognizer that specifies how to process the request. The first `StreamingRecognizeRequest` message must contain a `streaming_config` message.

    • bytes audio_content = 2

      The audio data to be recognized. Sequential chunks of audio data are sent in sequential `StreamingRecognizeRequest` messages. The first `StreamingRecognizeRequest` message must not contain `audio_content` data and all subsequent `StreamingRecognizeRequest` messages must contain `audio_content` data. The audio bytes must be encoded as specified in `RecognitionConfig`. Note: as with all bytes fields, protobuffers use a pure binary representation (not base64).

  message StreamingRecognizeResponse

  cloud_speech.proto:250

  `StreamingRecognizeResponse` is the only message returned to the client by `StreamingRecognize`. It contains the result as zero or more sequential `RecognizeResponse` messages.

  • optional rpc.Status error = 1

    [Output-only] If set, returns a [google.rpc.Status][] message that specifies the error for the operation.

  • repeated StreamingRecognitionResult results = 2

    [Output-only] 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.

  • int32 result_index = 3

    [Output-only] Indicates the lowest index in the `results` array that has changed. The repeated `SpeechRecognitionResult` results overwrite past results at this index and higher.

  • StreamingRecognizeResponse.EndpointerType endpointer_type = 4

    [Output-only] Indicates the type of endpointer event.

`AsyncRecognizeResponse` is the only message returned to the client by `AsyncRecognize`. It contains the result as zero or more sequential `RecognizeResponse` messages.

• repeated SpeechRecognitionResult results = 2

  [Output-only] Sequential list of transcription results corresponding to sequential portions of audio.

Contains audio data in the encoding specified in the `RecognitionConfig`. Either `content` or `uri` must be supplied. Supplying both or neither returns [google.rpc.Code.INVALID_ARGUMENT][].

Used in: AsyncRecognizeRequest, SyncRecognizeRequest

• oneof audio_source

  • bytes content = 1

    The audio data bytes encoded as specified in `RecognitionConfig`. Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64.

  • string uri = 2

    URI that points to a file that contains audio data bytes as specified in `RecognitionConfig`. Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format: `gs://bucket_name/object_name` (other URI formats return [google.rpc.Code.INVALID_ARGUMENT][]). For more information, see [Request URIs](/storage/docs/reference-uris).

The `RecognitionConfig` message provides information to the recognizer that specifies how to process the request.

Used in: AsyncRecognizeRequest, StreamingRecognitionConfig, SyncRecognizeRequest

• RecognitionConfig.AudioEncoding encoding = 1

  [Required] Encoding of audio data sent in all `RecognitionAudio` messages.

• int32 sample_rate = 2

  [Required] Sample rate in Hertz of the audio data sent in all `RecognitionAudio` messages. Valid values are: 8000-48000. 16000 is optimal. For best results, set the sampling rate of the audio source to 16000 Hz. If that's not possible, use the native sample rate of the audio source (instead of re-sampling).

• string language_code = 3

  [Optional] The language of the supplied audio as a BCP-47 language tag. Example: "en-GB" https://www.rfc-editor.org/rfc/bcp/bcp47.txt If omitted, defaults to "en-US". See [Language Support](/speech/docs/best-practices#language_support) for a list of the currently supported language codes.

• int32 max_alternatives = 4

  [Optional] Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechRecognitionResult`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of `1`. If omitted, defaults to `1`.

• bool profanity_filter = 5

  [Optional] If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out.

• optional SpeechContext speech_context = 6

  [Optional] A means to provide context to assist the speech recognition.

Audio encoding of the data sent in the audio message. All encodings support only 1 channel (mono) audio. Only `FLAC` includes a header that describes the bytes of audio that follow the header. The other encodings are raw audio bytes with no header. For best results, the audio source should be captured and transmitted using a lossless encoding (`FLAC` or `LINEAR16`). Recognition accuracy may be reduced if lossy codecs (such as AMR, AMR_WB and MULAW) are used to capture or transmit the audio, particularly if background noise is present.

Used in: RecognitionConfig

• ENCODING_UNSPECIFIED = 0

  Not specified. Will return result [google.rpc.Code.INVALID_ARGUMENT][].

• LINEAR16 = 1

  Uncompressed 16-bit signed little-endian samples. This is the only encoding that may be used by `AsyncRecognize`.

• FLAC = 2

  This is the recommended encoding for `SyncRecognize` and `StreamingRecognize` because it uses lossless compression; therefore recognition accuracy is not compromised by a lossy codec. The stream FLAC (Free Lossless Audio Codec) encoding is specified at: http://flac.sourceforge.net/documentation.html. Only 16-bit samples are supported. Not all fields in STREAMINFO are supported.

• MULAW = 3

  8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.

• AMR = 4

  Adaptive Multi-Rate Narrowband codec. `sample_rate` must be 8000 Hz.

• AMR_WB = 5

  Adaptive Multi-Rate Wideband codec. `sample_rate` must be 16000 Hz.

Provides "hints" to the speech recognizer to favor specific words and phrases in the results.

Used in: RecognitionConfig

• repeated string phrases = 1

  [Optional] A list of up to 50 phrases of up to 100 characters each to provide words and phrases "hints" to the speech recognition so that it is more likely to recognize them.

Alternative hypotheses (a.k.a. n-best list).

Used in: SpeechRecognitionResult, StreamingRecognitionResult

• string transcript = 1

  [Output-only] Transcript text representing the words that the user spoke.

• float confidence = 2

  [Output-only] The confidence estimate between 0.0 and 1.0. A higher number means the system is more confident that the recognition is correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. The default of 0.0 is a sentinel value indicating confidence was not set.

A speech recognition result corresponding to a portion of the audio.

Used in: AsyncRecognizeResponse, SyncRecognizeResponse

• repeated SpeechRecognitionAlternative alternatives = 1

  [Output-only] May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`).

The `StreamingRecognitionConfig` message provides information to the recognizer that specifies how to process the request.

Used in: StreamingRecognizeRequest

• optional RecognitionConfig config = 1

  [Required] The `config` message provides information to the recognizer that specifies how to process the request.

• bool single_utterance = 2

  [Optional] If `false` or omitted, the recognizer will perform continuous recognition (continuing to process audio even if the user pauses speaking) until the client closes the output stream (gRPC API) or when the maximum time limit has been reached. Multiple `SpeechRecognitionResult`s with the `is_final` flag set to `true` may be returned. If `true`, the recognizer will detect a single spoken utterance. When it detects that the user has paused or stopped speaking, it will return an `END_OF_UTTERANCE` event and cease recognition. It will return no more than one `SpeechRecognitionResult` with the `is_final` flag set to `true`.

• bool interim_results = 3

  [Optional] If `true`, interim results (tentative hypotheses) may be returned as they become available (these interim results are indicated with the `is_final=false` flag). If `false` or omitted, only `is_final=true` result(s) are returned.

A speech recognition result corresponding to a portion of the audio that is currently being processed. TODO(gshires): add a comment describing the various repeated interim and alternative results fields.

Used in: StreamingRecognizeResponse

• repeated SpeechRecognitionAlternative alternatives = 1

  [Output-only] May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`).

• bool is_final = 2

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

• float stability = 3

  [Output-only] An estimate of the probability that the recognizer will not change its guess about this interim result. Values range from 0.0 (completely unstable) to 1.0 (completely stable). Note that this is not the same as `confidence`, which estimates the probability that a recognition result is correct. 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.

Indicates the type of endpointer event.

Used in: StreamingRecognizeResponse

• ENDPOINTER_EVENT_UNSPECIFIED = 0

  No endpointer event specified.

• START_OF_SPEECH = 1

  Speech has been detected in the audio stream.

• END_OF_SPEECH = 2

  Speech has ceased to be detected in the audio stream.

• END_OF_AUDIO = 3

  The end of the audio stream has been reached. and it is being processed.

• END_OF_UTTERANCE = 4

  This event is only sent when `single_utterance` is `true`. It indicates that the server has detected the end of the user's speech utterance and expects no additional speech. Therefore, the server will not process additional audio. The client should stop sending additional audio data.