Class PhraseSet (4.7.0)

Version 4.7.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 final class PhraseSet extends GeneratedMessageV3 implements PhraseSetOrBuilder

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

Protobuf type google.cloud.speech.v1p1beta1.PhraseSet

Inheritance

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

Implements

PhraseSetOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

BOOST_FIELD_NUMBER

public static final int BOOST_FIELD_NUMBER

Field Value

Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value

Type	Description
int

PHRASES_FIELD_NUMBER

public static final int PHRASES_FIELD_NUMBER

Field Value

Type	Description
int

Static Methods

getDefaultInstance()

public static PhraseSet getDefaultInstance()

Returns

Type	Description
PhraseSet

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static PhraseSet.Builder newBuilder()

Returns

Type	Description
PhraseSet.Builder

newBuilder(PhraseSet prototype)

public static PhraseSet.Builder newBuilder(PhraseSet prototype)

Parameter

Name	Description
prototype	PhraseSet

Returns

Type	Description
PhraseSet.Builder

parseDelimitedFrom(InputStream input)

public static PhraseSet parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
PhraseSet

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PhraseSet parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
PhraseSet

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static PhraseSet parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
PhraseSet

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PhraseSet parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
PhraseSet

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PhraseSet parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
PhraseSet

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PhraseSet parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
PhraseSet

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PhraseSet parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
PhraseSet

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PhraseSet parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
PhraseSet

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static PhraseSet parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
PhraseSet

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PhraseSet parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
PhraseSet

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static PhraseSet parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
PhraseSet

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PhraseSet parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
PhraseSet

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<PhraseSet> parser()

Returns

Type	Description
Parser<PhraseSet>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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 as well as adding phrases both with and without boost to your requests.

float boost = 4;

Returns

Type	Description
float	The boost.

getDefaultInstanceForType()

public PhraseSet getDefaultInstanceForType()

Returns

Type	Description
PhraseSet

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.

getParserForType()

public Parser<PhraseSet> getParserForType()

Returns

Type	Description
Parser<PhraseSet>

Overrides

GeneratedMessageV3.getParserForType()

getPhrases(int index)

public PhraseSet.Phrase getPhrases(int index)

A list of word and phrases.

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

Parameter

Name	Description
index	int

Returns

Type	Description
PhraseSet.Phrase

getPhrasesCount()

public int getPhrasesCount()

A list of word and phrases.

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

Returns

Type	Description
int

getPhrasesList()

public List<PhraseSet.Phrase> getPhrasesList()

A list of word and phrases.

repeated .google.cloud.speech.v1p1beta1.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.v1p1beta1.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.v1p1beta1.PhraseSet.Phrase phrases = 2;

Returns

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

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public PhraseSet.Builder newBuilderForType()

Returns

Type	Description
PhraseSet.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PhraseSet.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
PhraseSet.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public PhraseSet.Builder toBuilder()

Returns

Type	Description
PhraseSet.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException