SpeechPhraseSet

A brief introduction to SpeechPhraseSet.

Property	Value
Google Cloud Service Name	Speech-to-Text
Google Cloud Service Documentation	/speech-to-text/docs/
Google Cloud REST Resource Name	v1.projects.locations.phraseSets
Google Cloud REST Resource Documentation	/speech-to-text/docs/reference/rest/v1/projects.locations.phraseSets
Config Connector Resource Short Names	gcpspeechphraseset gcpspeechphrasesets speechphraseset
Config Connector Service Name	speech.googleapis.com
Config Connector Resource Fully Qualified Name	speechphrasesets.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
displayName: string
location: string
phrases:
- boost: string
  value: string
projectRef:
  external: string
  kind: string
  name: string
  namespace: string
resourceID: string

Fields

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.
`displayName` Optional	`string` User-settable, human-readable name for the PhraseSet. Must be 63 characters or less.
`location` Required	`string` Immutable.
`phrases` Optional	`list (object)` A list of word and phrases.
`phrases[]` Optional	`object`
`phrases[].boost` Optional	`string` Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost values will return an error. Boost values must be between 0 and 20. Any values outside that range will return an error. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.
`phrases[].value` Optional	`string` The phrase itself.
`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 SpeechPhraseSet name. If not given, the metadata.name will be used.

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.

displayName

Optional

string

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

location

Required

string

Immutable.

phrases

Optional

list (object)

A list of word and phrases.

phrases[]

Optional

object

phrases[].boost

Optional

string

Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost values will return an error. Boost values must be between 0 and 20. Any values outside that range will return an error. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.

phrases[].value

Optional

string

The phrase itself.

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 SpeechPhraseSet 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
  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 SpeechPhraseSet 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.deleteTime`	`string` Output only. The time at which this resource 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 resource will be purged.
`observedState.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.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.reconciling`	`boolean` Output only. Whether or not this PhraseSet is in the process of being updated.
`observedState.state`	`string` Output only. The PhraseSet lifecycle state.
`observedState.uid`	`string` Output only. System-assigned unique identifier for the PhraseSet.
`observedState.updateTime`	`string` Output only. The most recent time this resource 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: SpeechPhraseSet
metadata:
  name: speechphraseset-sample
spec:
  projectRef:
    external: "projects/${PROJECT_ID?}"
  location: global # Expected resource location to be global
  displayName: "Initial description"
  phrases:
    - value: "initial phrase"
      boost: "1.0"