Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::AutomatedAgentReply (v1.20.0)

Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::AutomatedAgentReply.

Represents a response from an automated agent.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#allow_cancellation

def allow_cancellation() -> ::Boolean
Returns
  • (::Boolean) — 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.

#allow_cancellation=

def allow_cancellation=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.

#automated_agent_reply_type

def automated_agent_reply_type() -> ::Google::Cloud::Dialogflow::V2::AutomatedAgentReply::AutomatedAgentReplyType
Returns

#automated_agent_reply_type=

def automated_agent_reply_type=(value) -> ::Google::Cloud::Dialogflow::V2::AutomatedAgentReply::AutomatedAgentReplyType
Parameter
Returns

#call_companion_auth_code

def call_companion_auth_code() -> ::String
Returns
  • (::String) — The auth code for accessing Call Companion UI.

#call_companion_auth_code=

def call_companion_auth_code=(value) -> ::String
Parameter
  • value (::String) — The auth code for accessing Call Companion UI.
Returns
  • (::String) — The auth code for accessing Call Companion UI.

#cx_current_page

def cx_current_page() -> ::String
Returns
  • (::String) — 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>.

#cx_current_page=

def cx_current_page=(value) -> ::String
Parameter
  • value (::String) — 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>.
Returns
  • (::String) — 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>.

#detect_intent_response

def detect_intent_response() -> ::Google::Cloud::Dialogflow::V2::DetectIntentResponse
Returns

#detect_intent_response=

def detect_intent_response=(value) -> ::Google::Cloud::Dialogflow::V2::DetectIntentResponse
Parameter
Returns

#event

def event() -> ::String
Returns
  • (::String) — Event name if an event is triggered for the query.

#event=

def event=(value) -> ::String
Parameter
  • value (::String) — Event name if an event is triggered for the query.
Returns
  • (::String) — Event name if an event is triggered for the query.

#intent

def intent() -> ::String
Returns
  • (::String) — 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>.

#intent=

def intent=(value) -> ::String
Parameter
  • value (::String) — 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>.
Returns
  • (::String) — 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>.

#match_confidence

def match_confidence() -> ::Float
Returns
  • (::Float) — 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.

#match_confidence=

def match_confidence=(value) -> ::Float
Parameter
  • value (::Float) — 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.
Returns
  • (::Float) — 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.

#parameters

def parameters() -> ::Google::Protobuf::Struct
Returns

#parameters=

def parameters=(value) -> ::Google::Protobuf::Struct
Parameter
Returns

#response_messages

def response_messages() -> ::Array<::Google::Cloud::Dialogflow::V2::ResponseMessage>
Returns

#response_messages=

def response_messages=(value) -> ::Array<::Google::Cloud::Dialogflow::V2::ResponseMessage>
Parameter
Returns