Class PhraseSet (4.38.0)

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

Implements

PhraseSetOrBuilder

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

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

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PhraseSet.Builder toBuilder()
Returns
Type Description
PhraseSet.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException