Class SpeechToTextConfig.Builder (4.61.0) 

public static final class SpeechToTextConfig.Builder extends GeneratedMessageV3.Builder<SpeechToTextConfig.Builder> implements SpeechToTextConfigOrBuilder

Configures speech transcription for ConversationProfile.

Protobuf type google.cloud.dialogflow.v2beta1.SpeechToTextConfig

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addAllPhraseSets(Iterable<String> values)

public SpeechToTextConfig.Builder addAllPhraseSets(Iterable<String> values)

List of names of Cloud Speech phrase sets that are used for transcription.

repeated string phrase_sets = 4 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The phraseSets to add.
Returns
Type Description
SpeechToTextConfig.Builder

This builder for chaining.

addPhraseSets(String value)

public SpeechToTextConfig.Builder addPhraseSets(String value)

List of names of Cloud Speech phrase sets that are used for transcription.

repeated string phrase_sets = 4 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The phraseSets to add.
Returns
Type Description
SpeechToTextConfig.Builder

This builder for chaining.

addPhraseSetsBytes(ByteString value)

public SpeechToTextConfig.Builder addPhraseSetsBytes(ByteString value)

List of names of Cloud Speech phrase sets that are used for transcription.

repeated string phrase_sets = 4 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the phraseSets to add.
Returns
Type Description
SpeechToTextConfig.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public SpeechToTextConfig build()
Returns
Type Description
SpeechToTextConfig

buildPartial()

public SpeechToTextConfig buildPartial()
Returns
Type Description
SpeechToTextConfig

clear()

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

clearAudioEncoding()

public SpeechToTextConfig.Builder clearAudioEncoding()

Audio encoding of the audio content to process.

.google.cloud.dialogflow.v2beta1.AudioEncoding audio_encoding = 6;

Returns
Type Description
SpeechToTextConfig.Builder

This builder for chaining.

clearEnableWordInfo()

public SpeechToTextConfig.Builder clearEnableWordInfo()

If true, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.

bool enable_word_info = 9;

Returns
Type Description
SpeechToTextConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearLanguageCode()

public SpeechToTextConfig.Builder clearLanguageCode()

The language of the supplied audio. Dialogflow does not do translations. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.

string language_code = 8;

Returns
Type Description
SpeechToTextConfig.Builder

This builder for chaining.

clearModel()

public SpeechToTextConfig.Builder clearModel()

Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to Cloud Speech API documentation for more details. If you specify a model, the following models typically have the best performance:

  • phone_call (best for Agent Assist and telephony)
  • latest_short (best for Dialogflow non-telephony)

  • command_and_search

    Leave this field unspecified to use Agent Speech settings for model selection.

string model = 2;

Returns
Type Description
SpeechToTextConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPhraseSets()

public SpeechToTextConfig.Builder clearPhraseSets()

List of names of Cloud Speech phrase sets that are used for transcription.

repeated string phrase_sets = 4 [(.google.api.resource_reference) = { ... }

Returns
Type Description
SpeechToTextConfig.Builder

This builder for chaining.

clearSampleRateHertz()

public SpeechToTextConfig.Builder clearSampleRateHertz()

Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details.

int32 sample_rate_hertz = 7;

Returns
Type Description
SpeechToTextConfig.Builder

This builder for chaining.

clearSpeechModelVariant()

public SpeechToTextConfig.Builder clearSpeechModelVariant()

The speech model used in speech to text. SPEECH_MODEL_VARIANT_UNSPECIFIED, USE_BEST_AVAILABLE will be treated as USE_ENHANCED. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error.

.google.cloud.dialogflow.v2beta1.SpeechModelVariant speech_model_variant = 1;

Returns
Type Description
SpeechToTextConfig.Builder

This builder for chaining.

clearUseTimeoutBasedEndpointing()

public SpeechToTextConfig.Builder clearUseTimeoutBasedEndpointing()

Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.

bool use_timeout_based_endpointing = 11;

Returns
Type Description
SpeechToTextConfig.Builder

This builder for chaining.

clone()

public SpeechToTextConfig.Builder clone()
Returns
Type Description
SpeechToTextConfig.Builder
Overrides

getAudioEncoding()

public AudioEncoding getAudioEncoding()

Audio encoding of the audio content to process.

.google.cloud.dialogflow.v2beta1.AudioEncoding audio_encoding = 6;

Returns
Type Description
AudioEncoding

The audioEncoding.

getAudioEncodingValue()

public int getAudioEncodingValue()

Audio encoding of the audio content to process.

.google.cloud.dialogflow.v2beta1.AudioEncoding audio_encoding = 6;

Returns
Type Description
int

The enum numeric value on the wire for audioEncoding.

getDefaultInstanceForType()

public SpeechToTextConfig getDefaultInstanceForType()
Returns
Type Description
SpeechToTextConfig

getDescriptorForType()

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

getEnableWordInfo()

public boolean getEnableWordInfo()

If true, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.

bool enable_word_info = 9;

Returns
Type Description
boolean

The enableWordInfo.

getLanguageCode()

public String getLanguageCode()

The language of the supplied audio. Dialogflow does not do translations. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.

string language_code = 8;

Returns
Type Description
String

The languageCode.

getLanguageCodeBytes()

public ByteString getLanguageCodeBytes()

The language of the supplied audio. Dialogflow does not do translations. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.

string language_code = 8;

Returns
Type Description
ByteString

The bytes for languageCode.

getModel()

public String getModel()

Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to Cloud Speech API documentation for more details. If you specify a model, the following models typically have the best performance:

  • phone_call (best for Agent Assist and telephony)
  • latest_short (best for Dialogflow non-telephony)

  • command_and_search

    Leave this field unspecified to use Agent Speech settings for model selection.

string model = 2;

Returns
Type Description
String

The model.

getModelBytes()

public ByteString getModelBytes()

Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to Cloud Speech API documentation for more details. If you specify a model, the following models typically have the best performance:

  • phone_call (best for Agent Assist and telephony)
  • latest_short (best for Dialogflow non-telephony)

  • command_and_search

    Leave this field unspecified to use Agent Speech settings for model selection.

string model = 2;

Returns
Type Description
ByteString

The bytes for model.

getPhraseSets(int index)

public String getPhraseSets(int index)

List of names of Cloud Speech phrase sets that are used for transcription.

repeated string phrase_sets = 4 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

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

The phraseSets at the given index.

getPhraseSetsBytes(int index)

public ByteString getPhraseSetsBytes(int index)

List of names of Cloud Speech phrase sets that are used for transcription.

repeated string phrase_sets = 4 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

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

The bytes of the phraseSets at the given index.

getPhraseSetsCount()

public int getPhraseSetsCount()

List of names of Cloud Speech phrase sets that are used for transcription.

repeated string phrase_sets = 4 [(.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of phraseSets.

getPhraseSetsList()

public ProtocolStringList getPhraseSetsList()

List of names of Cloud Speech phrase sets that are used for transcription.

repeated string phrase_sets = 4 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the phraseSets.

getSampleRateHertz()

public int getSampleRateHertz()

Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details.

int32 sample_rate_hertz = 7;

Returns
Type Description
int

The sampleRateHertz.

getSpeechModelVariant()

public SpeechModelVariant getSpeechModelVariant()

The speech model used in speech to text. SPEECH_MODEL_VARIANT_UNSPECIFIED, USE_BEST_AVAILABLE will be treated as USE_ENHANCED. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error.

.google.cloud.dialogflow.v2beta1.SpeechModelVariant speech_model_variant = 1;

Returns
Type Description
SpeechModelVariant

The speechModelVariant.

getSpeechModelVariantValue()

public int getSpeechModelVariantValue()

The speech model used in speech to text. SPEECH_MODEL_VARIANT_UNSPECIFIED, USE_BEST_AVAILABLE will be treated as USE_ENHANCED. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error.

.google.cloud.dialogflow.v2beta1.SpeechModelVariant speech_model_variant = 1;

Returns
Type Description
int

The enum numeric value on the wire for speechModelVariant.

getUseTimeoutBasedEndpointing()

public boolean getUseTimeoutBasedEndpointing()

Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.

bool use_timeout_based_endpointing = 11;

Returns
Type Description
boolean

The useTimeoutBasedEndpointing.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SpeechToTextConfig other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setAudioEncoding(AudioEncoding value)

public SpeechToTextConfig.Builder setAudioEncoding(AudioEncoding value)

Audio encoding of the audio content to process.

.google.cloud.dialogflow.v2beta1.AudioEncoding audio_encoding = 6;

Parameter
Name Description
value AudioEncoding

The audioEncoding to set.
Returns
Type Description
SpeechToTextConfig.Builder

This builder for chaining.

setAudioEncodingValue(int value)

public SpeechToTextConfig.Builder setAudioEncodingValue(int value)

Audio encoding of the audio content to process.

.google.cloud.dialogflow.v2beta1.AudioEncoding audio_encoding = 6;

Parameter
Name Description
value int

The enum numeric value on the wire for audioEncoding to set.
Returns
Type Description
SpeechToTextConfig.Builder

This builder for chaining.

setEnableWordInfo(boolean value)

public SpeechToTextConfig.Builder setEnableWordInfo(boolean value)

If true, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.

bool enable_word_info = 9;

Parameter
Name Description
value boolean

The enableWordInfo to set.
Returns
Type Description
SpeechToTextConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setLanguageCode(String value)

public SpeechToTextConfig.Builder setLanguageCode(String value)

The language of the supplied audio. Dialogflow does not do translations. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.

string language_code = 8;

Parameter
Name Description
value String

The languageCode to set.
Returns
Type Description
SpeechToTextConfig.Builder

This builder for chaining.

setLanguageCodeBytes(ByteString value)

public SpeechToTextConfig.Builder setLanguageCodeBytes(ByteString value)

The language of the supplied audio. Dialogflow does not do translations. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.

string language_code = 8;

Parameter
Name Description
value ByteString

The bytes for languageCode to set.
Returns
Type Description
SpeechToTextConfig.Builder

This builder for chaining.

setModel(String value)

public SpeechToTextConfig.Builder setModel(String value)

Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to Cloud Speech API documentation for more details. If you specify a model, the following models typically have the best performance:

  • phone_call (best for Agent Assist and telephony)
  • latest_short (best for Dialogflow non-telephony)

  • command_and_search

    Leave this field unspecified to use Agent Speech settings for model selection.

string model = 2;

Parameter
Name Description
value String

The model to set.
Returns
Type Description
SpeechToTextConfig.Builder

This builder for chaining.

setModelBytes(ByteString value)

public SpeechToTextConfig.Builder setModelBytes(ByteString value)

Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to Cloud Speech API documentation for more details. If you specify a model, the following models typically have the best performance:

  • phone_call (best for Agent Assist and telephony)
  • latest_short (best for Dialogflow non-telephony)

  • command_and_search

    Leave this field unspecified to use Agent Speech settings for model selection.

string model = 2;

Parameter
Name Description
value ByteString

The bytes for model to set.
Returns
Type Description
SpeechToTextConfig.Builder

This builder for chaining.

setPhraseSets(int index, String value)

public SpeechToTextConfig.Builder setPhraseSets(int index, String value)

List of names of Cloud Speech phrase sets that are used for transcription.

repeated string phrase_sets = 4 [(.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.
value String

The phraseSets to set.
Returns
Type Description
SpeechToTextConfig.Builder

This builder for chaining.

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

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

setSampleRateHertz(int value)

public SpeechToTextConfig.Builder setSampleRateHertz(int value)

Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details.

int32 sample_rate_hertz = 7;

Parameter
Name Description
value int

The sampleRateHertz to set.
Returns
Type Description
SpeechToTextConfig.Builder

This builder for chaining.

setSpeechModelVariant(SpeechModelVariant value)

public SpeechToTextConfig.Builder setSpeechModelVariant(SpeechModelVariant value)

The speech model used in speech to text. SPEECH_MODEL_VARIANT_UNSPECIFIED, USE_BEST_AVAILABLE will be treated as USE_ENHANCED. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error.

.google.cloud.dialogflow.v2beta1.SpeechModelVariant speech_model_variant = 1;

Parameter
Name Description
value SpeechModelVariant

The speechModelVariant to set.
Returns
Type Description
SpeechToTextConfig.Builder

This builder for chaining.

setSpeechModelVariantValue(int value)

public SpeechToTextConfig.Builder setSpeechModelVariantValue(int value)

The speech model used in speech to text. SPEECH_MODEL_VARIANT_UNSPECIFIED, USE_BEST_AVAILABLE will be treated as USE_ENHANCED. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error.

.google.cloud.dialogflow.v2beta1.SpeechModelVariant speech_model_variant = 1;

Parameter
Name Description
value int

The enum numeric value on the wire for speechModelVariant to set.
Returns
Type Description
SpeechToTextConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setUseTimeoutBasedEndpointing(boolean value)

public SpeechToTextConfig.Builder setUseTimeoutBasedEndpointing(boolean value)

Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.

bool use_timeout_based_endpointing = 11;

Parameter
Name Description
value boolean

The useTimeoutBasedEndpointing to set.
Returns
Type Description
SpeechToTextConfig.Builder

This builder for chaining.