Class SpeechContext.Builder (4.39.0) 

public static final class SpeechContext.Builder extends GeneratedMessageV3.Builder<SpeechContext.Builder> implements SpeechContextOrBuilder

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

Protobuf type google.cloud.speech.v1.SpeechContext

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addAllPhrases(Iterable<String> values)

public SpeechContext.Builder addAllPhrases(Iterable<String> values)

A list of strings containing words and phrases "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 be set to classes for groups of words that represent common concepts that occur in natural language. For example, rather than providing phrase hints for every month of the year, using the $MONTH class improves the likelihood of correctly transcribing audio that includes months.

repeated string phrases = 1;

Parameter
Name Description
values Iterable<String>

The phrases to add.
Returns
Type Description
SpeechContext.Builder

This builder for chaining.

addPhrases(String value)

public SpeechContext.Builder addPhrases(String value)

A list of strings containing words and phrases "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 be set to classes for groups of words that represent common concepts that occur in natural language. For example, rather than providing phrase hints for every month of the year, using the $MONTH class improves the likelihood of correctly transcribing audio that includes months.

repeated string phrases = 1;

Parameter
Name Description
value String

The phrases to add.
Returns
Type Description
SpeechContext.Builder

This builder for chaining.

addPhrasesBytes(ByteString value)

public SpeechContext.Builder addPhrasesBytes(ByteString value)

A list of strings containing words and phrases "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 be set to classes for groups of words that represent common concepts that occur in natural language. For example, rather than providing phrase hints for every month of the year, using the $MONTH class improves the likelihood of correctly transcribing audio that includes months.

repeated string phrases = 1;

Parameter
Name Description
value ByteString

The bytes of the phrases to add.
Returns
Type Description
SpeechContext.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SpeechContext.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SpeechContext.Builder
Overrides

build()

public SpeechContext build()
Returns
Type Description
SpeechContext

buildPartial()

public SpeechContext buildPartial()
Returns
Type Description
SpeechContext

clear()

public SpeechContext.Builder clear()
Returns
Type Description
SpeechContext.Builder
Overrides

clearBoost()

public SpeechContext.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 and 20. We recommend using a binary search approach to finding the optimal value for your use case.

float boost = 4;

Returns
Type Description
SpeechContext.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SpeechContext.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SpeechContext.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SpeechContext.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SpeechContext.Builder
Overrides

clearPhrases()

public SpeechContext.Builder clearPhrases()

A list of strings containing words and phrases "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 be set to classes for groups of words that represent common concepts that occur in natural language. For example, rather than providing phrase hints for every month of the year, using the $MONTH class improves the likelihood of correctly transcribing audio that includes months.

repeated string phrases = 1;

Returns
Type Description
SpeechContext.Builder

This builder for chaining.

clone()

public SpeechContext.Builder clone()
Returns
Type Description
SpeechContext.Builder
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 and 20. We recommend using a binary search approach to finding the optimal value for your use case.

float boost = 4;

Returns
Type Description
float

The boost.

getDefaultInstanceForType()

public SpeechContext getDefaultInstanceForType()
Returns
Type Description
SpeechContext

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getPhrases(int index)

public String getPhrases(int index)

A list of strings containing words and phrases "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 be set to classes for groups of words that represent common concepts that occur in natural language. For example, rather than providing phrase hints for every month of the year, using the $MONTH class improves the likelihood of correctly transcribing audio that includes months.

repeated string phrases = 1;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The phrases at the given index.

getPhrasesBytes(int index)

public ByteString getPhrasesBytes(int index)

A list of strings containing words and phrases "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 be set to classes for groups of words that represent common concepts that occur in natural language. For example, rather than providing phrase hints for every month of the year, using the $MONTH class improves the likelihood of correctly transcribing audio that includes months.

repeated string phrases = 1;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the phrases at the given index.

getPhrasesCount()

public int getPhrasesCount()

A list of strings containing words and phrases "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 be set to classes for groups of words that represent common concepts that occur in natural language. For example, rather than providing phrase hints for every month of the year, using the $MONTH class improves the likelihood of correctly transcribing audio that includes months.

repeated string phrases = 1;

Returns
Type Description
int

The count of phrases.

getPhrasesList()

public ProtocolStringList getPhrasesList()

A list of strings containing words and phrases "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 be set to classes for groups of words that represent common concepts that occur in natural language. For example, rather than providing phrase hints for every month of the year, using the $MONTH class improves the likelihood of correctly transcribing audio that includes months.

repeated string phrases = 1;

Returns
Type Description
ProtocolStringList

A list containing the phrases.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SpeechContext other)

public SpeechContext.Builder mergeFrom(SpeechContext other)
Parameter
Name Description
other SpeechContext
Returns
Type Description
SpeechContext.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SpeechContext.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpeechContext.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SpeechContext.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SpeechContext.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SpeechContext.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SpeechContext.Builder
Overrides

setBoost(float value)

public SpeechContext.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 and 20. We recommend using a binary search approach to finding the optimal value for your use case.

float boost = 4;

Parameter
Name Description
value float

The boost to set.
Returns
Type Description
SpeechContext.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SpeechContext.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SpeechContext.Builder
Overrides

setPhrases(int index, String value)

public SpeechContext.Builder setPhrases(int index, String value)

A list of strings containing words and phrases "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 be set to classes for groups of words that represent common concepts that occur in natural language. For example, rather than providing phrase hints for every month of the year, using the $MONTH class improves the likelihood of correctly transcribing audio that includes months.

repeated string phrases = 1;

Parameters
Name Description
index int

The index to set the value at.
value String

The phrases to set.
Returns
Type Description
SpeechContext.Builder

This builder for chaining.

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

public SpeechContext.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SpeechContext.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final SpeechContext.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SpeechContext.Builder
Overrides