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.



11315
11316
11317
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 11315

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) 


11259
11260
11261
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 11259

def allow_cancellation
  @allow_cancellation
end

#automated_agent_reply_type ⇒ String

AutomatedAgentReply type. Corresponds to the JSON property automatedAgentReplyType

Returns:

  • (String) 


11265
11266
11267
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 11265

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) 


11271
11272
11273
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 11271

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


11277
11278
11279
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 11277

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:



11282
11283
11284
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 11282

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) 


11287
11288
11289
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 11287

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) 


11294
11295
11296
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 11294

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) 


11303
11304
11305
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 11303

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


11308
11309
11310
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 11308

def parameters
  @parameters
end

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

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

Returns:



11313
11314
11315
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 11313

def response_messages
  @response_messages
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 11320

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