Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1ResponseMessage

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



21295
21296
21297
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 21295

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

Instance Attribute Details

#end_interaction ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction

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

Returns:



21260
21261
21262
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 21260

def end_interaction
  @end_interaction
end

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

Returns:



21271
21272
21273
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 21271

def live_agent_handoff
  @live_agent_handoff
end

#mixed_audio ⇒ Google::Apis::DialogflowV3beta1::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:



21277
21278
21279
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 21277

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


21282
21283
21284
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 21282

def payload
  @payload
end

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



21288
21289
21290
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 21288

def telephony_transfer_call
  @telephony_transfer_call
end

#text ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1ResponseMessageText

The text response message. Corresponds to the JSON property text

Returns:



21293
21294
21295
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 21293

def text
  @text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



21300
21301
21302
21303
21304
21305
21306
21307
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 21300

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