Class AutomatedAgentReply (4.7.3)

public final class AutomatedAgentReply extends GeneratedMessageV3 implements AutomatedAgentReplyOrBuilder

Represents a response from an automated agent.

Protobuf type google.cloud.dialogflow.v2beta1.AutomatedAgentReply

Static Fields

ALLOW_CANCELLATION_FIELD_NUMBER

public static final int ALLOW_CANCELLATION_FIELD_NUMBER
Field Value
TypeDescription
int

AUTOMATED_AGENT_REPLY_TYPE_FIELD_NUMBER

public static final int AUTOMATED_AGENT_REPLY_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

CX_SESSION_PARAMETERS_FIELD_NUMBER

public static final int CX_SESSION_PARAMETERS_FIELD_NUMBER
Field Value
TypeDescription
int

DETECT_INTENT_RESPONSE_FIELD_NUMBER

public static final int DETECT_INTENT_RESPONSE_FIELD_NUMBER
Field Value
TypeDescription
int

EVENT_FIELD_NUMBER

public static final int EVENT_FIELD_NUMBER
Field Value
TypeDescription
int

INTENT_FIELD_NUMBER

public static final int INTENT_FIELD_NUMBER
Field Value
TypeDescription
int

MATCH_CONFIDENCE_FIELD_NUMBER

public static final int MATCH_CONFIDENCE_FIELD_NUMBER
Field Value
TypeDescription
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
TypeDescription
int

RESPONSE_MESSAGES_FIELD_NUMBER

public static final int RESPONSE_MESSAGES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AutomatedAgentReply getDefaultInstance()
Returns
TypeDescription
AutomatedAgentReply

getDescriptor()

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

newBuilder()

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

newBuilder(AutomatedAgentReply prototype)

public static AutomatedAgentReply.Builder newBuilder(AutomatedAgentReply prototype)
Parameter
NameDescription
prototypeAutomatedAgentReply
Returns
TypeDescription
AutomatedAgentReply.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAllowCancellation()

public boolean getAllowCancellation()

Indicates whether the partial automated agent reply is interruptible when a later reply message arrives. e.g. if the agent specified some music as partial response, it can be cancelled.

bool allow_cancellation = 8;

Returns
TypeDescription
boolean

The allowCancellation.

getAutomatedAgentReplyType()

public AutomatedAgentReply.AutomatedAgentReplyType getAutomatedAgentReplyType()

AutomatedAgentReply type.

.google.cloud.dialogflow.v2beta1.AutomatedAgentReply.AutomatedAgentReplyType automated_agent_reply_type = 7;

Returns
TypeDescription
AutomatedAgentReply.AutomatedAgentReplyType

The automatedAgentReplyType.

getAutomatedAgentReplyTypeValue()

public int getAutomatedAgentReplyTypeValue()

AutomatedAgentReply type.

.google.cloud.dialogflow.v2beta1.AutomatedAgentReply.AutomatedAgentReplyType automated_agent_reply_type = 7;

Returns
TypeDescription
int

The enum numeric value on the wire for automatedAgentReplyType.

getCxSessionParameters() (deprecated)

public Struct getCxSessionParameters()

Deprecated. google.cloud.dialogflow.v2beta1.AutomatedAgentReply.cx_session_parameters is deprecated. See google/cloud/dialogflow/v2beta1/participant.proto;l=474

The collection of current Dialogflow CX agent session parameters at the time of this response. Deprecated: Use parameters instead.

.google.protobuf.Struct cx_session_parameters = 6 [deprecated = true];

Returns
TypeDescription
Struct

The cxSessionParameters.

getCxSessionParametersOrBuilder()

public StructOrBuilder getCxSessionParametersOrBuilder()

The collection of current Dialogflow CX agent session parameters at the time of this response. Deprecated: Use parameters instead.

.google.protobuf.Struct cx_session_parameters = 6 [deprecated = true];

Returns
TypeDescription
StructOrBuilder

getDefaultInstanceForType()

public AutomatedAgentReply getDefaultInstanceForType()
Returns
TypeDescription
AutomatedAgentReply

getDetectIntentResponse()

public DetectIntentResponse getDetectIntentResponse()

Response of the Dialogflow Sessions.DetectIntent call.

.google.cloud.dialogflow.v2beta1.DetectIntentResponse detect_intent_response = 1;

Returns
TypeDescription
DetectIntentResponse

The detectIntentResponse.

getDetectIntentResponseOrBuilder()

public DetectIntentResponseOrBuilder getDetectIntentResponseOrBuilder()

Response of the Dialogflow Sessions.DetectIntent call.

.google.cloud.dialogflow.v2beta1.DetectIntentResponse detect_intent_response = 1;

Returns
TypeDescription
DetectIntentResponseOrBuilder

getEvent()

public String getEvent()

Event name if an event is triggered for the query.

string event = 5;

Returns
TypeDescription
String

The event.

getEventBytes()

public ByteString getEventBytes()

Event name if an event is triggered for the query.

string event = 5;

Returns
TypeDescription
ByteString

The bytes for event.

getIntent()

public String getIntent()

Name of the intent if an intent is matched for the query. For a V2 query, the value format is projects/<Project ID>/locations/ <Location ID>/agent/intents/<Intent ID>. For a V3 query, the value format is projects/<Project ID>/locations/ <Location ID>/agents/<Agent ID>/intents/<Intent ID>.

string intent = 4 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The intent.

getIntentBytes()

public ByteString getIntentBytes()

Name of the intent if an intent is matched for the query. For a V2 query, the value format is projects/<Project ID>/locations/ <Location ID>/agent/intents/<Intent ID>. For a V3 query, the value format is projects/<Project ID>/locations/ <Location ID>/agents/<Agent ID>/intents/<Intent ID>.

string intent = 4 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for intent.

getMatchCase()

public AutomatedAgentReply.MatchCase getMatchCase()
Returns
TypeDescription
AutomatedAgentReply.MatchCase

getMatchConfidence()

public float getMatchConfidence()

The confidence of the match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation.

float match_confidence = 9;

Returns
TypeDescription
float

The matchConfidence.

getParameters()

public Struct getParameters()

The collection of current parameters at the time of this response.

.google.protobuf.Struct parameters = 10;

Returns
TypeDescription
Struct

The parameters.

getParametersOrBuilder()

public StructOrBuilder getParametersOrBuilder()

The collection of current parameters at the time of this response.

.google.protobuf.Struct parameters = 10;

Returns
TypeDescription
StructOrBuilder

getParserForType()

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

getResponseCase()

public AutomatedAgentReply.ResponseCase getResponseCase()
Returns
TypeDescription
AutomatedAgentReply.ResponseCase

getResponseMessages(int index)

public ResponseMessage getResponseMessages(int index)

Response messages from the automated agent.

repeated .google.cloud.dialogflow.v2beta1.ResponseMessage response_messages = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
ResponseMessage

getResponseMessagesCount()

public int getResponseMessagesCount()

Response messages from the automated agent.

repeated .google.cloud.dialogflow.v2beta1.ResponseMessage response_messages = 3;

Returns
TypeDescription
int

getResponseMessagesList()

public List<ResponseMessage> getResponseMessagesList()

Response messages from the automated agent.

repeated .google.cloud.dialogflow.v2beta1.ResponseMessage response_messages = 3;

Returns
TypeDescription
List<ResponseMessage>

getResponseMessagesOrBuilder(int index)

public ResponseMessageOrBuilder getResponseMessagesOrBuilder(int index)

Response messages from the automated agent.

repeated .google.cloud.dialogflow.v2beta1.ResponseMessage response_messages = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
ResponseMessageOrBuilder

getResponseMessagesOrBuilderList()

public List<? extends ResponseMessageOrBuilder> getResponseMessagesOrBuilderList()

Response messages from the automated agent.

repeated .google.cloud.dialogflow.v2beta1.ResponseMessage response_messages = 3;

Returns
TypeDescription
List<? extends com.google.cloud.dialogflow.v2beta1.ResponseMessageOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasCxSessionParameters() (deprecated)

public boolean hasCxSessionParameters()

Deprecated. google.cloud.dialogflow.v2beta1.AutomatedAgentReply.cx_session_parameters is deprecated. See google/cloud/dialogflow/v2beta1/participant.proto;l=474

The collection of current Dialogflow CX agent session parameters at the time of this response. Deprecated: Use parameters instead.

.google.protobuf.Struct cx_session_parameters = 6 [deprecated = true];

Returns
TypeDescription
boolean

Whether the cxSessionParameters field is set.

hasDetectIntentResponse()

public boolean hasDetectIntentResponse()

Response of the Dialogflow Sessions.DetectIntent call.

.google.cloud.dialogflow.v2beta1.DetectIntentResponse detect_intent_response = 1;

Returns
TypeDescription
boolean

Whether the detectIntentResponse field is set.

hasEvent()

public boolean hasEvent()

Event name if an event is triggered for the query.

string event = 5;

Returns
TypeDescription
boolean

Whether the event field is set.

hasIntent()

public boolean hasIntent()

Name of the intent if an intent is matched for the query. For a V2 query, the value format is projects/<Project ID>/locations/ <Location ID>/agent/intents/<Intent ID>. For a V3 query, the value format is projects/<Project ID>/locations/ <Location ID>/agents/<Agent ID>/intents/<Intent ID>.

string intent = 4 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
boolean

Whether the intent field is set.

hasParameters()

public boolean hasParameters()

The collection of current parameters at the time of this response.

.google.protobuf.Struct parameters = 10;

Returns
TypeDescription
boolean

Whether the parameters 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 AutomatedAgentReply.Builder newBuilderForType()
Returns
TypeDescription
AutomatedAgentReply.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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