Class StreamingAnalyzeContentRequest.Builder (4.47.0)

public static final class StreamingAnalyzeContentRequest.Builder extends GeneratedMessageV3.Builder<StreamingAnalyzeContentRequest.Builder> implements StreamingAnalyzeContentRequestOrBuilder

The top-level message sent by the client to the Participants.StreamingAnalyzeContent method.

Multiple request messages should be sent in order:

  1. The first message must contain participant, config and optionally query_params. If you want to receive an audio response, it should also contain reply_audio_config. The message must not contain input.

  2. If config in the first message was set to audio_config, all subsequent messages must contain input_audio to continue with Speech recognition. However, note that:

    • Dialogflow will bill you for the audio so far.
    • Dialogflow discards all Speech recognition results in favor of the text input.
    1. If StreamingAnalyzeContentRequest.config in the first message was set to StreamingAnalyzeContentRequest.text_config, then the second message must contain only input_text. Moreover, you must not send more than two messages.

    After you sent all input, you must half-close or abort the request stream.

Protobuf type google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StreamingAnalyzeContentRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder
Overrides

build()

public StreamingAnalyzeContentRequest build()
Returns
TypeDescription
StreamingAnalyzeContentRequest

buildPartial()

public StreamingAnalyzeContentRequest buildPartial()
Returns
TypeDescription
StreamingAnalyzeContentRequest

clear()

public StreamingAnalyzeContentRequest.Builder clear()
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder
Overrides

clearAssistQueryParams()

public StreamingAnalyzeContentRequest.Builder clearAssistQueryParams()

Parameters for a human assist query.

.google.cloud.dialogflow.v2.AssistQueryParameters assist_query_params = 8;

Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

clearAudioConfig()

public StreamingAnalyzeContentRequest.Builder clearAudioConfig()

Instructs the speech recognizer how to process the speech audio.

.google.cloud.dialogflow.v2.InputAudioConfig audio_config = 2;

Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

clearConfig()

public StreamingAnalyzeContentRequest.Builder clearConfig()
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

clearCxParameters()

public StreamingAnalyzeContentRequest.Builder clearCxParameters()

Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

Note: this field should only be used if you are connecting to a Dialogflow CX agent.

.google.protobuf.Struct cx_parameters = 13;

Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

clearEnableDebuggingInfo()

public StreamingAnalyzeContentRequest.Builder clearEnableDebuggingInfo()

If true, StreamingAnalyzeContentResponse.debugging_info will get populated.

bool enable_debugging_info = 19;

Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

clearEnableExtendedStreaming()

public StreamingAnalyzeContentRequest.Builder clearEnableExtendedStreaming()

Optional. Enable full bidirectional streaming. You can keep streaming the audio until timeout, and there's no need to half close the stream to get the response.

Restrictions:

  • Timeout: 3 mins.
  • Audio Encoding: only supports AudioEncoding.AUDIO_ENCODING_LINEAR_16 and AudioEncoding.AUDIO_ENCODING_MULAW
  • Lifecycle: conversation should be in Assist Stage, go to [Conversation.CreateConversation][] for more information.

    InvalidArgument Error will be returned if the one of restriction checks failed.

    You can find more details in https://cloud.google.com/agent-assist/docs/extended-streaming

bool enable_extended_streaming = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

clearEnablePartialAutomatedAgentReply()

public StreamingAnalyzeContentRequest.Builder clearEnablePartialAutomatedAgentReply()

Enable partial virtual agent responses. If this flag is not enabled, response stream still contains only one final response even if some Fulfillments in Dialogflow virtual agent have been configured to return partial responses.

bool enable_partial_automated_agent_reply = 12;

Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public StreamingAnalyzeContentRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder
Overrides

clearInput()

public StreamingAnalyzeContentRequest.Builder clearInput()
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

clearInputAudio()

public StreamingAnalyzeContentRequest.Builder clearInputAudio()

The input audio content to be recognized. Must be sent if audio_config is set in the first message. The complete audio over all streaming messages must not exceed 1 minute.

bytes input_audio = 5;

Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

clearInputDtmf()

public StreamingAnalyzeContentRequest.Builder clearInputDtmf()

The DTMF digits used to invoke intent and fill in parameter value.

This input is ignored if the previous response indicated that DTMF input is not accepted.

.google.cloud.dialogflow.v2.TelephonyDtmfEvents input_dtmf = 9;

Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

clearInputText()

public StreamingAnalyzeContentRequest.Builder clearInputText()

The UTF-8 encoded natural language text to be processed. Must be sent if text_config is set in the first message. Text length must not exceed 256 bytes for virtual agent interactions. The input_text field can be only sent once, and would cancel the speech recognition if any ongoing.

string input_text = 6;

Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public StreamingAnalyzeContentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder
Overrides

clearParticipant()

public StreamingAnalyzeContentRequest.Builder clearParticipant()

Required. The name of the participant this text comes from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

string participant = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

clearQueryParams()

public StreamingAnalyzeContentRequest.Builder clearQueryParams()

Parameters for a Dialogflow virtual-agent query.

.google.cloud.dialogflow.v2.QueryParameters query_params = 7;

Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

clearReplyAudioConfig()

public StreamingAnalyzeContentRequest.Builder clearReplyAudioConfig()

Speech synthesis configuration. The speech synthesis settings for a virtual agent that may be configured for the associated conversation profile are not used when calling StreamingAnalyzeContent. If this configuration is not supplied, speech synthesis is disabled.

.google.cloud.dialogflow.v2.OutputAudioConfig reply_audio_config = 4;

Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

clearTextConfig()

public StreamingAnalyzeContentRequest.Builder clearTextConfig()

The natural language text to be processed.

.google.cloud.dialogflow.v2.InputTextConfig text_config = 3;

Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

clone()

public StreamingAnalyzeContentRequest.Builder clone()
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder
Overrides

getAssistQueryParams()

public AssistQueryParameters getAssistQueryParams()

Parameters for a human assist query.

.google.cloud.dialogflow.v2.AssistQueryParameters assist_query_params = 8;

Returns
TypeDescription
AssistQueryParameters

The assistQueryParams.

getAssistQueryParamsBuilder()

public AssistQueryParameters.Builder getAssistQueryParamsBuilder()

Parameters for a human assist query.

.google.cloud.dialogflow.v2.AssistQueryParameters assist_query_params = 8;

Returns
TypeDescription
AssistQueryParameters.Builder

getAssistQueryParamsOrBuilder()

public AssistQueryParametersOrBuilder getAssistQueryParamsOrBuilder()

Parameters for a human assist query.

.google.cloud.dialogflow.v2.AssistQueryParameters assist_query_params = 8;

Returns
TypeDescription
AssistQueryParametersOrBuilder

getAudioConfig()

public InputAudioConfig getAudioConfig()

Instructs the speech recognizer how to process the speech audio.

.google.cloud.dialogflow.v2.InputAudioConfig audio_config = 2;

Returns
TypeDescription
InputAudioConfig

The audioConfig.

getAudioConfigBuilder()

public InputAudioConfig.Builder getAudioConfigBuilder()

Instructs the speech recognizer how to process the speech audio.

.google.cloud.dialogflow.v2.InputAudioConfig audio_config = 2;

Returns
TypeDescription
InputAudioConfig.Builder

getAudioConfigOrBuilder()

public InputAudioConfigOrBuilder getAudioConfigOrBuilder()

Instructs the speech recognizer how to process the speech audio.

.google.cloud.dialogflow.v2.InputAudioConfig audio_config = 2;

Returns
TypeDescription
InputAudioConfigOrBuilder

getConfigCase()

public StreamingAnalyzeContentRequest.ConfigCase getConfigCase()
Returns
TypeDescription
StreamingAnalyzeContentRequest.ConfigCase

getCxParameters()

public Struct getCxParameters()

Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

Note: this field should only be used if you are connecting to a Dialogflow CX agent.

.google.protobuf.Struct cx_parameters = 13;

Returns
TypeDescription
Struct

The cxParameters.

getCxParametersBuilder()

public Struct.Builder getCxParametersBuilder()

Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

Note: this field should only be used if you are connecting to a Dialogflow CX agent.

.google.protobuf.Struct cx_parameters = 13;

Returns
TypeDescription
Builder

getCxParametersOrBuilder()

public StructOrBuilder getCxParametersOrBuilder()

Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

Note: this field should only be used if you are connecting to a Dialogflow CX agent.

.google.protobuf.Struct cx_parameters = 13;

Returns
TypeDescription
StructOrBuilder

getDefaultInstanceForType()

public StreamingAnalyzeContentRequest getDefaultInstanceForType()
Returns
TypeDescription
StreamingAnalyzeContentRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEnableDebuggingInfo()

public boolean getEnableDebuggingInfo()

If true, StreamingAnalyzeContentResponse.debugging_info will get populated.

bool enable_debugging_info = 19;

Returns
TypeDescription
boolean

The enableDebuggingInfo.

getEnableExtendedStreaming()

public boolean getEnableExtendedStreaming()

Optional. Enable full bidirectional streaming. You can keep streaming the audio until timeout, and there's no need to half close the stream to get the response.

Restrictions:

  • Timeout: 3 mins.
  • Audio Encoding: only supports AudioEncoding.AUDIO_ENCODING_LINEAR_16 and AudioEncoding.AUDIO_ENCODING_MULAW
  • Lifecycle: conversation should be in Assist Stage, go to [Conversation.CreateConversation][] for more information.

    InvalidArgument Error will be returned if the one of restriction checks failed.

    You can find more details in https://cloud.google.com/agent-assist/docs/extended-streaming

bool enable_extended_streaming = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

The enableExtendedStreaming.

getEnablePartialAutomatedAgentReply()

public boolean getEnablePartialAutomatedAgentReply()

Enable partial virtual agent responses. If this flag is not enabled, response stream still contains only one final response even if some Fulfillments in Dialogflow virtual agent have been configured to return partial responses.

bool enable_partial_automated_agent_reply = 12;

Returns
TypeDescription
boolean

The enablePartialAutomatedAgentReply.

getInputAudio()

public ByteString getInputAudio()

The input audio content to be recognized. Must be sent if audio_config is set in the first message. The complete audio over all streaming messages must not exceed 1 minute.

bytes input_audio = 5;

Returns
TypeDescription
ByteString

The inputAudio.

getInputCase()

public StreamingAnalyzeContentRequest.InputCase getInputCase()
Returns
TypeDescription
StreamingAnalyzeContentRequest.InputCase

getInputDtmf()

public TelephonyDtmfEvents getInputDtmf()

The DTMF digits used to invoke intent and fill in parameter value.

This input is ignored if the previous response indicated that DTMF input is not accepted.

.google.cloud.dialogflow.v2.TelephonyDtmfEvents input_dtmf = 9;

Returns
TypeDescription
TelephonyDtmfEvents

The inputDtmf.

getInputDtmfBuilder()

public TelephonyDtmfEvents.Builder getInputDtmfBuilder()

The DTMF digits used to invoke intent and fill in parameter value.

This input is ignored if the previous response indicated that DTMF input is not accepted.

.google.cloud.dialogflow.v2.TelephonyDtmfEvents input_dtmf = 9;

Returns
TypeDescription
TelephonyDtmfEvents.Builder

getInputDtmfOrBuilder()

public TelephonyDtmfEventsOrBuilder getInputDtmfOrBuilder()

The DTMF digits used to invoke intent and fill in parameter value.

This input is ignored if the previous response indicated that DTMF input is not accepted.

.google.cloud.dialogflow.v2.TelephonyDtmfEvents input_dtmf = 9;

Returns
TypeDescription
TelephonyDtmfEventsOrBuilder

getInputText()

public String getInputText()

The UTF-8 encoded natural language text to be processed. Must be sent if text_config is set in the first message. Text length must not exceed 256 bytes for virtual agent interactions. The input_text field can be only sent once, and would cancel the speech recognition if any ongoing.

string input_text = 6;

Returns
TypeDescription
String

The inputText.

getInputTextBytes()

public ByteString getInputTextBytes()

The UTF-8 encoded natural language text to be processed. Must be sent if text_config is set in the first message. Text length must not exceed 256 bytes for virtual agent interactions. The input_text field can be only sent once, and would cancel the speech recognition if any ongoing.

string input_text = 6;

Returns
TypeDescription
ByteString

The bytes for inputText.

getParticipant()

public String getParticipant()

Required. The name of the participant this text comes from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

string participant = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The participant.

getParticipantBytes()

public ByteString getParticipantBytes()

Required. The name of the participant this text comes from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

string participant = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for participant.

getQueryParams()

public QueryParameters getQueryParams()

Parameters for a Dialogflow virtual-agent query.

.google.cloud.dialogflow.v2.QueryParameters query_params = 7;

Returns
TypeDescription
QueryParameters

The queryParams.

getQueryParamsBuilder()

public QueryParameters.Builder getQueryParamsBuilder()

Parameters for a Dialogflow virtual-agent query.

.google.cloud.dialogflow.v2.QueryParameters query_params = 7;

Returns
TypeDescription
QueryParameters.Builder

getQueryParamsOrBuilder()

public QueryParametersOrBuilder getQueryParamsOrBuilder()

Parameters for a Dialogflow virtual-agent query.

.google.cloud.dialogflow.v2.QueryParameters query_params = 7;

Returns
TypeDescription
QueryParametersOrBuilder

getReplyAudioConfig()

public OutputAudioConfig getReplyAudioConfig()

Speech synthesis configuration. The speech synthesis settings for a virtual agent that may be configured for the associated conversation profile are not used when calling StreamingAnalyzeContent. If this configuration is not supplied, speech synthesis is disabled.

.google.cloud.dialogflow.v2.OutputAudioConfig reply_audio_config = 4;

Returns
TypeDescription
OutputAudioConfig

The replyAudioConfig.

getReplyAudioConfigBuilder()

public OutputAudioConfig.Builder getReplyAudioConfigBuilder()

Speech synthesis configuration. The speech synthesis settings for a virtual agent that may be configured for the associated conversation profile are not used when calling StreamingAnalyzeContent. If this configuration is not supplied, speech synthesis is disabled.

.google.cloud.dialogflow.v2.OutputAudioConfig reply_audio_config = 4;

Returns
TypeDescription
OutputAudioConfig.Builder

getReplyAudioConfigOrBuilder()

public OutputAudioConfigOrBuilder getReplyAudioConfigOrBuilder()

Speech synthesis configuration. The speech synthesis settings for a virtual agent that may be configured for the associated conversation profile are not used when calling StreamingAnalyzeContent. If this configuration is not supplied, speech synthesis is disabled.

.google.cloud.dialogflow.v2.OutputAudioConfig reply_audio_config = 4;

Returns
TypeDescription
OutputAudioConfigOrBuilder

getTextConfig()

public InputTextConfig getTextConfig()

The natural language text to be processed.

.google.cloud.dialogflow.v2.InputTextConfig text_config = 3;

Returns
TypeDescription
InputTextConfig

The textConfig.

getTextConfigBuilder()

public InputTextConfig.Builder getTextConfigBuilder()

The natural language text to be processed.

.google.cloud.dialogflow.v2.InputTextConfig text_config = 3;

Returns
TypeDescription
InputTextConfig.Builder

getTextConfigOrBuilder()

public InputTextConfigOrBuilder getTextConfigOrBuilder()

The natural language text to be processed.

.google.cloud.dialogflow.v2.InputTextConfig text_config = 3;

Returns
TypeDescription
InputTextConfigOrBuilder

hasAssistQueryParams()

public boolean hasAssistQueryParams()

Parameters for a human assist query.

.google.cloud.dialogflow.v2.AssistQueryParameters assist_query_params = 8;

Returns
TypeDescription
boolean

Whether the assistQueryParams field is set.

hasAudioConfig()

public boolean hasAudioConfig()

Instructs the speech recognizer how to process the speech audio.

.google.cloud.dialogflow.v2.InputAudioConfig audio_config = 2;

Returns
TypeDescription
boolean

Whether the audioConfig field is set.

hasCxParameters()

public boolean hasCxParameters()

Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

Note: this field should only be used if you are connecting to a Dialogflow CX agent.

.google.protobuf.Struct cx_parameters = 13;

Returns
TypeDescription
boolean

Whether the cxParameters field is set.

hasInputAudio()

public boolean hasInputAudio()

The input audio content to be recognized. Must be sent if audio_config is set in the first message. The complete audio over all streaming messages must not exceed 1 minute.

bytes input_audio = 5;

Returns
TypeDescription
boolean

Whether the inputAudio field is set.

hasInputDtmf()

public boolean hasInputDtmf()

The DTMF digits used to invoke intent and fill in parameter value.

This input is ignored if the previous response indicated that DTMF input is not accepted.

.google.cloud.dialogflow.v2.TelephonyDtmfEvents input_dtmf = 9;

Returns
TypeDescription
boolean

Whether the inputDtmf field is set.

hasInputText()

public boolean hasInputText()

The UTF-8 encoded natural language text to be processed. Must be sent if text_config is set in the first message. Text length must not exceed 256 bytes for virtual agent interactions. The input_text field can be only sent once, and would cancel the speech recognition if any ongoing.

string input_text = 6;

Returns
TypeDescription
boolean

Whether the inputText field is set.

hasQueryParams()

public boolean hasQueryParams()

Parameters for a Dialogflow virtual-agent query.

.google.cloud.dialogflow.v2.QueryParameters query_params = 7;

Returns
TypeDescription
boolean

Whether the queryParams field is set.

hasReplyAudioConfig()

public boolean hasReplyAudioConfig()

Speech synthesis configuration. The speech synthesis settings for a virtual agent that may be configured for the associated conversation profile are not used when calling StreamingAnalyzeContent. If this configuration is not supplied, speech synthesis is disabled.

.google.cloud.dialogflow.v2.OutputAudioConfig reply_audio_config = 4;

Returns
TypeDescription
boolean

Whether the replyAudioConfig field is set.

hasTextConfig()

public boolean hasTextConfig()

The natural language text to be processed.

.google.cloud.dialogflow.v2.InputTextConfig text_config = 3;

Returns
TypeDescription
boolean

Whether the textConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeAssistQueryParams(AssistQueryParameters value)

public StreamingAnalyzeContentRequest.Builder mergeAssistQueryParams(AssistQueryParameters value)

Parameters for a human assist query.

.google.cloud.dialogflow.v2.AssistQueryParameters assist_query_params = 8;

Parameter
NameDescription
valueAssistQueryParameters
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

mergeAudioConfig(InputAudioConfig value)

public StreamingAnalyzeContentRequest.Builder mergeAudioConfig(InputAudioConfig value)

Instructs the speech recognizer how to process the speech audio.

.google.cloud.dialogflow.v2.InputAudioConfig audio_config = 2;

Parameter
NameDescription
valueInputAudioConfig
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

mergeCxParameters(Struct value)

public StreamingAnalyzeContentRequest.Builder mergeCxParameters(Struct value)

Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

Note: this field should only be used if you are connecting to a Dialogflow CX agent.

.google.protobuf.Struct cx_parameters = 13;

Parameter
NameDescription
valueStruct
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

mergeFrom(StreamingAnalyzeContentRequest other)

public StreamingAnalyzeContentRequest.Builder mergeFrom(StreamingAnalyzeContentRequest other)
Parameter
NameDescription
otherStreamingAnalyzeContentRequest
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StreamingAnalyzeContentRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public StreamingAnalyzeContentRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder
Overrides

mergeInputDtmf(TelephonyDtmfEvents value)

public StreamingAnalyzeContentRequest.Builder mergeInputDtmf(TelephonyDtmfEvents value)

The DTMF digits used to invoke intent and fill in parameter value.

This input is ignored if the previous response indicated that DTMF input is not accepted.

.google.cloud.dialogflow.v2.TelephonyDtmfEvents input_dtmf = 9;

Parameter
NameDescription
valueTelephonyDtmfEvents
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

mergeQueryParams(QueryParameters value)

public StreamingAnalyzeContentRequest.Builder mergeQueryParams(QueryParameters value)

Parameters for a Dialogflow virtual-agent query.

.google.cloud.dialogflow.v2.QueryParameters query_params = 7;

Parameter
NameDescription
valueQueryParameters
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

mergeReplyAudioConfig(OutputAudioConfig value)

public StreamingAnalyzeContentRequest.Builder mergeReplyAudioConfig(OutputAudioConfig value)

Speech synthesis configuration. The speech synthesis settings for a virtual agent that may be configured for the associated conversation profile are not used when calling StreamingAnalyzeContent. If this configuration is not supplied, speech synthesis is disabled.

.google.cloud.dialogflow.v2.OutputAudioConfig reply_audio_config = 4;

Parameter
NameDescription
valueOutputAudioConfig
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

mergeTextConfig(InputTextConfig value)

public StreamingAnalyzeContentRequest.Builder mergeTextConfig(InputTextConfig value)

The natural language text to be processed.

.google.cloud.dialogflow.v2.InputTextConfig text_config = 3;

Parameter
NameDescription
valueInputTextConfig
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StreamingAnalyzeContentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder
Overrides

setAssistQueryParams(AssistQueryParameters value)

public StreamingAnalyzeContentRequest.Builder setAssistQueryParams(AssistQueryParameters value)

Parameters for a human assist query.

.google.cloud.dialogflow.v2.AssistQueryParameters assist_query_params = 8;

Parameter
NameDescription
valueAssistQueryParameters
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

setAssistQueryParams(AssistQueryParameters.Builder builderForValue)

public StreamingAnalyzeContentRequest.Builder setAssistQueryParams(AssistQueryParameters.Builder builderForValue)

Parameters for a human assist query.

.google.cloud.dialogflow.v2.AssistQueryParameters assist_query_params = 8;

Parameter
NameDescription
builderForValueAssistQueryParameters.Builder
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

setAudioConfig(InputAudioConfig value)

public StreamingAnalyzeContentRequest.Builder setAudioConfig(InputAudioConfig value)

Instructs the speech recognizer how to process the speech audio.

.google.cloud.dialogflow.v2.InputAudioConfig audio_config = 2;

Parameter
NameDescription
valueInputAudioConfig
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

setAudioConfig(InputAudioConfig.Builder builderForValue)

public StreamingAnalyzeContentRequest.Builder setAudioConfig(InputAudioConfig.Builder builderForValue)

Instructs the speech recognizer how to process the speech audio.

.google.cloud.dialogflow.v2.InputAudioConfig audio_config = 2;

Parameter
NameDescription
builderForValueInputAudioConfig.Builder
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

setCxParameters(Struct value)

public StreamingAnalyzeContentRequest.Builder setCxParameters(Struct value)

Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

Note: this field should only be used if you are connecting to a Dialogflow CX agent.

.google.protobuf.Struct cx_parameters = 13;

Parameter
NameDescription
valueStruct
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

setCxParameters(Struct.Builder builderForValue)

public StreamingAnalyzeContentRequest.Builder setCxParameters(Struct.Builder builderForValue)

Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

Note: this field should only be used if you are connecting to a Dialogflow CX agent.

.google.protobuf.Struct cx_parameters = 13;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

setEnableDebuggingInfo(boolean value)

public StreamingAnalyzeContentRequest.Builder setEnableDebuggingInfo(boolean value)

If true, StreamingAnalyzeContentResponse.debugging_info will get populated.

bool enable_debugging_info = 19;

Parameter
NameDescription
valueboolean

The enableDebuggingInfo to set.

Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

setEnableExtendedStreaming(boolean value)

public StreamingAnalyzeContentRequest.Builder setEnableExtendedStreaming(boolean value)

Optional. Enable full bidirectional streaming. You can keep streaming the audio until timeout, and there's no need to half close the stream to get the response.

Restrictions:

  • Timeout: 3 mins.
  • Audio Encoding: only supports AudioEncoding.AUDIO_ENCODING_LINEAR_16 and AudioEncoding.AUDIO_ENCODING_MULAW
  • Lifecycle: conversation should be in Assist Stage, go to [Conversation.CreateConversation][] for more information.

    InvalidArgument Error will be returned if the one of restriction checks failed.

    You can find more details in https://cloud.google.com/agent-assist/docs/extended-streaming

bool enable_extended_streaming = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueboolean

The enableExtendedStreaming to set.

Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

setEnablePartialAutomatedAgentReply(boolean value)

public StreamingAnalyzeContentRequest.Builder setEnablePartialAutomatedAgentReply(boolean value)

Enable partial virtual agent responses. If this flag is not enabled, response stream still contains only one final response even if some Fulfillments in Dialogflow virtual agent have been configured to return partial responses.

bool enable_partial_automated_agent_reply = 12;

Parameter
NameDescription
valueboolean

The enablePartialAutomatedAgentReply to set.

Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public StreamingAnalyzeContentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder
Overrides

setInputAudio(ByteString value)

public StreamingAnalyzeContentRequest.Builder setInputAudio(ByteString value)

The input audio content to be recognized. Must be sent if audio_config is set in the first message. The complete audio over all streaming messages must not exceed 1 minute.

bytes input_audio = 5;

Parameter
NameDescription
valueByteString

The inputAudio to set.

Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

setInputDtmf(TelephonyDtmfEvents value)

public StreamingAnalyzeContentRequest.Builder setInputDtmf(TelephonyDtmfEvents value)

The DTMF digits used to invoke intent and fill in parameter value.

This input is ignored if the previous response indicated that DTMF input is not accepted.

.google.cloud.dialogflow.v2.TelephonyDtmfEvents input_dtmf = 9;

Parameter
NameDescription
valueTelephonyDtmfEvents
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

setInputDtmf(TelephonyDtmfEvents.Builder builderForValue)

public StreamingAnalyzeContentRequest.Builder setInputDtmf(TelephonyDtmfEvents.Builder builderForValue)

The DTMF digits used to invoke intent and fill in parameter value.

This input is ignored if the previous response indicated that DTMF input is not accepted.

.google.cloud.dialogflow.v2.TelephonyDtmfEvents input_dtmf = 9;

Parameter
NameDescription
builderForValueTelephonyDtmfEvents.Builder
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

setInputText(String value)

public StreamingAnalyzeContentRequest.Builder setInputText(String value)

The UTF-8 encoded natural language text to be processed. Must be sent if text_config is set in the first message. Text length must not exceed 256 bytes for virtual agent interactions. The input_text field can be only sent once, and would cancel the speech recognition if any ongoing.

string input_text = 6;

Parameter
NameDescription
valueString

The inputText to set.

Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

setInputTextBytes(ByteString value)

public StreamingAnalyzeContentRequest.Builder setInputTextBytes(ByteString value)

The UTF-8 encoded natural language text to be processed. Must be sent if text_config is set in the first message. Text length must not exceed 256 bytes for virtual agent interactions. The input_text field can be only sent once, and would cancel the speech recognition if any ongoing.

string input_text = 6;

Parameter
NameDescription
valueByteString

The bytes for inputText to set.

Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

setParticipant(String value)

public StreamingAnalyzeContentRequest.Builder setParticipant(String value)

Required. The name of the participant this text comes from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

string participant = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueString

The participant to set.

Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

setParticipantBytes(ByteString value)

public StreamingAnalyzeContentRequest.Builder setParticipantBytes(ByteString value)

Required. The name of the participant this text comes from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

string participant = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueByteString

The bytes for participant to set.

Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

setQueryParams(QueryParameters value)

public StreamingAnalyzeContentRequest.Builder setQueryParams(QueryParameters value)

Parameters for a Dialogflow virtual-agent query.

.google.cloud.dialogflow.v2.QueryParameters query_params = 7;

Parameter
NameDescription
valueQueryParameters
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

setQueryParams(QueryParameters.Builder builderForValue)

public StreamingAnalyzeContentRequest.Builder setQueryParams(QueryParameters.Builder builderForValue)

Parameters for a Dialogflow virtual-agent query.

.google.cloud.dialogflow.v2.QueryParameters query_params = 7;

Parameter
NameDescription
builderForValueQueryParameters.Builder
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

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

public StreamingAnalyzeContentRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder
Overrides

setReplyAudioConfig(OutputAudioConfig value)

public StreamingAnalyzeContentRequest.Builder setReplyAudioConfig(OutputAudioConfig value)

Speech synthesis configuration. The speech synthesis settings for a virtual agent that may be configured for the associated conversation profile are not used when calling StreamingAnalyzeContent. If this configuration is not supplied, speech synthesis is disabled.

.google.cloud.dialogflow.v2.OutputAudioConfig reply_audio_config = 4;

Parameter
NameDescription
valueOutputAudioConfig
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

setReplyAudioConfig(OutputAudioConfig.Builder builderForValue)

public StreamingAnalyzeContentRequest.Builder setReplyAudioConfig(OutputAudioConfig.Builder builderForValue)

Speech synthesis configuration. The speech synthesis settings for a virtual agent that may be configured for the associated conversation profile are not used when calling StreamingAnalyzeContent. If this configuration is not supplied, speech synthesis is disabled.

.google.cloud.dialogflow.v2.OutputAudioConfig reply_audio_config = 4;

Parameter
NameDescription
builderForValueOutputAudioConfig.Builder
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

setTextConfig(InputTextConfig value)

public StreamingAnalyzeContentRequest.Builder setTextConfig(InputTextConfig value)

The natural language text to be processed.

.google.cloud.dialogflow.v2.InputTextConfig text_config = 3;

Parameter
NameDescription
valueInputTextConfig
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

setTextConfig(InputTextConfig.Builder builderForValue)

public StreamingAnalyzeContentRequest.Builder setTextConfig(InputTextConfig.Builder builderForValue)

The natural language text to be processed.

.google.cloud.dialogflow.v2.InputTextConfig text_config = 3;

Parameter
NameDescription
builderForValueInputTextConfig.Builder
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final StreamingAnalyzeContentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
StreamingAnalyzeContentRequest.Builder
Overrides