Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::ResponseMessage (v1.20.0)

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

Response messages from an automated agent.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#end_interaction

def end_interaction() -> ::Google::Cloud::Dialogflow::V2::ResponseMessage::EndInteraction
Returns
  • (::Google::Cloud::Dialogflow::V2::ResponseMessage::EndInteraction) — A signal that indicates the interaction with the Dialogflow agent has ended.

    Note: The following fields are mutually exclusive: end_interaction, text, payload, live_agent_handoff, mixed_audio, telephony_transfer_call. If a field in that set is populated, all other fields in the set will automatically be cleared.

#end_interaction=

def end_interaction=(value) -> ::Google::Cloud::Dialogflow::V2::ResponseMessage::EndInteraction
Parameter
  • value (::Google::Cloud::Dialogflow::V2::ResponseMessage::EndInteraction) — A signal that indicates the interaction with the Dialogflow agent has ended.

    Note: The following fields are mutually exclusive: end_interaction, text, payload, live_agent_handoff, mixed_audio, telephony_transfer_call. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Dialogflow::V2::ResponseMessage::EndInteraction) — A signal that indicates the interaction with the Dialogflow agent has ended.

    Note: The following fields are mutually exclusive: end_interaction, text, payload, live_agent_handoff, mixed_audio, telephony_transfer_call. If a field in that set is populated, all other fields in the set will automatically be cleared.

#live_agent_handoff

def live_agent_handoff() -> ::Google::Cloud::Dialogflow::V2::ResponseMessage::LiveAgentHandoff
Returns
  • (::Google::Cloud::Dialogflow::V2::ResponseMessage::LiveAgentHandoff) — Hands off conversation to a live agent.

    Note: The following fields are mutually exclusive: live_agent_handoff, text, payload, end_interaction, mixed_audio, telephony_transfer_call. If a field in that set is populated, all other fields in the set will automatically be cleared.

#live_agent_handoff=

def live_agent_handoff=(value) -> ::Google::Cloud::Dialogflow::V2::ResponseMessage::LiveAgentHandoff
Parameter
  • value (::Google::Cloud::Dialogflow::V2::ResponseMessage::LiveAgentHandoff) — Hands off conversation to a live agent.

    Note: The following fields are mutually exclusive: live_agent_handoff, text, payload, end_interaction, mixed_audio, telephony_transfer_call. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Dialogflow::V2::ResponseMessage::LiveAgentHandoff) — Hands off conversation to a live agent.

    Note: The following fields are mutually exclusive: live_agent_handoff, text, payload, end_interaction, mixed_audio, telephony_transfer_call. If a field in that set is populated, all other fields in the set will automatically be cleared.

#mixed_audio

def mixed_audio() -> ::Google::Cloud::Dialogflow::V2::ResponseMessage::MixedAudio
Returns
  • (::Google::Cloud::Dialogflow::V2::ResponseMessage::MixedAudio) — An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client.

    Note: The following fields are mutually exclusive: mixed_audio, text, payload, live_agent_handoff, end_interaction, telephony_transfer_call. If a field in that set is populated, all other fields in the set will automatically be cleared.

#mixed_audio=

def mixed_audio=(value) -> ::Google::Cloud::Dialogflow::V2::ResponseMessage::MixedAudio
Parameter
  • value (::Google::Cloud::Dialogflow::V2::ResponseMessage::MixedAudio) — An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client.

    Note: The following fields are mutually exclusive: mixed_audio, text, payload, live_agent_handoff, end_interaction, telephony_transfer_call. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Dialogflow::V2::ResponseMessage::MixedAudio) — An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client.

    Note: The following fields are mutually exclusive: mixed_audio, text, payload, live_agent_handoff, end_interaction, telephony_transfer_call. If a field in that set is populated, all other fields in the set will automatically be cleared.

#payload

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

    Note: The following fields are mutually exclusive: payload, text, live_agent_handoff, end_interaction, mixed_audio, telephony_transfer_call. If a field in that set is populated, all other fields in the set will automatically be cleared.

#payload=

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

    Note: The following fields are mutually exclusive: payload, text, live_agent_handoff, end_interaction, mixed_audio, telephony_transfer_call. If a field in that set is populated, all other fields in the set will automatically be cleared.

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

    Note: The following fields are mutually exclusive: payload, text, live_agent_handoff, end_interaction, mixed_audio, telephony_transfer_call. If a field in that set is populated, all other fields in the set will automatically be cleared.

#telephony_transfer_call

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

    Note: The following fields are mutually exclusive: telephony_transfer_call, text, payload, live_agent_handoff, end_interaction, mixed_audio. If a field in that set is populated, all other fields in the set will automatically be cleared.

#telephony_transfer_call=

def telephony_transfer_call=(value) -> ::Google::Cloud::Dialogflow::V2::ResponseMessage::TelephonyTransferCall
Parameter
  • value (::Google::Cloud::Dialogflow::V2::ResponseMessage::TelephonyTransferCall) — A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.

    Note: The following fields are mutually exclusive: telephony_transfer_call, text, payload, live_agent_handoff, end_interaction, mixed_audio. If a field in that set is populated, all other fields in the set will automatically be cleared.

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

    Note: The following fields are mutually exclusive: telephony_transfer_call, text, payload, live_agent_handoff, end_interaction, mixed_audio. If a field in that set is populated, all other fields in the set will automatically be cleared.

#text

def text() -> ::Google::Cloud::Dialogflow::V2::ResponseMessage::Text
Returns
  • (::Google::Cloud::Dialogflow::V2::ResponseMessage::Text) — Returns a text response.

    Note: The following fields are mutually exclusive: text, payload, live_agent_handoff, end_interaction, mixed_audio, telephony_transfer_call. If a field in that set is populated, all other fields in the set will automatically be cleared.

#text=

def text=(value) -> ::Google::Cloud::Dialogflow::V2::ResponseMessage::Text
Parameter
  • value (::Google::Cloud::Dialogflow::V2::ResponseMessage::Text) — Returns a text response.

    Note: The following fields are mutually exclusive: text, payload, live_agent_handoff, end_interaction, mixed_audio, telephony_transfer_call. If a field in that set is populated, all other fields in the set will automatically be cleared.

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

    Note: The following fields are mutually exclusive: text, payload, live_agent_handoff, end_interaction, mixed_audio, telephony_transfer_call. If a field in that set is populated, all other fields in the set will automatically be cleared.