public final class StreamingAnalyzeContentRequest extends GeneratedMessageV3 implements StreamingAnalyzeContentRequestOrBuilder
The top-level message sent by the client to the [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.StreamingAnalyzeContent] method. Multiple request messages should be sent in order: 1. The first message must contain [participant][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.participant], [config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.config] and optionally [query_params][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.query_params]. If you want to receive an audio response, it should also contain [reply_audio_config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.reply_audio_config]. The message must not contain [input][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.input]. 2. If [config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.config] in the first message was set to [audio_config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.audio_config], all subsequent messages must contain [input_audio][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.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][google.cloud.dialogflow.v2beta1.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. 3. If [StreamingAnalyzeContentRequest.config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.config] in the first message was set to [StreamingAnalyzeContentRequest.text_config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.text_config], then the second message must contain only [input_text][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.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
Modifier and Type | Class and Description |
---|---|
static class |
StreamingAnalyzeContentRequest.Builder
The top-level message sent by the client to the
[Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.StreamingAnalyzeContent] method.
|
static class |
StreamingAnalyzeContentRequest.ConfigCase |
static class |
StreamingAnalyzeContentRequest.InputCase |
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter
AbstractMessageLite.InternalOneOfEnum
Modifier and Type | Field and Description |
---|---|
static int |
ASSIST_QUERY_PARAMS_FIELD_NUMBER |
static int |
AUDIO_CONFIG_FIELD_NUMBER |
static int |
CX_CURRENT_PAGE_FIELD_NUMBER |
static int |
CX_PARAMETERS_FIELD_NUMBER |
static int |
ENABLE_PARTIAL_AUTOMATED_AGENT_REPLY_FIELD_NUMBER |
static int |
INPUT_AUDIO_FIELD_NUMBER |
static int |
INPUT_DTMF_FIELD_NUMBER |
static int |
INPUT_TEXT_FIELD_NUMBER |
static int |
PARTICIPANT_FIELD_NUMBER |
static int |
QUERY_PARAMS_FIELD_NUMBER |
static int |
REPLY_AUDIO_CONFIG_FIELD_NUMBER |
static int |
TEXT_CONFIG_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFields
memoizedSize
memoizedHashCode
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
toByteArray, toByteString, writeDelimitedTo, writeTo
public static final int PARTICIPANT_FIELD_NUMBER
public static final int AUDIO_CONFIG_FIELD_NUMBER
public static final int TEXT_CONFIG_FIELD_NUMBER
public static final int REPLY_AUDIO_CONFIG_FIELD_NUMBER
public static final int INPUT_AUDIO_FIELD_NUMBER
public static final int INPUT_TEXT_FIELD_NUMBER
public static final int INPUT_DTMF_FIELD_NUMBER
public static final int QUERY_PARAMS_FIELD_NUMBER
public static final int ASSIST_QUERY_PARAMS_FIELD_NUMBER
public static final int CX_PARAMETERS_FIELD_NUMBER
public static final int CX_CURRENT_PAGE_FIELD_NUMBER
public static final int ENABLE_PARTIAL_AUTOMATED_AGENT_REPLY_FIELD_NUMBER
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class GeneratedMessageV3
public final UnknownFieldSet getUnknownFields()
getUnknownFields
in interface MessageOrBuilder
getUnknownFields
in class GeneratedMessageV3
public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class GeneratedMessageV3
public StreamingAnalyzeContentRequest.ConfigCase getConfigCase()
getConfigCase
in interface StreamingAnalyzeContentRequestOrBuilder
public StreamingAnalyzeContentRequest.InputCase getInputCase()
getInputCase
in interface StreamingAnalyzeContentRequestOrBuilder
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) = { ... }
getParticipant
in interface StreamingAnalyzeContentRequestOrBuilder
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) = { ... }
getParticipantBytes
in interface StreamingAnalyzeContentRequestOrBuilder
public boolean hasAudioConfig()
Instructs the speech recognizer how to process the speech audio.
.google.cloud.dialogflow.v2beta1.InputAudioConfig audio_config = 2;
hasAudioConfig
in interface StreamingAnalyzeContentRequestOrBuilder
public InputAudioConfig getAudioConfig()
Instructs the speech recognizer how to process the speech audio.
.google.cloud.dialogflow.v2beta1.InputAudioConfig audio_config = 2;
getAudioConfig
in interface StreamingAnalyzeContentRequestOrBuilder
public InputAudioConfigOrBuilder getAudioConfigOrBuilder()
Instructs the speech recognizer how to process the speech audio.
.google.cloud.dialogflow.v2beta1.InputAudioConfig audio_config = 2;
getAudioConfigOrBuilder
in interface StreamingAnalyzeContentRequestOrBuilder
public boolean hasTextConfig()
The natural language text to be processed.
.google.cloud.dialogflow.v2beta1.InputTextConfig text_config = 3;
hasTextConfig
in interface StreamingAnalyzeContentRequestOrBuilder
public InputTextConfig getTextConfig()
The natural language text to be processed.
.google.cloud.dialogflow.v2beta1.InputTextConfig text_config = 3;
getTextConfig
in interface StreamingAnalyzeContentRequestOrBuilder
public InputTextConfigOrBuilder getTextConfigOrBuilder()
The natural language text to be processed.
.google.cloud.dialogflow.v2beta1.InputTextConfig text_config = 3;
getTextConfigOrBuilder
in interface StreamingAnalyzeContentRequestOrBuilder
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;
hasReplyAudioConfig
in interface StreamingAnalyzeContentRequestOrBuilder
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;
getReplyAudioConfig
in interface StreamingAnalyzeContentRequestOrBuilder
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;
getReplyAudioConfigOrBuilder
in interface StreamingAnalyzeContentRequestOrBuilder
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;
hasInputAudio
in interface StreamingAnalyzeContentRequestOrBuilder
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;
getInputAudio
in interface StreamingAnalyzeContentRequestOrBuilder
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.
string input_text = 6;
hasInputText
in interface StreamingAnalyzeContentRequestOrBuilder
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.
string input_text = 6;
getInputText
in interface StreamingAnalyzeContentRequestOrBuilder
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.
string input_text = 6;
getInputTextBytes
in interface StreamingAnalyzeContentRequestOrBuilder
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;
hasInputDtmf
in interface StreamingAnalyzeContentRequestOrBuilder
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;
getInputDtmf
in interface StreamingAnalyzeContentRequestOrBuilder
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;
getInputDtmfOrBuilder
in interface StreamingAnalyzeContentRequestOrBuilder
public boolean hasQueryParams()
Parameters for a Dialogflow virtual-agent query.
.google.cloud.dialogflow.v2beta1.QueryParameters query_params = 7;
hasQueryParams
in interface StreamingAnalyzeContentRequestOrBuilder
public QueryParameters getQueryParams()
Parameters for a Dialogflow virtual-agent query.
.google.cloud.dialogflow.v2beta1.QueryParameters query_params = 7;
getQueryParams
in interface StreamingAnalyzeContentRequestOrBuilder
public QueryParametersOrBuilder getQueryParamsOrBuilder()
Parameters for a Dialogflow virtual-agent query.
.google.cloud.dialogflow.v2beta1.QueryParameters query_params = 7;
getQueryParamsOrBuilder
in interface StreamingAnalyzeContentRequestOrBuilder
public boolean hasAssistQueryParams()
Parameters for a human assist query.
.google.cloud.dialogflow.v2beta1.AssistQueryParameters assist_query_params = 8;
hasAssistQueryParams
in interface StreamingAnalyzeContentRequestOrBuilder
public AssistQueryParameters getAssistQueryParams()
Parameters for a human assist query.
.google.cloud.dialogflow.v2beta1.AssistQueryParameters assist_query_params = 8;
getAssistQueryParams
in interface StreamingAnalyzeContentRequestOrBuilder
public AssistQueryParametersOrBuilder getAssistQueryParamsOrBuilder()
Parameters for a human assist query.
.google.cloud.dialogflow.v2beta1.AssistQueryParameters assist_query_params = 8;
getAssistQueryParamsOrBuilder
in interface StreamingAnalyzeContentRequestOrBuilder
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;
hasCxParameters
in interface StreamingAnalyzeContentRequestOrBuilder
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;
getCxParameters
in interface StreamingAnalyzeContentRequestOrBuilder
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;
getCxParametersOrBuilder
in interface StreamingAnalyzeContentRequestOrBuilder
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][QueryResult.current_page] and the [previous session parameters][QueryResult.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;
getCxCurrentPage
in interface StreamingAnalyzeContentRequestOrBuilder
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][QueryResult.current_page] and the [previous session parameters][QueryResult.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;
getCxCurrentPageBytes
in interface StreamingAnalyzeContentRequestOrBuilder
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 `Fulfillment`s in Dialogflow virtual agent have been configured to return partial responses.
bool enable_partial_automated_agent_reply = 12;
getEnablePartialAutomatedAgentReply
in interface StreamingAnalyzeContentRequestOrBuilder
public final boolean isInitialized()
isInitialized
in interface MessageLiteOrBuilder
isInitialized
in class GeneratedMessageV3
public void writeTo(CodedOutputStream output) throws IOException
writeTo
in interface MessageLite
writeTo
in class GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface MessageLite
getSerializedSize
in class GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface Message
equals
in class AbstractMessage
public int hashCode()
hashCode
in interface Message
hashCode
in class AbstractMessage
public static StreamingAnalyzeContentRequest parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static StreamingAnalyzeContentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static StreamingAnalyzeContentRequest parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static StreamingAnalyzeContentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static StreamingAnalyzeContentRequest parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static StreamingAnalyzeContentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static StreamingAnalyzeContentRequest parseFrom(InputStream input) throws IOException
IOException
public static StreamingAnalyzeContentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static StreamingAnalyzeContentRequest parseDelimitedFrom(InputStream input) throws IOException
IOException
public static StreamingAnalyzeContentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static StreamingAnalyzeContentRequest parseFrom(CodedInputStream input) throws IOException
IOException
public static StreamingAnalyzeContentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public StreamingAnalyzeContentRequest.Builder newBuilderForType()
newBuilderForType
in interface Message
newBuilderForType
in interface MessageLite
public static StreamingAnalyzeContentRequest.Builder newBuilder()
public static StreamingAnalyzeContentRequest.Builder newBuilder(StreamingAnalyzeContentRequest prototype)
public StreamingAnalyzeContentRequest.Builder toBuilder()
toBuilder
in interface Message
toBuilder
in interface MessageLite
protected StreamingAnalyzeContentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class GeneratedMessageV3
public static StreamingAnalyzeContentRequest getDefaultInstance()
public static Parser<StreamingAnalyzeContentRequest> parser()
public Parser<StreamingAnalyzeContentRequest> getParserForType()
getParserForType
in interface Message
getParserForType
in interface MessageLite
getParserForType
in class GeneratedMessageV3
public StreamingAnalyzeContentRequest getDefaultInstanceForType()
getDefaultInstanceForType
in interface MessageLiteOrBuilder
getDefaultInstanceForType
in interface MessageOrBuilder
Copyright © 2022 Google LLC. All rights reserved.