public static final class PhraseSet.Phrase.Builder extends GeneratedMessageV3.Builder<PhraseSet.Phrase.Builder> implements PhraseSet.PhraseOrBuilder
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.
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
with matching us or eu location value.
Protobuf type google.cloud.speech.v1.PhraseSet.Phrase
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PhraseSet.Phrase.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public PhraseSet.Phrase build()
buildPartial()
public PhraseSet.Phrase buildPartial()
clear()
public PhraseSet.Phrase.Builder clear()
Overrides
clearBoost()
public PhraseSet.Phrase.Builder clearBoost()
Hint Boost. Overrides the boost set at the phrase set level.
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 will simply be ignored. Though boost can accept a wide range of
positive values, most use cases are best served
with values between 0 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 = 2;
clearField(Descriptors.FieldDescriptor field)
public PhraseSet.Phrase.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public PhraseSet.Phrase.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearValue()
public PhraseSet.Phrase.Builder clearValue()
The phrase itself.
string value = 1;
clone()
public PhraseSet.Phrase.Builder clone()
Overrides
getBoost()
Hint Boost. Overrides the boost set at the phrase set level.
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 will simply be ignored. Though boost can accept a wide range of
positive values, most use cases are best served
with values between 0 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 = 2;
| Returns |
|---|
| Type | Description |
float | The boost.
|
getDefaultInstanceForType()
public PhraseSet.Phrase getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getValue()
The phrase itself.
string value = 1;
| Returns |
|---|
| Type | Description |
String | The value.
|
getValueBytes()
public ByteString getValueBytes()
The phrase itself.
string value = 1;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for value.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(PhraseSet.Phrase other)
public PhraseSet.Phrase.Builder mergeFrom(PhraseSet.Phrase other)
public PhraseSet.Phrase.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public PhraseSet.Phrase.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PhraseSet.Phrase.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setBoost(float value)
public PhraseSet.Phrase.Builder setBoost(float value)
Hint Boost. Overrides the boost set at the phrase set level.
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 will simply be ignored. Though boost can accept a wide range of
positive values, most use cases are best served
with values between 0 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 = 2;
| Parameter |
|---|
| Name | Description |
value | float
The boost to set.
|
setField(Descriptors.FieldDescriptor field, Object value)
public PhraseSet.Phrase.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PhraseSet.Phrase.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final PhraseSet.Phrase.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
setValue(String value)
public PhraseSet.Phrase.Builder setValue(String value)
The phrase itself.
string value = 1;
| Parameter |
|---|
| Name | Description |
value | String
The value to set.
|
setValueBytes(ByteString value)
public PhraseSet.Phrase.Builder setValueBytes(ByteString value)
The phrase itself.
string value = 1;
| Parameter |
|---|
| Name | Description |
value | ByteString
The bytes for value to set.
|
