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:
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.
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.
- 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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_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_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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static StreamingAnalyzeContentRequest.Builder newBuilder()
newBuilder(StreamingAnalyzeContentRequest prototype)
public static StreamingAnalyzeContentRequest.Builder newBuilder(StreamingAnalyzeContentRequest prototype)
parseDelimitedFrom(InputStream input)
public static StreamingAnalyzeContentRequest parseDelimitedFrom(InputStream input)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StreamingAnalyzeContentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static StreamingAnalyzeContentRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StreamingAnalyzeContentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static StreamingAnalyzeContentRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StreamingAnalyzeContentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
parseFrom(CodedInputStream input)
public static StreamingAnalyzeContentRequest parseFrom(CodedInputStream input)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static StreamingAnalyzeContentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(InputStream input)
public static StreamingAnalyzeContentRequest parseFrom(InputStream input)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StreamingAnalyzeContentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static StreamingAnalyzeContentRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static StreamingAnalyzeContentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<StreamingAnalyzeContentRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAssistQueryParams()
public AssistQueryParameters getAssistQueryParams()
Parameters for a human assist query.
.google.cloud.dialogflow.v2.AssistQueryParameters assist_query_params = 8;
getAssistQueryParamsOrBuilder()
public AssistQueryParametersOrBuilder getAssistQueryParamsOrBuilder()
Parameters for a human assist query.
.google.cloud.dialogflow.v2.AssistQueryParameters assist_query_params = 8;
getAudioConfig()
public InputAudioConfig getAudioConfig()
Instructs the speech recognizer how to process the speech audio.
.google.cloud.dialogflow.v2.InputAudioConfig audio_config = 2;
getAudioConfigOrBuilder()
public InputAudioConfigOrBuilder getAudioConfigOrBuilder()
Instructs the speech recognizer how to process the speech audio.
.google.cloud.dialogflow.v2.InputAudioConfig audio_config = 2;
getConfigCase()
public StreamingAnalyzeContentRequest.ConfigCase getConfigCase()
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;
getDefaultInstanceForType()
public StreamingAnalyzeContentRequest getDefaultInstanceForType()
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
Conversations.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()
Optional. Enable partial responses from Dialogflow CX agent. If this flag
is not enabled, response stream still contains only one final response even
if some Fulfillments in Dialogflow CX agent have been configured to
return partial responses.
bool enable_partial_automated_agent_reply = 12 [(.google.api.field_behavior) = OPTIONAL];
| 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()
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;
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;
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()
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.v2.QueryParameters query_params = 7;
getQueryParamsOrBuilder()
public QueryParametersOrBuilder getQueryParamsOrBuilder()
Parameters for a Dialogflow virtual-agent query.
.google.cloud.dialogflow.v2.QueryParameters query_params = 7;
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;
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;
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getTextConfig()
public InputTextConfig getTextConfig()
The natural language text to be processed.
.google.cloud.dialogflow.v2.InputTextConfig text_config = 3;
getTextConfigOrBuilder()
public InputTextConfigOrBuilder getTextConfigOrBuilder()
The natural language text to be processed.
.google.cloud.dialogflow.v2.InputTextConfig text_config = 3;
hasAssistQueryParams()
public boolean hasAssistQueryParams()
Parameters for a human assist query.
.google.cloud.dialogflow.v2.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.v2.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.v2.TelephonyDtmfEvents input_dtmf = 9;
| Returns |
| Type |
Description |
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 |
| Type |
Description |
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 |
| 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.v2.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.v2.InputTextConfig text_config = 3;
| Returns |
| Type |
Description |
boolean |
Whether the textConfig field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public StreamingAnalyzeContentRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected StreamingAnalyzeContentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public StreamingAnalyzeContentRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
