Class PhraseSet.Builder (2.4.0)

Version 2.4.0

• 4.48.0 (latest)
• 4.47.0
• 4.46.0
• 4.44.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.35.0
• 4.34.0
• 4.32.0
• 4.31.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.23.0
• 4.22.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.16.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.0
• 4.8.0
• 4.7.0
• 4.6.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.0
• 3.0.0
• 2.6.1
• 2.5.9
• 2.4.0
• 2.3.0
• 2.2.15

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

Provides "hints" to the speech recognizer to favor specific words and phrases in the results.

Protobuf type google.cloud.speech.v1.PhraseSet

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PhraseSet.Builder

Implements

PhraseSetOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addAllPhrases(Iterable<? extends PhraseSet.Phrase> values)

public PhraseSet.Builder addAllPhrases(Iterable<? extends PhraseSet.Phrase> values)

A list of word and phrases.

repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;

Parameter

Name	Description
values	Iterable<? extends com.google.cloud.speech.v1.PhraseSet.Phrase>

Returns

Type	Description
PhraseSet.Builder

addPhrases(PhraseSet.Phrase value)

public PhraseSet.Builder addPhrases(PhraseSet.Phrase value)

A list of word and phrases.

repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;

Parameter

Name	Description
value	PhraseSet.Phrase

Returns

Type	Description
PhraseSet.Builder

addPhrases(PhraseSet.Phrase.Builder builderForValue)

public PhraseSet.Builder addPhrases(PhraseSet.Phrase.Builder builderForValue)

A list of word and phrases.

repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;

Parameter

Name	Description
builderForValue	PhraseSet.Phrase.Builder

Returns

Type	Description
PhraseSet.Builder

addPhrases(int index, PhraseSet.Phrase value)

public PhraseSet.Builder addPhrases(int index, PhraseSet.Phrase value)

A list of word and phrases.

repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;

Parameters

Name	Description
index	int
value	PhraseSet.Phrase

Returns

Type	Description
PhraseSet.Builder

addPhrases(int index, PhraseSet.Phrase.Builder builderForValue)

public PhraseSet.Builder addPhrases(int index, PhraseSet.Phrase.Builder builderForValue)

A list of word and phrases.

repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;

Parameters

Name	Description
index	int
builderForValue	PhraseSet.Phrase.Builder

Returns

Type	Description
PhraseSet.Builder

addPhrasesBuilder()

public PhraseSet.Phrase.Builder addPhrasesBuilder()

A list of word and phrases.

repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;

Returns

Type	Description
PhraseSet.Phrase.Builder

addPhrasesBuilder(int index)

public PhraseSet.Phrase.Builder addPhrasesBuilder(int index)

A list of word and phrases.

repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;

Parameter

Name	Description
index	int

Returns

Type	Description
PhraseSet.Phrase.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PhraseSet.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
PhraseSet.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public PhraseSet build()

Returns

Type	Description
PhraseSet

buildPartial()

public PhraseSet buildPartial()

Returns

Type	Description
PhraseSet

clear()

public PhraseSet.Builder clear()

Returns

Type	Description
PhraseSet.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearBoost()

public PhraseSet.Builder clearBoost()

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. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so 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 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0.

float boost = 4;

Returns

Type	Description
PhraseSet.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public PhraseSet.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
PhraseSet.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearName()

public PhraseSet.Builder clearName()

The resource name of the phrase set.

string name = 1;

Returns

Type	Description
PhraseSet.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PhraseSet.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
PhraseSet.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPhrases()

public PhraseSet.Builder clearPhrases()

A list of word and phrases.

repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;

Returns

Type	Description
PhraseSet.Builder

clone()

public PhraseSet.Builder clone()

Returns

Type	Description
PhraseSet.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getBoost()

public float 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. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so 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 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0.

float boost = 4;

Returns

Type	Description
float	The boost.

getDefaultInstanceForType()

public PhraseSet getDefaultInstanceForType()

Returns

Type	Description
PhraseSet

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getName()

public String getName()

The resource name of the phrase set.

string name = 1;

Returns

Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

The resource name of the phrase set.

string name = 1;

Returns

Type	Description
ByteString	The bytes for name.

getPhrases(int index)

public PhraseSet.Phrase getPhrases(int index)

A list of word and phrases.

repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;

Parameter

Name	Description
index	int

Returns

Type	Description
PhraseSet.Phrase

getPhrasesBuilder(int index)

public PhraseSet.Phrase.Builder getPhrasesBuilder(int index)

A list of word and phrases.

repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;

Parameter

Name	Description
index	int

Returns

Type	Description
PhraseSet.Phrase.Builder

getPhrasesBuilderList()

public List<PhraseSet.Phrase.Builder> getPhrasesBuilderList()

A list of word and phrases.

repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;

Returns

Type	Description
List<Builder>

getPhrasesCount()

public int getPhrasesCount()

A list of word and phrases.

repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;

Returns

Type	Description
int

getPhrasesList()

public List<PhraseSet.Phrase> getPhrasesList()

A list of word and phrases.

repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;

Returns

Type	Description
List<Phrase>

getPhrasesOrBuilder(int index)

public PhraseSet.PhraseOrBuilder getPhrasesOrBuilder(int index)

A list of word and phrases.

repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;

Parameter

Name	Description
index	int

Returns

Type	Description
PhraseSet.PhraseOrBuilder

getPhrasesOrBuilderList()

public List<? extends PhraseSet.PhraseOrBuilder> getPhrasesOrBuilderList()

A list of word and phrases.

repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;

Returns

Type	Description
List<? extends com.google.cloud.speech.v1.PhraseSet.PhraseOrBuilder>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(PhraseSet other)

public PhraseSet.Builder mergeFrom(PhraseSet other)

Parameter

Name	Description
other	PhraseSet

Returns

Type	Description
PhraseSet.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PhraseSet.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
PhraseSet.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public PhraseSet.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
PhraseSet.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PhraseSet.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
PhraseSet.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removePhrases(int index)

public PhraseSet.Builder removePhrases(int index)

A list of word and phrases.

repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;

Parameter

Name	Description
index	int

Returns

Type	Description
PhraseSet.Builder

setBoost(float value)

public PhraseSet.Builder setBoost(float value)

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. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so 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 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0.

float boost = 4;

Parameter

Name	Description
value	float The boost to set.

Returns

Type	Description
PhraseSet.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public PhraseSet.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
PhraseSet.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setName(String value)

public PhraseSet.Builder setName(String value)

The resource name of the phrase set.

string name = 1;

Parameter

Name	Description
value	String The name to set.

Returns

Type	Description
PhraseSet.Builder	This builder for chaining.

setNameBytes(ByteString value)

public PhraseSet.Builder setNameBytes(ByteString value)

The resource name of the phrase set.

string name = 1;

Parameter

Name	Description
value	ByteString The bytes for name to set.

Returns

Type	Description
PhraseSet.Builder	This builder for chaining.

setPhrases(int index, PhraseSet.Phrase value)

public PhraseSet.Builder setPhrases(int index, PhraseSet.Phrase value)

A list of word and phrases.

repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;

Parameters

Name	Description
index	int
value	PhraseSet.Phrase

Returns

Type	Description
PhraseSet.Builder

setPhrases(int index, PhraseSet.Phrase.Builder builderForValue)

public PhraseSet.Builder setPhrases(int index, PhraseSet.Phrase.Builder builderForValue)

A list of word and phrases.

repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;

Parameters

Name	Description
index	int
builderForValue	PhraseSet.Phrase.Builder

Returns

Type	Description
PhraseSet.Builder

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

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

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
PhraseSet.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final PhraseSet.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
PhraseSet.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)