SpeechRecognizer


A brief introduction to SpeechRecognizer.

Property Value
Google Cloud Service Name Speech-to-Text
Google Cloud Service Documentation /speech-to-text/docs/
Google Cloud REST Resource Name v2.projects.locations.recognizers
Google Cloud REST Resource Documentation /speech-to-text/docs/reference/rest/v2/projects.locations.recognizers
Config Connector Resource Short Names gcpspeechrecognizer
gcpspeechrecognizers
speechrecognizer
Config Connector Service Name speech.googleapis.com
Config Connector Resource Fully Qualified Name speechrecognizers.speech.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember No
Config Connector Default Average Reconcile Interval In Seconds 600

Custom Resource Definition Properties

Spec

Schema

  annotations 
 : 
  
 string 
 : 
  
 string 
 defaultRecognitionConfig 
 : 
  
 languageCodes 
 : 
  
 - 
  
 string 
  
 model 
 : 
  
 string 
 displayName 
 : 
  
 string 
 location 
 : 
  
 string 
 projectRef 
 : 
  
 external 
 : 
  
 string 
  
 kind 
 : 
  
 string 
  
 name 
 : 
  
 string 
  
 namespace 
 : 
  
 string 
 resourceID 
 : 
  
 string 
 
Fields

annotations

Optional

map (key: string, value: string)

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.

defaultRecognitionConfig

Optional

object

Default configuration to use for requests with this Recognizer. This can be overwritten by inline configuration in the [RecognizeRequest.config][google.cloud.speech.v2.RecognizeRequest.config] field.

defaultRecognitionConfig.languageCodes

Optional

list (string)

Optional. The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Language tags are normalized to BCP-47 before they are used eg "en-us" becomes "en-US". Supported languages for each model are listed in the [Table of Supported Models](https://cloud.google.com/speech-to-text/v2/docs/speech-to-text-supported-languages). 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.

defaultRecognitionConfig.languageCodes[]

Optional

string

defaultRecognitionConfig.model

Optional

string

Optional. 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](https://cloud.google.com/speech-to-text/v2/docs/transcription-model) and the models supported in each region can be found in the [Table Of Supported Models](https://cloud.google.com/speech-to-text/v2/docs/speech-to-text-supported-languages).

displayName

Optional

string

User-settable, human-readable name for the Recognizer. Must be 63 characters or less.

location

Required

string

Immutable.

projectRef

Required

object

The Project that this resource belongs to.

projectRef.external

Optional

string

The `projectID` field of a project, when not managed by Config Connector.

projectRef.kind

Optional

string

The kind of the Project resource; optional but must be `Project` if provided.

projectRef.name

Optional

string

The `name` field of a `Project` resource.

projectRef.namespace

Optional

string

The `namespace` field of a `Project` resource.

resourceID

Optional

string

The SpeechRecognizer name. If not given, the metadata.name will be used.

Status

Schema

  conditions 
 : 
 - 
  
 lastTransitionTime 
 : 
  
 string 
  
 message 
 : 
  
 string 
  
 reason 
 : 
  
 string 
  
 status 
 : 
  
 string 
  
 type 
 : 
  
 string 
 externalRef 
 : 
  
 string 
 observedGeneration 
 : 
  
 integer 
 observedState 
 : 
  
 createTime 
 : 
  
 string 
  
 defaultRecognitionConfig 
 : 
  
 adaptation 
 : 
  
 customClasses 
 : 
  
 - 
  
 createTime 
 : 
  
 string 
  
 deleteTime 
 : 
  
 string 
  
 etag 
 : 
  
 string 
  
 expireTime 
 : 
  
 string 
  
 kmsKeyName 
 : 
  
 string 
  
 kmsKeyVersionName 
 : 
  
 string 
  
 name 
 : 
  
 string 
  
 reconciling 
 : 
  
 boolean 
  
 state 
 : 
  
 string 
  
 uid 
 : 
  
 string 
  
 updateTime 
 : 
  
 string 
  
 phraseSets 
 : 
  
 - 
  
 inlinePhraseSet 
 : 
  
 createTime 
 : 
  
 string 
  
 deleteTime 
 : 
  
 string 
  
 etag 
 : 
  
 string 
  
 expireTime 
 : 
  
 string 
  
 kmsKeyName 
 : 
  
 string 
  
 kmsKeyVersionName 
 : 
  
 string 
  
 name 
 : 
  
 string 
  
 reconciling 
 : 
  
 boolean 
  
 state 
 : 
  
 string 
  
 uid 
 : 
  
 string 
  
 updateTime 
 : 
  
 string 
  
 deleteTime 
 : 
  
 string 
  
 etag 
 : 
  
 string 
  
 expireTime 
 : 
  
 string 
  
 kmsKeyName 
 : 
  
 string 
  
 kmsKeyVersionName 
 : 
  
 string 
  
 reconciling 
 : 
  
 boolean 
  
 state 
 : 
  
 string 
  
 uid 
 : 
  
 string 
  
 updateTime 
 : 
  
 string 
 
Fields
conditions

list (object)

Conditions represent the latest available observations of the object's current state.

conditions[]

object

conditions[].lastTransitionTime

string

Last time the condition transitioned from one status to another.

conditions[].message

string

Human-readable message indicating details about last transition.

conditions[].reason

string

Unique, one-word, CamelCase reason for the condition's last transition.

conditions[].status

string

Status is the status of the condition. Can be True, False, Unknown.

conditions[].type

string

Type is the type of the condition.

externalRef

string

A unique specifier for the SpeechRecognizer resource in GCP.

observedGeneration

integer

ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.

observedState

object

ObservedState is the state of the resource as most recently observed in GCP.

observedState.createTime

string

Output only. Creation time.

observedState.defaultRecognitionConfig

object

Default configuration to use for requests with this Recognizer. This can be overwritten by inline configuration in the [RecognizeRequest.config][google.cloud.speech.v2.RecognizeRequest.config] field.

observedState.defaultRecognitionConfig.adaptation

object

Speech adaptation context that weights recognizer predictions for specific words and phrases.

observedState.defaultRecognitionConfig.adaptation.customClasses

list (object)

A list of inline CustomClasses. Existing CustomClass resources can be referenced directly in a PhraseSet.

observedState.defaultRecognitionConfig.adaptation.customClasses[]

object

observedState.defaultRecognitionConfig.adaptation.customClasses[].createTime

string

Output only. Creation time.

observedState.defaultRecognitionConfig.adaptation.customClasses[].deleteTime

string

Output only. The time at which this resource was requested for deletion.

observedState.defaultRecognitionConfig.adaptation.customClasses[].etag

string

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.

observedState.defaultRecognitionConfig.adaptation.customClasses[].expireTime

string

Output only. The time at which this resource will be purged.

observedState.defaultRecognitionConfig.adaptation.customClasses[].kmsKeyName

string

Output only. The [KMS key name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which the CustomClass is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.

observedState.defaultRecognitionConfig.adaptation.customClasses[].kmsKeyVersionName

string

Output only. The [KMS key version name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions) with which the CustomClass is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.

observedState.defaultRecognitionConfig.adaptation.customClasses[].name

string

Output only. Identifier. The resource name of the CustomClass. Format: `projects/{project}/locations/{location}/customClasses/{custom_class}`.

observedState.defaultRecognitionConfig.adaptation.customClasses[].reconciling

boolean

Output only. Whether or not this CustomClass is in the process of being updated.

observedState.defaultRecognitionConfig.adaptation.customClasses[].state

string

Output only. The CustomClass lifecycle state.

observedState.defaultRecognitionConfig.adaptation.customClasses[].uid

string

Output only. System-assigned unique identifier for the CustomClass.

observedState.defaultRecognitionConfig.adaptation.customClasses[].updateTime

string

Output only. The most recent time this resource was modified.

observedState.defaultRecognitionConfig.adaptation.phraseSets

list (object)

A list of inline or referenced PhraseSets.

observedState.defaultRecognitionConfig.adaptation.phraseSets[]

object

observedState.defaultRecognitionConfig.adaptation.phraseSets[].inlinePhraseSet

object

An inline defined PhraseSet.

observedState.defaultRecognitionConfig.adaptation.phraseSets[].inlinePhraseSet.createTime

string

Output only. Creation time.

observedState.defaultRecognitionConfig.adaptation.phraseSets[].inlinePhraseSet.deleteTime

string

Output only. The time at which this resource was requested for deletion.

observedState.defaultRecognitionConfig.adaptation.phraseSets[].inlinePhraseSet.etag

string

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.

observedState.defaultRecognitionConfig.adaptation.phraseSets[].inlinePhraseSet.expireTime

string

Output only. The time at which this resource will be purged.

observedState.defaultRecognitionConfig.adaptation.phraseSets[].inlinePhraseSet.kmsKeyName

string

Output only. The [KMS key name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which the PhraseSet is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.

observedState.defaultRecognitionConfig.adaptation.phraseSets[].inlinePhraseSet.kmsKeyVersionName

string

Output only. The [KMS key version name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions) with which the PhraseSet is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.

observedState.defaultRecognitionConfig.adaptation.phraseSets[].inlinePhraseSet.name

string

Output only. Identifier. The resource name of the PhraseSet. Format: `projects/{project}/locations/{location}/phraseSets/{phrase_set}`.

observedState.defaultRecognitionConfig.adaptation.phraseSets[].inlinePhraseSet.reconciling

boolean

Output only. Whether or not this PhraseSet is in the process of being updated.

observedState.defaultRecognitionConfig.adaptation.phraseSets[].inlinePhraseSet.state

string

Output only. The PhraseSet lifecycle state.

observedState.defaultRecognitionConfig.adaptation.phraseSets[].inlinePhraseSet.uid

string

Output only. System-assigned unique identifier for the PhraseSet.

observedState.defaultRecognitionConfig.adaptation.phraseSets[].inlinePhraseSet.updateTime

string

Output only. The most recent time this resource was modified.

observedState.deleteTime

string

Output only. The time at which this Recognizer was requested for deletion.

observedState.etag

string

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.

observedState.expireTime

string

Output only. The time at which this Recognizer will be purged.

observedState.kmsKeyName

string

Output only. The [KMS key name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which the Recognizer is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.

observedState.kmsKeyVersionName

string

Output only. The [KMS key version name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions) with which the Recognizer is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.

observedState.reconciling

boolean

Output only. Whether or not this Recognizer is in the process of being updated.

observedState.state

string

Output only. The Recognizer lifecycle state.

observedState.uid

string

Output only. System-assigned unique identifier for the Recognizer.

observedState.updateTime

string

Output only. The most recent time this Recognizer was modified.

Sample YAML(s)

Typical Use Case

  # Copyright 2025 Google LLC 
 # 
 # Licensed under the Apache License, Version 2.0 (the "License"); 
 # you may not use this file except in compliance with the License. 
 # You may obtain a copy of the License at 
 # 
 #      http://www.apache.org/licenses/LICENSE-2.0 
 # 
 # Unless required by applicable law or agreed to in writing, software 
 # distributed under the License is distributed on an "AS IS" BASIS, 
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 # See the License for the specific language governing permissions and 
 # limitations under the License. 
 apiVersion 
 : 
  
 speech.cnrm.cloud.google.com/v1beta1 
 kind 
 : 
  
 SpeechRecognizer 
 metadata 
 : 
  
 name 
 : 
  
 speechrecognizer-sample 
 spec 
 : 
  
 projectRef 
 : 
  
 external 
 : 
  
 "projects/${PROJECT_ID?}" 
  
 location 
 : 
  
 global 
  
 displayName 
 : 
  
 "Sample 
  
 Speech 
  
 Recognizer" 
  
 defaultRecognitionConfig 
 : 
  
 model 
 : 
  
 long 
  
 languageCodes 
 : 
  
 - 
  
 en-US 
 
Create a Mobile Website
View Site in Mobile | Classic
Share by: