public final class AutomatedAgentReply extends GeneratedMessageV3 implements AutomatedAgentReplyOrBuilder
Represents a response from an automated agent.
Protobuf type google.cloud.dialogflow.v2beta1.AutomatedAgentReply
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static AutomatedAgentReply.Builder newBuilder()
newBuilder(AutomatedAgentReply prototype)
public static AutomatedAgentReply.Builder newBuilder(AutomatedAgentReply prototype)
public static AutomatedAgentReply parseDelimitedFrom(InputStream input)
public static AutomatedAgentReply parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static AutomatedAgentReply parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AutomatedAgentReply parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static AutomatedAgentReply parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AutomatedAgentReply parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AutomatedAgentReply parseFrom(CodedInputStream input)
public static AutomatedAgentReply parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AutomatedAgentReply parseFrom(InputStream input)
public static AutomatedAgentReply parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static AutomatedAgentReply parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AutomatedAgentReply parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<AutomatedAgentReply> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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;
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];
getDefaultInstanceForType()
public AutomatedAgentReply getDefaultInstanceForType()
getDetectIntentResponse()
public DetectIntentResponse getDetectIntentResponse()
Response of the Dialogflow
Sessions.DetectIntent
call.
.google.cloud.dialogflow.v2beta1.DetectIntentResponse detect_intent_response = 1;
getDetectIntentResponseOrBuilder()
public DetectIntentResponseOrBuilder getDetectIntentResponseOrBuilder()
Response of the Dialogflow
Sessions.DetectIntent
call.
.google.cloud.dialogflow.v2beta1.DetectIntentResponse detect_intent_response = 1;
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()
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;
getParserForType()
public Parser<AutomatedAgentReply> getParserForType()
Overrides
getResponseCase()
public AutomatedAgentReply.ResponseCase getResponseCase()
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
|
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;
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
|
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public AutomatedAgentReply.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AutomatedAgentReply.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public AutomatedAgentReply.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
