Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::ResponseMessage (v0.20.0)

Version 0.20.0

• 1.1.1 (latest)
• 1.1.0
• 1.0.0
• 0.26.0
• 0.25.0
• 0.24.2
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.1
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.2
• 0.9.0
• 0.8.1
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::ResponseMessage.

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.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#channel

def channel() -> ::String

Returns

• (::String) — The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.

#channel=

def channel=(value) -> ::String

Parameter

• value (::String) — The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.

Returns

• (::String) — The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.

#conversation_success

def conversation_success() -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::ConversationSuccess

Returns

• (::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::ConversationSuccess) — Indicates that the conversation succeeded.

#conversation_success=

def conversation_success=(value) -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::ConversationSuccess

Parameter

• value (::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::ConversationSuccess) — Indicates that the conversation succeeded.

Returns

• (::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::ConversationSuccess) — Indicates that the conversation succeeded.

#end_interaction

def end_interaction() -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::EndInteraction

Returns

• (::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::EndInteraction) — Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches END_SESSION page. It is not supposed to be defined by the user.

  It's guaranteed that there is at most one such message in each response.

#live_agent_handoff

def live_agent_handoff() -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::LiveAgentHandoff

Returns

• (::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::LiveAgentHandoff) — Hands off conversation to a human agent.

#live_agent_handoff=

def live_agent_handoff=(value) -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::LiveAgentHandoff

Parameter

• value (::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::LiveAgentHandoff) — Hands off conversation to a human agent.

Returns

• (::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::LiveAgentHandoff) — Hands off conversation to a human agent.

#mixed_audio

def mixed_audio() -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::MixedAudio

Returns

• (::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::MixedAudio) — Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.

#output_audio_text

def output_audio_text() -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::OutputAudioText

Returns

• (::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::OutputAudioText) — A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.

#output_audio_text=

def output_audio_text=(value) -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::OutputAudioText

Parameter

• value (::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::OutputAudioText) — A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.

Returns

• (::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::OutputAudioText) — A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.

#payload

def payload() -> ::Google::Protobuf::Struct

Returns

• (::Google::Protobuf::Struct) — Returns a response containing a custom, platform-specific payload.

#payload=

def payload=(value) -> ::Google::Protobuf::Struct

Parameter

• value (::Google::Protobuf::Struct) — Returns a response containing a custom, platform-specific payload.

Returns

• (::Google::Protobuf::Struct) — Returns a response containing a custom, platform-specific payload.

#play_audio

def play_audio() -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::PlayAudio

Returns

• (::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::PlayAudio) — Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.

#play_audio=

def play_audio=(value) -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::PlayAudio

Parameter

• value (::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::PlayAudio) — Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.

Returns

• (::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::PlayAudio) — Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.

#response_type

def response_type() -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::ResponseType

Returns

• (::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::ResponseType) — Response type.

#response_type=

def response_type=(value) -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::ResponseType

Parameter

• value (::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::ResponseType) — Response type.

Returns

• (::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::ResponseType) — Response type.

#telephony_transfer_call

def telephony_transfer_call() -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::TelephonyTransferCall

Returns

• (::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::TelephonyTransferCall) — A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.

#telephony_transfer_call=

def telephony_transfer_call=(value) -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::TelephonyTransferCall

Parameter

• value (::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::TelephonyTransferCall) — A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.

Returns

• (::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::TelephonyTransferCall) — A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.

#text

def text() -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::Text

Returns

• (::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::Text) — Returns a text response.

#text=

def text=(value) -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::Text

Parameter

• value (::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::Text) — Returns a text response.

Returns

• (::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::Text) — Returns a text response.