Class PhraseSet.Phrase (4.44.0)

public static final class PhraseSet.Phrase extends GeneratedMessageV3 implements PhraseSet.PhraseOrBuilder

A phrases containing 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. See usage limits.

List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built $MONTH class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with $ e.g. $MONTH. To refer to custom classes that were defined inline in the request, set the class's custom_class_id to a string unique to all class resources and inline classes. Then use the class' id wrapped in ${...} e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in ${} (e.g. ${my-months}).

Speech-to-Text supports three locations: global, us (US North America), and eu (Europe). If you are calling the speech.googleapis.com endpoint, use the global location. To specify a region, use a regional endpoint with matching us or eu location value.

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

Static Fields

BOOST_FIELD_NUMBER

public static final int BOOST_FIELD_NUMBER
Field Value
Type Description
int

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PhraseSet.Phrase getDefaultInstance()
Returns
Type Description
PhraseSet.Phrase

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PhraseSet.Phrase.Builder newBuilder()
Returns
Type Description
PhraseSet.Phrase.Builder

newBuilder(PhraseSet.Phrase prototype)

public static PhraseSet.Phrase.Builder newBuilder(PhraseSet.Phrase prototype)
Parameter
Name Description
prototype PhraseSet.Phrase
Returns
Type Description
PhraseSet.Phrase.Builder

parseDelimitedFrom(InputStream input)

public static PhraseSet.Phrase parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PhraseSet.Phrase
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PhraseSet.Phrase parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PhraseSet.Phrase
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PhraseSet.Phrase parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PhraseSet.Phrase
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PhraseSet.Phrase parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PhraseSet.Phrase
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PhraseSet.Phrase parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PhraseSet.Phrase
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PhraseSet.Phrase parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PhraseSet.Phrase
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PhraseSet.Phrase parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PhraseSet.Phrase
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PhraseSet.Phrase parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PhraseSet.Phrase
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PhraseSet.Phrase parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PhraseSet.Phrase
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PhraseSet.Phrase parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PhraseSet.Phrase
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PhraseSet.Phrase parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PhraseSet.Phrase
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PhraseSet.Phrase parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PhraseSet.Phrase
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PhraseSet.Phrase> parser()
Returns
Type Description
Parser<Phrase>

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. 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 will simply be ignored. Though boost can accept a wide range of positive values, most use cases are best served with values between 0 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 = 2;

Returns
Type Description
float

The boost.

getDefaultInstanceForType()

public PhraseSet.Phrase getDefaultInstanceForType()
Returns
Type Description
PhraseSet.Phrase

getParserForType()

public Parser<PhraseSet.Phrase> getParserForType()
Returns
Type Description
Parser<Phrase>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getValue()

public String getValue()

The phrase itself.

string value = 1;

Returns
Type Description
String

The value.

getValueBytes()

public ByteString getValueBytes()

The phrase itself.

string value = 1;

Returns
Type Description
ByteString

The bytes for value.

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.Phrase.Builder newBuilderForType()
Returns
Type Description
PhraseSet.Phrase.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PhraseSet.Phrase.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PhraseSet.Phrase.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.Phrase.Builder toBuilder()
Returns
Type Description
PhraseSet.Phrase.Builder

writeTo(CodedOutputStream output)

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