Reference documentation and code samples for the Cloud Speech V2 Client class RecognizeRequest.
Request message for the
Recognize method. Either
content or uri must be supplied. Supplying both or neither returns
INVALID_ARGUMENT. See content
limits.
Generated from protobuf message google.cloud.speech.v2.RecognizeRequest
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 |
↳ 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 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 ( |
↳ content |
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. |
↳ uri |
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: |
getRecognizer
Required. The name of the Recognizer to use during recognition. The
expected format is
projects/{project}/locations/{location}/recognizers/{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}.
| 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 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 | |
|---|---|
| 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 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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getContent
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.
| Returns | |
|---|---|
| Type | Description |
string | |
hasContent
setContent
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUri
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). For more
information, see Request
URIs.
| Returns | |
|---|---|
| Type | Description |
string | |
hasUri
setUri
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). For more
information, see Request
URIs.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAudioSource
| Returns | |
|---|---|
| Type | Description |
string | |