Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ResponseMessage

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

Response messages from an automated agent.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1ResponseMessage

Returns a new instance of GoogleCloudDialogflowV2beta1ResponseMessage.



13729
13730
13731
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 13729

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

Instance Attribute Details

#end_interactionGoogle::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction

Indicates that interaction with the Dialogflow agent has ended. Corresponds to the JSON property endInteraction



13700
13701
13702
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 13700

def end_interaction
  @end_interaction
end

#live_agent_handoffGoogle::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff

Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. Corresponds to the JSON property liveAgentHandoff



13711
13712
13713
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 13711

def live_agent_handoff
  @live_agent_handoff
end

#payloadHash<String,Object>

Returns a response containing a custom, platform-specific payload. Corresponds to the JSON property payload

Returns:

  • (Hash<String,Object>)


13716
13717
13718
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 13716

def payload
  @payload
end

#telephony_transfer_callGoogle::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall

Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. Corresponds to the JSON property telephonyTransferCall



13722
13723
13724
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 13722

def telephony_transfer_call
  @telephony_transfer_call
end

#textGoogle::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ResponseMessageText

The text response message. Corresponds to the JSON property text



13727
13728
13729
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 13727

def text
  @text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



13734
13735
13736
13737
13738
13739
13740
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 13734

def update!(**args)
  @end_interaction = args[:end_interaction] if args.key?(:end_interaction)
  @live_agent_handoff = args[:live_agent_handoff] if args.key?(:live_agent_handoff)
  @payload = args[:payload] if args.key?(:payload)
  @telephony_transfer_call = args[:telephony_transfer_call] if args.key?(:telephony_transfer_call)
  @text = args[:text] if args.key?(:text)
end