Class PhraseSet (2.28.0)

Version 2.28.0

• 2.28.1 (latest)
• 2.28.0
• 2.27.0
• 2.26.1
• 2.25.1
• 2.24.1
• 2.23.0
• 2.22.0
• 2.21.1
• 2.20.1
• 2.19.0
• 2.18.0
• 2.17.3
• 2.16.2
• 2.15.1
• 2.14.1
• 2.13.1
• 2.12.0
• 2.11.1
• 2.10.0
• 2.9.3
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.1
• 2.4.1
• 2.3.0
• 2.2.1
• 2.1.0
• 2.0.1
• 1.3.4
• 1.2.0
• 1.1.0

PhraseSet(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.
phrases	MutableSequence[google.cloud.speech_v2.types.PhraseSet.Phrase] A list of word and phrases.
boost	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.
state	google.cloud.speech_v2.types.PhraseSet.State Output only. The PhraseSet lifecycle state.
create_time	google.protobuf.timestamp_pb2.Timestamp Output only. Creation time.
update_time	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.
kms_key_name	str Output only. The `KMS key name
kms_key_version_name	str Output only. The `KMS key version name

Classes

AnnotationsEntry

AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

Phrase

Phrase(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.