com.google.cloud.dialogflow.v2beta1.AutomatedAgentReplyOrBuilder Maven / Gradle / Ivy
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/dialogflow/v2beta1/participant.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.dialogflow.v2beta1;
public interface AutomatedAgentReplyOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.v2beta1.AutomatedAgentReply)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Response of the Dialogflow
* [Sessions.DetectIntent][google.cloud.dialogflow.v2beta1.Sessions.DetectIntent]
* call.
*
*
* .google.cloud.dialogflow.v2beta1.DetectIntentResponse detect_intent_response = 1;
*
* @return Whether the detectIntentResponse field is set.
*/
boolean hasDetectIntentResponse();
/**
*
*
*
* Response of the Dialogflow
* [Sessions.DetectIntent][google.cloud.dialogflow.v2beta1.Sessions.DetectIntent]
* call.
*
*
* .google.cloud.dialogflow.v2beta1.DetectIntentResponse detect_intent_response = 1;
*
* @return The detectIntentResponse.
*/
com.google.cloud.dialogflow.v2beta1.DetectIntentResponse getDetectIntentResponse();
/**
*
*
*
* Response of the Dialogflow
* [Sessions.DetectIntent][google.cloud.dialogflow.v2beta1.Sessions.DetectIntent]
* call.
*
*
* .google.cloud.dialogflow.v2beta1.DetectIntentResponse detect_intent_response = 1;
*/
com.google.cloud.dialogflow.v2beta1.DetectIntentResponseOrBuilder
getDetectIntentResponseOrBuilder();
/**
*
*
*
* Response messages from the automated agent.
*
*
* repeated .google.cloud.dialogflow.v2beta1.ResponseMessage response_messages = 3;
*/
java.util.List getResponseMessagesList();
/**
*
*
*
* Response messages from the automated agent.
*
*
* repeated .google.cloud.dialogflow.v2beta1.ResponseMessage response_messages = 3;
*/
com.google.cloud.dialogflow.v2beta1.ResponseMessage getResponseMessages(int index);
/**
*
*
*
* Response messages from the automated agent.
*
*
* repeated .google.cloud.dialogflow.v2beta1.ResponseMessage response_messages = 3;
*/
int getResponseMessagesCount();
/**
*
*
*
* Response messages from the automated agent.
*
*
* repeated .google.cloud.dialogflow.v2beta1.ResponseMessage response_messages = 3;
*/
java.util.List
getResponseMessagesOrBuilderList();
/**
*
*
*
* Response messages from the automated agent.
*
*
* repeated .google.cloud.dialogflow.v2beta1.ResponseMessage response_messages = 3;
*/
com.google.cloud.dialogflow.v2beta1.ResponseMessageOrBuilder getResponseMessagesOrBuilder(
int index);
/**
*
*
*
* 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) = { ... }
*
* @return Whether the intent field is set.
*/
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) = { ... }
*
* @return The intent.
*/
java.lang.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) = { ... }
*
* @return The bytes for intent.
*/
com.google.protobuf.ByteString getIntentBytes();
/**
*
*
*
* Event name if an event is triggered for the query.
*
*
* string event = 5;
*
* @return Whether the event field is set.
*/
boolean hasEvent();
/**
*
*
*
* Event name if an event is triggered for the query.
*
*
* string event = 5;
*
* @return The event.
*/
java.lang.String getEvent();
/**
*
*
*
* Event name if an event is triggered for the query.
*
*
* string event = 5;
*
* @return The bytes for event.
*/
com.google.protobuf.ByteString getEventBytes();
/**
*
*
*
* 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;
*
* @return The matchConfidence.
*/
float getMatchConfidence();
/**
*
*
*
* The collection of current parameters at the time of this response.
*
*
* .google.protobuf.Struct parameters = 10;
*
* @return Whether the parameters field is set.
*/
boolean hasParameters();
/**
*
*
*
* The collection of current parameters at the time of this response.
*
*
* .google.protobuf.Struct parameters = 10;
*
* @return The parameters.
*/
com.google.protobuf.Struct getParameters();
/**
*
*
*
* The collection of current parameters at the time of this response.
*
*
* .google.protobuf.Struct parameters = 10;
*/
com.google.protobuf.StructOrBuilder getParametersOrBuilder();
/**
*
*
*
* 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];
*
* @deprecated google.cloud.dialogflow.v2beta1.AutomatedAgentReply.cx_session_parameters is
* deprecated. See google/cloud/dialogflow/v2beta1/participant.proto;l=542
* @return Whether the cxSessionParameters field is set.
*/
@java.lang.Deprecated
boolean hasCxSessionParameters();
/**
*
*
*
* 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];
*
* @deprecated google.cloud.dialogflow.v2beta1.AutomatedAgentReply.cx_session_parameters is
* deprecated. See google/cloud/dialogflow/v2beta1/participant.proto;l=542
* @return The cxSessionParameters.
*/
@java.lang.Deprecated
com.google.protobuf.Struct getCxSessionParameters();
/**
*
*
*
* 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];
*/
@java.lang.Deprecated
com.google.protobuf.StructOrBuilder getCxSessionParametersOrBuilder();
/**
*
*
*
* AutomatedAgentReply type.
*
*
*
* .google.cloud.dialogflow.v2beta1.AutomatedAgentReply.AutomatedAgentReplyType automated_agent_reply_type = 7;
*
*
* @return The enum numeric value on the wire for automatedAgentReplyType.
*/
int getAutomatedAgentReplyTypeValue();
/**
*
*
*
* AutomatedAgentReply type.
*
*
*
* .google.cloud.dialogflow.v2beta1.AutomatedAgentReply.AutomatedAgentReplyType automated_agent_reply_type = 7;
*
*
* @return The automatedAgentReplyType.
*/
com.google.cloud.dialogflow.v2beta1.AutomatedAgentReply.AutomatedAgentReplyType
getAutomatedAgentReplyType();
/**
*
*
*
* 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;
*
* @return The allowCancellation.
*/
boolean getAllowCancellation();
/**
*
*
*
* 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;
*
* @return The cxCurrentPage.
*/
java.lang.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;
*
* @return The bytes for cxCurrentPage.
*/
com.google.protobuf.ByteString getCxCurrentPageBytes();
/**
*
*
*
* The auth code for accessing Call Companion UI.
*
*
* bytes call_companion_auth_code = 12;
*
* @return The callCompanionAuthCode.
*/
com.google.protobuf.ByteString getCallCompanionAuthCode();
com.google.cloud.dialogflow.v2beta1.AutomatedAgentReply.ResponseCase getResponseCase();
com.google.cloud.dialogflow.v2beta1.AutomatedAgentReply.MatchCase getMatchCase();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy