Reference documentation and code samples for the Cloud Speech V2 Client class Recognizer.
A Recognizer message. Stores recognition configuration and metadata.
Generated from protobuf message google.cloud.speech.v2.Recognizer
Namespace
Google \ Cloud \ Speech \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ name | stringOutput only. Identifier. The resource name of the Recognizer. Format: |
↳ uid | stringOutput only. System-assigned unique identifier for the Recognizer. |
↳ display_name | stringUser-settable, human-readable name for the Recognizer. Must be 63 characters or less. |
↳ model | stringOptional. This field is now deprecated. Prefer the |
↳ language_codes | arrayOptional. This field is now deprecated. Prefer the |
↳ default_recognition_config | RecognitionConfigDefault configuration to use for requests with this Recognizer. This can be overwritten by inline configuration in the RecognizeRequest.config field. |
↳ annotations | array|Google\Protobuf\Internal\MapFieldAllows users to store small amounts of arbitrary data. Both the key and the value must be 63 characters or less each. At most 100 annotations. |
↳ state | intOutput only. The Recognizer lifecycle state. |
↳ create_time | Google\Protobuf\TimestampOutput only. Creation time. |
↳ update_time | Google\Protobuf\TimestampOutput only. The most recent time this Recognizer was modified. |
↳ delete_time | Google\Protobuf\TimestampOutput only. The time at which this Recognizer was requested for deletion. |
↳ expire_time | Google\Protobuf\TimestampOutput only. The time at which this Recognizer will be purged. |
↳ etag | stringOutput only. This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding. |
↳ reconciling | boolOutput only. Whether or not this Recognizer is in the process of being updated. |
↳ kms_key_name | stringOutput only. The KMS key name with which the Recognizer is encrypted. The expected format is |
↳ kms_key_version_name | stringOutput only. The KMS key version name with which the Recognizer is encrypted. The expected format is |
getName
Output only. Identifier. The resource name of the Recognizer.
Format: projects/{project}/locations/{location}/recognizers/{recognizer}.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. Identifier. The resource name of the Recognizer.
Format: projects/{project}/locations/{location}/recognizers/{recognizer}.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getUid
Output only. System-assigned unique identifier for the Recognizer.
| Returns | |
|---|---|
| Type | Description |
string | |
setUid
Output only. System-assigned unique identifier for the Recognizer.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
User-settable, human-readable name for the Recognizer. Must be 63 characters or less.
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
User-settable, human-readable name for the Recognizer. Must be 63 characters or less.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getModel
Optional. This field is now deprecated. Prefer the model field in the RecognitionConfig message.
Which model to use for recognition requests. Select the model best suited to your domain to get best results. Guidance for choosing which model to use can be found in the Transcription Models Documentation and the models supported in each region can be found in the Table Of Supported Models.
| Returns | |
|---|---|
| Type | Description |
string | |
setModel
Optional. This field is now deprecated. Prefer the model field in the RecognitionConfig message.
Which model to use for recognition requests. Select the model best suited to your domain to get best results. Guidance for choosing which model to use can be found in the Transcription Models Documentation and the models supported in each region can be found in the Table Of Supported Models.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getLanguageCodes
Optional. This field is now deprecated. Prefer the language_codes field in the RecognitionConfig message.
The language of the supplied audio as a BCP-47 language tag. Supported languages for each model are listed in the Table of Supported Models. If additional languages are provided, recognition result will contain recognition in the most likely language detected. The recognition result will include the language tag of the language detected in the audio. When you create or update a Recognizer, these values are stored in normalized BCP-47 form. For example, "en-us" is stored as "en-US".
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setLanguageCodes
Optional. This field is now deprecated. Prefer the language_codes field in the RecognitionConfig message.
The language of the supplied audio as a BCP-47 language tag. Supported languages for each model are listed in the Table of Supported Models. If additional languages are provided, recognition result will contain recognition in the most likely language detected. The recognition result will include the language tag of the language detected in the audio. When you create or update a Recognizer, these values are stored in normalized BCP-47 form. For example, "en-us" is stored as "en-US".
| Parameter | |
|---|---|
| Name | Description |
var | string[] |
| Returns | |
|---|---|
| Type | Description |
$this | |
getDefaultRecognitionConfig
Default configuration to use for requests with this Recognizer.
This can be overwritten by inline configuration in the RecognizeRequest.config field.
| Returns | |
|---|---|
| Type | Description |
RecognitionConfig|null | |
hasDefaultRecognitionConfig
clearDefaultRecognitionConfig
setDefaultRecognitionConfig
Default configuration to use for requests with this Recognizer.
This can be overwritten by inline configuration in the RecognizeRequest.config field.
| Parameter | |
|---|---|
| Name | Description |
var | RecognitionConfig |
| Returns | |
|---|---|
| Type | Description |
$this | |
getAnnotations
Allows users to store small amounts of arbitrary data.
Both the key and the value must be 63 characters or less each. At most 100 annotations.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setAnnotations
Allows users to store small amounts of arbitrary data.
Both the key and the value must be 63 characters or less each. At most 100 annotations.
| Parameter | |
|---|---|
| Name | Description |
var | array|Google\Protobuf\Internal\MapField |
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. The Recognizer lifecycle state.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. The Recognizer lifecycle state.
| Parameter | |
|---|---|
| Name | Description |
var | int |
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Creation time.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Creation time.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Protobuf\Timestamp |
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. The most recent time this Recognizer was modified.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The most recent time this Recognizer was modified.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Protobuf\Timestamp |
| Returns | |
|---|---|
| Type | Description |
$this | |
getDeleteTime
Output only. The time at which this Recognizer was requested for deletion.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasDeleteTime
clearDeleteTime
setDeleteTime
Output only. The time at which this Recognizer was requested for deletion.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Protobuf\Timestamp |
| Returns | |
|---|---|
| Type | Description |
$this | |
getExpireTime
Output only. The time at which this Recognizer will be purged.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasExpireTime
clearExpireTime
setExpireTime
Output only. The time at which this Recognizer will be purged.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Protobuf\Timestamp |
| Returns | |
|---|---|
| Type | Description |
$this | |
getEtag
Output only. This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding.
| Returns | |
|---|---|
| Type | Description |
string | |
setEtag
Output only. This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getReconciling
Output only. Whether or not this Recognizer is in the process of being updated.
| Returns | |
|---|---|
| Type | Description |
bool | |
setReconciling
Output only. Whether or not this Recognizer is in the process of being updated.
| Parameter | |
|---|---|
| Name | Description |
var | bool |
| Returns | |
|---|---|
| Type | Description |
$this | |
getKmsKeyName
Output only. The KMS key name with which the Recognizer is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
| Returns | |
|---|---|
| Type | Description |
string | |
setKmsKeyName
Output only. The KMS key name with which the Recognizer is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getKmsKeyVersionName
Output only. The KMS key version name with which the Recognizer is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}.
| Returns | |
|---|---|
| Type | Description |
string | |
setKmsKeyVersionName
Output only. The KMS key version name with which the Recognizer is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |