com.google.cloud.dialogflow.cx.v3

Class StreamingDetectIntentRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest

All Implemented Interfaces:

StreamingDetectIntentRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class StreamingDetectIntentRequest
extends com.google.protobuf.GeneratedMessageV3
implements StreamingDetectIntentRequestOrBuilder

 The top-level message sent by the client to the
 [Sessions.StreamingDetectIntent][google.cloud.dialogflow.cx.v3.Sessions.StreamingDetectIntent] method.
 Multiple request messages should be sent in order:
 1.  The first message must contain
     [session][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.session],
     [query_input][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.query_input] plus optionally
     [query_params][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.query_params]. If the client
     wants to receive an audio response, it should also contain
     [output_audio_config][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.output_audio_config].
 2.  If [query_input][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.query_input] was set to
     [query_input.audio.config][google.cloud.dialogflow.cx.v3.AudioInput.config], all subsequent messages
     must contain [query_input.audio.audio][google.cloud.dialogflow.cx.v3.AudioInput.audio] to continue with
     Speech recognition.
     If you decide to rather detect an intent from text
     input after you already started Speech recognition, please send a message
     with [query_input.text][google.cloud.dialogflow.cx.v3.QueryInput.text].
     However, note that:
     * Dialogflow will bill you for the audio duration so far.
     * Dialogflow discards all Speech recognition results in favor of the
       input text.
     * Dialogflow will use the language code from the first message.
 After you sent all input, you must half-close or abort the request stream.
 

Protobuf type google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StreamingDetectIntentRequest.Builder The top-level message sent by the client to the [Sessions.StreamingDetectIntent][google.cloud.dialogflow.cx.v3.Sessions.StreamingDetectIntent] method.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ENABLE_PARTIAL_RESPONSE_FIELD_NUMBER
static int	OUTPUT_AUDIO_CONFIG_FIELD_NUMBER
static int	QUERY_INPUT_FIELD_NUMBER
static int	QUERY_PARAMS_FIELD_NUMBER
static int	SESSION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static StreamingDetectIntentRequest	getDefaultInstance()
StreamingDetectIntentRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getEnablePartialResponse() Enable partial detect intent response.
OutputAudioConfig	getOutputAudioConfig() Instructs the speech synthesizer how to generate the output audio.
OutputAudioConfigOrBuilder	getOutputAudioConfigOrBuilder() Instructs the speech synthesizer how to generate the output audio.
com.google.protobuf.Parser<StreamingDetectIntentRequest>	getParserForType()
QueryInput	getQueryInput() Required.
QueryInputOrBuilder	getQueryInputOrBuilder() Required.
QueryParameters	getQueryParams() The parameters of this query.
QueryParametersOrBuilder	getQueryParamsOrBuilder() The parameters of this query.
int	getSerializedSize()
String	getSession() The name of the session this query is sent to.
com.google.protobuf.ByteString	getSessionBytes() The name of the session this query is sent to.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasOutputAudioConfig() Instructs the speech synthesizer how to generate the output audio.
boolean	hasQueryInput() Required.
boolean	hasQueryParams() The parameters of this query.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static StreamingDetectIntentRequest.Builder	newBuilder()
static StreamingDetectIntentRequest.Builder	newBuilder(StreamingDetectIntentRequest prototype)
StreamingDetectIntentRequest.Builder	newBuilderForType()
protected StreamingDetectIntentRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static StreamingDetectIntentRequest	parseDelimitedFrom(InputStream input)
static StreamingDetectIntentRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StreamingDetectIntentRequest	parseFrom(byte[] data)
static StreamingDetectIntentRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StreamingDetectIntentRequest	parseFrom(ByteBuffer data)
static StreamingDetectIntentRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StreamingDetectIntentRequest	parseFrom(com.google.protobuf.ByteString data)
static StreamingDetectIntentRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StreamingDetectIntentRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static StreamingDetectIntentRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StreamingDetectIntentRequest	parseFrom(InputStream input)
static StreamingDetectIntentRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<StreamingDetectIntentRequest>	parser()
StreamingDetectIntentRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

SESSION_FIELD_NUMBER

public static final int SESSION_FIELD_NUMBER

See Also:

Constant Field Values

QUERY_PARAMS_FIELD_NUMBER

public static final int QUERY_PARAMS_FIELD_NUMBER

See Also:

Constant Field Values

QUERY_INPUT_FIELD_NUMBER

public static final int QUERY_INPUT_FIELD_NUMBER

See Also:

Constant Field Values

OUTPUT_AUDIO_CONFIG_FIELD_NUMBER

public static final int OUTPUT_AUDIO_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

ENABLE_PARTIAL_RESPONSE_FIELD_NUMBER

public static final int ENABLE_PARTIAL_RESPONSE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getSession

public String getSession()

 The name of the session this query is sent to.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/sessions/<Session ID>` or `projects/<Project ID>/locations/<Location
 ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>`.
 If `Environment ID` is not specified, we assume default 'draft'
 environment.
 It's up to the API caller to choose an appropriate `Session ID`. It can be
 a random number or some type of session identifiers (preferably hashed).
 The length of the `Session ID` must not exceed 36 characters.
 Note: session must be set in the first request.
 For more information, see the [sessions
 guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).
 Note: Always use agent versions for production traffic.
 See [Versions and
 environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
 

string session = 1 [(.google.api.resource_reference) = { ... }

Specified by:

getSession in interface StreamingDetectIntentRequestOrBuilder

Returns:

The session.

getSessionBytes

public com.google.protobuf.ByteString getSessionBytes()

 The name of the session this query is sent to.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/sessions/<Session ID>` or `projects/<Project ID>/locations/<Location
 ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>`.
 If `Environment ID` is not specified, we assume default 'draft'
 environment.
 It's up to the API caller to choose an appropriate `Session ID`. It can be
 a random number or some type of session identifiers (preferably hashed).
 The length of the `Session ID` must not exceed 36 characters.
 Note: session must be set in the first request.
 For more information, see the [sessions
 guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).
 Note: Always use agent versions for production traffic.
 See [Versions and
 environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
 

string session = 1 [(.google.api.resource_reference) = { ... }

Specified by:

getSessionBytes in interface StreamingDetectIntentRequestOrBuilder

Returns:

The bytes for session.

hasQueryParams

public boolean hasQueryParams()

 The parameters of this query.
 

.google.cloud.dialogflow.cx.v3.QueryParameters query_params = 2;

Specified by:

hasQueryParams in interface StreamingDetectIntentRequestOrBuilder

Returns:

Whether the queryParams field is set.

getQueryParams

public QueryParameters getQueryParams()

 The parameters of this query.
 

.google.cloud.dialogflow.cx.v3.QueryParameters query_params = 2;

Specified by:

getQueryParams in interface StreamingDetectIntentRequestOrBuilder

Returns:

The queryParams.

getQueryParamsOrBuilder

public QueryParametersOrBuilder getQueryParamsOrBuilder()

 The parameters of this query.
 

.google.cloud.dialogflow.cx.v3.QueryParameters query_params = 2;

Specified by:

getQueryParamsOrBuilder in interface StreamingDetectIntentRequestOrBuilder

hasQueryInput

public boolean hasQueryInput()

 Required. The input specification.
 

.google.cloud.dialogflow.cx.v3.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];

Specified by:

hasQueryInput in interface StreamingDetectIntentRequestOrBuilder

Returns:

Whether the queryInput field is set.

getQueryInput

public QueryInput getQueryInput()

 Required. The input specification.
 

.google.cloud.dialogflow.cx.v3.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getQueryInput in interface StreamingDetectIntentRequestOrBuilder

Returns:

The queryInput.

getQueryInputOrBuilder

public QueryInputOrBuilder getQueryInputOrBuilder()

 Required. The input specification.
 

.google.cloud.dialogflow.cx.v3.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getQueryInputOrBuilder in interface StreamingDetectIntentRequestOrBuilder

hasOutputAudioConfig

public boolean hasOutputAudioConfig()

 Instructs the speech synthesizer how to generate the output audio.
 

.google.cloud.dialogflow.cx.v3.OutputAudioConfig output_audio_config = 4;

Specified by:

hasOutputAudioConfig in interface StreamingDetectIntentRequestOrBuilder

Returns:

Whether the outputAudioConfig field is set.

getOutputAudioConfig

public OutputAudioConfig getOutputAudioConfig()

 Instructs the speech synthesizer how to generate the output audio.
 

.google.cloud.dialogflow.cx.v3.OutputAudioConfig output_audio_config = 4;

Specified by:

getOutputAudioConfig in interface StreamingDetectIntentRequestOrBuilder

Returns:

The outputAudioConfig.

getOutputAudioConfigOrBuilder

public OutputAudioConfigOrBuilder getOutputAudioConfigOrBuilder()

 Instructs the speech synthesizer how to generate the output audio.
 

.google.cloud.dialogflow.cx.v3.OutputAudioConfig output_audio_config = 4;

Specified by:

getOutputAudioConfigOrBuilder in interface StreamingDetectIntentRequestOrBuilder

getEnablePartialResponse

public boolean getEnablePartialResponse()

 Enable partial detect intent response. If this flag is not enabled,
 response stream still contains only one final `DetectIntentResponse` even
 if some `Fulfillment`s in the agent have been configured to return partial
 responses.
 

bool enable_partial_response = 5;

Specified by:

getEnablePartialResponse in interface StreamingDetectIntentRequestOrBuilder

Returns:

The enablePartialResponse.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static StreamingDetectIntentRequest parseFrom(ByteBuffer data)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamingDetectIntentRequest parseFrom(ByteBuffer data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamingDetectIntentRequest parseFrom(com.google.protobuf.ByteString data)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamingDetectIntentRequest parseFrom(com.google.protobuf.ByteString data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamingDetectIntentRequest parseFrom(byte[] data)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamingDetectIntentRequest parseFrom(byte[] data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamingDetectIntentRequest parseFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseFrom

public static StreamingDetectIntentRequest parseFrom(InputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static StreamingDetectIntentRequest parseDelimitedFrom(InputStream input)
                                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static StreamingDetectIntentRequest parseDelimitedFrom(InputStream input,
                                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                       throws IOException

Throws:

IOException

parseFrom

public static StreamingDetectIntentRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                              throws IOException

Throws:

IOException

parseFrom

public static StreamingDetectIntentRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

newBuilderForType

public StreamingDetectIntentRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static StreamingDetectIntentRequest.Builder newBuilder()

newBuilder

public static StreamingDetectIntentRequest.Builder newBuilder(StreamingDetectIntentRequest prototype)

toBuilder

public StreamingDetectIntentRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected StreamingDetectIntentRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static StreamingDetectIntentRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<StreamingDetectIntentRequest> parser()

getParserForType

public com.google.protobuf.Parser<StreamingDetectIntentRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public StreamingDetectIntentRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder