Class PhraseSet.Phrase.Builder (4.46.0)

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.v1p1beta1.PhraseSet.Phrase

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PhraseSet.Phrase.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PhraseSet.Phrase.Builder
Overrides

build()

public PhraseSet.Phrase build()
Returns
Type Description
PhraseSet.Phrase

buildPartial()

public PhraseSet.Phrase buildPartial()
Returns
Type Description
PhraseSet.Phrase

clear()

public PhraseSet.Phrase.Builder clear()
Returns
Type Description
PhraseSet.Phrase.Builder
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;

Returns
Type Description
PhraseSet.Phrase.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public PhraseSet.Phrase.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
PhraseSet.Phrase.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public PhraseSet.Phrase.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
PhraseSet.Phrase.Builder
Overrides

clearValue()

public PhraseSet.Phrase.Builder clearValue()

The phrase itself.

string value = 1;

Returns
Type Description
PhraseSet.Phrase.Builder

This builder for chaining.

clone()

public PhraseSet.Phrase.Builder clone()
Returns
Type Description
PhraseSet.Phrase.Builder
Overrides

getBoost()

public float 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()
Returns
Type Description
PhraseSet.Phrase

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getValue()

public String 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()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(PhraseSet.Phrase other)

public PhraseSet.Phrase.Builder mergeFrom(PhraseSet.Phrase other)
Parameter
Name Description
other PhraseSet.Phrase
Returns
Type Description
PhraseSet.Phrase.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PhraseSet.Phrase.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PhraseSet.Phrase.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public PhraseSet.Phrase.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PhraseSet.Phrase.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PhraseSet.Phrase.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PhraseSet.Phrase.Builder
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.

Returns
Type Description
PhraseSet.Phrase.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public PhraseSet.Phrase.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PhraseSet.Phrase.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PhraseSet.Phrase.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
PhraseSet.Phrase.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final PhraseSet.Phrase.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PhraseSet.Phrase.Builder
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.

Returns
Type Description
PhraseSet.Phrase.Builder

This builder for chaining.

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.

Returns
Type Description
PhraseSet.Phrase.Builder

This builder for chaining.