# Cloud Speech V2 Client - Class BatchRecognizeRequest (2.5.1)

2.5.1 (latest) 2.5.0 2.4.0 2.3.0 2.2.1 2.1.1 2.0.1 1.20.1 1.19.2 1.18.3 1.16.0 1.15.0 1.14.3 1.13.1 1.12.0 1.11.2 1.10.0 1.9.1 1.8.0 1.7.0 Reference documentation and code samples for the Cloud Speech V2 Client class BatchRecognizeRequest.

Request message for the
[BatchRecognize](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.Client.SpeechClient#_Google_Cloud_Speech_V2_Client_SpeechClient__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` | `https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.RecognitionConfig` Features and audio metadata to use for the Automatic Speech Recognition. This field in combination with the [config_mask](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.BatchRecognizeRequest#_Google_Cloud_Speech_V2_BatchRecognizeRequest__getConfigMask__) field can be used to override parts of the [default_recognition_config](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.Recognizer#_Google_Cloud_Speech_V2_Recognizer__getDefaultRecognitionConfig__) of the Recognizer resource. |
| `↳ config_mask` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/FieldMask` The list of fields in [config](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.BatchRecognizeRequest#_Google_Cloud_Speech_V2_BatchRecognizeRequest__getConfig__) that override the values in the [default_recognition_config](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.Recognizer#_Google_Cloud_Speech_V2_Recognizer__getDefaultRecognitionConfig__) of the recognizer during this recognition request. If no mask is provided, all given fields in [config](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.BatchRecognizeRequest#_Google_Cloud_Speech_V2_BatchRecognizeRequest__getConfig__) 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](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.BatchRecognizeRequest#_Google_Cloud_Speech_V2_BatchRecognizeRequest__getConfig__) completely overrides and replaces the config in the recognizer for this recognition request. |
| `↳ files` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.BatchRecognizeFileMetadata>` Audio files with file metadata for ASR. The maximum number of files allowed to be specified is 15. |
| `↳ recognition_output_config` | `https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/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](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.BatchRecognizeRequest#_Google_Cloud_Speech_V2_BatchRecognizeRequest__getConfigMask__)
field can be used to override parts of the
[default_recognition_config](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.Recognizer#_Google_Cloud_Speech_V2_Recognizer__getDefaultRecognitionConfig__)
of the Recognizer resource.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/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](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.BatchRecognizeRequest#_Google_Cloud_Speech_V2_BatchRecognizeRequest__getConfigMask__)
field can be used to override parts of the
[default_recognition_config](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.Recognizer#_Google_Cloud_Speech_V2_Recognizer__getDefaultRecognitionConfig__)
of the Recognizer resource.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.RecognitionConfig` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getConfigMask

The list of fields in
[config](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.BatchRecognizeRequest#_Google_Cloud_Speech_V2_BatchRecognizeRequest__getConfig__) that override
the values in the
[default_recognition_config](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.Recognizer#_Google_Cloud_Speech_V2_Recognizer__getDefaultRecognitionConfig__)
of the recognizer during this recognition request. If no mask is provided,
all given fields in
[config](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.BatchRecognizeRequest#_Google_Cloud_Speech_V2_BatchRecognizeRequest__getConfig__) 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](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.BatchRecognizeRequest#_Google_Cloud_Speech_V2_BatchRecognizeRequest__getConfig__) completely
overrides and replaces the config in the recognizer for this recognition
request.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/FieldMask|null` |   |

### hasConfigMask

### clearConfigMask

### setConfigMask

The list of fields in
[config](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.BatchRecognizeRequest#_Google_Cloud_Speech_V2_BatchRecognizeRequest__getConfig__) that override
the values in the
[default_recognition_config](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.Recognizer#_Google_Cloud_Speech_V2_Recognizer__getDefaultRecognitionConfig__)
of the recognizer during this recognition request. If no mask is provided,
all given fields in
[config](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.BatchRecognizeRequest#_Google_Cloud_Speech_V2_BatchRecognizeRequest__getConfig__) 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](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.BatchRecognizeRequest#_Google_Cloud_Speech_V2_BatchRecognizeRequest__getConfig__) completely
overrides and replaces the config in the recognizer for this recognition
request.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/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** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.BatchRecognizeFileMetadata>` |   |

### setFiles

Audio files with file metadata for ASR.

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.BatchRecognizeFileMetadata>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getRecognitionOutputConfig

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.RecognitionOutputConfig|null` |   |

### hasRecognitionOutputConfig

### clearRecognitionOutputConfig

### setRecognitionOutputConfig

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.RecognitionOutputConfig` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getProcessingStrategy

Processing strategy to use for this request.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [ProcessingStrategy](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.BatchRecognizeRequest.ProcessingStrategy). |

### setProcessingStrategy

Processing strategy to use for this request.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [ProcessingStrategy](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.BatchRecognizeRequest.ProcessingStrategy). |

| **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 SpeechClient::recognizerName() for help formatting this field. |
| `config` | `https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.RecognitionConfig` Features and audio metadata to use for the Automatic Speech Recognition. This field in combination with the [config_mask](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.BatchRecognizeRequest#_Google_Cloud_Speech_V2_BatchRecognizeRequest__getConfigMask__) field can be used to override parts of the [default_recognition_config](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.Recognizer#_Google_Cloud_Speech_V2_Recognizer__getDefaultRecognitionConfig__) of the Recognizer resource. |
| `configMask` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/FieldMask` The list of fields in [config](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.BatchRecognizeRequest#_Google_Cloud_Speech_V2_BatchRecognizeRequest__getConfig__) that override the values in the [default_recognition_config](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.Recognizer#_Google_Cloud_Speech_V2_Recognizer__getDefaultRecognitionConfig__) of the recognizer during this recognition request. If no mask is provided, all given fields in [config](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.BatchRecognizeRequest#_Google_Cloud_Speech_V2_BatchRecognizeRequest__getConfig__) 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](https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.BatchRecognizeRequest#_Google_Cloud_Speech_V2_BatchRecognizeRequest__getConfig__) completely overrides and replaces the config in the recognizer for this recognition request. |
| `files` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.BatchRecognizeFileMetadata>` Audio files with file metadata for ASR. The maximum number of files allowed to be specified is 15. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-speech/latest/V2.BatchRecognizeRequest` |   |