com.google.cloud.speech.v2

Class PhraseSet.Phrase.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<PhraseSet.Phrase.Builder>

com.google.cloud.speech.v2.PhraseSet.Phrase.Builder

All Implemented Interfaces:

PhraseSet.PhraseOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

PhraseSet.Phrase

public static final class PhraseSet.Phrase.Builder
extends com.google.protobuf.GeneratedMessage.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

Method Summary

Modifier and Type	Method and Description
PhraseSet.Phrase	build()
PhraseSet.Phrase	buildPartial()
PhraseSet.Phrase.Builder	clear()
PhraseSet.Phrase.Builder	clearBoost() Hint Boost.
PhraseSet.Phrase.Builder	clearValue() The phrase itself.
float	getBoost() Hint Boost.
PhraseSet.Phrase	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getValue() The phrase itself.
com.google.protobuf.ByteString	getValueBytes() The phrase itself.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
PhraseSet.Phrase.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
PhraseSet.Phrase.Builder	mergeFrom(com.google.protobuf.Message other)
PhraseSet.Phrase.Builder	mergeFrom(PhraseSet.Phrase other)
PhraseSet.Phrase.Builder	setBoost(float value) Hint Boost.
PhraseSet.Phrase.Builder	setValue(String value) The phrase itself.
PhraseSet.Phrase.Builder	setValueBytes(com.google.protobuf.ByteString value) The phrase itself.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<PhraseSet.Phrase.Builder>

clear

public PhraseSet.Phrase.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<PhraseSet.Phrase.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<PhraseSet.Phrase.Builder>

getDefaultInstanceForType

public PhraseSet.Phrase getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public PhraseSet.Phrase build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public PhraseSet.Phrase buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public PhraseSet.Phrase.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PhraseSet.Phrase.Builder>

mergeFrom

public PhraseSet.Phrase.Builder mergeFrom(PhraseSet.Phrase other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<PhraseSet.Phrase.Builder>

mergeFrom

public PhraseSet.Phrase.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PhraseSet.Phrase.Builder>

Throws:

IOException

getValue

public String getValue()

 The phrase itself.
 

string value = 1;

Specified by:

getValue in interface PhraseSet.PhraseOrBuilder

Returns:

The value.

getValueBytes

public com.google.protobuf.ByteString getValueBytes()

 The phrase itself.
 

string value = 1;

Specified by:

getValueBytes in interface PhraseSet.PhraseOrBuilder

Returns:

The bytes for value.

setValue

public PhraseSet.Phrase.Builder setValue(String value)

 The phrase itself.
 

string value = 1;

Parameters:

value - The value to set.

Returns:

This builder for chaining.

clearValue

public PhraseSet.Phrase.Builder clearValue()

 The phrase itself.
 

string value = 1;

Returns:

This builder for chaining.

setValueBytes

public PhraseSet.Phrase.Builder setValueBytes(com.google.protobuf.ByteString value)

 The phrase itself.
 

string value = 1;

Parameters:

value - The bytes for value to set.

Returns:

This builder for chaining.

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;

Specified by:

getBoost in interface PhraseSet.PhraseOrBuilder

Returns:

The boost.

setBoost

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;

Parameters:

value - The boost to set.

Returns:

This builder for chaining.

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:

This builder for chaining.