public final class PhraseSet extends GeneratedMessageV3 implements PhraseSetOrBuilder
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.
Protobuf type google.cloud.speech.v2.PhraseSet
Static Fields
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
BOOST_FIELD_NUMBER
public static final int BOOST_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DELETE_TIME_FIELD_NUMBER
public static final int DELETE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
EXPIRE_TIME_FIELD_NUMBER
public static final int EXPIRE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
KMS_KEY_NAME_FIELD_NUMBER
public static final int KMS_KEY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
KMS_KEY_VERSION_NAME_FIELD_NUMBER
public static final int KMS_KEY_VERSION_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PHRASES_FIELD_NUMBER
public static final int PHRASES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RECONCILING_FIELD_NUMBER
public static final int RECONCILING_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static PhraseSet getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static PhraseSet.Builder newBuilder()
newBuilder(PhraseSet prototype)
public static PhraseSet.Builder newBuilder(PhraseSet prototype)
public static PhraseSet parseDelimitedFrom(InputStream input)
public static PhraseSet parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static PhraseSet parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PhraseSet parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static PhraseSet parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PhraseSet parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PhraseSet parseFrom(CodedInputStream input)
public static PhraseSet parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PhraseSet parseFrom(InputStream input)
public static PhraseSet parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static PhraseSet parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PhraseSet parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<PhraseSet> parser()
Methods
containsAnnotations(String key)
public boolean containsAnnotations(String key)
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.
map<string, string> annotations = 10;
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAnnotations()
public Map<String,String> getAnnotations()
getAnnotationsCount()
public int getAnnotationsCount()
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.
map<string, string> annotations = 10;
| Returns |
|---|
| Type | Description |
int | |
getAnnotationsMap()
public Map<String,String> getAnnotationsMap()
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.
map<string, string> annotations = 10;
getAnnotationsOrDefault(String key, String defaultValue)
public String getAnnotationsOrDefault(String key, String defaultValue)
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.
map<string, string> annotations = 10;
getAnnotationsOrThrow(String key)
public String getAnnotationsOrThrow(String key)
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.
map<string, string> annotations = 10;
| Parameter |
|---|
| Name | Description |
key | String
|
getBoost()
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.
float boost = 4;
| Returns |
|---|
| Type | Description |
float | The boost.
|
getCreateTime()
public Timestamp getCreateTime()
Output only. Creation time.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Creation time.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public PhraseSet getDefaultInstanceForType()
getDeleteTime()
public Timestamp getDeleteTime()
Output only. The time at which this resource was requested for deletion.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The deleteTime.
|
getDeleteTimeOrBuilder()
public TimestampOrBuilder getDeleteTimeOrBuilder()
Output only. The time at which this resource was requested for deletion.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDisplayName()
public String getDisplayName()
User-settable, human-readable name for the PhraseSet. Must be 63
characters or less.
string display_name = 5;
| Returns |
|---|
| Type | Description |
String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
User-settable, human-readable name for the PhraseSet. Must be 63
characters or less.
string display_name = 5;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for displayName.
|
getEtag()
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.
string etag = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The etag.
|
getEtagBytes()
public ByteString getEtagBytes()
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.
string etag = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for etag.
|
getExpireTime()
public Timestamp getExpireTime()
Output only. The time at which this resource will be purged.
.google.protobuf.Timestamp expire_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The expireTime.
|
getExpireTimeOrBuilder()
public TimestampOrBuilder getExpireTimeOrBuilder()
Output only. The time at which this resource will be purged.
.google.protobuf.Timestamp expire_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getKmsKeyName()
public String getKmsKeyName()
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}.
string kms_key_name = 13 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
String | The kmsKeyName.
|
getKmsKeyNameBytes()
public ByteString getKmsKeyNameBytes()
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}.
string kms_key_name = 13 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
ByteString | The bytes for kmsKeyName.
|
getKmsKeyVersionName()
public String getKmsKeyVersionName()
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}.
string kms_key_version_name = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
String | The kmsKeyVersionName.
|
getKmsKeyVersionNameBytes()
public ByteString getKmsKeyVersionNameBytes()
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}.
string kms_key_version_name = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
ByteString | The bytes for kmsKeyVersionName.
|
getName()
Output only. The resource name of the PhraseSet.
Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only. The resource name of the PhraseSet.
Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<PhraseSet> getParserForType()
Overrides
getPhrases(int index)
public PhraseSet.Phrase getPhrases(int index)
A list of word and phrases.
repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;
| Parameter |
|---|
| Name | Description |
index | int
|
getPhrasesCount()
public int getPhrasesCount()
A list of word and phrases.
repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;
| Returns |
|---|
| Type | Description |
int | |
getPhrasesList()
public List<PhraseSet.Phrase> getPhrasesList()
A list of word and phrases.
repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;
getPhrasesOrBuilder(int index)
public PhraseSet.PhraseOrBuilder getPhrasesOrBuilder(int index)
A list of word and phrases.
repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;
| Parameter |
|---|
| Name | Description |
index | int
|
getPhrasesOrBuilderList()
public List<? extends PhraseSet.PhraseOrBuilder> getPhrasesOrBuilderList()
A list of word and phrases.
repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.speech.v2.PhraseSet.PhraseOrBuilder> | |
getReconciling()
public boolean getReconciling()
Output only. Whether or not this PhraseSet is in the process of being
updated.
bool reconciling = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | The reconciling.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getState()
public PhraseSet.State getState()
Output only. The PhraseSet lifecycle state.
.google.cloud.speech.v2.PhraseSet.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue()
public int getStateValue()
Output only. The PhraseSet lifecycle state.
.google.cloud.speech.v2.PhraseSet.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for state.
|
getUid()
Output only. System-assigned unique identifier for the PhraseSet.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The uid.
|
getUidBytes()
public ByteString getUidBytes()
Output only. System-assigned unique identifier for the PhraseSet.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for uid.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The most recent time this resource was modified.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The most recent time this resource was modified.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. Creation time.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the createTime field is set.
|
hasDeleteTime()
public boolean hasDeleteTime()
Output only. The time at which this resource was requested for deletion.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the deleteTime field is set.
|
hasExpireTime()
public boolean hasExpireTime()
Output only. The time at which this resource will be purged.
.google.protobuf.Timestamp expire_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the expireTime field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. The most recent time this resource was modified.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public PhraseSet.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PhraseSet.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public PhraseSet.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
