Class Message (2.5.0)

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

Corresponds to the Response field in the Dialogflow console. .. attribute:: text

Returns a text response.

:type: google.cloud.dialogflow_v2beta1.types.Intent.Message.Text

Attributes

NameDescription
image google.cloud.dialogflow_v2beta1.types.Intent.Message.Image
Displays an image.
quick_replies google.cloud.dialogflow_v2beta1.types.Intent.Message.QuickReplies
Displays quick replies.
card google.cloud.dialogflow_v2beta1.types.Intent.Message.Card
Displays a card.
payload google.protobuf.struct_pb2.Struct
A custom platform-specific response.
simple_responses google.cloud.dialogflow_v2beta1.types.Intent.Message.SimpleResponses
Returns a voice or text-only response for Actions on Google.
basic_card google.cloud.dialogflow_v2beta1.types.Intent.Message.BasicCard
Displays a basic card for Actions on Google.
suggestions google.cloud.dialogflow_v2beta1.types.Intent.Message.Suggestions
Displays suggestion chips for Actions on Google.
link_out_suggestion google.cloud.dialogflow_v2beta1.types.Intent.Message.LinkOutSuggestion
Displays a link out suggestion chip for Actions on Google.
list_select google.cloud.dialogflow_v2beta1.types.Intent.Message.ListSelect
Displays a list card for Actions on Google.
carousel_select google.cloud.dialogflow_v2beta1.types.Intent.Message.CarouselSelect
Displays a carousel card for Actions on Google.
telephony_play_audio google.cloud.dialogflow_v2beta1.types.Intent.Message.TelephonyPlayAudio
Plays audio from a file in Telephony Gateway.
telephony_synthesize_speech google.cloud.dialogflow_v2beta1.types.Intent.Message.TelephonySynthesizeSpeech
Synthesizes speech in Telephony Gateway.
telephony_transfer_call google.cloud.dialogflow_v2beta1.types.Intent.Message.TelephonyTransferCall
Transfers the call in Telephony Gateway.
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.
rbm_standalone_rich_card google.cloud.dialogflow_v2beta1.types.Intent.Message.RbmStandaloneCard
Standalone Rich Business Messaging (RBM) rich card response.
rbm_carousel_rich_card google.cloud.dialogflow_v2beta1.types.Intent.Message.RbmCarouselCard
Rich Business Messaging (RBM) carousel rich card response.
browse_carousel_card google.cloud.dialogflow_v2beta1.types.Intent.Message.BrowseCarouselCard
Browse carousel card for Actions on Google.
table_card google.cloud.dialogflow_v2beta1.types.Intent.Message.TableCard
Table card for Actions on Google.
media_content google.cloud.dialogflow_v2beta1.types.Intent.Message.MediaContent
The media content card for Actions on Google.
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. .. attribute:: title

Optional. The title of the card.

:type: str

BrowseCarouselCard

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

Card

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

The card response message. .. attribute:: title

Optional. The title of the card.

:type: str

CarouselSelect

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

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

Required. Carousel items.

:type: Sequence[google.cloud.dialogflow_v2beta1.types.Intent.Message.CarouselSelect.Item]

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. .. attribute:: image_uri

Optional. The public URI to an image file.

:type: str

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. .. attribute:: title

Optional. The overall title of the list.

:type: str

MediaContent

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

The media content card for Actions on Google. .. attribute:: media_type

Optional. What type of media is the content (ie "audio").

:type: google.cloud.dialogflow_v2beta1.types.Intent.Message.MediaContent.ResponseMediaType

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. .. attribute:: title

Optional. The title of the collection of quick replies.

:type: str

RbmCardContent

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

Rich Business Messaging (RBM) Card content .. attribute:: title

Optional. Title of the card (at most 200 bytes). At least one of the title, description or media must be set.

:type: str

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.

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).

RbmText

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

Rich Business Messaging (RBM) text response with suggestions. .. attribute:: text

Required. Text sent and displayed to the user.

:type: str

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. .. attribute:: text_to_speech

One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml.

:type: str

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. .. attribute:: suggestions

Required. The list of suggested replies.

:type: Sequence[google.cloud.dialogflow_v2beta1.types.Intent.Message.Suggestion]

TableCard

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

Table card for Actions on Google. .. attribute:: title

Required. Title of the card.

:type: str

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. .. attribute:: audio_uri

Required. URI to a Google Cloud Storage object containing the audio to play, e.g., "gs://bucket/object". The object must contain a single channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

This object must be readable by the service-<Project Number>@gcp-sa-dialogflow.iam.gserviceaccount.com service account where is the number of the Telephony Gateway project (usually the same as the Dialogflow agent project). If the Google Cloud Storage bucket is in the Telephony Gateway project, this permission is added by default when enabling the Dialogflow V2 API.

For audio from other sources, consider using the TelephonySynthesizeSpeech message with SSML.

:type: str

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.

TelephonyTransferCall

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

Transfers the call in Telephony Gateway. .. attribute:: phone_number

Required. The phone number to transfer the call to in E.164 format <https://en.wikipedia.org/wiki/E.164>__.

We currently only allow transferring to US numbers (+1xxxyyyzzzz).

:type: str

Text

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

The text response message. .. attribute:: text

Optional. The collection of the agent's responses.

:type: Sequence[str]