Class SpeechContext.Builder (4.89.0)

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

Hints for the speech recognizer to help with recognition in a specific conversation state.

Protobuf type google.cloud.dialogflow.v2.SpeechContext

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)

Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood.

This list can be used to:

  • improve accuracy for words and phrases you expect the user to say, e.g. typical commands for your Dialogflow agent
  • add additional words to the speech recognizer vocabulary
  • ...

    See the Cloud Speech documentation for usage limits.

repeated string phrases = 1 [(.google.api.field_behavior) = OPTIONAL];

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)

Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood.

This list can be used to:

  • improve accuracy for words and phrases you expect the user to say, e.g. typical commands for your Dialogflow agent
  • add additional words to the speech recognizer vocabulary
  • ...

    See the Cloud Speech documentation for usage limits.

repeated string phrases = 1 [(.google.api.field_behavior) = OPTIONAL];

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)

Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood.

This list can be used to:

  • improve accuracy for words and phrases you expect the user to say, e.g. typical commands for your Dialogflow agent
  • add additional words to the speech recognizer vocabulary
  • ...

    See the Cloud Speech documentation for usage limits.

repeated string phrases = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the phrases to add.

Returns
Type Description
SpeechContext.Builder

This builder for chaining.

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()

Optional. Boost for this context compared to other contexts:

  • If the boost is positive, Dialogflow will increase the probability that the phrases in this context are recognized over similar sounding phrases.
  • If the boost is unspecified or non-positive, Dialogflow will not apply any boost.

    Dialogflow recommends that you use boosts in the range (0, 20] and that you find a value that fits your use case with binary search.

float boost = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SpeechContext.Builder

This builder for chaining.

clearPhrases()

public SpeechContext.Builder clearPhrases()

Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood.

This list can be used to:

  • improve accuracy for words and phrases you expect the user to say, e.g. typical commands for your Dialogflow agent
  • add additional words to the speech recognizer vocabulary
  • ...

    See the Cloud Speech documentation for usage limits.

repeated string phrases = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SpeechContext.Builder

This builder for chaining.

getBoost()

public float getBoost()

Optional. Boost for this context compared to other contexts:

  • If the boost is positive, Dialogflow will increase the probability that the phrases in this context are recognized over similar sounding phrases.
  • If the boost is unspecified or non-positive, Dialogflow will not apply any boost.

    Dialogflow recommends that you use boosts in the range (0, 20] and that you find a value that fits your use case with binary search.

float boost = 2 [(.google.api.field_behavior) = OPTIONAL];

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)

Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood.

This list can be used to:

  • improve accuracy for words and phrases you expect the user to say, e.g. typical commands for your Dialogflow agent
  • add additional words to the speech recognizer vocabulary
  • ...

    See the Cloud Speech documentation for usage limits.

repeated string phrases = 1 [(.google.api.field_behavior) = OPTIONAL];

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)

Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood.

This list can be used to:

  • improve accuracy for words and phrases you expect the user to say, e.g. typical commands for your Dialogflow agent
  • add additional words to the speech recognizer vocabulary
  • ...

    See the Cloud Speech documentation for usage limits.

repeated string phrases = 1 [(.google.api.field_behavior) = OPTIONAL];

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()

Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood.

This list can be used to:

  • improve accuracy for words and phrases you expect the user to say, e.g. typical commands for your Dialogflow agent
  • add additional words to the speech recognizer vocabulary
  • ...

    See the Cloud Speech documentation for usage limits.

repeated string phrases = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of phrases.

getPhrasesList()

public ProtocolStringList getPhrasesList()

Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood.

This list can be used to:

  • improve accuracy for words and phrases you expect the user to say, e.g. typical commands for your Dialogflow agent
  • add additional words to the speech recognizer vocabulary
  • ...

    See the Cloud Speech documentation for usage limits.

repeated string phrases = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the phrases.

internalGetFieldAccessorTable()

protected GeneratedMessage.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

setBoost(float value)

public SpeechContext.Builder setBoost(float value)

Optional. Boost for this context compared to other contexts:

  • If the boost is positive, Dialogflow will increase the probability that the phrases in this context are recognized over similar sounding phrases.
  • If the boost is unspecified or non-positive, Dialogflow will not apply any boost.

    Dialogflow recommends that you use boosts in the range (0, 20] and that you find a value that fits your use case with binary search.

float boost = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value float

The boost to set.

Returns
Type Description
SpeechContext.Builder

This builder for chaining.

setPhrases(int index, String value)

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

Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood.

This list can be used to:

  • improve accuracy for words and phrases you expect the user to say, e.g. typical commands for your Dialogflow agent
  • add additional words to the speech recognizer vocabulary
  • ...

    See the Cloud Speech documentation for usage limits.

repeated string phrases = 1 [(.google.api.field_behavior) = OPTIONAL];

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.