Class Message (2.17.0)

Version 2.17.0

• 2.38.0 (latest)
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.2
• 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

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

Corresponds to the Response field in the Dialogflow console.

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.Intent.Message.Text Returns a text response. This field is a member of oneof_ message.
image	google.cloud.dialogflow_v2beta1.types.Intent.Message.Image Displays an image. This field is a member of oneof_ message.
quick_replies	google.cloud.dialogflow_v2beta1.types.Intent.Message.QuickReplies Displays quick replies. This field is a member of oneof_ message.
card	google.cloud.dialogflow_v2beta1.types.Intent.Message.Card Displays a card. This field is a member of oneof_ message.
payload	google.protobuf.struct_pb2.Struct A custom platform-specific response. This field is a member of oneof_ message.
simple_responses	google.cloud.dialogflow_v2beta1.types.Intent.Message.SimpleResponses Returns a voice or text-only response for Actions on Google. This field is a member of oneof_ message.
basic_card	google.cloud.dialogflow_v2beta1.types.Intent.Message.BasicCard Displays a basic card for Actions on Google. This field is a member of oneof_ message.
suggestions	google.cloud.dialogflow_v2beta1.types.Intent.Message.Suggestions Displays suggestion chips for Actions on Google. This field is a member of oneof_ message.
link_out_suggestion	google.cloud.dialogflow_v2beta1.types.Intent.Message.LinkOutSuggestion Displays a link out suggestion chip for Actions on Google. This field is a member of oneof_ message.
list_select	google.cloud.dialogflow_v2beta1.types.Intent.Message.ListSelect Displays a list card for Actions on Google. This field is a member of oneof_ message.
carousel_select	google.cloud.dialogflow_v2beta1.types.Intent.Message.CarouselSelect Displays a carousel card for Actions on Google. This field is a member of oneof_ message.
telephony_play_audio	google.cloud.dialogflow_v2beta1.types.Intent.Message.TelephonyPlayAudio Plays audio from a file in Telephony Gateway. This field is a member of oneof_ message.
telephony_synthesize_speech	google.cloud.dialogflow_v2beta1.types.Intent.Message.TelephonySynthesizeSpeech Synthesizes speech in Telephony Gateway. This field is a member of oneof_ message.
telephony_transfer_call	google.cloud.dialogflow_v2beta1.types.Intent.Message.TelephonyTransferCall Transfers the call in Telephony Gateway. This field is a member of oneof_ message.
rbm_text	google.cloud.dialogflow_v2beta1.types.Intent.Message.RbmText Rich Business Messaging (RBM) text response. RBM allows businesses to send enriched and branded versions of SMS. See https://jibe.google.com/business-messaging. This field is a member of oneof_ message.
rbm_standalone_rich_card	google.cloud.dialogflow_v2beta1.types.Intent.Message.RbmStandaloneCard Standalone Rich Business Messaging (RBM) rich card response. This field is a member of oneof_ message.
rbm_carousel_rich_card	google.cloud.dialogflow_v2beta1.types.Intent.Message.RbmCarouselCard Rich Business Messaging (RBM) carousel rich card response. This field is a member of oneof_ message.
browse_carousel_card	google.cloud.dialogflow_v2beta1.types.Intent.Message.BrowseCarouselCard Browse carousel card for Actions on Google. This field is a member of oneof_ message.
table_card	google.cloud.dialogflow_v2beta1.types.Intent.Message.TableCard Table card for Actions on Google. This field is a member of oneof_ message.
media_content	google.cloud.dialogflow_v2beta1.types.Intent.Message.MediaContent The media content card for Actions on Google. This field is a member of oneof_ message.
platform	google.cloud.dialogflow_v2beta1.types.Intent.Message.Platform Optional. The platform that this message is intended for.

Classes

BasicCard

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

The basic card message. Useful for displaying information.

BrowseCarouselCard

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

Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel

Card

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

The card response message.

CarouselSelect

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

The card for presenting a carousel of options to select from.

ColumnProperties

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

Column properties for TableCard.

Image

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

The image response message.

LinkOutSuggestion

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

The suggestion chip message that allows the user to jump out to the app or website associated with this agent.

ListSelect

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

The card for presenting a list of options to select from.

MediaContent

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

The media content card for Actions on Google.

Platform

Platform(value)

Represents different platforms that a rich message can be intended for.

QuickReplies

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

The quick replies response message.

RbmCardContent

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

Rich Business Messaging (RBM) Card content

RbmCarouselCard

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

Carousel Rich Business Messaging (RBM) rich card.

Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions.

If you want to show a single card with more control over the layout, please use RbmStandaloneCard instead.

RbmStandaloneCard

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

Standalone Rich Business Messaging (RBM) rich card.

Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions.

You can group multiple rich cards into one using RbmCarouselCard but carousel cards will give you less control over the card layout.

RbmSuggestedAction

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

Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card.

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

RbmSuggestedReply

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

Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response.

RbmSuggestion

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

Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

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

RbmText

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

Rich Business Messaging (RBM) text response with suggestions.

SelectItemInfo

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

Additional info about the select item for when it is triggered in a dialog.

SimpleResponse

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

The simple response message containing speech or text.

SimpleResponses

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

The collection of simple response candidates. This message in QueryResult.fulfillment_messages and WebhookResponse.fulfillment_messages should contain only one SimpleResponse.

Suggestion

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

The suggestion chip message that the user can tap to quickly post a reply to the conversation.

Suggestions

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

The collection of suggestions.

TableCard

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

Table card for Actions on Google.

TableCardCell

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

Cell of TableCardRow.

TableCardRow

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

Row of TableCard.

TelephonyPlayAudio

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

Plays audio from a file in Telephony Gateway.

TelephonySynthesizeSpeech

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

Synthesizes speech and plays back the synthesized audio to the caller in Telephony Gateway.

Telephony Gateway takes the synthesizer settings from DetectIntentResponse.output_audio_config which can either be set at request-level or can come from the agent-level synthesizer config.

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

TelephonyTransferCall

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

Transfers the call in Telephony Gateway.

Text

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

The text response message.