Class StreamingAnalyzeContentRequest.Builder (4.61.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. If you decide to rather analyze text input after you already started Speech recognition, please send a message with StreamingAnalyzeContentRequest.input_text.

    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.v2beta1.StreamingAnalyzeContentRequest

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public StreamingAnalyzeContentRequest build()
Returns
Type Description
StreamingAnalyzeContentRequest

buildPartial()

public StreamingAnalyzeContentRequest buildPartial()
Returns
Type Description
StreamingAnalyzeContentRequest

clear()

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

clearAssistQueryParams()

public StreamingAnalyzeContentRequest.Builder clearAssistQueryParams()

Parameters for a human assist query.

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

Returns
Type Description
StreamingAnalyzeContentRequest.Builder

clearAudioConfig()

public StreamingAnalyzeContentRequest.Builder clearAudioConfig()

Instructs the speech recognizer how to process the speech audio.

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

Returns
Type Description
StreamingAnalyzeContentRequest.Builder

clearConfig()

public StreamingAnalyzeContentRequest.Builder clearConfig()
Returns
Type Description
StreamingAnalyzeContentRequest.Builder

clearCxCurrentPage()

public StreamingAnalyzeContentRequest.Builder clearCxCurrentPage()

The unique identifier of the CX page to override the current_page in the session. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

If cx_current_page is specified, the previous state of the session will be ignored by Dialogflow CX, including the previous page and the previous session parameters. In most cases, cx_current_page and cx_parameters should be configured together to direct a session to a specific state.

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

string cx_current_page = 15;

Returns
Type Description
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

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
Type Description
StreamingAnalyzeContentRequest.Builder

clearEnableDebuggingInfo()

public StreamingAnalyzeContentRequest.Builder clearEnableDebuggingInfo()

if true, StreamingAnalyzeContentResponse.debugging_info will get populated.

bool enable_debugging_info = 19;

Returns
Type Description
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
Type Description
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
Type Description
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearInput()

public StreamingAnalyzeContentRequest.Builder clearInput()
Returns
Type Description
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
Type Description
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.v2beta1.TelephonyDtmfEvents input_dtmf = 9;

Returns
Type Description
StreamingAnalyzeContentRequest.Builder

clearInputEvent()

public StreamingAnalyzeContentRequest.Builder clearInputEvent()

The input event name. This can only be sent once and would cancel the ongoing speech recognition if any.

string input_event = 20;

Returns
Type Description
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

clearInputIntent()

public StreamingAnalyzeContentRequest.Builder clearInputIntent()

The intent to be triggered on V3 agent. Format: projects/<Project ID>/locations/<Location ID>/locations/ <Location ID>/agents/<Agent ID>/intents/<Intent ID>.

string input_intent = 17;

Returns
Type Description
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

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
Type Description
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public StreamingAnalyzeContentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
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
Type Description
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

clearQueryParams()

public StreamingAnalyzeContentRequest.Builder clearQueryParams()

Parameters for a Dialogflow virtual-agent query.

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

Returns
Type Description
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.v2beta1.OutputAudioConfig reply_audio_config = 4;

Returns
Type Description
StreamingAnalyzeContentRequest.Builder

clearTextConfig()

public StreamingAnalyzeContentRequest.Builder clearTextConfig()

The natural language text to be processed.

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

Returns
Type Description
StreamingAnalyzeContentRequest.Builder

clone()

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

getAssistQueryParams()

public AssistQueryParameters getAssistQueryParams()

Parameters for a human assist query.

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

Returns
Type Description
AssistQueryParameters

The assistQueryParams.

getAssistQueryParamsBuilder()

public AssistQueryParameters.Builder getAssistQueryParamsBuilder()

Parameters for a human assist query.

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

Returns
Type Description
AssistQueryParameters.Builder

getAssistQueryParamsOrBuilder()

public AssistQueryParametersOrBuilder getAssistQueryParamsOrBuilder()

Parameters for a human assist query.

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

Returns
Type Description
AssistQueryParametersOrBuilder

getAudioConfig()

public InputAudioConfig getAudioConfig()

Instructs the speech recognizer how to process the speech audio.

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

Returns
Type Description
InputAudioConfig

The audioConfig.

getAudioConfigBuilder()

public InputAudioConfig.Builder getAudioConfigBuilder()

Instructs the speech recognizer how to process the speech audio.

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

Returns
Type Description
InputAudioConfig.Builder

getAudioConfigOrBuilder()

public InputAudioConfigOrBuilder getAudioConfigOrBuilder()

Instructs the speech recognizer how to process the speech audio.

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

Returns
Type Description
InputAudioConfigOrBuilder

getConfigCase()

public StreamingAnalyzeContentRequest.ConfigCase getConfigCase()
Returns
Type Description
StreamingAnalyzeContentRequest.ConfigCase

getCxCurrentPage()

public String getCxCurrentPage()

The unique identifier of the CX page to override the current_page in the session. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

If cx_current_page is specified, the previous state of the session will be ignored by Dialogflow CX, including the previous page and the previous session parameters. In most cases, cx_current_page and cx_parameters should be configured together to direct a session to a specific state.

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

string cx_current_page = 15;

Returns
Type Description
String

The cxCurrentPage.

getCxCurrentPageBytes()

public ByteString getCxCurrentPageBytes()

The unique identifier of the CX page to override the current_page in the session. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

If cx_current_page is specified, the previous state of the session will be ignored by Dialogflow CX, including the previous page and the previous session parameters. In most cases, cx_current_page and cx_parameters should be configured together to direct a session to a specific state.

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

string cx_current_page = 15;

Returns
Type Description
ByteString

The bytes for cxCurrentPage.

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
Type Description
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
Type Description
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
Type Description
StructOrBuilder

getDefaultInstanceForType()

public StreamingAnalyzeContentRequest getDefaultInstanceForType()
Returns
Type Description
StreamingAnalyzeContentRequest

getDescriptorForType()

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

getEnableDebuggingInfo()

public boolean getEnableDebuggingInfo()

if true, StreamingAnalyzeContentResponse.debugging_info will get populated.

bool enable_debugging_info = 19;

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
ByteString

The inputAudio.

getInputCase()

public StreamingAnalyzeContentRequest.InputCase getInputCase()
Returns
Type Description
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.v2beta1.TelephonyDtmfEvents input_dtmf = 9;

Returns
Type Description
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.v2beta1.TelephonyDtmfEvents input_dtmf = 9;

Returns
Type Description
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.v2beta1.TelephonyDtmfEvents input_dtmf = 9;

Returns
Type Description
TelephonyDtmfEventsOrBuilder

getInputEvent()

public String getInputEvent()

The input event name. This can only be sent once and would cancel the ongoing speech recognition if any.

string input_event = 20;

Returns
Type Description
String

The inputEvent.

getInputEventBytes()

public ByteString getInputEventBytes()

The input event name. This can only be sent once and would cancel the ongoing speech recognition if any.

string input_event = 20;

Returns
Type Description
ByteString

The bytes for inputEvent.

getInputIntent()

public String getInputIntent()

The intent to be triggered on V3 agent. Format: projects/<Project ID>/locations/<Location ID>/locations/ <Location ID>/agents/<Agent ID>/intents/<Intent ID>.

string input_intent = 17;

Returns
Type Description
String

The inputIntent.

getInputIntentBytes()

public ByteString getInputIntentBytes()

The intent to be triggered on V3 agent. Format: projects/<Project ID>/locations/<Location ID>/locations/ <Location ID>/agents/<Agent ID>/intents/<Intent ID>.

string input_intent = 17;

Returns
Type Description
ByteString

The bytes for inputIntent.

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
Type Description
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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for participant.

getQueryParams()

public QueryParameters getQueryParams()

Parameters for a Dialogflow virtual-agent query.

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

Returns
Type Description
QueryParameters

The queryParams.

getQueryParamsBuilder()

public QueryParameters.Builder getQueryParamsBuilder()

Parameters for a Dialogflow virtual-agent query.

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

Returns
Type Description
QueryParameters.Builder

getQueryParamsOrBuilder()

public QueryParametersOrBuilder getQueryParamsOrBuilder()

Parameters for a Dialogflow virtual-agent query.

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

Returns
Type Description
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.v2beta1.OutputAudioConfig reply_audio_config = 4;

Returns
Type Description
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.v2beta1.OutputAudioConfig reply_audio_config = 4;

Returns
Type Description
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.v2beta1.OutputAudioConfig reply_audio_config = 4;

Returns
Type Description
OutputAudioConfigOrBuilder

getTextConfig()

public InputTextConfig getTextConfig()

The natural language text to be processed.

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

Returns
Type Description
InputTextConfig

The textConfig.

getTextConfigBuilder()

public InputTextConfig.Builder getTextConfigBuilder()

The natural language text to be processed.

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

Returns
Type Description
InputTextConfig.Builder

getTextConfigOrBuilder()

public InputTextConfigOrBuilder getTextConfigOrBuilder()

The natural language text to be processed.

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

Returns
Type Description
InputTextConfigOrBuilder

hasAssistQueryParams()

public boolean hasAssistQueryParams()

Parameters for a human assist query.

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

Returns
Type Description
boolean

Whether the assistQueryParams field is set.

hasAudioConfig()

public boolean hasAudioConfig()

Instructs the speech recognizer how to process the speech audio.

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

Returns
Type Description
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
Type Description
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
Type Description
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.v2beta1.TelephonyDtmfEvents input_dtmf = 9;

Returns
Type Description
boolean

Whether the inputDtmf field is set.

hasInputEvent()

public boolean hasInputEvent()

The input event name. This can only be sent once and would cancel the ongoing speech recognition if any.

string input_event = 20;

Returns
Type Description
boolean

Whether the inputEvent field is set.

hasInputIntent()

public boolean hasInputIntent()

The intent to be triggered on V3 agent. Format: projects/<Project ID>/locations/<Location ID>/locations/ <Location ID>/agents/<Agent ID>/intents/<Intent ID>.

string input_intent = 17;

Returns
Type Description
boolean

Whether the inputIntent 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
Type Description
boolean

Whether the inputText field is set.

hasQueryParams()

public boolean hasQueryParams()

Parameters for a Dialogflow virtual-agent query.

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

Returns
Type Description
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.v2beta1.OutputAudioConfig reply_audio_config = 4;

Returns
Type Description
boolean

Whether the replyAudioConfig field is set.

hasTextConfig()

public boolean hasTextConfig()

The natural language text to be processed.

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

Returns
Type Description
boolean

Whether the textConfig field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAssistQueryParams(AssistQueryParameters value)

public StreamingAnalyzeContentRequest.Builder mergeAssistQueryParams(AssistQueryParameters value)

Parameters for a human assist query.

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

Parameter
Name Description
value AssistQueryParameters
Returns
Type Description
StreamingAnalyzeContentRequest.Builder

mergeAudioConfig(InputAudioConfig value)

public StreamingAnalyzeContentRequest.Builder mergeAudioConfig(InputAudioConfig value)

Instructs the speech recognizer how to process the speech audio.

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

Parameter
Name Description
value InputAudioConfig
Returns
Type Description
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
Name Description
value Struct
Returns
Type Description
StreamingAnalyzeContentRequest.Builder

mergeFrom(StreamingAnalyzeContentRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public StreamingAnalyzeContentRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
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.v2beta1.TelephonyDtmfEvents input_dtmf = 9;

Parameter
Name Description
value TelephonyDtmfEvents
Returns
Type Description
StreamingAnalyzeContentRequest.Builder

mergeQueryParams(QueryParameters value)

public StreamingAnalyzeContentRequest.Builder mergeQueryParams(QueryParameters value)

Parameters for a Dialogflow virtual-agent query.

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

Parameter
Name Description
value QueryParameters
Returns
Type Description
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.v2beta1.OutputAudioConfig reply_audio_config = 4;

Parameter
Name Description
value OutputAudioConfig
Returns
Type Description
StreamingAnalyzeContentRequest.Builder

mergeTextConfig(InputTextConfig value)

public StreamingAnalyzeContentRequest.Builder mergeTextConfig(InputTextConfig value)

The natural language text to be processed.

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

Parameter
Name Description
value InputTextConfig
Returns
Type Description
StreamingAnalyzeContentRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setAssistQueryParams(AssistQueryParameters value)

public StreamingAnalyzeContentRequest.Builder setAssistQueryParams(AssistQueryParameters value)

Parameters for a human assist query.

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

Parameter
Name Description
value AssistQueryParameters
Returns
Type Description
StreamingAnalyzeContentRequest.Builder

setAssistQueryParams(AssistQueryParameters.Builder builderForValue)

public StreamingAnalyzeContentRequest.Builder setAssistQueryParams(AssistQueryParameters.Builder builderForValue)

Parameters for a human assist query.

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

Parameter
Name Description
builderForValue AssistQueryParameters.Builder
Returns
Type Description
StreamingAnalyzeContentRequest.Builder

setAudioConfig(InputAudioConfig value)

public StreamingAnalyzeContentRequest.Builder setAudioConfig(InputAudioConfig value)

Instructs the speech recognizer how to process the speech audio.

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

Parameter
Name Description
value InputAudioConfig
Returns
Type Description
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.v2beta1.InputAudioConfig audio_config = 2;

Parameter
Name Description
builderForValue InputAudioConfig.Builder
Returns
Type Description
StreamingAnalyzeContentRequest.Builder

setCxCurrentPage(String value)

public StreamingAnalyzeContentRequest.Builder setCxCurrentPage(String value)

The unique identifier of the CX page to override the current_page in the session. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

If cx_current_page is specified, the previous state of the session will be ignored by Dialogflow CX, including the previous page and the previous session parameters. In most cases, cx_current_page and cx_parameters should be configured together to direct a session to a specific state.

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

string cx_current_page = 15;

Parameter
Name Description
value String

The cxCurrentPage to set.
Returns
Type Description
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

setCxCurrentPageBytes(ByteString value)

public StreamingAnalyzeContentRequest.Builder setCxCurrentPageBytes(ByteString value)

The unique identifier of the CX page to override the current_page in the session. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

If cx_current_page is specified, the previous state of the session will be ignored by Dialogflow CX, including the previous page and the previous session parameters. In most cases, cx_current_page and cx_parameters should be configured together to direct a session to a specific state.

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

string cx_current_page = 15;

Parameter
Name Description
value ByteString

The bytes for cxCurrentPage to set.
Returns
Type Description
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

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
Name Description
value Struct
Returns
Type Description
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
Name Description
builderForValue Builder
Returns
Type Description
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
Name Description
value boolean

The enableDebuggingInfo to set.
Returns
Type Description
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
Name Description
value boolean

The enableExtendedStreaming to set.
Returns
Type Description
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
Name Description
value boolean

The enablePartialAutomatedAgentReply to set.
Returns
Type Description
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public StreamingAnalyzeContentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
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
Name Description
value ByteString

The inputAudio to set.
Returns
Type Description
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.v2beta1.TelephonyDtmfEvents input_dtmf = 9;

Parameter
Name Description
value TelephonyDtmfEvents
Returns
Type Description
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.v2beta1.TelephonyDtmfEvents input_dtmf = 9;

Parameter
Name Description
builderForValue TelephonyDtmfEvents.Builder
Returns
Type Description
StreamingAnalyzeContentRequest.Builder

setInputEvent(String value)

public StreamingAnalyzeContentRequest.Builder setInputEvent(String value)

The input event name. This can only be sent once and would cancel the ongoing speech recognition if any.

string input_event = 20;

Parameter
Name Description
value String

The inputEvent to set.
Returns
Type Description
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

setInputEventBytes(ByteString value)

public StreamingAnalyzeContentRequest.Builder setInputEventBytes(ByteString value)

The input event name. This can only be sent once and would cancel the ongoing speech recognition if any.

string input_event = 20;

Parameter
Name Description
value ByteString

The bytes for inputEvent to set.
Returns
Type Description
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

setInputIntent(String value)

public StreamingAnalyzeContentRequest.Builder setInputIntent(String value)

The intent to be triggered on V3 agent. Format: projects/<Project ID>/locations/<Location ID>/locations/ <Location ID>/agents/<Agent ID>/intents/<Intent ID>.

string input_intent = 17;

Parameter
Name Description
value String

The inputIntent to set.
Returns
Type Description
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

setInputIntentBytes(ByteString value)

public StreamingAnalyzeContentRequest.Builder setInputIntentBytes(ByteString value)

The intent to be triggered on V3 agent. Format: projects/<Project ID>/locations/<Location ID>/locations/ <Location ID>/agents/<Agent ID>/intents/<Intent ID>.

string input_intent = 17;

Parameter
Name Description
value ByteString

The bytes for inputIntent to set.
Returns
Type Description
StreamingAnalyzeContentRequest.Builder

This builder for chaining.

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
Name Description
value String

The inputText to set.
Returns
Type Description
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
Name Description
value ByteString

The bytes for inputText to set.
Returns
Type Description
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
Name Description
value String

The participant to set.
Returns
Type Description
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
Name Description
value ByteString

The bytes for participant to set.
Returns
Type Description
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.v2beta1.QueryParameters query_params = 7;

Parameter
Name Description
value QueryParameters
Returns
Type Description
StreamingAnalyzeContentRequest.Builder

setQueryParams(QueryParameters.Builder builderForValue)

public StreamingAnalyzeContentRequest.Builder setQueryParams(QueryParameters.Builder builderForValue)

Parameters for a Dialogflow virtual-agent query.

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

Parameter
Name Description
builderForValue QueryParameters.Builder
Returns
Type Description
StreamingAnalyzeContentRequest.Builder

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

public StreamingAnalyzeContentRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
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.v2beta1.OutputAudioConfig reply_audio_config = 4;

Parameter
Name Description
value OutputAudioConfig
Returns
Type Description
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.v2beta1.OutputAudioConfig reply_audio_config = 4;

Parameter
Name Description
builderForValue OutputAudioConfig.Builder
Returns
Type Description
StreamingAnalyzeContentRequest.Builder

setTextConfig(InputTextConfig value)

public StreamingAnalyzeContentRequest.Builder setTextConfig(InputTextConfig value)

The natural language text to be processed.

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

Parameter
Name Description
value InputTextConfig
Returns
Type Description
StreamingAnalyzeContentRequest.Builder

setTextConfig(InputTextConfig.Builder builderForValue)

public StreamingAnalyzeContentRequest.Builder setTextConfig(InputTextConfig.Builder builderForValue)

The natural language text to be processed.

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

Parameter
Name Description
builderForValue InputTextConfig.Builder
Returns
Type Description
StreamingAnalyzeContentRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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