Package com.google.cloud.dialogflow.v2beta1

Class AutomatedAgentReply

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.v2beta1.AutomatedAgentReply
All Implemented Interfaces:
AutomatedAgentReplyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class AutomatedAgentReply extends com.google.protobuf.GeneratedMessage implements AutomatedAgentReplyOrBuilder
 Represents a response from an automated agent.
Protobuf type google.cloud.dialogflow.v2beta1.AutomatedAgentReply
See Also:

  • Field Details

    • DETECT_INTENT_RESPONSE_FIELD_NUMBER

      public static final int DETECT_INTENT_RESPONSE_FIELD_NUMBER
      See Also:

    • RESPONSE_MESSAGES_FIELD_NUMBER

      public static final int RESPONSE_MESSAGES_FIELD_NUMBER
      See Also:

    • INTENT_FIELD_NUMBER

      public static final int INTENT_FIELD_NUMBER
      See Also:

    • EVENT_FIELD_NUMBER

      public static final int EVENT_FIELD_NUMBER
      See Also:

    • MATCH_CONFIDENCE_FIELD_NUMBER

      public static final int MATCH_CONFIDENCE_FIELD_NUMBER
      See Also:

    • PARAMETERS_FIELD_NUMBER

      public static final int PARAMETERS_FIELD_NUMBER
      See Also:

    • CX_SESSION_PARAMETERS_FIELD_NUMBER

      public static final int CX_SESSION_PARAMETERS_FIELD_NUMBER
      See Also:

    • AUTOMATED_AGENT_REPLY_TYPE_FIELD_NUMBER

      public static final int AUTOMATED_AGENT_REPLY_TYPE_FIELD_NUMBER
      See Also:

    • ALLOW_CANCELLATION_FIELD_NUMBER

      public static final int ALLOW_CANCELLATION_FIELD_NUMBER
      See Also:

    • CX_CURRENT_PAGE_FIELD_NUMBER

      public static final int CX_CURRENT_PAGE_FIELD_NUMBER
      See Also:

    • CALL_COMPANION_AUTH_CODE_FIELD_NUMBER

      public static final int CALL_COMPANION_AUTH_CODE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getResponseCase

      public AutomatedAgentReply.ResponseCase getResponseCase()
      Specified by:
      getResponseCase in interface AutomatedAgentReplyOrBuilder

    • getMatchCase

      public AutomatedAgentReply.MatchCase getMatchCase()
      Specified by:
      getMatchCase in interface AutomatedAgentReplyOrBuilder

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

    • getDetectIntentResponseOrBuilder

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

    • getResponseMessagesList

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

    • getResponseMessagesOrBuilderList

      public List<? extends ResponseMessageOrBuilder> getResponseMessagesOrBuilderList()
       Response messages from the automated agent.
      repeated .google.cloud.dialogflow.v2beta1.ResponseMessage response_messages = 3;
      Specified by:
      getResponseMessagesOrBuilderList in interface AutomatedAgentReplyOrBuilder

    • 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

    • getResponseMessages

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

    • getResponseMessagesOrBuilder

      public ResponseMessageOrBuilder getResponseMessagesOrBuilder(int index)
       Response messages from the automated agent.
      repeated .google.cloud.dialogflow.v2beta1.ResponseMessage response_messages = 3;
      Specified by:
      getResponseMessagesOrBuilder 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.

    • getEvent

      public String getEvent()
       Event name if an event is triggered for the query.
      string event = 5;
      Specified by:
      getEvent in interface AutomatedAgentReplyOrBuilder
      Returns:
      The event.

    • 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=584
       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=584
       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.

    • getAutomatedAgentReplyType

      public AutomatedAgentReply.AutomatedAgentReplyType getAutomatedAgentReplyType()
       AutomatedAgentReply type.
      .google.cloud.dialogflow.v2beta1.AutomatedAgentReply.AutomatedAgentReplyType automated_agent_reply_type = 7;
      Specified by:
      getAutomatedAgentReplyType in interface AutomatedAgentReplyOrBuilder
      Returns:
      The 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.

    • getCallCompanionAuthCode

      public com.google.protobuf.ByteString getCallCompanionAuthCode()
       The auth code for accessing Call Companion UI.
      bytes call_companion_auth_code = 12;
      Specified by:
      getCallCompanionAuthCode in interface AutomatedAgentReplyOrBuilder
      Returns:
      The callCompanionAuthCode.

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static AutomatedAgentReply parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AutomatedAgentReply parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • 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

    • newBuilder

      public static AutomatedAgentReply.Builder newBuilder()

    • newBuilder

      public static AutomatedAgentReply.Builder newBuilder(AutomatedAgentReply prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static AutomatedAgentReply getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<AutomatedAgentReply> parser()

    • 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.GeneratedMessage

    • getDefaultInstanceForType

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