public sealed class PhraseSet : IMessage<PhraseSet>, IEquatable<PhraseSet>, IDeepCloneable<PhraseSet>, IBufferMessage, IMessage
Reference documentation and code samples for the Cloud Speech-to-Text v2 API class PhraseSet.
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.
Implements
IMessagePhraseSet, IEquatablePhraseSet, IDeepCloneablePhraseSet, IBufferMessage, IMessageNamespace
Google.Cloud.Speech.V2Assembly
Google.Cloud.Speech.V2.dll
Constructors
PhraseSet()
public PhraseSet()
PhraseSet(PhraseSet)
public PhraseSet(PhraseSet other)
Parameter | |
---|---|
Name | Description |
other |
PhraseSet |
Properties
Annotations
public MapField<string, string> Annotations { get; }
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.
Property Value | |
---|---|
Type | Description |
MapFieldstringstring |
Boost
public float Boost { get; set; }
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.
Property Value | |
---|---|
Type | Description |
float |
CreateTime
public Timestamp CreateTime { get; set; }
Output only. Creation time.
Property Value | |
---|---|
Type | Description |
Timestamp |
DeleteTime
public Timestamp DeleteTime { get; set; }
Output only. The time at which this resource was requested for deletion.
Property Value | |
---|---|
Type | Description |
Timestamp |
DisplayName
public string DisplayName { get; set; }
User-settable, human-readable name for the PhraseSet. Must be 63 characters or less.
Property Value | |
---|---|
Type | Description |
string |
Etag
public string Etag { get; set; }
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.
Property Value | |
---|---|
Type | Description |
string |
ExpireTime
public Timestamp ExpireTime { get; set; }
Output only. The time at which this resource will be purged.
Property Value | |
---|---|
Type | Description |
Timestamp |
KmsKeyName
public string KmsKeyName { get; set; }
Output only. The KMS key
name with which
the PhraseSet is encrypted. The expected format is
projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}
.
Property Value | |
---|---|
Type | Description |
string |
KmsKeyNameAsCryptoKeyName
public CryptoKeyName KmsKeyNameAsCryptoKeyName { get; set; }
CryptoKeyName-typed view over the KmsKeyName resource name property.
Property Value | |
---|---|
Type | Description |
CryptoKeyName |
KmsKeyVersionName
public string KmsKeyVersionName { get; set; }
Output only. The KMS key version
name
with which the PhraseSet is encrypted. The expected format is
projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}
.
Property Value | |
---|---|
Type | Description |
string |
KmsKeyVersionNameAsCryptoKeyVersionName
public CryptoKeyVersionName KmsKeyVersionNameAsCryptoKeyVersionName { get; set; }
CryptoKeyVersionName-typed view over the KmsKeyVersionName resource name property.
Property Value | |
---|---|
Type | Description |
CryptoKeyVersionName |
Name
public string Name { get; set; }
Output only. Identifier. The resource name of the PhraseSet.
Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}
.
Property Value | |
---|---|
Type | Description |
string |
PhraseSetName
public PhraseSetName PhraseSetName { get; set; }
PhraseSetName-typed view over the Name resource name property.
Property Value | |
---|---|
Type | Description |
PhraseSetName |
Phrases
public RepeatedField<PhraseSet.Types.Phrase> Phrases { get; }
A list of word and phrases.
Property Value | |
---|---|
Type | Description |
RepeatedFieldPhraseSetTypesPhrase |
Reconciling
public bool Reconciling { get; set; }
Output only. Whether or not this PhraseSet is in the process of being updated.
Property Value | |
---|---|
Type | Description |
bool |
State
public PhraseSet.Types.State State { get; set; }
Output only. The PhraseSet lifecycle state.
Property Value | |
---|---|
Type | Description |
PhraseSetTypesState |
Uid
public string Uid { get; set; }
Output only. System-assigned unique identifier for the PhraseSet.
Property Value | |
---|---|
Type | Description |
string |
UpdateTime
public Timestamp UpdateTime { get; set; }
Output only. The most recent time this resource was modified.
Property Value | |
---|---|
Type | Description |
Timestamp |