Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1ResponseMessage

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v2/classes.rb,
lib/google/apis/dialogflow_v2/representations.rb,
lib/google/apis/dialogflow_v2/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.



23221
23222
23223
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 23221

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

Instance Attribute Details

#end_interaction ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction

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

Returns:



23186
23187
23188
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 23186

def end_interaction
  @end_interaction
end

#live_agent_handoff ⇒ Google::Apis::DialogflowV2::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 Dialogflow 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

Returns:



23197
23198
23199
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 23197

def live_agent_handoff
  @live_agent_handoff
end

#mixed_audio ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio

Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. Corresponds to the JSON property mixedAudio

Returns:



23203
23204
23205
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 23203

def mixed_audio
  @mixed_audio
end

#payload ⇒ Hash<String,Object>

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

Returns:

  • (Hash<String,Object>) 


23208
23209
23210
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 23208

def payload
  @payload
end

#telephony_transfer_call ⇒ Google::Apis::DialogflowV2::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

Returns:



23214
23215
23216
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 23214

def telephony_transfer_call
  @telephony_transfer_call
end

#text ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1ResponseMessageText

The text response message. Corresponds to the JSON property text

Returns:



23219
23220
23221
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 23219

def text
  @text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



23226
23227
23228
23229
23230
23231
23232
23233
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 23226

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)
  @mixed_audio = args[:mixed_audio] if args.key?(:mixed_audio)
  @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