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.



11176
11177
11178
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 11176

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) 


11120
11121
11122
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 11120

def allow_cancellation
  @allow_cancellation
end

#automated_agent_reply_type ⇒ String

AutomatedAgentReply type. Corresponds to the JSON property automatedAgentReplyType

Returns:

  • (String) 


11126
11127
11128
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 11126

def automated_agent_reply_type
  @automated_agent_reply_type
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) 


11132
11133
11134
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 11132

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>) 


11138
11139
11140
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 11138

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:



11143
11144
11145
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 11143

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) 


11148
11149
11150
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 11148

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) 


11155
11156
11157
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 11155

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) 


11164
11165
11166
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 11164

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>) 


11169
11170
11171
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 11169

def parameters
  @parameters
end

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

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

Returns:



11174
11175
11176
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 11174

def response_messages
  @response_messages
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11181
11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 11181

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)
  @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