Class AutomatedAgentReply (4.58.0)

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
Type Description
int

AUTOMATED_AGENT_REPLY_TYPE_FIELD_NUMBER

public static final int AUTOMATED_AGENT_REPLY_TYPE_FIELD_NUMBER
Field Value
Type Description
int

CALL_COMPANION_AUTH_CODE_FIELD_NUMBER

public static final int CALL_COMPANION_AUTH_CODE_FIELD_NUMBER
Field Value
Type Description
int

CX_CURRENT_PAGE_FIELD_NUMBER

public static final int CX_CURRENT_PAGE_FIELD_NUMBER
Field Value
Type Description
int

CX_SESSION_PARAMETERS_FIELD_NUMBER

public static final int CX_SESSION_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

DETECT_INTENT_RESPONSE_FIELD_NUMBER

public static final int DETECT_INTENT_RESPONSE_FIELD_NUMBER
Field Value
Type Description
int

EVENT_FIELD_NUMBER

public static final int EVENT_FIELD_NUMBER
Field Value
Type Description
int

INTENT_FIELD_NUMBER

public static final int INTENT_FIELD_NUMBER
Field Value
Type Description
int

MATCH_CONFIDENCE_FIELD_NUMBER

public static final int MATCH_CONFIDENCE_FIELD_NUMBER
Field Value
Type Description
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

RESPONSE_MESSAGES_FIELD_NUMBER

public static final int RESPONSE_MESSAGES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AutomatedAgentReply getDefaultInstance()
Returns
Type Description
AutomatedAgentReply

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AutomatedAgentReply.Builder newBuilder()
Returns
Type Description
AutomatedAgentReply.Builder

newBuilder(AutomatedAgentReply prototype)

public static AutomatedAgentReply.Builder newBuilder(AutomatedAgentReply prototype)
Parameter
Name Description
prototype AutomatedAgentReply
Returns
Type Description
AutomatedAgentReply.Builder

parseDelimitedFrom(InputStream input)

public static AutomatedAgentReply parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AutomatedAgentReply
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AutomatedAgentReply parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AutomatedAgentReply
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AutomatedAgentReply parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AutomatedAgentReply
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AutomatedAgentReply parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AutomatedAgentReply
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AutomatedAgentReply parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AutomatedAgentReply
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AutomatedAgentReply parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AutomatedAgentReply
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AutomatedAgentReply parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AutomatedAgentReply
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AutomatedAgentReply parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AutomatedAgentReply
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AutomatedAgentReply parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AutomatedAgentReply
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AutomatedAgentReply parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AutomatedAgentReply
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AutomatedAgentReply parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AutomatedAgentReply
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AutomatedAgentReply parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AutomatedAgentReply
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AutomatedAgentReply> parser()
Returns
Type Description
Parser<AutomatedAgentReply>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Type Description
boolean

The allowCancellation.

getAutomatedAgentReplyType()

public AutomatedAgentReply.AutomatedAgentReplyType getAutomatedAgentReplyType()

AutomatedAgentReply type.

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

Returns
Type Description
AutomatedAgentReply.AutomatedAgentReplyType

The automatedAgentReplyType.

getAutomatedAgentReplyTypeValue()

public int getAutomatedAgentReplyTypeValue()

AutomatedAgentReply type.

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

Returns
Type Description
int

The enum numeric value on the wire for automatedAgentReplyType.

getCallCompanionAuthCode()

public ByteString getCallCompanionAuthCode()

The auth code for accessing Call Companion UI.

bytes call_companion_auth_code = 12;

Returns
Type Description
ByteString

The callCompanionAuthCode.

getCxCurrentPage()

public String getCxCurrentPage()

The unique identifier of the current Dialogflow CX conversation page. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

string cx_current_page = 11;

Returns
Type Description
String

The cxCurrentPage.

getCxCurrentPageBytes()

public ByteString getCxCurrentPageBytes()

The unique identifier of the current Dialogflow CX conversation page. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

string cx_current_page = 11;

Returns
Type Description
ByteString

The bytes for cxCurrentPage.

getCxSessionParameters() (deprecated)

public Struct getCxSessionParameters()

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

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
Type Description
Struct

The cxSessionParameters.

getCxSessionParametersOrBuilder() (deprecated)

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
Type Description
StructOrBuilder

getDefaultInstanceForType()

public AutomatedAgentReply getDefaultInstanceForType()
Returns
Type Description
AutomatedAgentReply

getDetectIntentResponse()

public DetectIntentResponse getDetectIntentResponse()

Response of the Dialogflow Sessions.DetectIntent call.

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

Returns
Type Description
DetectIntentResponse

The detectIntentResponse.

getDetectIntentResponseOrBuilder()

public DetectIntentResponseOrBuilder getDetectIntentResponseOrBuilder()

Response of the Dialogflow Sessions.DetectIntent call.

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

Returns
Type Description
DetectIntentResponseOrBuilder

getEvent()

public String getEvent()

Event name if an event is triggered for the query.

string event = 5;

Returns
Type Description
String

The event.

getEventBytes()

public ByteString getEventBytes()

Event name if an event is triggered for the query.

string event = 5;

Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for intent.

getMatchCase()

public AutomatedAgentReply.MatchCase getMatchCase()
Returns
Type Description
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
Type Description
float

The matchConfidence.

getParameters()

public Struct getParameters()

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

.google.protobuf.Struct parameters = 10;

Returns
Type Description
Struct

The parameters.

getParametersOrBuilder()

public StructOrBuilder getParametersOrBuilder()

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

.google.protobuf.Struct parameters = 10;

Returns
Type Description
StructOrBuilder

getParserForType()

public Parser<AutomatedAgentReply> getParserForType()
Returns
Type Description
Parser<AutomatedAgentReply>
Overrides

getResponseCase()

public AutomatedAgentReply.ResponseCase getResponseCase()
Returns
Type Description
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
Name Description
index int
Returns
Type Description
ResponseMessage

getResponseMessagesCount()

public int getResponseMessagesCount()

Response messages from the automated agent.

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

Returns
Type Description
int

getResponseMessagesList()

public List<ResponseMessage> getResponseMessagesList()

Response messages from the automated agent.

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

Returns
Type Description
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
Name Description
index int
Returns
Type Description
ResponseMessageOrBuilder

getResponseMessagesOrBuilderList()

public List<? extends ResponseMessageOrBuilder> getResponseMessagesOrBuilderList()

Response messages from the automated agent.

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

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
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=542

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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
boolean

Whether the parameters field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AutomatedAgentReply.Builder newBuilderForType()
Returns
Type Description
AutomatedAgentReply.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AutomatedAgentReply.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AutomatedAgentReply.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AutomatedAgentReply.Builder toBuilder()
Returns
Type Description
AutomatedAgentReply.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException