Cloud Speech-to-Text V2 API - Class Google::Cloud::Speech::V2::RecognizeRequest (v0.16.0)

Reference documentation and code samples for the Cloud Speech-to-Text V2 API class Google::Cloud::Speech::V2::RecognizeRequest.

Request message for the Recognize method. Either content or uri must be supplied. Supplying both or neither returns [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. See content limits.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#config

def config() -> ::Google::Cloud::Speech::V2::RecognitionConfig
Returns

#config=

def config=(value) -> ::Google::Cloud::Speech::V2::RecognitionConfig
Parameter
Returns

#config_mask

def config_mask() -> ::Google::Protobuf::FieldMask
Returns
  • (::Google::Protobuf::FieldMask) — The list of fields in config that override the values in the default_recognition_config of the recognizer during this recognition request. If no mask is provided, all non-default valued fields in config override the values in the recognizer for this recognition request. If a mask is provided, only the fields listed in the mask override the config in the recognizer for this recognition request. If a wildcard (*) is provided, config completely overrides and replaces the config in the recognizer for this recognition request.

#config_mask=

def config_mask=(value) -> ::Google::Protobuf::FieldMask
Parameter
  • value (::Google::Protobuf::FieldMask) — The list of fields in config that override the values in the default_recognition_config of the recognizer during this recognition request. If no mask is provided, all non-default valued fields in config override the values in the recognizer for this recognition request. If a mask is provided, only the fields listed in the mask override the config in the recognizer for this recognition request. If a wildcard (*) is provided, config completely overrides and replaces the config in the recognizer for this recognition request.
Returns
  • (::Google::Protobuf::FieldMask) — The list of fields in config that override the values in the default_recognition_config of the recognizer during this recognition request. If no mask is provided, all non-default valued fields in config override the values in the recognizer for this recognition request. If a mask is provided, only the fields listed in the mask override the config in the recognizer for this recognition request. If a wildcard (*) is provided, config completely overrides and replaces the config in the recognizer for this recognition request.

#content

def content() -> ::String
Returns
  • (::String) — The audio data bytes encoded as specified in RecognitionConfig. As with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64.

    Note: The following fields are mutually exclusive: content, uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

#content=

def content=(value) -> ::String
Parameter
  • value (::String) — The audio data bytes encoded as specified in RecognitionConfig. As with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64.

    Note: The following fields are mutually exclusive: content, uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — The audio data bytes encoded as specified in RecognitionConfig. As with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64.

    Note: The following fields are mutually exclusive: content, uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

#recognizer

def recognizer() -> ::String
Returns
  • (::String) — Required. The name of the Recognizer to use during recognition. The expected format is projects/{project}/locations/{location}/recognizers/{recognizer}. The {recognizer} segment may be set to _ to use an empty implicit Recognizer.

#recognizer=

def recognizer=(value) -> ::String
Parameter
  • value (::String) — Required. The name of the Recognizer to use during recognition. The expected format is projects/{project}/locations/{location}/recognizers/{recognizer}. The {recognizer} segment may be set to _ to use an empty implicit Recognizer.
Returns
  • (::String) — Required. The name of the Recognizer to use during recognition. The expected format is projects/{project}/locations/{location}/recognizers/{recognizer}. The {recognizer} segment may be set to _ to use an empty implicit Recognizer.

#uri

def uri() -> ::String
Returns
  • (::String) — 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 [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs.

    Note: The following fields are mutually exclusive: uri, content. If a field in that set is populated, all other fields in the set will automatically be cleared.

#uri=

def uri=(value) -> ::String
Parameter
  • value (::String) — 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 [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs.

    Note: The following fields are mutually exclusive: uri, content. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — 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 [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs.

    Note: The following fields are mutually exclusive: uri, content. If a field in that set is populated, all other fields in the set will automatically be cleared.