Package com.google.cloud.dialogflow.v2beta1

Class AutomatedAgentReply

  • All Implemented Interfaces:
    AutomatedAgentReplyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class AutomatedAgentReply
extends com.google.protobuf.GeneratedMessageV3
implements AutomatedAgentReplyOrBuilder
     Represents a response from an automated agent.
    Protobuf type google.cloud.dialogflow.v2beta1.AutomatedAgentReply
    See Also:
    Serialized Form

    • Field Detail

      • DETECT_INTENT_RESPONSE_FIELD_NUMBER

        public static final int DETECT_INTENT_RESPONSE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RESPONSE_MESSAGES_FIELD_NUMBER

        public static final int RESPONSE_MESSAGES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MATCH_CONFIDENCE_FIELD_NUMBER

        public static final int MATCH_CONFIDENCE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PARAMETERS_FIELD_NUMBER

        public static final int PARAMETERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CX_SESSION_PARAMETERS_FIELD_NUMBER

        public static final int CX_SESSION_PARAMETERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AUTOMATED_AGENT_REPLY_TYPE_FIELD_NUMBER

        public static final int AUTOMATED_AGENT_REPLY_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ALLOW_CANCELLATION_FIELD_NUMBER

        public static final int ALLOW_CANCELLATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CX_CURRENT_PAGE_FIELD_NUMBER

        public static final int CX_CURRENT_PAGE_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasDetectIntentResponse

        public boolean hasDetectIntentResponse()
         Response of the Dialogflow
 [Sessions.DetectIntent][google.cloud.dialogflow.v2beta1.Sessions.DetectIntent]
 call.
        .google.cloud.dialogflow.v2beta1.DetectIntentResponse detect_intent_response = 1;
        Specified by:
        hasDetectIntentResponse in interface AutomatedAgentReplyOrBuilder
        Returns:
        Whether the detectIntentResponse field is set.

      • getDetectIntentResponse

        public DetectIntentResponse getDetectIntentResponse()
         Response of the Dialogflow
 [Sessions.DetectIntent][google.cloud.dialogflow.v2beta1.Sessions.DetectIntent]
 call.
        .google.cloud.dialogflow.v2beta1.DetectIntentResponse detect_intent_response = 1;
        Specified by:
        getDetectIntentResponse in interface AutomatedAgentReplyOrBuilder
        Returns:
        The detectIntentResponse.

      • getResponseMessagesCount

        public int getResponseMessagesCount()
         Response messages from the automated agent.
        repeated .google.cloud.dialogflow.v2beta1.ResponseMessage response_messages = 3;
        Specified by:
        getResponseMessagesCount in interface AutomatedAgentReplyOrBuilder

      • 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) = { ... }
        Specified by:
        hasIntent in interface AutomatedAgentReplyOrBuilder
        Returns:
        Whether the intent field is set.

      • 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) = { ... }
        Specified by:
        getIntent in interface AutomatedAgentReplyOrBuilder
        Returns:
        The intent.

      • getIntentBytes

        public com.google.protobuf.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) = { ... }
        Specified by:
        getIntentBytes in interface AutomatedAgentReplyOrBuilder
        Returns:
        The bytes for intent.

      • hasEvent

        public boolean hasEvent()
         Event name if an event is triggered for the query.
        string event = 5;
        Specified by:
        hasEvent in interface AutomatedAgentReplyOrBuilder
        Returns:
        Whether the event field is set.

      • getEventBytes

        public com.google.protobuf.ByteString getEventBytes()
         Event name if an event is triggered for the query.
        string event = 5;
        Specified by:
        getEventBytes in interface AutomatedAgentReplyOrBuilder
        Returns:
        The bytes for event.

      • 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;
        Specified by:
        getMatchConfidence in interface AutomatedAgentReplyOrBuilder
        Returns:
        The matchConfidence.

      • hasParameters

        public boolean hasParameters()
         The collection of current parameters at the time of this response.
        .google.protobuf.Struct parameters = 10;
        Specified by:
        hasParameters in interface AutomatedAgentReplyOrBuilder
        Returns:
        Whether the parameters field is set.

      • getParameters

        public com.google.protobuf.Struct getParameters()
         The collection of current parameters at the time of this response.
        .google.protobuf.Struct parameters = 10;
        Specified by:
        getParameters in interface AutomatedAgentReplyOrBuilder
        Returns:
        The parameters.

      • getParametersOrBuilder

        public com.google.protobuf.StructOrBuilder getParametersOrBuilder()
         The collection of current parameters at the time of this response.
        .google.protobuf.Struct parameters = 10;
        Specified by:
        getParametersOrBuilder in interface AutomatedAgentReplyOrBuilder

      • hasCxSessionParameters

        @Deprecated
public 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];
        Specified by:
        hasCxSessionParameters in interface AutomatedAgentReplyOrBuilder
        Returns:
        Whether the cxSessionParameters field is set.

      • getCxSessionParameters

        @Deprecated
public com.google.protobuf.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];
        Specified by:
        getCxSessionParameters in interface AutomatedAgentReplyOrBuilder
        Returns:
        The cxSessionParameters.

      • getCxSessionParametersOrBuilder

        @Deprecated
public com.google.protobuf.StructOrBuilder getCxSessionParametersOrBuilder()
        Deprecated.
         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];
        Specified by:
        getCxSessionParametersOrBuilder in interface AutomatedAgentReplyOrBuilder

      • getAutomatedAgentReplyTypeValue

        public int getAutomatedAgentReplyTypeValue()
         AutomatedAgentReply type.
        .google.cloud.dialogflow.v2beta1.AutomatedAgentReply.AutomatedAgentReplyType automated_agent_reply_type = 7;
        Specified by:
        getAutomatedAgentReplyTypeValue in interface AutomatedAgentReplyOrBuilder
        Returns:
        The enum numeric value on the wire for automatedAgentReplyType.

      • 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;
        Specified by:
        getAllowCancellation in interface AutomatedAgentReplyOrBuilder
        Returns:
        The allowCancellation.

      • 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;
        Specified by:
        getCxCurrentPage in interface AutomatedAgentReplyOrBuilder
        Returns:
        The cxCurrentPage.

      • getCxCurrentPageBytes

        public com.google.protobuf.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;
        Specified by:
        getCxCurrentPageBytes in interface AutomatedAgentReplyOrBuilder
        Returns:
        The bytes for cxCurrentPage.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static AutomatedAgentReply parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AutomatedAgentReply parseFrom​(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AutomatedAgentReply parseFrom​(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AutomatedAgentReply parseFrom​(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AutomatedAgentReply parseFrom​(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AutomatedAgentReply parseFrom​(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AutomatedAgentReply parseFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException
        Throws:
        IOException

      • newBuilderForType

        public AutomatedAgentReply.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public AutomatedAgentReply.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected AutomatedAgentReply.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<AutomatedAgentReply> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public AutomatedAgentReply getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder