Cloud Speech V2 Client - Class BatchRecognizeRequest (1.19.0)

Reference documentation and code samples for the Cloud Speech V2 Client class BatchRecognizeRequest.

Request message for the BatchRecognize method.

Generated from protobuf message google.cloud.speech.v2.BatchRecognizeRequest

Namespace

Google \ Cloud \ Speech \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ recognizer 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.
↳ config Google\Cloud\Speech\V2\RecognitionConfig

Features and audio metadata to use for the Automatic Speech Recognition. This field in combination with the config_mask field can be used to override parts of the default_recognition_config of the Recognizer resource.
↳ config_mask 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 given 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.
↳ files array<Google\Cloud\Speech\V2\BatchRecognizeFileMetadata>

Audio files with file metadata for ASR. The maximum number of files allowed to be specified is 15.
↳ recognition_output_config Google\Cloud\Speech\V2\RecognitionOutputConfig

Configuration options for where to output the transcripts of each file.
↳ processing_strategy int

Processing strategy to use for this request.

getRecognizer

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
Type Description
string

setRecognizer

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getConfig

Features and audio metadata to use for the Automatic Speech Recognition.

This field in combination with the config_mask field can be used to override parts of the default_recognition_config of the Recognizer resource.

Returns
Type Description
Google\Cloud\Speech\V2\RecognitionConfig|null

hasConfig

clearConfig

setConfig

Features and audio metadata to use for the Automatic Speech Recognition.

This field in combination with the config_mask field can be used to override parts of the default_recognition_config of the Recognizer resource.

Parameter
Name Description
var Google\Cloud\Speech\V2\RecognitionConfig
Returns
Type Description
$this

getConfigMask

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 given 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
Type Description
Google\Protobuf\FieldMask|null

hasConfigMask

clearConfigMask

setConfigMask

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

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

getFiles

Audio files with file metadata for ASR.

The maximum number of files allowed to be specified is 15.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setFiles

Audio files with file metadata for ASR.

The maximum number of files allowed to be specified is 15.

Parameter
Name Description
var array<Google\Cloud\Speech\V2\BatchRecognizeFileMetadata>
Returns
Type Description
$this

getRecognitionOutputConfig

Configuration options for where to output the transcripts of each file.

Returns
Type Description
Google\Cloud\Speech\V2\RecognitionOutputConfig|null

hasRecognitionOutputConfig

clearRecognitionOutputConfig

setRecognitionOutputConfig

Configuration options for where to output the transcripts of each file.

Parameter
Name Description
var Google\Cloud\Speech\V2\RecognitionOutputConfig
Returns
Type Description
$this

getProcessingStrategy

Processing strategy to use for this request.

Returns
Type Description
int

setProcessingStrategy

Processing strategy to use for this request.

Parameter
Name Description
var int
Returns
Type Description
$this

static::build

Parameters
Name Description
recognizer 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. Please see Google\Cloud\Speech\V2\SpeechClient::recognizerName() for help formatting this field.
config Google\Cloud\Speech\V2\RecognitionConfig

Features and audio metadata to use for the Automatic Speech Recognition. This field in combination with the config_mask field can be used to override parts of the default_recognition_config of the Recognizer resource.
configMask 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 given 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.
files array<Google\Cloud\Speech\V2\BatchRecognizeFileMetadata>

Audio files with file metadata for ASR. The maximum number of files allowed to be specified is 15.
Returns
Type Description
Google\Cloud\Speech\V2\BatchRecognizeRequest