Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1ResponseMessage

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v3/classes.rb,
lib/google/apis/dialogflow_v3/representations.rb,
lib/google/apis/dialogflow_v3/representations.rb

Overview

Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3beta1ResponseMessage

Returns a new instance of GoogleCloudDialogflowCxV3beta1ResponseMessage.



8201
8202
8203
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 8201

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

Instance Attribute Details

#conversation_success ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess

Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. Corresponds to the JSON property conversationSuccess

Returns:



8147
8148
8149
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 8147

def conversation_success
  @conversation_success
end

#end_interaction ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction

Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. Corresponds to the JSON property endInteraction

Returns:



8153
8154
8155
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 8153

def end_interaction
  @end_interaction
end

#live_agent_handoff ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff

Indicates that the conversation should be handed off to a live 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 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:



8164
8165
8166
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 8164

def live_agent_handoff
  @live_agent_handoff
end

#mixed_audio ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio

Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. Corresponds to the JSON property mixedAudio

Returns:



8172
8173
8174
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 8172

def mixed_audio
  @mixed_audio
end

#output_audio_text ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText

A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. Corresponds to the JSON property outputAudioText

Returns:



8178
8179
8180
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 8178

def output_audio_text
  @output_audio_text
end

#payload ⇒ Hash<String,Object>

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

Returns:

  • (Hash<String,Object>) 


8183
8184
8185
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 8183

def payload
  @payload
end

#play_audio ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio

Specifies an audio clip to be played by the client as part of the response. Corresponds to the JSON property playAudio

Returns:



8188
8189
8190
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 8188

def play_audio
  @play_audio
end

#telephony_transfer_call ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCall

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:



8194
8195
8196
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 8194

def telephony_transfer_call
  @telephony_transfer_call
end

#text ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1ResponseMessageText

The text response message. Corresponds to the JSON property text

Returns:



8199
8200
8201
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 8199

def text
  @text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 8206

def update!(**args)
  @conversation_success = args[:conversation_success] if args.key?(:conversation_success)
  @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)
  @output_audio_text = args[:output_audio_text] if args.key?(:output_audio_text)
  @payload = args[:payload] if args.key?(:payload)
  @play_audio = args[:play_audio] if args.key?(:play_audio)
  @telephony_transfer_call = args[:telephony_transfer_call] if args.key?(:telephony_transfer_call)
  @text = args[:text] if args.key?(:text)
end