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.



14975
14976
14977
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 14975

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



14940
14941
14942
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 14940

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



14951
14952
14953
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 14951

def live_agent_handoff
  @live_agent_handoff
end

#mixed_audioGoogle::Apis::DialogflowV2beta1::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



14957
14958
14959
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 14957

def mixed_audio
  @mixed_audio
end

#payloadHash<String,Object>

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

Returns:

  • (Hash<String,Object>)


14962
14963
14964
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 14962

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



14968
14969
14970
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 14968

def telephony_transfer_call
  @telephony_transfer_call
end

#textGoogle::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ResponseMessageText

The text response message. Corresponds to the JSON property text



14973
14974
14975
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 14973

def text
  @text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



14980
14981
14982
14983
14984
14985
14986
14987
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 14980

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