Interface AutomatedAgentReplyOrBuilder (4.37.0)

Version 4.37.0

• 4.59.0 (latest)
• 4.58.0
• 4.57.0
• 4.55.0
• 4.54.0
• 4.53.0
• 4.52.0
• 4.51.0
• 4.50.0
• 4.49.0
• 4.48.0
• 4.47.0
• 4.46.0
• 4.45.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.35.0
• 4.34.0
• 4.33.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.23.0
• 4.22.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.1
• 4.8.6
• 4.7.5
• 4.6.0
• 4.5.11
• 4.4.0
• 4.3.1

public interface AutomatedAgentReplyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAllowCancellation()

public abstract 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 abstract 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 abstract 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.

getCxCurrentPage()

public abstract 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 abstract 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 abstract Struct getCxSessionParameters()

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

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 abstract 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

getDetectIntentResponse()

public abstract 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 abstract DetectIntentResponseOrBuilder getDetectIntentResponseOrBuilder()

Response of the Dialogflow Sessions.DetectIntent call.

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

Returns
Type	Description
DetectIntentResponseOrBuilder

getEvent()

public abstract String getEvent()

Event name if an event is triggered for the query.

string event = 5;

Returns
Type	Description
String	The event.

getEventBytes()

public abstract 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 abstract 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 abstract 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 abstract AutomatedAgentReply.MatchCase getMatchCase()

Returns
Type	Description
AutomatedAgentReply.MatchCase

getMatchConfidence()

public abstract 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 abstract 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 abstract StructOrBuilder getParametersOrBuilder()

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

.google.protobuf.Struct parameters = 10;

Returns
Type	Description
StructOrBuilder

getResponseCase()

public abstract AutomatedAgentReply.ResponseCase getResponseCase()

Returns
Type	Description
AutomatedAgentReply.ResponseCase

getResponseMessages(int index)

public abstract 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 abstract int getResponseMessagesCount()

Response messages from the automated agent.

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

Returns
Type	Description
int

getResponseMessagesList()

public abstract 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 abstract 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 abstract 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>

hasCxSessionParameters() (deprecated)

public abstract boolean hasCxSessionParameters()

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

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