Class ResponseMessage (2.15.0)

Version 2.15.0

• 2.30.0 (latest)
• 2.29.0
• 2.28.3
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.1
• 2.23.3
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.1
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.2
• 2.14.1
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.1
• 2.8.1
• 2.7.1
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.2
• 2.0.0
• 1.1.3
• 1.0.0
• 0.8.0
• 0.7.2

ResponseMessage(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Response messages from an automated agent.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name	Description
text	google.cloud.dialogflow_v2beta1.types.ResponseMessage.Text Returns a text response. This field is a member of `oneof`_ ``message``.
payload	google.protobuf.struct_pb2.Struct Returns a response containing a custom, platform-specific payload. This field is a member of `oneof`_ ``message``.
live_agent_handoff	google.cloud.dialogflow_v2beta1.types.ResponseMessage.LiveAgentHandoff Hands off conversation to a live agent. This field is a member of `oneof`_ ``message``.
end_interaction	google.cloud.dialogflow_v2beta1.types.ResponseMessage.EndInteraction A signal that indicates the interaction with the Dialogflow agent has ended. This field is a member of `oneof`_ ``message``.
mixed_audio	google.cloud.dialogflow_v2beta1.types.ResponseMessage.MixedAudio An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. This field is a member of `oneof`_ ``message``.
telephony_transfer_call	google.cloud.dialogflow_v2beta1.types.ResponseMessage.TelephonyTransferCall A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. This field is a member of `oneof`_ ``message``.

Inheritance

builtins.object > proto.message.Message > ResponseMessage

Classes

EndInteraction

EndInteraction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Indicates that interaction with the Dialogflow agent has ended.

LiveAgentHandoff

LiveAgentHandoff(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

MixedAudio

MixedAudio(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs.

TelephonyTransferCall

TelephonyTransferCall(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Text

Text(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The text response message.