Interface StreamingAnalyzeContentRequestOrBuilder (4.47.0)

Version latest

• 4.47.0 (latest)
• 4.46.0
• 4.45.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.35.0
• 4.34.0
• 4.33.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.23.0
• 4.22.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.1
• 4.8.6
• 4.7.5
• 4.6.0
• 4.5.11
• 4.4.0
• 4.3.1

public interface StreamingAnalyzeContentRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAssistQueryParams()

public abstract AssistQueryParameters getAssistQueryParams()

Parameters for a human assist query.

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

Returns
Type	Description
AssistQueryParameters	The assistQueryParams.

getAssistQueryParamsOrBuilder()

public abstract AssistQueryParametersOrBuilder getAssistQueryParamsOrBuilder()

Parameters for a human assist query.

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

Returns
Type	Description
AssistQueryParametersOrBuilder

getAudioConfig()

public abstract 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.

getAudioConfigOrBuilder()

public abstract 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 abstract StreamingAnalyzeContentRequest.ConfigCase getConfigCase()

Returns
Type	Description
StreamingAnalyzeContentRequest.ConfigCase

getCxCurrentPage()

public abstract 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 abstract 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 abstract 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.

getCxParametersOrBuilder()

public abstract 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

getEnableDebuggingInfo()

public abstract boolean getEnableDebuggingInfo()

if true, StreamingAnalyzeContentResponse.debugging_info will get populated.

bool enable_debugging_info = 19;

Returns
Type	Description
boolean	The enableDebuggingInfo.

getEnableExtendedStreaming()

public abstract 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 abstract 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 abstract 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 abstract StreamingAnalyzeContentRequest.InputCase getInputCase()

Returns
Type	Description
StreamingAnalyzeContentRequest.InputCase

getInputDtmf()

public abstract 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.

getInputDtmfOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract QueryParameters getQueryParams()

Parameters for a Dialogflow virtual-agent query.

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

Returns
Type	Description
QueryParameters	The queryParams.

getQueryParamsOrBuilder()

public abstract QueryParametersOrBuilder getQueryParamsOrBuilder()

Parameters for a Dialogflow virtual-agent query.

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

Returns
Type	Description
QueryParametersOrBuilder

getReplyAudioConfig()

public abstract 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.

getReplyAudioConfigOrBuilder()

public abstract 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 abstract InputTextConfig getTextConfig()

The natural language text to be processed.

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

Returns
Type	Description
InputTextConfig	The textConfig.

getTextConfigOrBuilder()

public abstract InputTextConfigOrBuilder getTextConfigOrBuilder()

The natural language text to be processed.

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

Returns
Type	Description
InputTextConfigOrBuilder

hasAssistQueryParams()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.