Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AutomatedAgentReply

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v2beta1/classes.rb,
lib/google/apis/dialogflow_v2beta1/representations.rb,
lib/google/apis/dialogflow_v2beta1/representations.rb

Overview

Represents a response from an automated agent.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1AutomatedAgentReply

Returns a new instance of GoogleCloudDialogflowV2beta1AutomatedAgentReply.



13154
13155
13156
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 13154

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#allow_cancellation ⇒ Boolean Also known as: allow_cancellation?

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. Corresponds to the JSON property allowCancellation

Returns:

  • (Boolean) 


13092
13093
13094
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 13092

def allow_cancellation
  @allow_cancellation
end

#automated_agent_reply_type ⇒ String

AutomatedAgentReply type. Corresponds to the JSON property automatedAgentReplyType

Returns:

  • (String) 


13098
13099
13100
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 13098

def automated_agent_reply_type
  @automated_agent_reply_type
end

#call_companion_auth_code ⇒ String

The auth code for accessing Call Companion UI. Corresponds to the JSON property callCompanionAuthCode NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


13104
13105
13106
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 13104

def call_companion_auth_code
  @call_companion_auth_code
end

#cx_current_page ⇒ String

The unique identifier of the current Dialogflow CX conversation page. Format: projects//locations//agents//flows//pages/. Corresponds to the JSON property cxCurrentPage

Returns:

  • (String) 


13110
13111
13112
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 13110

def cx_current_page
  @cx_current_page
end

#cx_session_parameters ⇒ Hash<String,Object>

The collection of current Dialogflow CX agent session parameters at the time of this response. Deprecated: Use parameters instead. Corresponds to the JSON property cxSessionParameters

Returns:

  • (Hash<String,Object>) 


13116
13117
13118
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 13116

def cx_session_parameters
  @cx_session_parameters
end

#detect_intent_response ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentResponse

The message returned from the DetectIntent method. Corresponds to the JSON property detectIntentResponse

Returns:



13121
13122
13123
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 13121

def detect_intent_response
  @detect_intent_response
end

#event ⇒ String

Event name if an event is triggered for the query. Corresponds to the JSON property event

Returns:

  • (String) 


13126
13127
13128
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 13126

def event
  @event
end

#intent ⇒ String

Name of the intent if an intent is matched for the query. For a V2 query, the value format is projects//locations/ /agent/intents/. For a V3 query, the value format is projects//locations/ /agents//intents/. Corresponds to the JSON property intent

Returns:

  • (String) 


13133
13134
13135
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 13133

def intent
  @intent
end

#match_confidence ⇒ 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. Corresponds to the JSON property matchConfidence

Returns:

  • (Float) 


13142
13143
13144
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 13142

def match_confidence
  @match_confidence
end

#parameters ⇒ Hash<String,Object>

The collection of current parameters at the time of this response. Corresponds to the JSON property parameters

Returns:

  • (Hash<String,Object>) 


13147
13148
13149
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 13147

def parameters
  @parameters
end

#response_messages ⇒ Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ResponseMessage>

Response messages from the automated agent. Corresponds to the JSON property responseMessages

Returns:



13152
13153
13154
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 13152

def response_messages
  @response_messages
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



13159
13160
13161
13162
13163
13164
13165
13166
13167
13168
13169
13170
13171
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 13159

def update!(**args)
  @allow_cancellation = args[:allow_cancellation] if args.key?(:allow_cancellation)
  @automated_agent_reply_type = args[:automated_agent_reply_type] if args.key?(:automated_agent_reply_type)
  @call_companion_auth_code = args[:call_companion_auth_code] if args.key?(:call_companion_auth_code)
  @cx_current_page = args[:cx_current_page] if args.key?(:cx_current_page)
  @cx_session_parameters = args[:cx_session_parameters] if args.key?(:cx_session_parameters)
  @detect_intent_response = args[:detect_intent_response] if args.key?(:detect_intent_response)
  @event = args[:event] if args.key?(:event)
  @intent = args[:intent] if args.key?(:intent)
  @match_confidence = args[:match_confidence] if args.key?(:match_confidence)
  @parameters = args[:parameters] if args.key?(:parameters)
  @response_messages = args[:response_messages] if args.key?(:response_messages)
end