Class PhraseSet.Phrase.Builder (4.30.0)

public static final class PhraseSet.Phrase.Builder extends GeneratedMessageV3.Builder<PhraseSet.Phrase.Builder> implements PhraseSet.PhraseOrBuilder

A Phrase contains 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.

List items can also include CustomClass references containing groups of words that represent common concepts that occur in natural language.

Protobuf type google.cloud.speech.v2.PhraseSet.Phrase

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PhraseSet.Phrase.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PhraseSet.Phrase.Builder
Overrides

build()

public PhraseSet.Phrase build()
Returns
TypeDescription
PhraseSet.Phrase

buildPartial()

public PhraseSet.Phrase buildPartial()
Returns
TypeDescription
PhraseSet.Phrase

clear()

public PhraseSet.Phrase.Builder clear()
Returns
TypeDescription
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 values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost values will return an error. Boost values must be between 0 and 20. Any values outside that range will return an error. 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
TypeDescription
PhraseSet.Phrase.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public PhraseSet.Phrase.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
PhraseSet.Phrase.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public PhraseSet.Phrase.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
PhraseSet.Phrase.Builder
Overrides

clearValue()

public PhraseSet.Phrase.Builder clearValue()

The phrase itself.

string value = 1;

Returns
TypeDescription
PhraseSet.Phrase.Builder

This builder for chaining.

clone()

public PhraseSet.Phrase.Builder clone()
Returns
TypeDescription
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 values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost values will return an error. Boost values must be between 0 and 20. Any values outside that range will return an error. 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
TypeDescription
float

The boost.

getDefaultInstanceForType()

public PhraseSet.Phrase getDefaultInstanceForType()
Returns
TypeDescription
PhraseSet.Phrase

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getValue()

public String getValue()

The phrase itself.

string value = 1;

Returns
TypeDescription
String

The value.

getValueBytes()

public ByteString getValueBytes()

The phrase itself.

string value = 1;

Returns
TypeDescription
ByteString

The bytes for value.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(PhraseSet.Phrase other)

public PhraseSet.Phrase.Builder mergeFrom(PhraseSet.Phrase other)
Parameter
NameDescription
otherPhraseSet.Phrase
Returns
TypeDescription
PhraseSet.Phrase.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PhraseSet.Phrase.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PhraseSet.Phrase.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public PhraseSet.Phrase.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
PhraseSet.Phrase.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PhraseSet.Phrase.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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 values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost values will return an error. Boost values must be between 0 and 20. Any values outside that range will return an error. 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
NameDescription
valuefloat

The boost to set.

Returns
TypeDescription
PhraseSet.Phrase.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public PhraseSet.Phrase.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
PhraseSet.Phrase.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final PhraseSet.Phrase.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PhraseSet.Phrase.Builder
Overrides

setValue(String value)

public PhraseSet.Phrase.Builder setValue(String value)

The phrase itself.

string value = 1;

Parameter
NameDescription
valueString

The value to set.

Returns
TypeDescription
PhraseSet.Phrase.Builder

This builder for chaining.

setValueBytes(ByteString value)

public PhraseSet.Phrase.Builder setValueBytes(ByteString value)

The phrase itself.

string value = 1;

Parameter
NameDescription
valueByteString

The bytes for value to set.

Returns
TypeDescription
PhraseSet.Phrase.Builder

This builder for chaining.