PhraseSet(mapping=None, *, ignore_unknown_fields=False, **kwargs)Provides "hints" to the speech recognizer to favor specific words and phrases in the results.
Attributes |
|
|---|---|
| Name | Description |
name |
str
The resource name of the phrase set. |
phrases |
MutableSequence[google.cloud.speech_v1p1beta1.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. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though boost can accept a wide range of positive values, most
use cases are best served with values 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.
|
kms_key_name |
str
Output only. The `KMS key name |
kms_key_version_name |
str
Output only. The `KMS key version name |
uid |
str
Output only. System-assigned unique identifier for the PhraseSet. This field is not used. |
display_name |
str
Output only. User-settable, human-readable name for the PhraseSet. Must be 63 characters or less. This field is not used. |
state |
google.cloud.speech_v1p1beta1.types.PhraseSet.State
Output only. The CustomClass lifecycle state. This field is not used. |
delete_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time at which this resource was requested for deletion. This field is not used. |
expire_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time at which this resource will be purged. This field is not used. |
annotations |
MutableMapping[str, str]
Output only. 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. This field is not used. |
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. This field is not used. |
reconciling |
bool
Output only. Whether or not this PhraseSet is in the process of being updated. This field is not used. |
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,
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 |
Phrase
Phrase(mapping=None, *, ignore_unknown_fields=False, **kwargs)A phrases containing 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.
See usage
limits <https://cloud.google.com/speech-to-text/quotas#content>__.
List items can also include pre-built or custom classes containing
groups of words that represent common concepts that occur in natural
language. For example, rather than providing a phrase hint for every
month of the year (e.g. "i was born in january", "i was born in
febuary", ...), use the pre-built $MONTH class improves the
likelihood of correctly transcribing audio that includes months
(e.g. "i was born in $month"). To refer to pre-built classes, use
the class' symbol prepended with $ e.g. $MONTH. To refer to
custom classes that were defined inline in the request, set the
class's custom_class_id to a string unique to all class
resources and inline classes. Then use the class' id wrapped in
$\ {...} e.g. "${my-months}". To refer to custom classes
resources, use the class' id wrapped in ${} (e.g.
${my-months}).
Speech-to-Text supports three locations: global, us (US
North America), and eu (Europe). If you are calling the
speech.googleapis.com endpoint, use the global location. To
specify a region, use a regional
endpoint <https://cloud.google.com/speech-to-text/docs/endpoints>__
with matching us or eu location value.
State
State(value)Set of states that define the lifecycle of a CustomClass.