Class StreamingAnalyzeContentRequest (4.57.0) 

public final class StreamingAnalyzeContentRequest extends GeneratedMessageV3 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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > StreamingAnalyzeContentRequest

Static Fields

ASSIST_QUERY_PARAMS_FIELD_NUMBER

public static final int ASSIST_QUERY_PARAMS_FIELD_NUMBER
Field Value
Type Description
int

AUDIO_CONFIG_FIELD_NUMBER

public static final int AUDIO_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

CX_CURRENT_PAGE_FIELD_NUMBER

public static final int CX_CURRENT_PAGE_FIELD_NUMBER
Field Value
Type Description
int

CX_PARAMETERS_FIELD_NUMBER

public static final int CX_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_DEBUGGING_INFO_FIELD_NUMBER

public static final int ENABLE_DEBUGGING_INFO_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_EXTENDED_STREAMING_FIELD_NUMBER

public static final int ENABLE_EXTENDED_STREAMING_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_PARTIAL_AUTOMATED_AGENT_REPLY_FIELD_NUMBER

public static final int ENABLE_PARTIAL_AUTOMATED_AGENT_REPLY_FIELD_NUMBER
Field Value
Type Description
int

INPUT_AUDIO_FIELD_NUMBER

public static final int INPUT_AUDIO_FIELD_NUMBER
Field Value
Type Description
int

INPUT_DTMF_FIELD_NUMBER

public static final int INPUT_DTMF_FIELD_NUMBER
Field Value
Type Description
int

INPUT_EVENT_FIELD_NUMBER

public static final int INPUT_EVENT_FIELD_NUMBER
Field Value
Type Description
int

INPUT_INTENT_FIELD_NUMBER

public static final int INPUT_INTENT_FIELD_NUMBER
Field Value
Type Description
int

INPUT_TEXT_FIELD_NUMBER

public static final int INPUT_TEXT_FIELD_NUMBER
Field Value
Type Description
int

PARTICIPANT_FIELD_NUMBER

public static final int PARTICIPANT_FIELD_NUMBER
Field Value
Type Description
int

QUERY_PARAMS_FIELD_NUMBER

public static final int QUERY_PARAMS_FIELD_NUMBER
Field Value
Type Description
int

REPLY_AUDIO_CONFIG_FIELD_NUMBER

public static final int REPLY_AUDIO_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

TEXT_CONFIG_FIELD_NUMBER

public static final int TEXT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static StreamingAnalyzeContentRequest getDefaultInstance()
Returns
Type Description
StreamingAnalyzeContentRequest

getDescriptor()

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

newBuilder()

public static StreamingAnalyzeContentRequest.Builder newBuilder()
Returns
Type Description
StreamingAnalyzeContentRequest.Builder

newBuilder(StreamingAnalyzeContentRequest prototype)

public static StreamingAnalyzeContentRequest.Builder newBuilder(StreamingAnalyzeContentRequest prototype)
Parameter
Name Description
prototype StreamingAnalyzeContentRequest
Returns
Type Description
StreamingAnalyzeContentRequest.Builder

parseDelimitedFrom(InputStream input)

public static StreamingAnalyzeContentRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StreamingAnalyzeContentRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamingAnalyzeContentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamingAnalyzeContentRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static StreamingAnalyzeContentRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
StreamingAnalyzeContentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StreamingAnalyzeContentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamingAnalyzeContentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StreamingAnalyzeContentRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
StreamingAnalyzeContentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StreamingAnalyzeContentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamingAnalyzeContentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StreamingAnalyzeContentRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
StreamingAnalyzeContentRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamingAnalyzeContentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamingAnalyzeContentRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static StreamingAnalyzeContentRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StreamingAnalyzeContentRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamingAnalyzeContentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamingAnalyzeContentRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static StreamingAnalyzeContentRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
StreamingAnalyzeContentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StreamingAnalyzeContentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamingAnalyzeContentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<StreamingAnalyzeContentRequest> parser()
Returns
Type Description
Parser<StreamingAnalyzeContentRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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.

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.

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

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.

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.

getParserForType()

public Parser<StreamingAnalyzeContentRequest> getParserForType()
Returns
Type Description
Parser<StreamingAnalyzeContentRequest>
Overrides

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.

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StreamingAnalyzeContentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
StreamingAnalyzeContentRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException