Class DetectIntentRequest (0.74.0)

public final class DetectIntentRequest extends GeneratedMessageV3 implements DetectIntentRequestOrBuilder

The top-level message sent by the client to the Sessions.DetectIntent method.

Multiple request messages should be sent in order:

  1. The first message must contain session, query_input plus optionally query_params. If the client wants to receive an audio response, it should also contain output_audio_config.

  2. If query_input was set to query_input.audio.config, all subsequent messages must contain query_input.audio.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.

    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.DetectIntentRequest

Static Fields

ENABLE_DEBUGGING_INFO_FIELD_NUMBER

public static final int ENABLE_DEBUGGING_INFO_FIELD_NUMBER
Field Value
TypeDescription
int

ENABLE_PARTIAL_RESPONSE_FIELD_NUMBER

public static final int ENABLE_PARTIAL_RESPONSE_FIELD_NUMBER
Field Value
TypeDescription
int

OUTPUT_AUDIO_CONFIG_FIELD_NUMBER

public static final int OUTPUT_AUDIO_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_INPUT_FIELD_NUMBER

public static final int QUERY_INPUT_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_PARAMS_FIELD_NUMBER

public static final int QUERY_PARAMS_FIELD_NUMBER
Field Value
TypeDescription
int

SESSION_FIELD_NUMBER

public static final int SESSION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DetectIntentRequest getDefaultInstance()
Returns
TypeDescription
DetectIntentRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static DetectIntentRequest.Builder newBuilder()
Returns
TypeDescription
DetectIntentRequest.Builder

newBuilder(DetectIntentRequest )

public static DetectIntentRequest.Builder newBuilder(DetectIntentRequest )
Parameter
NameDescription
DetectIntentRequest
Returns
TypeDescription
DetectIntentRequest.Builder

parseDelimitedFrom(InputStream input)

public static DetectIntentRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DetectIntentRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DetectIntentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DetectIntentRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static DetectIntentRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
DetectIntentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DetectIntentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DetectIntentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DetectIntentRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
DetectIntentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DetectIntentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DetectIntentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DetectIntentRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
DetectIntentRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DetectIntentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DetectIntentRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static DetectIntentRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DetectIntentRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DetectIntentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DetectIntentRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static DetectIntentRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
DetectIntentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DetectIntentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DetectIntentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<DetectIntentRequest> parser()
Returns
TypeDescription
Parser<DetectIntentRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public DetectIntentRequest getDefaultInstanceForType()
Returns
TypeDescription
DetectIntentRequest

getEnableDebuggingInfo()

public boolean getEnableDebuggingInfo()

If true, DetectIntentResponse.debugging_info will get populated.

bool enable_debugging_info = 8;

Returns
TypeDescription
boolean

The enableDebuggingInfo.

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 Fulfillments in the agent have been configured to return partial responses.

bool enable_partial_response = 5;

Returns
TypeDescription
boolean

The enablePartialResponse.

getOutputAudioConfig()

public OutputAudioConfig getOutputAudioConfig()

Instructs the speech synthesizer how to generate the output audio.

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

Returns
TypeDescription
OutputAudioConfig

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;

Returns
TypeDescription
OutputAudioConfigOrBuilder

getParserForType()

public Parser<DetectIntentRequest> getParserForType()
Returns
TypeDescription
Parser<DetectIntentRequest>
Overrides

getQueryInput()

public QueryInput getQueryInput()

Required. The input specification.

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

Returns
TypeDescription
QueryInput

The queryInput.

getQueryInputOrBuilder()

public QueryInputOrBuilder getQueryInputOrBuilder()

Required. The input specification.

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

Returns
TypeDescription
QueryInputOrBuilder

getQueryParams()

public QueryParameters getQueryParams()

The parameters of this query.

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

Returns
TypeDescription
QueryParameters

The queryParams.

getQueryParamsOrBuilder()

public QueryParametersOrBuilder getQueryParamsOrBuilder()

The parameters of this query.

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

Returns
TypeDescription
QueryParametersOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSession()

public String getSession()

The name of the session this query is sent to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID> or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>. 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.

Note: Always use agent versions for production traffic. See Versions and environments.

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

Returns
TypeDescription
String

The session.

getSessionBytes()

public ByteString getSessionBytes()

The name of the session this query is sent to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID> or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>. 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.

Note: Always use agent versions for production traffic. See Versions and environments.

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

Returns
TypeDescription
ByteString

The bytes for session.

hasOutputAudioConfig()

public boolean hasOutputAudioConfig()

Instructs the speech synthesizer how to generate the output audio.

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

Returns
TypeDescription
boolean

Whether the outputAudioConfig field is set.

hasQueryInput()

public boolean hasQueryInput()

Required. The input specification.

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

Returns
TypeDescription
boolean

Whether the queryInput field is set.

hasQueryParams()

public boolean hasQueryParams()

The parameters of this query.

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

Returns
TypeDescription
boolean

Whether the queryParams field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public DetectIntentRequest.Builder newBuilderForType()
Returns
TypeDescription
DetectIntentRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DetectIntentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
DetectIntentRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public DetectIntentRequest.Builder toBuilder()
Returns
TypeDescription
DetectIntentRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException