lib/google/cloud/speech/v1p1beta1/doc/google/cloud/speech/v1p1beta1/cloud_speech.rb in google-cloud-speech-0.34.0 vs lib/google/cloud/speech/v1p1beta1/doc/google/cloud/speech/v1p1beta1/cloud_speech.rb in google-cloud-speech-0.34.1
- old
+ new
@@ -91,20 +91,22 @@
# request.
# @!attribute [rw] encoding
# @return [Google::Cloud::Speech::V1p1beta1::RecognitionConfig::AudioEncoding]
# Encoding of audio data sent in all `RecognitionAudio` messages.
# This field is optional for `FLAC` and `WAV` audio files and required
- # for all other audio formats. For details, see {Google::Cloud::Speech::V1p1beta1::RecognitionConfig::AudioEncoding AudioEncoding}.
+ # for all other audio formats. For details, see
+ # {Google::Cloud::Speech::V1p1beta1::RecognitionConfig::AudioEncoding AudioEncoding}.
# @!attribute [rw] sample_rate_hertz
# @return [Integer]
# 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).
# This field is optional for `FLAC` and `WAV` audio files and required
- # for all other audio formats. For details, see {Google::Cloud::Speech::V1p1beta1::RecognitionConfig::AudioEncoding AudioEncoding}.
+ # for all other audio formats. For details, see
+ # {Google::Cloud::Speech::V1p1beta1::RecognitionConfig::AudioEncoding AudioEncoding}.
# @!attribute [rw] audio_channel_count
# @return [Integer]
# *Optional* The number of channels in the input audio data.
# ONLY set this for MULTI-CHANNEL recognition.
# Valid values for LINEAR16 and FLAC are `1`-`8`.
@@ -157,13 +159,14 @@
# 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.
# @!attribute [rw] speech_contexts
# @return [Array<Google::Cloud::Speech::V1p1beta1::SpeechContext>]
- # *Optional* array of {Google::Cloud::Speech::V1p1beta1::SpeechContext SpeechContext}.
- # A means to provide context to assist the speech recognition. For more
- # information, see [Phrase Hints](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints).
+ # *Optional* array of
+ # {Google::Cloud::Speech::V1p1beta1::SpeechContext SpeechContext}. A means to
+ # provide context to assist the speech recognition. For more information, see
+ # [Phrase Hints](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints).
# @!attribute [rw] enable_word_time_offsets
# @return [true, false]
# *Optional* If `true`, the top result includes a list of words and
# the start and end time offsets (timestamps) for those words. If
# `false`, no word-level time offset information is returned. The default is
@@ -271,11 +274,12 @@
# your request, you do not need to specify an `AudioEncoding`; the audio
# encoding format is determined from the file header. If you specify
# an `AudioEncoding` when you send send `FLAC` or `WAV` audio, the
# encoding configuration must match the encoding described in the audio
# header; otherwise the request returns an
- # {Google::Rpc::Code::INVALID_ARGUMENT} error code.
+ # {Google::Rpc::Code::INVALID_ARGUMENT} error
+ # code.
module AudioEncoding
# Not specified.
ENCODING_UNSPECIFIED = 0
# Uncompressed 16-bit signed little-endian samples (Linear PCM).
@@ -463,12 +467,12 @@
# [usage limits](https://cloud.google.com/speech-to-text/quotas#content).
class SpeechContext; end
# 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}. See
- # [content limits](https://cloud.google.com/speech-to-text/quotas#content).
+ # returns {Google::Rpc::Code::INVALID_ARGUMENT}.
+ # See [content limits](https://cloud.google.com/speech-to-text/quotas#content).
# @!attribute [rw] content
# @return [String]
# 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.
@@ -477,12 +481,13 @@
# URI that points to a file that contains audio data bytes as specified in
# `RecognitionConfig`. The file must not be compressed (for example, gzip).
# 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](https://cloud.google.com/storage/docs/reference-uris).
+ # {Google::Rpc::Code::INVALID_ARGUMENT}).
+ # For more information, see [Request
+ # URIs](https://cloud.google.com/storage/docs/reference-uris).
class RecognitionAudio; end
# The only message returned to the client by the `Recognize` method. It
# contains the result as zero or more sequential `SpeechRecognitionResult`
# messages.
@@ -567,11 +572,11 @@
# `error`,
# `speech_event_type`, or
# one or more (repeated) `results`.
# @!attribute [rw] error
# @return [Google::Rpc::Status]
- # Output only. If set, returns a {Google::Rpc::Status} message that
- # specifies the error for the operation.
+ # Output only. If set, returns a {Google::Rpc::Status}
+ # message that specifies the error for the operation.
# @!attribute [rw] results
# @return [Array<Google::Cloud::Speech::V1p1beta1::StreamingRecognitionResult>]
# 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),
\ No newline at end of file