PhraseSet for biasing in speech recognition. A PhraseSet is
used to provide "hints" to the speech recognizer to favor
specific words and phrases in the results.
Attributes
Name
Description
name
str
Output only. Identifier. The resource name of the PhraseSet.
Format:
projects/{project}/locations/{location}/phraseSets/{phrase_set}.
uid
str
Output only. System-assigned unique
identifier for the PhraseSet.
float
Hint Boost. 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. Valid
boost values are between 0 (exclusive) and 20. 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.
display_name
str
User-settable, human-readable name for the
PhraseSet. Must be 63 characters or less.
google.protobuf.timestamp_pb2.Timestamp
Output only. The most recent time this
resource was modified.
delete_time
google.protobuf.timestamp_pb2.Timestamp
Output only. The time at which this resource
was requested for deletion.
expire_time
google.protobuf.timestamp_pb2.Timestamp
Output only. The time at which this resource
will be purged.
annotations
MutableMapping[str, str]
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.
etag
str
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.
reconciling
bool
Output only. Whether or not this PhraseSet is
in the process of being updated.
A Phrase contains words and phrase "hints" so that the speech
recognition is more likely to recognize them. This can be used
to improve the accuracy for specific words and phrases, for
example, if specific commands are typically spoken by the user.
This can also be used to add additional words to the vocabulary
of the recognizer.
List items can also include CustomClass references containing
groups of words that represent common concepts that occur in
natural language.
State
State(value)
Set of states that define the lifecycle of a PhraseSet.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Class PhraseSet (2.33.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.33.0 (latest)](/python/docs/reference/speech/latest/google.cloud.speech_v2.types.PhraseSet)\n- [2.32.0](/python/docs/reference/speech/2.32.0/google.cloud.speech_v2.types.PhraseSet)\n- [2.31.0](/python/docs/reference/speech/2.31.0/google.cloud.speech_v2.types.PhraseSet)\n- [2.30.0](/python/docs/reference/speech/2.30.0/google.cloud.speech_v2.types.PhraseSet)\n- [2.29.0](/python/docs/reference/speech/2.29.0/google.cloud.speech_v2.types.PhraseSet)\n- [2.28.1](/python/docs/reference/speech/2.28.1/google.cloud.speech_v2.types.PhraseSet)\n- [2.27.0](/python/docs/reference/speech/2.27.0/google.cloud.speech_v2.types.PhraseSet)\n- [2.26.1](/python/docs/reference/speech/2.26.1/google.cloud.speech_v2.types.PhraseSet)\n- [2.25.1](/python/docs/reference/speech/2.25.1/google.cloud.speech_v2.types.PhraseSet)\n- [2.24.1](/python/docs/reference/speech/2.24.1/google.cloud.speech_v2.types.PhraseSet)\n- [2.23.0](/python/docs/reference/speech/2.23.0/google.cloud.speech_v2.types.PhraseSet)\n- [2.22.0](/python/docs/reference/speech/2.22.0/google.cloud.speech_v2.types.PhraseSet)\n- [2.21.1](/python/docs/reference/speech/2.21.1/google.cloud.speech_v2.types.PhraseSet)\n- [2.20.1](/python/docs/reference/speech/2.20.1/google.cloud.speech_v2.types.PhraseSet)\n- [2.19.0](/python/docs/reference/speech/2.19.0/google.cloud.speech_v2.types.PhraseSet)\n- [2.18.0](/python/docs/reference/speech/2.18.0/google.cloud.speech_v2.types.PhraseSet)\n- [2.17.3](/python/docs/reference/speech/2.17.3/google.cloud.speech_v2.types.PhraseSet)\n- [2.16.2](/python/docs/reference/speech/2.16.2/google.cloud.speech_v2.types.PhraseSet)\n- [2.15.1](/python/docs/reference/speech/2.15.1/google.cloud.speech_v2.types.PhraseSet)\n- [2.14.1](/python/docs/reference/speech/2.14.1/google.cloud.speech_v2.types.PhraseSet)\n- [2.13.1](/python/docs/reference/speech/2.13.1/google.cloud.speech_v2.types.PhraseSet)\n- [2.12.0](/python/docs/reference/speech/2.12.0/google.cloud.speech_v2.types.PhraseSet)\n- [2.11.1](/python/docs/reference/speech/2.11.1/google.cloud.speech_v2.types.PhraseSet)\n- [2.10.0](/python/docs/reference/speech/2.10.0/google.cloud.speech_v2.types.PhraseSet)\n- [2.9.3](/python/docs/reference/speech/2.9.3/google.cloud.speech_v2.types.PhraseSet)\n- [2.8.0](/python/docs/reference/speech/2.8.0/google.cloud.speech_v2.types.PhraseSet)\n- [2.7.0](/python/docs/reference/speech/2.7.0/google.cloud.speech_v2.types.PhraseSet)\n- [2.6.0](/python/docs/reference/speech/2.6.0/google.cloud.speech_v2.types.PhraseSet)\n- [2.5.1](/python/docs/reference/speech/2.5.1/google.cloud.speech_v2.types.PhraseSet)\n- [2.4.1](/python/docs/reference/speech/2.4.1/google.cloud.speech_v2.types.PhraseSet)\n- [2.3.0](/python/docs/reference/speech/2.3.0/google.cloud.speech_v2.types.PhraseSet)\n- [2.2.1](/python/docs/reference/speech/2.2.1/google.cloud.speech_v2.types.PhraseSet)\n- [2.1.0](/python/docs/reference/speech/2.1.0/google.cloud.speech_v2.types.PhraseSet)\n- [2.0.1](/python/docs/reference/speech/2.0.1/google.cloud.speech_v2.types.PhraseSet)\n- [1.3.4](/python/docs/reference/speech/1.3.4/google.cloud.speech_v2.types.PhraseSet)\n- [1.2.0](/python/docs/reference/speech/1.2.0/google.cloud.speech_v2.types.PhraseSet)\n- [1.1.0](/python/docs/reference/speech/1.1.0/google.cloud.speech_v2.types.PhraseSet) \n\n PhraseSet(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nPhraseSet for biasing in speech recognition. A PhraseSet is\nused to provide \"hints\" to the speech recognizer to favor\nspecific words and phrases in the results.\n\nClasses\n-------\n\n### AnnotationsEntry\n\n AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nThe abstract base class for a message.\n\n### Phrase\n\n Phrase(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nA Phrase contains words and phrase \"hints\" so that the speech\nrecognition is more likely to recognize them. This can be used\nto improve the accuracy for specific words and phrases, for\nexample, if specific commands are typically spoken by the user.\nThis can also be used to add additional words to the vocabulary\nof the recognizer.\n\nList items can also include CustomClass references containing\ngroups of words that represent common concepts that occur in\nnatural language.\n\n### State\n\n State(value)\n\nSet of states that define the lifecycle of a PhraseSet."]]