batchDelete(parent=None, body=None, x__xgafv=None)
Deletes intents in the specified agent.
batchUpdate(parent=None, body=None, x__xgafv=None)
Updates/Creates multiple intents in the specified agent.
create(parent=None, body=None, languageCode=None, intentView=None, x__xgafv=None)
Creates an intent in the specified agent.
delete(name=None, x__xgafv=None)
Deletes the specified intent and its direct or indirect followup intents.
get(name=None, languageCode=None, intentView=None, x__xgafv=None)
Retrieves the specified intent.
list(parent=None, pageSize=None, languageCode=None, intentView=None, pageToken=None, x__xgafv=None)
Returns the list of all intents in the specified agent.
list_next(previous_request=*, previous_response=*)
Retrieves the next page of results.
patch(name=None, body=None, languageCode=None, intentView=None, updateMask=None, x__xgafv=None)
Updates the specified intent.
batchDelete(parent=None, body=None, x__xgafv=None)
Deletes intents in the specified agent.
Operation <response: google.protobuf.Empty>
Args:
parent: string, Required. The name of the agent to delete all entities types for. Format:
`projects/<Project ID>/agent`. (required)
body: object, The request body.
The object takes the form of:
{ # The request message for Intents.BatchDeleteIntents.
"intents": [ # Required. The collection of intents to delete. Only intent `name` must be
# filled in.
{ # Represents an intent.
# Intents convert a number of user expressions or patterns into an action. An
# action is an extraction of a user command or sentence semantics.
"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
# Note: If `ml_disabled` setting is set to true, then this intent is not
# taken into account during inference in `ML ONLY` match mode. Also,
# auto-markup in the UI is turned off.
"displayName": "A String", # Required. The name of this intent.
"name": "A String", # The unique identifier of this intent.
# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
# methods.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
# whether the intent cannot be completed without collecting the parameter
# value.
"name": "A String", # The unique identifier of this parameter.
"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
# result.
# Default values can be extracted from contexts by using the following
# syntax: `#context_name.parameter_name`.
"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
# describes values of the parameter. If the parameter is
# required, this must be provided.
"value": "A String", # Optional. The definition of the parameter value. It can be:
# - a constant string,
# - a parameter value defined as `$parameter_name`,
# - an original parameter value defined as `$parameter_name.original`,
# - a parameter value from some context defined as
# `#context_name.parameter_name`.
"prompts": [ # Optional. The collection of prompts that the agent can present to the
# user in order to collect a value for the parameter.
"A String",
],
"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
"displayName": "A String", # Required. The name of the parameter.
},
],
"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
# (e.g., Actions on Google or Dialogflow phone gateway) use this information
# to close interaction with an end user. Default is false.
"followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
# a direct or indirect parent. We populate this field only in the output.
{ # Represents a single followup intent in the chain.
"followupIntentName": "A String", # The unique identifier of the followup intent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
},
],
"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
"parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
# chain of followup intents. You can set this field when creating an intent,
# for example with CreateIntent or
# BatchUpdateIntents, in order to make this
# intent a followup intent.
#
# It identifies the parent followup intent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"messages": [ # Optional. The collection of rich messages corresponding to the
# `Response` field in the Dialogflow console.
{ # Corresponds to the `Response` field in the Dialogflow console.
"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
# This message in `QueryResult.fulfillment_messages` and
# `WebhookResponse.fulfillment_messages` should contain only one
# `SimpleResponse`.
"simpleResponses": [ # Required. The list of simple responses.
{ # The simple response message containing speech or text.
"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
# response to the user in the SSML format. Mutually exclusive with
# text_to_speech.
"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
# speech output. Mutually exclusive with ssml.
"displayText": "A String", # Optional. The text to display.
},
],
},
"quickReplies": { # The quick replies response message. # Displays quick replies.
"quickReplies": [ # Optional. The collection of quick replies.
"A String",
],
"title": "A String", # Optional. The title of the collection of quick replies.
},
"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.
# or website associated with this agent.
"uri": "A String", # Required. The URI of the app or site to open when the user taps the
# suggestion chip.
"destinationName": "A String", # Required. The name of the app or site this chip is linking to.
},
"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
"items": [ # Required. List items.
{ # An item in the list.
"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
# dialog.
"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
# item in dialog.
"A String",
],
"key": "A String", # Required. A unique key that will be sent back to the agent if this
# response is given.
},
"image": { # The image response message. # Optional. The image to display.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"description": "A String", # Optional. The main text describing the item.
"title": "A String", # Required. The title of the list item.
},
],
"subtitle": "A String", # Optional. Subtitle of the list.
"title": "A String", # Optional. The overall title of the list.
},
"text": { # The text response message. # Returns a text response.
"text": [ # Optional. The collection of the agent's responses.
"A String",
],
},
"image": { # The image response message. # Displays an image.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
#
# RBM allows businesses to send enriched and branded versions of SMS. See
# https://jibe.google.com/business-messaging.
"text": "A String", # Required. Text sent and displayed to the user.
"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
# (https://goo.gl/6GLJD2). If the user has an app installed that is
# registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI.
"uri": "A String", # Required. The uri to open on the user device
},
"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
# to send back to the agent (https://goo.gl/GXotJW).
},
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
# but does not dial automatically (https://goo.gl/ergbB2).
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
# +15556767888.
},
"text": "A String", # Text to display alongside the action.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
# instead of typing in their own response.
"text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
},
],
},
"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
# For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead.
"cardContents": [ # Required. The cards in the carousel. A carousel must have at least
# 2 cards and at most 10.
{ # Rich Business Messaging (RBM) Card content
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
#
# ## Image Types
#
# image/jpeg
# image/jpg'
# image/gif
# image/png
#
# ## Video Types
#
# video/h263
# video/m4v
# video/mp4
# video/mpeg
# video/mpeg4
# video/webm
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
# provide a thumbnail URI, the RBM platform displays a blank
# placeholder thumbnail until the user's device downloads the file.
# Depending on the user's setting, the file may not download
# automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
},
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
# (https://goo.gl/6GLJD2). If the user has an app installed that is
# registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI.
"uri": "A String", # Required. The uri to open on the user device
},
"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
# to send back to the agent (https://goo.gl/GXotJW).
},
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
# but does not dial automatically (https://goo.gl/ergbB2).
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
# +15556767888.
},
"text": "A String", # Text to display alongside the action.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
# instead of typing in their own response.
"text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
},
],
"description": "A String", # Optional. Description of the card (at most 2000 bytes).
#
# At least one of the title, description or media must be set.
"title": "A String", # Optional. Title of the card (at most 200 bytes).
#
# At least one of the title, description or media must be set.
},
],
"cardWidth": "A String", # Required. The width of the cards in the carousel.
},
"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
"audioUri": "A String", # 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 <Project Number> 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.
},
"payload": { # Returns a response containing a custom, platform-specific payload.
# See the Intent.Message.Platform type for a description of the
# structure that may be required for your platform.
"a_key": "", # Properties of the object.
},
"platform": "A String", # Optional. The platform that this message is intended for.
"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
# 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.
"ssml": "A String", # The SSML to be synthesized. For more information, see
# [SSML](https://developers.google.com/actions/reference/ssml).
"text": "A String", # The raw text to be synthesized.
},
"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
"buttons": [ # Optional. The collection of card buttons.
{ # The button object that appears at the bottom of a card.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
"title": "A String", # Required. The title of the button.
},
],
"subtitle": "A String", # Optional. The subtitle of the card.
"image": { # The image response message. # Optional. The image for the card.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"formattedText": "A String", # Required, unless image is present. The body text of the card.
"title": "A String", # Optional. The title of the card.
},
"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
"mediaObjects": [ # Required. List of media objects.
{ # Response media object for media content card.
"contentUrl": "A String", # Required. Url where the media is stored.
"description": "A String", # Optional. Description of media card.
"name": "A String", # Required. Name of media card.
"largeImage": { # The image response message. # Optional. Image to display above media content.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"icon": { # The image response message. # Optional. Icon to display above media content.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
},
],
"mediaType": "A String", # Optional. What type of media is the content (ie "audio").
},
"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
"items": [ # Required. Carousel items.
{ # An item in the carousel.
"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
# dialog.
"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
# item in dialog.
"A String",
],
"key": "A String", # Required. A unique key that will be sent back to the agent if this
# response is given.
},
"image": { # The image response message. # Optional. The image to display.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"description": "A String", # Optional. The body text of the card.
"title": "A String", # Required. Title of the carousel item.
},
],
},
"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
# https://developers.google.com/actions/assistant/responses#browsing_carousel
"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
# items, maximum of ten.
{ # Browsing carousel tile
"image": { # The image response message. # Optional. Hero image for the carousel item.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
# Card. Maximum of one line of text.
"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
# text.
"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
"url": "A String", # Required. URL
"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
# the URL. Defaults to opening via web browser.
},
"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
},
],
"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
# items.
},
"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
"suggestions": [ # Required. The list of suggested replies.
{ # The suggestion chip message that the user can tap to quickly post a reply
# to the conversation.
"title": "A String", # Required. The text shown the in the suggestion chip.
},
],
},
"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
"phoneNumber": "A String", # 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).
},
"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
# For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout.
"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
# Image preview alignment for standalone cards with horizontal layout.
"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
#
# ## Image Types
#
# image/jpeg
# image/jpg'
# image/gif
# image/png
#
# ## Video Types
#
# video/h263
# video/m4v
# video/mp4
# video/mpeg
# video/mpeg4
# video/webm
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
# provide a thumbnail URI, the RBM platform displays a blank
# placeholder thumbnail until the user's device downloads the file.
# Depending on the user's setting, the file may not download
# automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
},
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
# (https://goo.gl/6GLJD2). If the user has an app installed that is
# registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI.
"uri": "A String", # Required. The uri to open on the user device
},
"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
# to send back to the agent (https://goo.gl/GXotJW).
},
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
# but does not dial automatically (https://goo.gl/ergbB2).
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
# +15556767888.
},
"text": "A String", # Text to display alongside the action.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
# instead of typing in their own response.
"text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
},
],
"description": "A String", # Optional. Description of the card (at most 2000 bytes).
#
# At least one of the title, description or media must be set.
"title": "A String", # Optional. Title of the card (at most 200 bytes).
#
# At least one of the title, description or media must be set.
},
"cardOrientation": "A String", # Required. Orientation of the card.
},
"card": { # The card response message. # Displays a card.
"buttons": [ # Optional. The collection of card buttons.
{ # Optional. Contains information about a button.
"text": "A String", # Optional. The text to show on the button.
"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
# open.
},
],
"imageUri": "A String", # Optional. The public URI to an image file for the card.
"subtitle": "A String", # Optional. The subtitle of the card.
"title": "A String", # Optional. The title of the card.
},
"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
"rows": [ # Optional. Rows in this table of data.
{ # Row of TableCard.
"cells": [ # Optional. List of cells that make up this row.
{ # Cell of TableCardRow.
"text": "A String", # Required. Text in this cell.
},
],
"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
},
],
"subtitle": "A String", # Optional. Subtitle to the title.
"title": "A String", # Required. Title of the card.
"image": { # The image response message. # Optional. Image which should be displayed on the card.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"columnProperties": [ # Optional. Display properties for the columns in this table.
{ # Column properties for TableCard.
"header": "A String", # Required. Column heading.
"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
},
],
"buttons": [ # Optional. List of buttons for the card.
{ # The button object that appears at the bottom of a card.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
"title": "A String", # Required. The title of the button.
},
],
},
},
],
"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
# session when this intent is matched.
"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
"A String",
],
"priority": 42, # The priority of this intent. Higher numbers represent higher
# priorities.
#
# - If the supplied value is unspecified or 0, the service
# translates the value to 500,000, which corresponds to the
# `Normal` priority in the console.
# - If the supplied value is negative, the intent is ignored
# in runtime detect intent requests.
"rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
# followup intents. It identifies the correct followup intents chain for
# this intent. We populate this field only in the output.
#
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"trainingPhrases": [ # Optional. The collection of examples that the agent is
# trained on.
{ # Represents an example that the agent is trained on.
"parts": [ # Required. The ordered list of training phrase parts.
# The parts are concatenated in order to form the training phrase.
#
# Note: The API does not automatically annotate training phrases like the
# Dialogflow Console does.
#
# Note: Do not forget to include whitespace at part boundaries,
# so the training phrase is well formatted when the parts are concatenated.
#
# If the training phrase does not need to be annotated with parameters,
# you just need a single part with only the Part.text field set.
#
# If you want to annotate the training phrase, you must create multiple
# parts, where the fields of each part are populated in one of two ways:
#
# - `Part.text` is set to a part of the phrase that has no parameters.
# - `Part.text` is set to a part of the phrase that you want to annotate,
# and the `entity_type`, `alias`, and `user_defined` fields are all
# set.
{ # Represents a part of a training phrase.
"alias": "A String", # Optional. The parameter name for the value extracted from the
# annotated part of the example.
# This field is required for annotated parts of the training phrase.
"entityType": "A String", # Optional. The entity type name prefixed with `@`.
# This field is required for annotated parts of the training phrase.
"text": "A String", # Required. The text for this part.
"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
# This field is set to true when the Dialogflow Console is used to
# manually annotate the part. When creating an annotated part with the
# API, you must set this to true.
},
],
"type": "A String", # Required. The type of the training phrase.
"name": "A String", # Output only. The unique identifier of this training phrase.
"timesAddedCount": 42, # Optional. Indicates how many times this example was added to
# the intent. Each time a developer adds an existing sample by editing an
# intent or training, this counter is increased.
},
],
"inputContextNames": [ # Optional. The list of context names required for this intent to be
# triggered.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
"A String",
],
"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
# Note: If `ml_enabled` setting is set to false, then this intent is not
# taken into account during inference in `ML ONLY` match mode. Also,
# auto-markup in the UI is turned off.
# DEPRECATED! Please use `ml_disabled` field instead.
# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
# then the default value is determined as follows:
# - Before April 15th, 2018 the default is:
# ml_enabled = false / ml_disabled = true.
# - After April 15th, 2018 the default is:
# ml_enabled = true / ml_disabled = false.
"action": "A String", # Optional. The name of the action associated with the intent.
# Note: The action name must not contain whitespaces.
"outputContexts": [ # Optional. The collection of contexts that are activated when the intent
# is matched. Context messages in this collection should not set the
# parameters field. Setting the `lifespan_count` to 0 will reset the context
# when the intent is matched.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
{ # Represents a context.
"parameters": { # Optional. The collection of parameters associated with this context.
# Refer to [this
# doc](https://cloud.google.com/dialogflow/docs/intents-actions-parameters)
# for syntax.
"a_key": "", # Properties of the object.
},
"name": "A String", # Required. The unique identifier of the context. Format:
# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,
# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
# ID>/sessions/<Session ID>/contexts/<Context ID>`.
#
# The `Context ID` is always converted to lowercase, may only contain
# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
#
# If `Environment ID` is not specified, we assume default 'draft'
# environment. If `User ID` is not specified, we assume default '-' user.
#
# The following context names are reserved for internal use by Dialogflow.
# You should not use these contexts or create contexts with these names:
#
# * `__system_counters__`
# * `*_id_dialog_context`
# * `*_dialog_params_size`
"lifespanCount": 42, # Optional. The number of conversational query requests after which the
# context expires. If set to `0` (the default) the context expires
# immediately. Contexts expire automatically after 20 minutes if there
# are no matching queries.
},
],
"events": [ # Optional. The collection of event names that trigger the intent.
# If the collection of input contexts is not empty, all of the contexts must
# be present in the active user session for an event to trigger this intent.
# Event names are limited to 50 characters.
"A String",
],
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a
# network API call.
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
# long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
# three pieces of data: error code, error message, and error details.
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"done": True or False, # If the value is `false`, it means the operation is still in progress.
# If `true`, the operation is completed, and either `error` or `response` is
# available.
"response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
# `Get`/`Create`/`Update`, the response should be the resource. For other
# methods, the response should have the type `XxxResponse`, where `Xxx`
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should be a resource name ending with `operations/{unique_id}`.
}
batchUpdate(parent=None, body=None, x__xgafv=None)
Updates/Creates multiple intents in the specified agent.
Operation <response: BatchUpdateIntentsResponse>
Args:
parent: string, Required. The name of the agent to update or create intents in.
Format: `projects/<Project ID>/agent`. (required)
body: object, The request body.
The object takes the form of:
{ # The request message for Intents.BatchUpdateIntents.
"languageCode": "A String", # Optional. The language of training phrases, parameters and rich messages
# defined in `intents`. If not specified, the agent's default language is
# used. [Many
# languages](https://cloud.google.com/dialogflow/docs/reference/language)
# are supported. Note: languages must be enabled in the agent before they can
# be used.
"intentBatchUri": "A String", # The URI to a Google Cloud Storage file containing intents to update or
# create. The file format can either be a serialized proto (of IntentBatch
# type) or JSON object. Note: The URI must start with "gs://".
"intentBatchInline": { # This message is a wrapper around a collection of intents. # The collection of intents to update or create.
"intents": [ # A collection of intents.
{ # Represents an intent.
# Intents convert a number of user expressions or patterns into an action. An
# action is an extraction of a user command or sentence semantics.
"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
# Note: If `ml_disabled` setting is set to true, then this intent is not
# taken into account during inference in `ML ONLY` match mode. Also,
# auto-markup in the UI is turned off.
"displayName": "A String", # Required. The name of this intent.
"name": "A String", # The unique identifier of this intent.
# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
# methods.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
# whether the intent cannot be completed without collecting the parameter
# value.
"name": "A String", # The unique identifier of this parameter.
"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
# result.
# Default values can be extracted from contexts by using the following
# syntax: `#context_name.parameter_name`.
"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
# describes values of the parameter. If the parameter is
# required, this must be provided.
"value": "A String", # Optional. The definition of the parameter value. It can be:
# - a constant string,
# - a parameter value defined as `$parameter_name`,
# - an original parameter value defined as `$parameter_name.original`,
# - a parameter value from some context defined as
# `#context_name.parameter_name`.
"prompts": [ # Optional. The collection of prompts that the agent can present to the
# user in order to collect a value for the parameter.
"A String",
],
"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
"displayName": "A String", # Required. The name of the parameter.
},
],
"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
# (e.g., Actions on Google or Dialogflow phone gateway) use this information
# to close interaction with an end user. Default is false.
"followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
# a direct or indirect parent. We populate this field only in the output.
{ # Represents a single followup intent in the chain.
"followupIntentName": "A String", # The unique identifier of the followup intent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
},
],
"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
"parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
# chain of followup intents. You can set this field when creating an intent,
# for example with CreateIntent or
# BatchUpdateIntents, in order to make this
# intent a followup intent.
#
# It identifies the parent followup intent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"messages": [ # Optional. The collection of rich messages corresponding to the
# `Response` field in the Dialogflow console.
{ # Corresponds to the `Response` field in the Dialogflow console.
"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
# This message in `QueryResult.fulfillment_messages` and
# `WebhookResponse.fulfillment_messages` should contain only one
# `SimpleResponse`.
"simpleResponses": [ # Required. The list of simple responses.
{ # The simple response message containing speech or text.
"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
# response to the user in the SSML format. Mutually exclusive with
# text_to_speech.
"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
# speech output. Mutually exclusive with ssml.
"displayText": "A String", # Optional. The text to display.
},
],
},
"quickReplies": { # The quick replies response message. # Displays quick replies.
"quickReplies": [ # Optional. The collection of quick replies.
"A String",
],
"title": "A String", # Optional. The title of the collection of quick replies.
},
"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.
# or website associated with this agent.
"uri": "A String", # Required. The URI of the app or site to open when the user taps the
# suggestion chip.
"destinationName": "A String", # Required. The name of the app or site this chip is linking to.
},
"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
"items": [ # Required. List items.
{ # An item in the list.
"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
# dialog.
"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
# item in dialog.
"A String",
],
"key": "A String", # Required. A unique key that will be sent back to the agent if this
# response is given.
},
"image": { # The image response message. # Optional. The image to display.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"description": "A String", # Optional. The main text describing the item.
"title": "A String", # Required. The title of the list item.
},
],
"subtitle": "A String", # Optional. Subtitle of the list.
"title": "A String", # Optional. The overall title of the list.
},
"text": { # The text response message. # Returns a text response.
"text": [ # Optional. The collection of the agent's responses.
"A String",
],
},
"image": { # The image response message. # Displays an image.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
#
# RBM allows businesses to send enriched and branded versions of SMS. See
# https://jibe.google.com/business-messaging.
"text": "A String", # Required. Text sent and displayed to the user.
"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
# (https://goo.gl/6GLJD2). If the user has an app installed that is
# registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI.
"uri": "A String", # Required. The uri to open on the user device
},
"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
# to send back to the agent (https://goo.gl/GXotJW).
},
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
# but does not dial automatically (https://goo.gl/ergbB2).
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
# +15556767888.
},
"text": "A String", # Text to display alongside the action.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
# instead of typing in their own response.
"text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
},
],
},
"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
# For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead.
"cardContents": [ # Required. The cards in the carousel. A carousel must have at least
# 2 cards and at most 10.
{ # Rich Business Messaging (RBM) Card content
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
#
# ## Image Types
#
# image/jpeg
# image/jpg'
# image/gif
# image/png
#
# ## Video Types
#
# video/h263
# video/m4v
# video/mp4
# video/mpeg
# video/mpeg4
# video/webm
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
# provide a thumbnail URI, the RBM platform displays a blank
# placeholder thumbnail until the user's device downloads the file.
# Depending on the user's setting, the file may not download
# automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
},
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
# (https://goo.gl/6GLJD2). If the user has an app installed that is
# registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI.
"uri": "A String", # Required. The uri to open on the user device
},
"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
# to send back to the agent (https://goo.gl/GXotJW).
},
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
# but does not dial automatically (https://goo.gl/ergbB2).
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
# +15556767888.
},
"text": "A String", # Text to display alongside the action.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
# instead of typing in their own response.
"text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
},
],
"description": "A String", # Optional. Description of the card (at most 2000 bytes).
#
# At least one of the title, description or media must be set.
"title": "A String", # Optional. Title of the card (at most 200 bytes).
#
# At least one of the title, description or media must be set.
},
],
"cardWidth": "A String", # Required. The width of the cards in the carousel.
},
"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
"audioUri": "A String", # 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 <Project Number> 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.
},
"payload": { # Returns a response containing a custom, platform-specific payload.
# See the Intent.Message.Platform type for a description of the
# structure that may be required for your platform.
"a_key": "", # Properties of the object.
},
"platform": "A String", # Optional. The platform that this message is intended for.
"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
# 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.
"ssml": "A String", # The SSML to be synthesized. For more information, see
# [SSML](https://developers.google.com/actions/reference/ssml).
"text": "A String", # The raw text to be synthesized.
},
"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
"buttons": [ # Optional. The collection of card buttons.
{ # The button object that appears at the bottom of a card.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
"title": "A String", # Required. The title of the button.
},
],
"subtitle": "A String", # Optional. The subtitle of the card.
"image": { # The image response message. # Optional. The image for the card.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"formattedText": "A String", # Required, unless image is present. The body text of the card.
"title": "A String", # Optional. The title of the card.
},
"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
"mediaObjects": [ # Required. List of media objects.
{ # Response media object for media content card.
"contentUrl": "A String", # Required. Url where the media is stored.
"description": "A String", # Optional. Description of media card.
"name": "A String", # Required. Name of media card.
"largeImage": { # The image response message. # Optional. Image to display above media content.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"icon": { # The image response message. # Optional. Icon to display above media content.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
},
],
"mediaType": "A String", # Optional. What type of media is the content (ie "audio").
},
"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
"items": [ # Required. Carousel items.
{ # An item in the carousel.
"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
# dialog.
"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
# item in dialog.
"A String",
],
"key": "A String", # Required. A unique key that will be sent back to the agent if this
# response is given.
},
"image": { # The image response message. # Optional. The image to display.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"description": "A String", # Optional. The body text of the card.
"title": "A String", # Required. Title of the carousel item.
},
],
},
"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
# https://developers.google.com/actions/assistant/responses#browsing_carousel
"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
# items, maximum of ten.
{ # Browsing carousel tile
"image": { # The image response message. # Optional. Hero image for the carousel item.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
# Card. Maximum of one line of text.
"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
# text.
"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
"url": "A String", # Required. URL
"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
# the URL. Defaults to opening via web browser.
},
"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
},
],
"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
# items.
},
"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
"suggestions": [ # Required. The list of suggested replies.
{ # The suggestion chip message that the user can tap to quickly post a reply
# to the conversation.
"title": "A String", # Required. The text shown the in the suggestion chip.
},
],
},
"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
"phoneNumber": "A String", # 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).
},
"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
# For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout.
"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
# Image preview alignment for standalone cards with horizontal layout.
"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
#
# ## Image Types
#
# image/jpeg
# image/jpg'
# image/gif
# image/png
#
# ## Video Types
#
# video/h263
# video/m4v
# video/mp4
# video/mpeg
# video/mpeg4
# video/webm
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
# provide a thumbnail URI, the RBM platform displays a blank
# placeholder thumbnail until the user's device downloads the file.
# Depending on the user's setting, the file may not download
# automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
},
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
# (https://goo.gl/6GLJD2). If the user has an app installed that is
# registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI.
"uri": "A String", # Required. The uri to open on the user device
},
"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
# to send back to the agent (https://goo.gl/GXotJW).
},
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
# but does not dial automatically (https://goo.gl/ergbB2).
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
# +15556767888.
},
"text": "A String", # Text to display alongside the action.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
# instead of typing in their own response.
"text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
},
],
"description": "A String", # Optional. Description of the card (at most 2000 bytes).
#
# At least one of the title, description or media must be set.
"title": "A String", # Optional. Title of the card (at most 200 bytes).
#
# At least one of the title, description or media must be set.
},
"cardOrientation": "A String", # Required. Orientation of the card.
},
"card": { # The card response message. # Displays a card.
"buttons": [ # Optional. The collection of card buttons.
{ # Optional. Contains information about a button.
"text": "A String", # Optional. The text to show on the button.
"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
# open.
},
],
"imageUri": "A String", # Optional. The public URI to an image file for the card.
"subtitle": "A String", # Optional. The subtitle of the card.
"title": "A String", # Optional. The title of the card.
},
"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
"rows": [ # Optional. Rows in this table of data.
{ # Row of TableCard.
"cells": [ # Optional. List of cells that make up this row.
{ # Cell of TableCardRow.
"text": "A String", # Required. Text in this cell.
},
],
"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
},
],
"subtitle": "A String", # Optional. Subtitle to the title.
"title": "A String", # Required. Title of the card.
"image": { # The image response message. # Optional. Image which should be displayed on the card.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"columnProperties": [ # Optional. Display properties for the columns in this table.
{ # Column properties for TableCard.
"header": "A String", # Required. Column heading.
"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
},
],
"buttons": [ # Optional. List of buttons for the card.
{ # The button object that appears at the bottom of a card.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
"title": "A String", # Required. The title of the button.
},
],
},
},
],
"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
# session when this intent is matched.
"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
"A String",
],
"priority": 42, # The priority of this intent. Higher numbers represent higher
# priorities.
#
# - If the supplied value is unspecified or 0, the service
# translates the value to 500,000, which corresponds to the
# `Normal` priority in the console.
# - If the supplied value is negative, the intent is ignored
# in runtime detect intent requests.
"rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
# followup intents. It identifies the correct followup intents chain for
# this intent. We populate this field only in the output.
#
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"trainingPhrases": [ # Optional. The collection of examples that the agent is
# trained on.
{ # Represents an example that the agent is trained on.
"parts": [ # Required. The ordered list of training phrase parts.
# The parts are concatenated in order to form the training phrase.
#
# Note: The API does not automatically annotate training phrases like the
# Dialogflow Console does.
#
# Note: Do not forget to include whitespace at part boundaries,
# so the training phrase is well formatted when the parts are concatenated.
#
# If the training phrase does not need to be annotated with parameters,
# you just need a single part with only the Part.text field set.
#
# If you want to annotate the training phrase, you must create multiple
# parts, where the fields of each part are populated in one of two ways:
#
# - `Part.text` is set to a part of the phrase that has no parameters.
# - `Part.text` is set to a part of the phrase that you want to annotate,
# and the `entity_type`, `alias`, and `user_defined` fields are all
# set.
{ # Represents a part of a training phrase.
"alias": "A String", # Optional. The parameter name for the value extracted from the
# annotated part of the example.
# This field is required for annotated parts of the training phrase.
"entityType": "A String", # Optional. The entity type name prefixed with `@`.
# This field is required for annotated parts of the training phrase.
"text": "A String", # Required. The text for this part.
"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
# This field is set to true when the Dialogflow Console is used to
# manually annotate the part. When creating an annotated part with the
# API, you must set this to true.
},
],
"type": "A String", # Required. The type of the training phrase.
"name": "A String", # Output only. The unique identifier of this training phrase.
"timesAddedCount": 42, # Optional. Indicates how many times this example was added to
# the intent. Each time a developer adds an existing sample by editing an
# intent or training, this counter is increased.
},
],
"inputContextNames": [ # Optional. The list of context names required for this intent to be
# triggered.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
"A String",
],
"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
# Note: If `ml_enabled` setting is set to false, then this intent is not
# taken into account during inference in `ML ONLY` match mode. Also,
# auto-markup in the UI is turned off.
# DEPRECATED! Please use `ml_disabled` field instead.
# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
# then the default value is determined as follows:
# - Before April 15th, 2018 the default is:
# ml_enabled = false / ml_disabled = true.
# - After April 15th, 2018 the default is:
# ml_enabled = true / ml_disabled = false.
"action": "A String", # Optional. The name of the action associated with the intent.
# Note: The action name must not contain whitespaces.
"outputContexts": [ # Optional. The collection of contexts that are activated when the intent
# is matched. Context messages in this collection should not set the
# parameters field. Setting the `lifespan_count` to 0 will reset the context
# when the intent is matched.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
{ # Represents a context.
"parameters": { # Optional. The collection of parameters associated with this context.
# Refer to [this
# doc](https://cloud.google.com/dialogflow/docs/intents-actions-parameters)
# for syntax.
"a_key": "", # Properties of the object.
},
"name": "A String", # Required. The unique identifier of the context. Format:
# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,
# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
# ID>/sessions/<Session ID>/contexts/<Context ID>`.
#
# The `Context ID` is always converted to lowercase, may only contain
# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
#
# If `Environment ID` is not specified, we assume default 'draft'
# environment. If `User ID` is not specified, we assume default '-' user.
#
# The following context names are reserved for internal use by Dialogflow.
# You should not use these contexts or create contexts with these names:
#
# * `__system_counters__`
# * `*_id_dialog_context`
# * `*_dialog_params_size`
"lifespanCount": 42, # Optional. The number of conversational query requests after which the
# context expires. If set to `0` (the default) the context expires
# immediately. Contexts expire automatically after 20 minutes if there
# are no matching queries.
},
],
"events": [ # Optional. The collection of event names that trigger the intent.
# If the collection of input contexts is not empty, all of the contexts must
# be present in the active user session for an event to trigger this intent.
# Event names are limited to 50 characters.
"A String",
],
},
],
},
"updateMask": "A String", # Optional. The mask to control which fields get updated.
"intentView": "A String", # Optional. The resource view to apply to the returned intent.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a
# network API call.
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
# long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
# three pieces of data: error code, error message, and error details.
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"done": True or False, # If the value is `false`, it means the operation is still in progress.
# If `true`, the operation is completed, and either `error` or `response` is
# available.
"response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
# `Get`/`Create`/`Update`, the response should be the resource. For other
# methods, the response should have the type `XxxResponse`, where `Xxx`
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should be a resource name ending with `operations/{unique_id}`.
}
create(parent=None, body=None, languageCode=None, intentView=None, x__xgafv=None)
Creates an intent in the specified agent.
Args:
parent: string, Required. The agent to create a intent for.
Format: `projects/<Project ID>/agent`. (required)
body: object, The request body.
The object takes the form of:
{ # Represents an intent.
# Intents convert a number of user expressions or patterns into an action. An
# action is an extraction of a user command or sentence semantics.
"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
# Note: If `ml_disabled` setting is set to true, then this intent is not
# taken into account during inference in `ML ONLY` match mode. Also,
# auto-markup in the UI is turned off.
"displayName": "A String", # Required. The name of this intent.
"name": "A String", # The unique identifier of this intent.
# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
# methods.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
# whether the intent cannot be completed without collecting the parameter
# value.
"name": "A String", # The unique identifier of this parameter.
"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
# result.
# Default values can be extracted from contexts by using the following
# syntax: `#context_name.parameter_name`.
"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
# describes values of the parameter. If the parameter is
# required, this must be provided.
"value": "A String", # Optional. The definition of the parameter value. It can be:
# - a constant string,
# - a parameter value defined as `$parameter_name`,
# - an original parameter value defined as `$parameter_name.original`,
# - a parameter value from some context defined as
# `#context_name.parameter_name`.
"prompts": [ # Optional. The collection of prompts that the agent can present to the
# user in order to collect a value for the parameter.
"A String",
],
"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
"displayName": "A String", # Required. The name of the parameter.
},
],
"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
# (e.g., Actions on Google or Dialogflow phone gateway) use this information
# to close interaction with an end user. Default is false.
"followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
# a direct or indirect parent. We populate this field only in the output.
{ # Represents a single followup intent in the chain.
"followupIntentName": "A String", # The unique identifier of the followup intent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
},
],
"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
"parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
# chain of followup intents. You can set this field when creating an intent,
# for example with CreateIntent or
# BatchUpdateIntents, in order to make this
# intent a followup intent.
#
# It identifies the parent followup intent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"messages": [ # Optional. The collection of rich messages corresponding to the
# `Response` field in the Dialogflow console.
{ # Corresponds to the `Response` field in the Dialogflow console.
"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
# This message in `QueryResult.fulfillment_messages` and
# `WebhookResponse.fulfillment_messages` should contain only one
# `SimpleResponse`.
"simpleResponses": [ # Required. The list of simple responses.
{ # The simple response message containing speech or text.
"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
# response to the user in the SSML format. Mutually exclusive with
# text_to_speech.
"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
# speech output. Mutually exclusive with ssml.
"displayText": "A String", # Optional. The text to display.
},
],
},
"quickReplies": { # The quick replies response message. # Displays quick replies.
"quickReplies": [ # Optional. The collection of quick replies.
"A String",
],
"title": "A String", # Optional. The title of the collection of quick replies.
},
"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.
# or website associated with this agent.
"uri": "A String", # Required. The URI of the app or site to open when the user taps the
# suggestion chip.
"destinationName": "A String", # Required. The name of the app or site this chip is linking to.
},
"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
"items": [ # Required. List items.
{ # An item in the list.
"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
# dialog.
"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
# item in dialog.
"A String",
],
"key": "A String", # Required. A unique key that will be sent back to the agent if this
# response is given.
},
"image": { # The image response message. # Optional. The image to display.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"description": "A String", # Optional. The main text describing the item.
"title": "A String", # Required. The title of the list item.
},
],
"subtitle": "A String", # Optional. Subtitle of the list.
"title": "A String", # Optional. The overall title of the list.
},
"text": { # The text response message. # Returns a text response.
"text": [ # Optional. The collection of the agent's responses.
"A String",
],
},
"image": { # The image response message. # Displays an image.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
#
# RBM allows businesses to send enriched and branded versions of SMS. See
# https://jibe.google.com/business-messaging.
"text": "A String", # Required. Text sent and displayed to the user.
"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
# (https://goo.gl/6GLJD2). If the user has an app installed that is
# registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI.
"uri": "A String", # Required. The uri to open on the user device
},
"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
# to send back to the agent (https://goo.gl/GXotJW).
},
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
# but does not dial automatically (https://goo.gl/ergbB2).
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
# +15556767888.
},
"text": "A String", # Text to display alongside the action.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
# instead of typing in their own response.
"text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
},
],
},
"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
# For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead.
"cardContents": [ # Required. The cards in the carousel. A carousel must have at least
# 2 cards and at most 10.
{ # Rich Business Messaging (RBM) Card content
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
#
# ## Image Types
#
# image/jpeg
# image/jpg'
# image/gif
# image/png
#
# ## Video Types
#
# video/h263
# video/m4v
# video/mp4
# video/mpeg
# video/mpeg4
# video/webm
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
# provide a thumbnail URI, the RBM platform displays a blank
# placeholder thumbnail until the user's device downloads the file.
# Depending on the user's setting, the file may not download
# automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
},
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
# (https://goo.gl/6GLJD2). If the user has an app installed that is
# registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI.
"uri": "A String", # Required. The uri to open on the user device
},
"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
# to send back to the agent (https://goo.gl/GXotJW).
},
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
# but does not dial automatically (https://goo.gl/ergbB2).
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
# +15556767888.
},
"text": "A String", # Text to display alongside the action.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
# instead of typing in their own response.
"text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
},
],
"description": "A String", # Optional. Description of the card (at most 2000 bytes).
#
# At least one of the title, description or media must be set.
"title": "A String", # Optional. Title of the card (at most 200 bytes).
#
# At least one of the title, description or media must be set.
},
],
"cardWidth": "A String", # Required. The width of the cards in the carousel.
},
"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
"audioUri": "A String", # 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 <Project Number> 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.
},
"payload": { # Returns a response containing a custom, platform-specific payload.
# See the Intent.Message.Platform type for a description of the
# structure that may be required for your platform.
"a_key": "", # Properties of the object.
},
"platform": "A String", # Optional. The platform that this message is intended for.
"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
# 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.
"ssml": "A String", # The SSML to be synthesized. For more information, see
# [SSML](https://developers.google.com/actions/reference/ssml).
"text": "A String", # The raw text to be synthesized.
},
"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
"buttons": [ # Optional. The collection of card buttons.
{ # The button object that appears at the bottom of a card.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
"title": "A String", # Required. The title of the button.
},
],
"subtitle": "A String", # Optional. The subtitle of the card.
"image": { # The image response message. # Optional. The image for the card.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"formattedText": "A String", # Required, unless image is present. The body text of the card.
"title": "A String", # Optional. The title of the card.
},
"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
"mediaObjects": [ # Required. List of media objects.
{ # Response media object for media content card.
"contentUrl": "A String", # Required. Url where the media is stored.
"description": "A String", # Optional. Description of media card.
"name": "A String", # Required. Name of media card.
"largeImage": { # The image response message. # Optional. Image to display above media content.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"icon": { # The image response message. # Optional. Icon to display above media content.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
},
],
"mediaType": "A String", # Optional. What type of media is the content (ie "audio").
},
"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
"items": [ # Required. Carousel items.
{ # An item in the carousel.
"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
# dialog.
"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
# item in dialog.
"A String",
],
"key": "A String", # Required. A unique key that will be sent back to the agent if this
# response is given.
},
"image": { # The image response message. # Optional. The image to display.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"description": "A String", # Optional. The body text of the card.
"title": "A String", # Required. Title of the carousel item.
},
],
},
"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
# https://developers.google.com/actions/assistant/responses#browsing_carousel
"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
# items, maximum of ten.
{ # Browsing carousel tile
"image": { # The image response message. # Optional. Hero image for the carousel item.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
# Card. Maximum of one line of text.
"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
# text.
"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
"url": "A String", # Required. URL
"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
# the URL. Defaults to opening via web browser.
},
"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
},
],
"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
# items.
},
"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
"suggestions": [ # Required. The list of suggested replies.
{ # The suggestion chip message that the user can tap to quickly post a reply
# to the conversation.
"title": "A String", # Required. The text shown the in the suggestion chip.
},
],
},
"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
"phoneNumber": "A String", # 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).
},
"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
# For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout.
"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
# Image preview alignment for standalone cards with horizontal layout.
"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
#
# ## Image Types
#
# image/jpeg
# image/jpg'
# image/gif
# image/png
#
# ## Video Types
#
# video/h263
# video/m4v
# video/mp4
# video/mpeg
# video/mpeg4
# video/webm
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
# provide a thumbnail URI, the RBM platform displays a blank
# placeholder thumbnail until the user's device downloads the file.
# Depending on the user's setting, the file may not download
# automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
},
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
# (https://goo.gl/6GLJD2). If the user has an app installed that is
# registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI.
"uri": "A String", # Required. The uri to open on the user device
},
"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
# to send back to the agent (https://goo.gl/GXotJW).
},
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
# but does not dial automatically (https://goo.gl/ergbB2).
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
# +15556767888.
},
"text": "A String", # Text to display alongside the action.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
# instead of typing in their own response.
"text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
},
],
"description": "A String", # Optional. Description of the card (at most 2000 bytes).
#
# At least one of the title, description or media must be set.
"title": "A String", # Optional. Title of the card (at most 200 bytes).
#
# At least one of the title, description or media must be set.
},
"cardOrientation": "A String", # Required. Orientation of the card.
},
"card": { # The card response message. # Displays a card.
"buttons": [ # Optional. The collection of card buttons.
{ # Optional. Contains information about a button.
"text": "A String", # Optional. The text to show on the button.
"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
# open.
},
],
"imageUri": "A String", # Optional. The public URI to an image file for the card.
"subtitle": "A String", # Optional. The subtitle of the card.
"title": "A String", # Optional. The title of the card.
},
"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
"rows": [ # Optional. Rows in this table of data.
{ # Row of TableCard.
"cells": [ # Optional. List of cells that make up this row.
{ # Cell of TableCardRow.
"text": "A String", # Required. Text in this cell.
},
],
"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
},
],
"subtitle": "A String", # Optional. Subtitle to the title.
"title": "A String", # Required. Title of the card.
"image": { # The image response message. # Optional. Image which should be displayed on the card.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"columnProperties": [ # Optional. Display properties for the columns in this table.
{ # Column properties for TableCard.
"header": "A String", # Required. Column heading.
"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
},
],
"buttons": [ # Optional. List of buttons for the card.
{ # The button object that appears at the bottom of a card.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
"title": "A String", # Required. The title of the button.
},
],
},
},
],
"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
# session when this intent is matched.
"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
"A String",
],
"priority": 42, # The priority of this intent. Higher numbers represent higher
# priorities.
#
# - If the supplied value is unspecified or 0, the service
# translates the value to 500,000, which corresponds to the
# `Normal` priority in the console.
# - If the supplied value is negative, the intent is ignored
# in runtime detect intent requests.
"rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
# followup intents. It identifies the correct followup intents chain for
# this intent. We populate this field only in the output.
#
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"trainingPhrases": [ # Optional. The collection of examples that the agent is
# trained on.
{ # Represents an example that the agent is trained on.
"parts": [ # Required. The ordered list of training phrase parts.
# The parts are concatenated in order to form the training phrase.
#
# Note: The API does not automatically annotate training phrases like the
# Dialogflow Console does.
#
# Note: Do not forget to include whitespace at part boundaries,
# so the training phrase is well formatted when the parts are concatenated.
#
# If the training phrase does not need to be annotated with parameters,
# you just need a single part with only the Part.text field set.
#
# If you want to annotate the training phrase, you must create multiple
# parts, where the fields of each part are populated in one of two ways:
#
# - `Part.text` is set to a part of the phrase that has no parameters.
# - `Part.text` is set to a part of the phrase that you want to annotate,
# and the `entity_type`, `alias`, and `user_defined` fields are all
# set.
{ # Represents a part of a training phrase.
"alias": "A String", # Optional. The parameter name for the value extracted from the
# annotated part of the example.
# This field is required for annotated parts of the training phrase.
"entityType": "A String", # Optional. The entity type name prefixed with `@`.
# This field is required for annotated parts of the training phrase.
"text": "A String", # Required. The text for this part.
"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
# This field is set to true when the Dialogflow Console is used to
# manually annotate the part. When creating an annotated part with the
# API, you must set this to true.
},
],
"type": "A String", # Required. The type of the training phrase.
"name": "A String", # Output only. The unique identifier of this training phrase.
"timesAddedCount": 42, # Optional. Indicates how many times this example was added to
# the intent. Each time a developer adds an existing sample by editing an
# intent or training, this counter is increased.
},
],
"inputContextNames": [ # Optional. The list of context names required for this intent to be
# triggered.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
"A String",
],
"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
# Note: If `ml_enabled` setting is set to false, then this intent is not
# taken into account during inference in `ML ONLY` match mode. Also,
# auto-markup in the UI is turned off.
# DEPRECATED! Please use `ml_disabled` field instead.
# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
# then the default value is determined as follows:
# - Before April 15th, 2018 the default is:
# ml_enabled = false / ml_disabled = true.
# - After April 15th, 2018 the default is:
# ml_enabled = true / ml_disabled = false.
"action": "A String", # Optional. The name of the action associated with the intent.
# Note: The action name must not contain whitespaces.
"outputContexts": [ # Optional. The collection of contexts that are activated when the intent
# is matched. Context messages in this collection should not set the
# parameters field. Setting the `lifespan_count` to 0 will reset the context
# when the intent is matched.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
{ # Represents a context.
"parameters": { # Optional. The collection of parameters associated with this context.
# Refer to [this
# doc](https://cloud.google.com/dialogflow/docs/intents-actions-parameters)
# for syntax.
"a_key": "", # Properties of the object.
},
"name": "A String", # Required. The unique identifier of the context. Format:
# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,
# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
# ID>/sessions/<Session ID>/contexts/<Context ID>`.
#
# The `Context ID` is always converted to lowercase, may only contain
# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
#
# If `Environment ID` is not specified, we assume default 'draft'
# environment. If `User ID` is not specified, we assume default '-' user.
#
# The following context names are reserved for internal use by Dialogflow.
# You should not use these contexts or create contexts with these names:
#
# * `__system_counters__`
# * `*_id_dialog_context`
# * `*_dialog_params_size`
"lifespanCount": 42, # Optional. The number of conversational query requests after which the
# context expires. If set to `0` (the default) the context expires
# immediately. Contexts expire automatically after 20 minutes if there
# are no matching queries.
},
],
"events": [ # Optional. The collection of event names that trigger the intent.
# If the collection of input contexts is not empty, all of the contexts must
# be present in the active user session for an event to trigger this intent.
# Event names are limited to 50 characters.
"A String",
],
}
languageCode: string, Optional. The language of training phrases, parameters and rich messages
defined in `intent`. If not specified, the agent's default language is
used. [Many
languages](https://cloud.google.com/dialogflow/docs/reference/language)
are supported. Note: languages must be enabled in the agent before they can
be used.
intentView: string, Optional. The resource view to apply to the returned intent.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents an intent.
# Intents convert a number of user expressions or patterns into an action. An
# action is an extraction of a user command or sentence semantics.
"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
# Note: If `ml_disabled` setting is set to true, then this intent is not
# taken into account during inference in `ML ONLY` match mode. Also,
# auto-markup in the UI is turned off.
"displayName": "A String", # Required. The name of this intent.
"name": "A String", # The unique identifier of this intent.
# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
# methods.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
# whether the intent cannot be completed without collecting the parameter
# value.
"name": "A String", # The unique identifier of this parameter.
"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
# result.
# Default values can be extracted from contexts by using the following
# syntax: `#context_name.parameter_name`.
"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
# describes values of the parameter. If the parameter is
# required, this must be provided.
"value": "A String", # Optional. The definition of the parameter value. It can be:
# - a constant string,
# - a parameter value defined as `$parameter_name`,
# - an original parameter value defined as `$parameter_name.original`,
# - a parameter value from some context defined as
# `#context_name.parameter_name`.
"prompts": [ # Optional. The collection of prompts that the agent can present to the
# user in order to collect a value for the parameter.
"A String",
],
"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
"displayName": "A String", # Required. The name of the parameter.
},
],
"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
# (e.g., Actions on Google or Dialogflow phone gateway) use this information
# to close interaction with an end user. Default is false.
"followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
# a direct or indirect parent. We populate this field only in the output.
{ # Represents a single followup intent in the chain.
"followupIntentName": "A String", # The unique identifier of the followup intent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
},
],
"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
"parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
# chain of followup intents. You can set this field when creating an intent,
# for example with CreateIntent or
# BatchUpdateIntents, in order to make this
# intent a followup intent.
#
# It identifies the parent followup intent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"messages": [ # Optional. The collection of rich messages corresponding to the
# `Response` field in the Dialogflow console.
{ # Corresponds to the `Response` field in the Dialogflow console.
"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
# This message in `QueryResult.fulfillment_messages` and
# `WebhookResponse.fulfillment_messages` should contain only one
# `SimpleResponse`.
"simpleResponses": [ # Required. The list of simple responses.
{ # The simple response message containing speech or text.
"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
# response to the user in the SSML format. Mutually exclusive with
# text_to_speech.
"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
# speech output. Mutually exclusive with ssml.
"displayText": "A String", # Optional. The text to display.
},
],
},
"quickReplies": { # The quick replies response message. # Displays quick replies.
"quickReplies": [ # Optional. The collection of quick replies.
"A String",
],
"title": "A String", # Optional. The title of the collection of quick replies.
},
"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.
# or website associated with this agent.
"uri": "A String", # Required. The URI of the app or site to open when the user taps the
# suggestion chip.
"destinationName": "A String", # Required. The name of the app or site this chip is linking to.
},
"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
"items": [ # Required. List items.
{ # An item in the list.
"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
# dialog.
"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
# item in dialog.
"A String",
],
"key": "A String", # Required. A unique key that will be sent back to the agent if this
# response is given.
},
"image": { # The image response message. # Optional. The image to display.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"description": "A String", # Optional. The main text describing the item.
"title": "A String", # Required. The title of the list item.
},
],
"subtitle": "A String", # Optional. Subtitle of the list.
"title": "A String", # Optional. The overall title of the list.
},
"text": { # The text response message. # Returns a text response.
"text": [ # Optional. The collection of the agent's responses.
"A String",
],
},
"image": { # The image response message. # Displays an image.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
#
# RBM allows businesses to send enriched and branded versions of SMS. See
# https://jibe.google.com/business-messaging.
"text": "A String", # Required. Text sent and displayed to the user.
"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
# (https://goo.gl/6GLJD2). If the user has an app installed that is
# registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI.
"uri": "A String", # Required. The uri to open on the user device
},
"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
# to send back to the agent (https://goo.gl/GXotJW).
},
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
# but does not dial automatically (https://goo.gl/ergbB2).
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
# +15556767888.
},
"text": "A String", # Text to display alongside the action.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
# instead of typing in their own response.
"text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
},
],
},
"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
# For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead.
"cardContents": [ # Required. The cards in the carousel. A carousel must have at least
# 2 cards and at most 10.
{ # Rich Business Messaging (RBM) Card content
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
#
# ## Image Types
#
# image/jpeg
# image/jpg'
# image/gif
# image/png
#
# ## Video Types
#
# video/h263
# video/m4v
# video/mp4
# video/mpeg
# video/mpeg4
# video/webm
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
# provide a thumbnail URI, the RBM platform displays a blank
# placeholder thumbnail until the user's device downloads the file.
# Depending on the user's setting, the file may not download
# automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
},
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
# (https://goo.gl/6GLJD2). If the user has an app installed that is
# registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI.
"uri": "A String", # Required. The uri to open on the user device
},
"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
# to send back to the agent (https://goo.gl/GXotJW).
},
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
# but does not dial automatically (https://goo.gl/ergbB2).
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
# +15556767888.
},
"text": "A String", # Text to display alongside the action.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
# instead of typing in their own response.
"text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
},
],
"description": "A String", # Optional. Description of the card (at most 2000 bytes).
#
# At least one of the title, description or media must be set.
"title": "A String", # Optional. Title of the card (at most 200 bytes).
#
# At least one of the title, description or media must be set.
},
],
"cardWidth": "A String", # Required. The width of the cards in the carousel.
},
"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
"audioUri": "A String", # 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 <Project Number> 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.
},
"payload": { # Returns a response containing a custom, platform-specific payload.
# See the Intent.Message.Platform type for a description of the
# structure that may be required for your platform.
"a_key": "", # Properties of the object.
},
"platform": "A String", # Optional. The platform that this message is intended for.
"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
# 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.
"ssml": "A String", # The SSML to be synthesized. For more information, see
# [SSML](https://developers.google.com/actions/reference/ssml).
"text": "A String", # The raw text to be synthesized.
},
"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
"buttons": [ # Optional. The collection of card buttons.
{ # The button object that appears at the bottom of a card.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
"title": "A String", # Required. The title of the button.
},
],
"subtitle": "A String", # Optional. The subtitle of the card.
"image": { # The image response message. # Optional. The image for the card.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"formattedText": "A String", # Required, unless image is present. The body text of the card.
"title": "A String", # Optional. The title of the card.
},
"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
"mediaObjects": [ # Required. List of media objects.
{ # Response media object for media content card.
"contentUrl": "A String", # Required. Url where the media is stored.
"description": "A String", # Optional. Description of media card.
"name": "A String", # Required. Name of media card.
"largeImage": { # The image response message. # Optional. Image to display above media content.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"icon": { # The image response message. # Optional. Icon to display above media content.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
},
],
"mediaType": "A String", # Optional. What type of media is the content (ie "audio").
},
"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
"items": [ # Required. Carousel items.
{ # An item in the carousel.
"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
# dialog.
"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
# item in dialog.
"A String",
],
"key": "A String", # Required. A unique key that will be sent back to the agent if this
# response is given.
},
"image": { # The image response message. # Optional. The image to display.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"description": "A String", # Optional. The body text of the card.
"title": "A String", # Required. Title of the carousel item.
},
],
},
"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
# https://developers.google.com/actions/assistant/responses#browsing_carousel
"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
# items, maximum of ten.
{ # Browsing carousel tile
"image": { # The image response message. # Optional. Hero image for the carousel item.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
# Card. Maximum of one line of text.
"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
# text.
"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
"url": "A String", # Required. URL
"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
# the URL. Defaults to opening via web browser.
},
"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
},
],
"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
# items.
},
"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
"suggestions": [ # Required. The list of suggested replies.
{ # The suggestion chip message that the user can tap to quickly post a reply
# to the conversation.
"title": "A String", # Required. The text shown the in the suggestion chip.
},
],
},
"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
"phoneNumber": "A String", # 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).
},
"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
# For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout.
"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
# Image preview alignment for standalone cards with horizontal layout.
"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
#
# ## Image Types
#
# image/jpeg
# image/jpg'
# image/gif
# image/png
#
# ## Video Types
#
# video/h263
# video/m4v
# video/mp4
# video/mpeg
# video/mpeg4
# video/webm
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
# provide a thumbnail URI, the RBM platform displays a blank
# placeholder thumbnail until the user's device downloads the file.
# Depending on the user's setting, the file may not download
# automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
},
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
# (https://goo.gl/6GLJD2). If the user has an app installed that is
# registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI.
"uri": "A String", # Required. The uri to open on the user device
},
"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
# to send back to the agent (https://goo.gl/GXotJW).
},
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
# but does not dial automatically (https://goo.gl/ergbB2).
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
# +15556767888.
},
"text": "A String", # Text to display alongside the action.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
# instead of typing in their own response.
"text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
},
],
"description": "A String", # Optional. Description of the card (at most 2000 bytes).
#
# At least one of the title, description or media must be set.
"title": "A String", # Optional. Title of the card (at most 200 bytes).
#
# At least one of the title, description or media must be set.
},
"cardOrientation": "A String", # Required. Orientation of the card.
},
"card": { # The card response message. # Displays a card.
"buttons": [ # Optional. The collection of card buttons.
{ # Optional. Contains information about a button.
"text": "A String", # Optional. The text to show on the button.
"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
# open.
},
],
"imageUri": "A String", # Optional. The public URI to an image file for the card.
"subtitle": "A String", # Optional. The subtitle of the card.
"title": "A String", # Optional. The title of the card.
},
"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
"rows": [ # Optional. Rows in this table of data.
{ # Row of TableCard.
"cells": [ # Optional. List of cells that make up this row.
{ # Cell of TableCardRow.
"text": "A String", # Required. Text in this cell.
},
],
"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
},
],
"subtitle": "A String", # Optional. Subtitle to the title.
"title": "A String", # Required. Title of the card.
"image": { # The image response message. # Optional. Image which should be displayed on the card.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"columnProperties": [ # Optional. Display properties for the columns in this table.
{ # Column properties for TableCard.
"header": "A String", # Required. Column heading.
"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
},
],
"buttons": [ # Optional. List of buttons for the card.
{ # The button object that appears at the bottom of a card.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
"title": "A String", # Required. The title of the button.
},
],
},
},
],
"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
# session when this intent is matched.
"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
"A String",
],
"priority": 42, # The priority of this intent. Higher numbers represent higher
# priorities.
#
# - If the supplied value is unspecified or 0, the service
# translates the value to 500,000, which corresponds to the
# `Normal` priority in the console.
# - If the supplied value is negative, the intent is ignored
# in runtime detect intent requests.
"rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
# followup intents. It identifies the correct followup intents chain for
# this intent. We populate this field only in the output.
#
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"trainingPhrases": [ # Optional. The collection of examples that the agent is
# trained on.
{ # Represents an example that the agent is trained on.
"parts": [ # Required. The ordered list of training phrase parts.
# The parts are concatenated in order to form the training phrase.
#
# Note: The API does not automatically annotate training phrases like the
# Dialogflow Console does.
#
# Note: Do not forget to include whitespace at part boundaries,
# so the training phrase is well formatted when the parts are concatenated.
#
# If the training phrase does not need to be annotated with parameters,
# you just need a single part with only the Part.text field set.
#
# If you want to annotate the training phrase, you must create multiple
# parts, where the fields of each part are populated in one of two ways:
#
# - `Part.text` is set to a part of the phrase that has no parameters.
# - `Part.text` is set to a part of the phrase that you want to annotate,
# and the `entity_type`, `alias`, and `user_defined` fields are all
# set.
{ # Represents a part of a training phrase.
"alias": "A String", # Optional. The parameter name for the value extracted from the
# annotated part of the example.
# This field is required for annotated parts of the training phrase.
"entityType": "A String", # Optional. The entity type name prefixed with `@`.
# This field is required for annotated parts of the training phrase.
"text": "A String", # Required. The text for this part.
"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
# This field is set to true when the Dialogflow Console is used to
# manually annotate the part. When creating an annotated part with the
# API, you must set this to true.
},
],
"type": "A String", # Required. The type of the training phrase.
"name": "A String", # Output only. The unique identifier of this training phrase.
"timesAddedCount": 42, # Optional. Indicates how many times this example was added to
# the intent. Each time a developer adds an existing sample by editing an
# intent or training, this counter is increased.
},
],
"inputContextNames": [ # Optional. The list of context names required for this intent to be
# triggered.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
"A String",
],
"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
# Note: If `ml_enabled` setting is set to false, then this intent is not
# taken into account during inference in `ML ONLY` match mode. Also,
# auto-markup in the UI is turned off.
# DEPRECATED! Please use `ml_disabled` field instead.
# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
# then the default value is determined as follows:
# - Before April 15th, 2018 the default is:
# ml_enabled = false / ml_disabled = true.
# - After April 15th, 2018 the default is:
# ml_enabled = true / ml_disabled = false.
"action": "A String", # Optional. The name of the action associated with the intent.
# Note: The action name must not contain whitespaces.
"outputContexts": [ # Optional. The collection of contexts that are activated when the intent
# is matched. Context messages in this collection should not set the
# parameters field. Setting the `lifespan_count` to 0 will reset the context
# when the intent is matched.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
{ # Represents a context.
"parameters": { # Optional. The collection of parameters associated with this context.
# Refer to [this
# doc](https://cloud.google.com/dialogflow/docs/intents-actions-parameters)
# for syntax.
"a_key": "", # Properties of the object.
},
"name": "A String", # Required. The unique identifier of the context. Format:
# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,
# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
# ID>/sessions/<Session ID>/contexts/<Context ID>`.
#
# The `Context ID` is always converted to lowercase, may only contain
# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
#
# If `Environment ID` is not specified, we assume default 'draft'
# environment. If `User ID` is not specified, we assume default '-' user.
#
# The following context names are reserved for internal use by Dialogflow.
# You should not use these contexts or create contexts with these names:
#
# * `__system_counters__`
# * `*_id_dialog_context`
# * `*_dialog_params_size`
"lifespanCount": 42, # Optional. The number of conversational query requests after which the
# context expires. If set to `0` (the default) the context expires
# immediately. Contexts expire automatically after 20 minutes if there
# are no matching queries.
},
],
"events": [ # Optional. The collection of event names that trigger the intent.
# If the collection of input contexts is not empty, all of the contexts must
# be present in the active user session for an event to trigger this intent.
# Event names are limited to 50 characters.
"A String",
],
}
delete(name=None, x__xgafv=None)
Deletes the specified intent and its direct or indirect followup intents.
Args:
name: string, Required. The name of the intent to delete. If this intent has direct or
indirect followup intents, we also delete them.
Format: `projects/<Project ID>/agent/intents/<Intent ID>`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
#
# service Foo {
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}
get(name=None, languageCode=None, intentView=None, x__xgafv=None)
Retrieves the specified intent.
Args:
name: string, Required. The name of the intent.
Format: `projects/<Project ID>/agent/intents/<Intent ID>`. (required)
languageCode: string, Optional. The language to retrieve training phrases, parameters and rich
messages for. If not specified, the agent's default language is used.
[Many
languages](https://cloud.google.com/dialogflow/docs/reference/language)
are supported. Note: languages must be enabled in the agent before they can
be used.
intentView: string, Optional. The resource view to apply to the returned intent.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents an intent.
# Intents convert a number of user expressions or patterns into an action. An
# action is an extraction of a user command or sentence semantics.
"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
# Note: If `ml_disabled` setting is set to true, then this intent is not
# taken into account during inference in `ML ONLY` match mode. Also,
# auto-markup in the UI is turned off.
"displayName": "A String", # Required. The name of this intent.
"name": "A String", # The unique identifier of this intent.
# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
# methods.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
# whether the intent cannot be completed without collecting the parameter
# value.
"name": "A String", # The unique identifier of this parameter.
"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
# result.
# Default values can be extracted from contexts by using the following
# syntax: `#context_name.parameter_name`.
"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
# describes values of the parameter. If the parameter is
# required, this must be provided.
"value": "A String", # Optional. The definition of the parameter value. It can be:
# - a constant string,
# - a parameter value defined as `$parameter_name`,
# - an original parameter value defined as `$parameter_name.original`,
# - a parameter value from some context defined as
# `#context_name.parameter_name`.
"prompts": [ # Optional. The collection of prompts that the agent can present to the
# user in order to collect a value for the parameter.
"A String",
],
"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
"displayName": "A String", # Required. The name of the parameter.
},
],
"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
# (e.g., Actions on Google or Dialogflow phone gateway) use this information
# to close interaction with an end user. Default is false.
"followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
# a direct or indirect parent. We populate this field only in the output.
{ # Represents a single followup intent in the chain.
"followupIntentName": "A String", # The unique identifier of the followup intent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
},
],
"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
"parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
# chain of followup intents. You can set this field when creating an intent,
# for example with CreateIntent or
# BatchUpdateIntents, in order to make this
# intent a followup intent.
#
# It identifies the parent followup intent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"messages": [ # Optional. The collection of rich messages corresponding to the
# `Response` field in the Dialogflow console.
{ # Corresponds to the `Response` field in the Dialogflow console.
"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
# This message in `QueryResult.fulfillment_messages` and
# `WebhookResponse.fulfillment_messages` should contain only one
# `SimpleResponse`.
"simpleResponses": [ # Required. The list of simple responses.
{ # The simple response message containing speech or text.
"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
# response to the user in the SSML format. Mutually exclusive with
# text_to_speech.
"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
# speech output. Mutually exclusive with ssml.
"displayText": "A String", # Optional. The text to display.
},
],
},
"quickReplies": { # The quick replies response message. # Displays quick replies.
"quickReplies": [ # Optional. The collection of quick replies.
"A String",
],
"title": "A String", # Optional. The title of the collection of quick replies.
},
"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.
# or website associated with this agent.
"uri": "A String", # Required. The URI of the app or site to open when the user taps the
# suggestion chip.
"destinationName": "A String", # Required. The name of the app or site this chip is linking to.
},
"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
"items": [ # Required. List items.
{ # An item in the list.
"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
# dialog.
"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
# item in dialog.
"A String",
],
"key": "A String", # Required. A unique key that will be sent back to the agent if this
# response is given.
},
"image": { # The image response message. # Optional. The image to display.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"description": "A String", # Optional. The main text describing the item.
"title": "A String", # Required. The title of the list item.
},
],
"subtitle": "A String", # Optional. Subtitle of the list.
"title": "A String", # Optional. The overall title of the list.
},
"text": { # The text response message. # Returns a text response.
"text": [ # Optional. The collection of the agent's responses.
"A String",
],
},
"image": { # The image response message. # Displays an image.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
#
# RBM allows businesses to send enriched and branded versions of SMS. See
# https://jibe.google.com/business-messaging.
"text": "A String", # Required. Text sent and displayed to the user.
"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
# (https://goo.gl/6GLJD2). If the user has an app installed that is
# registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI.
"uri": "A String", # Required. The uri to open on the user device
},
"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
# to send back to the agent (https://goo.gl/GXotJW).
},
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
# but does not dial automatically (https://goo.gl/ergbB2).
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
# +15556767888.
},
"text": "A String", # Text to display alongside the action.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
# instead of typing in their own response.
"text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
},
],
},
"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
# For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead.
"cardContents": [ # Required. The cards in the carousel. A carousel must have at least
# 2 cards and at most 10.
{ # Rich Business Messaging (RBM) Card content
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
#
# ## Image Types
#
# image/jpeg
# image/jpg'
# image/gif
# image/png
#
# ## Video Types
#
# video/h263
# video/m4v
# video/mp4
# video/mpeg
# video/mpeg4
# video/webm
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
# provide a thumbnail URI, the RBM platform displays a blank
# placeholder thumbnail until the user's device downloads the file.
# Depending on the user's setting, the file may not download
# automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
},
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
# (https://goo.gl/6GLJD2). If the user has an app installed that is
# registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI.
"uri": "A String", # Required. The uri to open on the user device
},
"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
# to send back to the agent (https://goo.gl/GXotJW).
},
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
# but does not dial automatically (https://goo.gl/ergbB2).
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
# +15556767888.
},
"text": "A String", # Text to display alongside the action.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
# instead of typing in their own response.
"text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
},
],
"description": "A String", # Optional. Description of the card (at most 2000 bytes).
#
# At least one of the title, description or media must be set.
"title": "A String", # Optional. Title of the card (at most 200 bytes).
#
# At least one of the title, description or media must be set.
},
],
"cardWidth": "A String", # Required. The width of the cards in the carousel.
},
"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
"audioUri": "A String", # 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 <Project Number> 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.
},
"payload": { # Returns a response containing a custom, platform-specific payload.
# See the Intent.Message.Platform type for a description of the
# structure that may be required for your platform.
"a_key": "", # Properties of the object.
},
"platform": "A String", # Optional. The platform that this message is intended for.
"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
# 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.
"ssml": "A String", # The SSML to be synthesized. For more information, see
# [SSML](https://developers.google.com/actions/reference/ssml).
"text": "A String", # The raw text to be synthesized.
},
"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
"buttons": [ # Optional. The collection of card buttons.
{ # The button object that appears at the bottom of a card.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
"title": "A String", # Required. The title of the button.
},
],
"subtitle": "A String", # Optional. The subtitle of the card.
"image": { # The image response message. # Optional. The image for the card.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"formattedText": "A String", # Required, unless image is present. The body text of the card.
"title": "A String", # Optional. The title of the card.
},
"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
"mediaObjects": [ # Required. List of media objects.
{ # Response media object for media content card.
"contentUrl": "A String", # Required. Url where the media is stored.
"description": "A String", # Optional. Description of media card.
"name": "A String", # Required. Name of media card.
"largeImage": { # The image response message. # Optional. Image to display above media content.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"icon": { # The image response message. # Optional. Icon to display above media content.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
},
],
"mediaType": "A String", # Optional. What type of media is the content (ie "audio").
},
"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
"items": [ # Required. Carousel items.
{ # An item in the carousel.
"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
# dialog.
"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
# item in dialog.
"A String",
],
"key": "A String", # Required. A unique key that will be sent back to the agent if this
# response is given.
},
"image": { # The image response message. # Optional. The image to display.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"description": "A String", # Optional. The body text of the card.
"title": "A String", # Required. Title of the carousel item.
},
],
},
"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
# https://developers.google.com/actions/assistant/responses#browsing_carousel
"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
# items, maximum of ten.
{ # Browsing carousel tile
"image": { # The image response message. # Optional. Hero image for the carousel item.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
# Card. Maximum of one line of text.
"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
# text.
"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
"url": "A String", # Required. URL
"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
# the URL. Defaults to opening via web browser.
},
"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
},
],
"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
# items.
},
"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
"suggestions": [ # Required. The list of suggested replies.
{ # The suggestion chip message that the user can tap to quickly post a reply
# to the conversation.
"title": "A String", # Required. The text shown the in the suggestion chip.
},
],
},
"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
"phoneNumber": "A String", # 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).
},
"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
# For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout.
"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
# Image preview alignment for standalone cards with horizontal layout.
"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
#
# ## Image Types
#
# image/jpeg
# image/jpg'
# image/gif
# image/png
#
# ## Video Types
#
# video/h263
# video/m4v
# video/mp4
# video/mpeg
# video/mpeg4
# video/webm
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
# provide a thumbnail URI, the RBM platform displays a blank
# placeholder thumbnail until the user's device downloads the file.
# Depending on the user's setting, the file may not download
# automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
},
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
# (https://goo.gl/6GLJD2). If the user has an app installed that is
# registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI.
"uri": "A String", # Required. The uri to open on the user device
},
"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
# to send back to the agent (https://goo.gl/GXotJW).
},
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
# but does not dial automatically (https://goo.gl/ergbB2).
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
# +15556767888.
},
"text": "A String", # Text to display alongside the action.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
# instead of typing in their own response.
"text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
},
],
"description": "A String", # Optional. Description of the card (at most 2000 bytes).
#
# At least one of the title, description or media must be set.
"title": "A String", # Optional. Title of the card (at most 200 bytes).
#
# At least one of the title, description or media must be set.
},
"cardOrientation": "A String", # Required. Orientation of the card.
},
"card": { # The card response message. # Displays a card.
"buttons": [ # Optional. The collection of card buttons.
{ # Optional. Contains information about a button.
"text": "A String", # Optional. The text to show on the button.
"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
# open.
},
],
"imageUri": "A String", # Optional. The public URI to an image file for the card.
"subtitle": "A String", # Optional. The subtitle of the card.
"title": "A String", # Optional. The title of the card.
},
"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
"rows": [ # Optional. Rows in this table of data.
{ # Row of TableCard.
"cells": [ # Optional. List of cells that make up this row.
{ # Cell of TableCardRow.
"text": "A String", # Required. Text in this cell.
},
],
"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
},
],
"subtitle": "A String", # Optional. Subtitle to the title.
"title": "A String", # Required. Title of the card.
"image": { # The image response message. # Optional. Image which should be displayed on the card.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"columnProperties": [ # Optional. Display properties for the columns in this table.
{ # Column properties for TableCard.
"header": "A String", # Required. Column heading.
"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
},
],
"buttons": [ # Optional. List of buttons for the card.
{ # The button object that appears at the bottom of a card.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
"title": "A String", # Required. The title of the button.
},
],
},
},
],
"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
# session when this intent is matched.
"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
"A String",
],
"priority": 42, # The priority of this intent. Higher numbers represent higher
# priorities.
#
# - If the supplied value is unspecified or 0, the service
# translates the value to 500,000, which corresponds to the
# `Normal` priority in the console.
# - If the supplied value is negative, the intent is ignored
# in runtime detect intent requests.
"rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
# followup intents. It identifies the correct followup intents chain for
# this intent. We populate this field only in the output.
#
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"trainingPhrases": [ # Optional. The collection of examples that the agent is
# trained on.
{ # Represents an example that the agent is trained on.
"parts": [ # Required. The ordered list of training phrase parts.
# The parts are concatenated in order to form the training phrase.
#
# Note: The API does not automatically annotate training phrases like the
# Dialogflow Console does.
#
# Note: Do not forget to include whitespace at part boundaries,
# so the training phrase is well formatted when the parts are concatenated.
#
# If the training phrase does not need to be annotated with parameters,
# you just need a single part with only the Part.text field set.
#
# If you want to annotate the training phrase, you must create multiple
# parts, where the fields of each part are populated in one of two ways:
#
# - `Part.text` is set to a part of the phrase that has no parameters.
# - `Part.text` is set to a part of the phrase that you want to annotate,
# and the `entity_type`, `alias`, and `user_defined` fields are all
# set.
{ # Represents a part of a training phrase.
"alias": "A String", # Optional. The parameter name for the value extracted from the
# annotated part of the example.
# This field is required for annotated parts of the training phrase.
"entityType": "A String", # Optional. The entity type name prefixed with `@`.
# This field is required for annotated parts of the training phrase.
"text": "A String", # Required. The text for this part.
"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
# This field is set to true when the Dialogflow Console is used to
# manually annotate the part. When creating an annotated part with the
# API, you must set this to true.
},
],
"type": "A String", # Required. The type of the training phrase.
"name": "A String", # Output only. The unique identifier of this training phrase.
"timesAddedCount": 42, # Optional. Indicates how many times this example was added to
# the intent. Each time a developer adds an existing sample by editing an
# intent or training, this counter is increased.
},
],
"inputContextNames": [ # Optional. The list of context names required for this intent to be
# triggered.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
"A String",
],
"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
# Note: If `ml_enabled` setting is set to false, then this intent is not
# taken into account during inference in `ML ONLY` match mode. Also,
# auto-markup in the UI is turned off.
# DEPRECATED! Please use `ml_disabled` field instead.
# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
# then the default value is determined as follows:
# - Before April 15th, 2018 the default is:
# ml_enabled = false / ml_disabled = true.
# - After April 15th, 2018 the default is:
# ml_enabled = true / ml_disabled = false.
"action": "A String", # Optional. The name of the action associated with the intent.
# Note: The action name must not contain whitespaces.
"outputContexts": [ # Optional. The collection of contexts that are activated when the intent
# is matched. Context messages in this collection should not set the
# parameters field. Setting the `lifespan_count` to 0 will reset the context
# when the intent is matched.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
{ # Represents a context.
"parameters": { # Optional. The collection of parameters associated with this context.
# Refer to [this
# doc](https://cloud.google.com/dialogflow/docs/intents-actions-parameters)
# for syntax.
"a_key": "", # Properties of the object.
},
"name": "A String", # Required. The unique identifier of the context. Format:
# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,
# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
# ID>/sessions/<Session ID>/contexts/<Context ID>`.
#
# The `Context ID` is always converted to lowercase, may only contain
# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
#
# If `Environment ID` is not specified, we assume default 'draft'
# environment. If `User ID` is not specified, we assume default '-' user.
#
# The following context names are reserved for internal use by Dialogflow.
# You should not use these contexts or create contexts with these names:
#
# * `__system_counters__`
# * `*_id_dialog_context`
# * `*_dialog_params_size`
"lifespanCount": 42, # Optional. The number of conversational query requests after which the
# context expires. If set to `0` (the default) the context expires
# immediately. Contexts expire automatically after 20 minutes if there
# are no matching queries.
},
],
"events": [ # Optional. The collection of event names that trigger the intent.
# If the collection of input contexts is not empty, all of the contexts must
# be present in the active user session for an event to trigger this intent.
# Event names are limited to 50 characters.
"A String",
],
}
list(parent=None, pageSize=None, languageCode=None, intentView=None, pageToken=None, x__xgafv=None)
Returns the list of all intents in the specified agent.
Args:
parent: string, Required. The agent to list all intents from.
Format: `projects/<Project ID>/agent`. (required)
pageSize: integer, Optional. The maximum number of items to return in a single page. By
default 100 and at most 1000.
languageCode: string, Optional. The language to list training phrases, parameters and rich
messages for. If not specified, the agent's default language is used.
[Many
languages](https://cloud.google.com/dialogflow/docs/reference/language)
are supported. Note: languages must be enabled in the agent before they can
be used.
intentView: string, Optional. The resource view to apply to the returned intent.
pageToken: string, Optional. The next_page_token value returned from a previous list request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response message for Intents.ListIntents.
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
# more results in the list.
"intents": [ # The list of agent intents. There will be a maximum number of items
# returned based on the page_size field in the request.
{ # Represents an intent.
# Intents convert a number of user expressions or patterns into an action. An
# action is an extraction of a user command or sentence semantics.
"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
# Note: If `ml_disabled` setting is set to true, then this intent is not
# taken into account during inference in `ML ONLY` match mode. Also,
# auto-markup in the UI is turned off.
"displayName": "A String", # Required. The name of this intent.
"name": "A String", # The unique identifier of this intent.
# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
# methods.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
# whether the intent cannot be completed without collecting the parameter
# value.
"name": "A String", # The unique identifier of this parameter.
"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
# result.
# Default values can be extracted from contexts by using the following
# syntax: `#context_name.parameter_name`.
"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
# describes values of the parameter. If the parameter is
# required, this must be provided.
"value": "A String", # Optional. The definition of the parameter value. It can be:
# - a constant string,
# - a parameter value defined as `$parameter_name`,
# - an original parameter value defined as `$parameter_name.original`,
# - a parameter value from some context defined as
# `#context_name.parameter_name`.
"prompts": [ # Optional. The collection of prompts that the agent can present to the
# user in order to collect a value for the parameter.
"A String",
],
"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
"displayName": "A String", # Required. The name of the parameter.
},
],
"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
# (e.g., Actions on Google or Dialogflow phone gateway) use this information
# to close interaction with an end user. Default is false.
"followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
# a direct or indirect parent. We populate this field only in the output.
{ # Represents a single followup intent in the chain.
"followupIntentName": "A String", # The unique identifier of the followup intent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
},
],
"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
"parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
# chain of followup intents. You can set this field when creating an intent,
# for example with CreateIntent or
# BatchUpdateIntents, in order to make this
# intent a followup intent.
#
# It identifies the parent followup intent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"messages": [ # Optional. The collection of rich messages corresponding to the
# `Response` field in the Dialogflow console.
{ # Corresponds to the `Response` field in the Dialogflow console.
"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
# This message in `QueryResult.fulfillment_messages` and
# `WebhookResponse.fulfillment_messages` should contain only one
# `SimpleResponse`.
"simpleResponses": [ # Required. The list of simple responses.
{ # The simple response message containing speech or text.
"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
# response to the user in the SSML format. Mutually exclusive with
# text_to_speech.
"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
# speech output. Mutually exclusive with ssml.
"displayText": "A String", # Optional. The text to display.
},
],
},
"quickReplies": { # The quick replies response message. # Displays quick replies.
"quickReplies": [ # Optional. The collection of quick replies.
"A String",
],
"title": "A String", # Optional. The title of the collection of quick replies.
},
"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.
# or website associated with this agent.
"uri": "A String", # Required. The URI of the app or site to open when the user taps the
# suggestion chip.
"destinationName": "A String", # Required. The name of the app or site this chip is linking to.
},
"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
"items": [ # Required. List items.
{ # An item in the list.
"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
# dialog.
"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
# item in dialog.
"A String",
],
"key": "A String", # Required. A unique key that will be sent back to the agent if this
# response is given.
},
"image": { # The image response message. # Optional. The image to display.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"description": "A String", # Optional. The main text describing the item.
"title": "A String", # Required. The title of the list item.
},
],
"subtitle": "A String", # Optional. Subtitle of the list.
"title": "A String", # Optional. The overall title of the list.
},
"text": { # The text response message. # Returns a text response.
"text": [ # Optional. The collection of the agent's responses.
"A String",
],
},
"image": { # The image response message. # Displays an image.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
#
# RBM allows businesses to send enriched and branded versions of SMS. See
# https://jibe.google.com/business-messaging.
"text": "A String", # Required. Text sent and displayed to the user.
"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
# (https://goo.gl/6GLJD2). If the user has an app installed that is
# registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI.
"uri": "A String", # Required. The uri to open on the user device
},
"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
# to send back to the agent (https://goo.gl/GXotJW).
},
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
# but does not dial automatically (https://goo.gl/ergbB2).
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
# +15556767888.
},
"text": "A String", # Text to display alongside the action.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
# instead of typing in their own response.
"text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
},
],
},
"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
# For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead.
"cardContents": [ # Required. The cards in the carousel. A carousel must have at least
# 2 cards and at most 10.
{ # Rich Business Messaging (RBM) Card content
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
#
# ## Image Types
#
# image/jpeg
# image/jpg'
# image/gif
# image/png
#
# ## Video Types
#
# video/h263
# video/m4v
# video/mp4
# video/mpeg
# video/mpeg4
# video/webm
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
# provide a thumbnail URI, the RBM platform displays a blank
# placeholder thumbnail until the user's device downloads the file.
# Depending on the user's setting, the file may not download
# automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
},
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
# (https://goo.gl/6GLJD2). If the user has an app installed that is
# registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI.
"uri": "A String", # Required. The uri to open on the user device
},
"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
# to send back to the agent (https://goo.gl/GXotJW).
},
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
# but does not dial automatically (https://goo.gl/ergbB2).
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
# +15556767888.
},
"text": "A String", # Text to display alongside the action.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
# instead of typing in their own response.
"text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
},
],
"description": "A String", # Optional. Description of the card (at most 2000 bytes).
#
# At least one of the title, description or media must be set.
"title": "A String", # Optional. Title of the card (at most 200 bytes).
#
# At least one of the title, description or media must be set.
},
],
"cardWidth": "A String", # Required. The width of the cards in the carousel.
},
"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
"audioUri": "A String", # 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 <Project Number> 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.
},
"payload": { # Returns a response containing a custom, platform-specific payload.
# See the Intent.Message.Platform type for a description of the
# structure that may be required for your platform.
"a_key": "", # Properties of the object.
},
"platform": "A String", # Optional. The platform that this message is intended for.
"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
# 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.
"ssml": "A String", # The SSML to be synthesized. For more information, see
# [SSML](https://developers.google.com/actions/reference/ssml).
"text": "A String", # The raw text to be synthesized.
},
"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
"buttons": [ # Optional. The collection of card buttons.
{ # The button object that appears at the bottom of a card.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
"title": "A String", # Required. The title of the button.
},
],
"subtitle": "A String", # Optional. The subtitle of the card.
"image": { # The image response message. # Optional. The image for the card.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"formattedText": "A String", # Required, unless image is present. The body text of the card.
"title": "A String", # Optional. The title of the card.
},
"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
"mediaObjects": [ # Required. List of media objects.
{ # Response media object for media content card.
"contentUrl": "A String", # Required. Url where the media is stored.
"description": "A String", # Optional. Description of media card.
"name": "A String", # Required. Name of media card.
"largeImage": { # The image response message. # Optional. Image to display above media content.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"icon": { # The image response message. # Optional. Icon to display above media content.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
},
],
"mediaType": "A String", # Optional. What type of media is the content (ie "audio").
},
"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
"items": [ # Required. Carousel items.
{ # An item in the carousel.
"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
# dialog.
"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
# item in dialog.
"A String",
],
"key": "A String", # Required. A unique key that will be sent back to the agent if this
# response is given.
},
"image": { # The image response message. # Optional. The image to display.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"description": "A String", # Optional. The body text of the card.
"title": "A String", # Required. Title of the carousel item.
},
],
},
"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
# https://developers.google.com/actions/assistant/responses#browsing_carousel
"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
# items, maximum of ten.
{ # Browsing carousel tile
"image": { # The image response message. # Optional. Hero image for the carousel item.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
# Card. Maximum of one line of text.
"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
# text.
"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
"url": "A String", # Required. URL
"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
# the URL. Defaults to opening via web browser.
},
"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
},
],
"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
# items.
},
"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
"suggestions": [ # Required. The list of suggested replies.
{ # The suggestion chip message that the user can tap to quickly post a reply
# to the conversation.
"title": "A String", # Required. The text shown the in the suggestion chip.
},
],
},
"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
"phoneNumber": "A String", # 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).
},
"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
# For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout.
"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
# Image preview alignment for standalone cards with horizontal layout.
"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
#
# ## Image Types
#
# image/jpeg
# image/jpg'
# image/gif
# image/png
#
# ## Video Types
#
# video/h263
# video/m4v
# video/mp4
# video/mpeg
# video/mpeg4
# video/webm
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
# provide a thumbnail URI, the RBM platform displays a blank
# placeholder thumbnail until the user's device downloads the file.
# Depending on the user's setting, the file may not download
# automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
},
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
# (https://goo.gl/6GLJD2). If the user has an app installed that is
# registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI.
"uri": "A String", # Required. The uri to open on the user device
},
"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
# to send back to the agent (https://goo.gl/GXotJW).
},
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
# but does not dial automatically (https://goo.gl/ergbB2).
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
# +15556767888.
},
"text": "A String", # Text to display alongside the action.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
# instead of typing in their own response.
"text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
},
],
"description": "A String", # Optional. Description of the card (at most 2000 bytes).
#
# At least one of the title, description or media must be set.
"title": "A String", # Optional. Title of the card (at most 200 bytes).
#
# At least one of the title, description or media must be set.
},
"cardOrientation": "A String", # Required. Orientation of the card.
},
"card": { # The card response message. # Displays a card.
"buttons": [ # Optional. The collection of card buttons.
{ # Optional. Contains information about a button.
"text": "A String", # Optional. The text to show on the button.
"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
# open.
},
],
"imageUri": "A String", # Optional. The public URI to an image file for the card.
"subtitle": "A String", # Optional. The subtitle of the card.
"title": "A String", # Optional. The title of the card.
},
"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
"rows": [ # Optional. Rows in this table of data.
{ # Row of TableCard.
"cells": [ # Optional. List of cells that make up this row.
{ # Cell of TableCardRow.
"text": "A String", # Required. Text in this cell.
},
],
"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
},
],
"subtitle": "A String", # Optional. Subtitle to the title.
"title": "A String", # Required. Title of the card.
"image": { # The image response message. # Optional. Image which should be displayed on the card.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"columnProperties": [ # Optional. Display properties for the columns in this table.
{ # Column properties for TableCard.
"header": "A String", # Required. Column heading.
"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
},
],
"buttons": [ # Optional. List of buttons for the card.
{ # The button object that appears at the bottom of a card.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
"title": "A String", # Required. The title of the button.
},
],
},
},
],
"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
# session when this intent is matched.
"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
"A String",
],
"priority": 42, # The priority of this intent. Higher numbers represent higher
# priorities.
#
# - If the supplied value is unspecified or 0, the service
# translates the value to 500,000, which corresponds to the
# `Normal` priority in the console.
# - If the supplied value is negative, the intent is ignored
# in runtime detect intent requests.
"rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
# followup intents. It identifies the correct followup intents chain for
# this intent. We populate this field only in the output.
#
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"trainingPhrases": [ # Optional. The collection of examples that the agent is
# trained on.
{ # Represents an example that the agent is trained on.
"parts": [ # Required. The ordered list of training phrase parts.
# The parts are concatenated in order to form the training phrase.
#
# Note: The API does not automatically annotate training phrases like the
# Dialogflow Console does.
#
# Note: Do not forget to include whitespace at part boundaries,
# so the training phrase is well formatted when the parts are concatenated.
#
# If the training phrase does not need to be annotated with parameters,
# you just need a single part with only the Part.text field set.
#
# If you want to annotate the training phrase, you must create multiple
# parts, where the fields of each part are populated in one of two ways:
#
# - `Part.text` is set to a part of the phrase that has no parameters.
# - `Part.text` is set to a part of the phrase that you want to annotate,
# and the `entity_type`, `alias`, and `user_defined` fields are all
# set.
{ # Represents a part of a training phrase.
"alias": "A String", # Optional. The parameter name for the value extracted from the
# annotated part of the example.
# This field is required for annotated parts of the training phrase.
"entityType": "A String", # Optional. The entity type name prefixed with `@`.
# This field is required for annotated parts of the training phrase.
"text": "A String", # Required. The text for this part.
"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
# This field is set to true when the Dialogflow Console is used to
# manually annotate the part. When creating an annotated part with the
# API, you must set this to true.
},
],
"type": "A String", # Required. The type of the training phrase.
"name": "A String", # Output only. The unique identifier of this training phrase.
"timesAddedCount": 42, # Optional. Indicates how many times this example was added to
# the intent. Each time a developer adds an existing sample by editing an
# intent or training, this counter is increased.
},
],
"inputContextNames": [ # Optional. The list of context names required for this intent to be
# triggered.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
"A String",
],
"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
# Note: If `ml_enabled` setting is set to false, then this intent is not
# taken into account during inference in `ML ONLY` match mode. Also,
# auto-markup in the UI is turned off.
# DEPRECATED! Please use `ml_disabled` field instead.
# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
# then the default value is determined as follows:
# - Before April 15th, 2018 the default is:
# ml_enabled = false / ml_disabled = true.
# - After April 15th, 2018 the default is:
# ml_enabled = true / ml_disabled = false.
"action": "A String", # Optional. The name of the action associated with the intent.
# Note: The action name must not contain whitespaces.
"outputContexts": [ # Optional. The collection of contexts that are activated when the intent
# is matched. Context messages in this collection should not set the
# parameters field. Setting the `lifespan_count` to 0 will reset the context
# when the intent is matched.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
{ # Represents a context.
"parameters": { # Optional. The collection of parameters associated with this context.
# Refer to [this
# doc](https://cloud.google.com/dialogflow/docs/intents-actions-parameters)
# for syntax.
"a_key": "", # Properties of the object.
},
"name": "A String", # Required. The unique identifier of the context. Format:
# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,
# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
# ID>/sessions/<Session ID>/contexts/<Context ID>`.
#
# The `Context ID` is always converted to lowercase, may only contain
# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
#
# If `Environment ID` is not specified, we assume default 'draft'
# environment. If `User ID` is not specified, we assume default '-' user.
#
# The following context names are reserved for internal use by Dialogflow.
# You should not use these contexts or create contexts with these names:
#
# * `__system_counters__`
# * `*_id_dialog_context`
# * `*_dialog_params_size`
"lifespanCount": 42, # Optional. The number of conversational query requests after which the
# context expires. If set to `0` (the default) the context expires
# immediately. Contexts expire automatically after 20 minutes if there
# are no matching queries.
},
],
"events": [ # Optional. The collection of event names that trigger the intent.
# If the collection of input contexts is not empty, all of the contexts must
# be present in the active user session for an event to trigger this intent.
# Event names are limited to 50 characters.
"A String",
],
},
],
}
list_next(previous_request=*, previous_response=*)
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name=None, body=None, languageCode=None, intentView=None, updateMask=None, x__xgafv=None)
Updates the specified intent.
Args:
name: string, The unique identifier of this intent.
Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
methods.
Format: `projects/<Project ID>/agent/intents/<Intent ID>`. (required)
body: object, The request body.
The object takes the form of:
{ # Represents an intent.
# Intents convert a number of user expressions or patterns into an action. An
# action is an extraction of a user command or sentence semantics.
"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
# Note: If `ml_disabled` setting is set to true, then this intent is not
# taken into account during inference in `ML ONLY` match mode. Also,
# auto-markup in the UI is turned off.
"displayName": "A String", # Required. The name of this intent.
"name": "A String", # The unique identifier of this intent.
# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
# methods.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
# whether the intent cannot be completed without collecting the parameter
# value.
"name": "A String", # The unique identifier of this parameter.
"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
# result.
# Default values can be extracted from contexts by using the following
# syntax: `#context_name.parameter_name`.
"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
# describes values of the parameter. If the parameter is
# required, this must be provided.
"value": "A String", # Optional. The definition of the parameter value. It can be:
# - a constant string,
# - a parameter value defined as `$parameter_name`,
# - an original parameter value defined as `$parameter_name.original`,
# - a parameter value from some context defined as
# `#context_name.parameter_name`.
"prompts": [ # Optional. The collection of prompts that the agent can present to the
# user in order to collect a value for the parameter.
"A String",
],
"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
"displayName": "A String", # Required. The name of the parameter.
},
],
"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
# (e.g., Actions on Google or Dialogflow phone gateway) use this information
# to close interaction with an end user. Default is false.
"followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
# a direct or indirect parent. We populate this field only in the output.
{ # Represents a single followup intent in the chain.
"followupIntentName": "A String", # The unique identifier of the followup intent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
},
],
"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
"parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
# chain of followup intents. You can set this field when creating an intent,
# for example with CreateIntent or
# BatchUpdateIntents, in order to make this
# intent a followup intent.
#
# It identifies the parent followup intent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"messages": [ # Optional. The collection of rich messages corresponding to the
# `Response` field in the Dialogflow console.
{ # Corresponds to the `Response` field in the Dialogflow console.
"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
# This message in `QueryResult.fulfillment_messages` and
# `WebhookResponse.fulfillment_messages` should contain only one
# `SimpleResponse`.
"simpleResponses": [ # Required. The list of simple responses.
{ # The simple response message containing speech or text.
"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
# response to the user in the SSML format. Mutually exclusive with
# text_to_speech.
"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
# speech output. Mutually exclusive with ssml.
"displayText": "A String", # Optional. The text to display.
},
],
},
"quickReplies": { # The quick replies response message. # Displays quick replies.
"quickReplies": [ # Optional. The collection of quick replies.
"A String",
],
"title": "A String", # Optional. The title of the collection of quick replies.
},
"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.
# or website associated with this agent.
"uri": "A String", # Required. The URI of the app or site to open when the user taps the
# suggestion chip.
"destinationName": "A String", # Required. The name of the app or site this chip is linking to.
},
"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
"items": [ # Required. List items.
{ # An item in the list.
"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
# dialog.
"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
# item in dialog.
"A String",
],
"key": "A String", # Required. A unique key that will be sent back to the agent if this
# response is given.
},
"image": { # The image response message. # Optional. The image to display.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"description": "A String", # Optional. The main text describing the item.
"title": "A String", # Required. The title of the list item.
},
],
"subtitle": "A String", # Optional. Subtitle of the list.
"title": "A String", # Optional. The overall title of the list.
},
"text": { # The text response message. # Returns a text response.
"text": [ # Optional. The collection of the agent's responses.
"A String",
],
},
"image": { # The image response message. # Displays an image.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
#
# RBM allows businesses to send enriched and branded versions of SMS. See
# https://jibe.google.com/business-messaging.
"text": "A String", # Required. Text sent and displayed to the user.
"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
# (https://goo.gl/6GLJD2). If the user has an app installed that is
# registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI.
"uri": "A String", # Required. The uri to open on the user device
},
"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
# to send back to the agent (https://goo.gl/GXotJW).
},
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
# but does not dial automatically (https://goo.gl/ergbB2).
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
# +15556767888.
},
"text": "A String", # Text to display alongside the action.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
# instead of typing in their own response.
"text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
},
],
},
"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
# For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead.
"cardContents": [ # Required. The cards in the carousel. A carousel must have at least
# 2 cards and at most 10.
{ # Rich Business Messaging (RBM) Card content
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
#
# ## Image Types
#
# image/jpeg
# image/jpg'
# image/gif
# image/png
#
# ## Video Types
#
# video/h263
# video/m4v
# video/mp4
# video/mpeg
# video/mpeg4
# video/webm
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
# provide a thumbnail URI, the RBM platform displays a blank
# placeholder thumbnail until the user's device downloads the file.
# Depending on the user's setting, the file may not download
# automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
},
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
# (https://goo.gl/6GLJD2). If the user has an app installed that is
# registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI.
"uri": "A String", # Required. The uri to open on the user device
},
"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
# to send back to the agent (https://goo.gl/GXotJW).
},
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
# but does not dial automatically (https://goo.gl/ergbB2).
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
# +15556767888.
},
"text": "A String", # Text to display alongside the action.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
# instead of typing in their own response.
"text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
},
],
"description": "A String", # Optional. Description of the card (at most 2000 bytes).
#
# At least one of the title, description or media must be set.
"title": "A String", # Optional. Title of the card (at most 200 bytes).
#
# At least one of the title, description or media must be set.
},
],
"cardWidth": "A String", # Required. The width of the cards in the carousel.
},
"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
"audioUri": "A String", # 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 <Project Number> 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.
},
"payload": { # Returns a response containing a custom, platform-specific payload.
# See the Intent.Message.Platform type for a description of the
# structure that may be required for your platform.
"a_key": "", # Properties of the object.
},
"platform": "A String", # Optional. The platform that this message is intended for.
"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
# 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.
"ssml": "A String", # The SSML to be synthesized. For more information, see
# [SSML](https://developers.google.com/actions/reference/ssml).
"text": "A String", # The raw text to be synthesized.
},
"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
"buttons": [ # Optional. The collection of card buttons.
{ # The button object that appears at the bottom of a card.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
"title": "A String", # Required. The title of the button.
},
],
"subtitle": "A String", # Optional. The subtitle of the card.
"image": { # The image response message. # Optional. The image for the card.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"formattedText": "A String", # Required, unless image is present. The body text of the card.
"title": "A String", # Optional. The title of the card.
},
"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
"mediaObjects": [ # Required. List of media objects.
{ # Response media object for media content card.
"contentUrl": "A String", # Required. Url where the media is stored.
"description": "A String", # Optional. Description of media card.
"name": "A String", # Required. Name of media card.
"largeImage": { # The image response message. # Optional. Image to display above media content.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"icon": { # The image response message. # Optional. Icon to display above media content.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
},
],
"mediaType": "A String", # Optional. What type of media is the content (ie "audio").
},
"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
"items": [ # Required. Carousel items.
{ # An item in the carousel.
"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
# dialog.
"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
# item in dialog.
"A String",
],
"key": "A String", # Required. A unique key that will be sent back to the agent if this
# response is given.
},
"image": { # The image response message. # Optional. The image to display.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"description": "A String", # Optional. The body text of the card.
"title": "A String", # Required. Title of the carousel item.
},
],
},
"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
# https://developers.google.com/actions/assistant/responses#browsing_carousel
"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
# items, maximum of ten.
{ # Browsing carousel tile
"image": { # The image response message. # Optional. Hero image for the carousel item.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
# Card. Maximum of one line of text.
"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
# text.
"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
"url": "A String", # Required. URL
"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
# the URL. Defaults to opening via web browser.
},
"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
},
],
"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
# items.
},
"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
"suggestions": [ # Required. The list of suggested replies.
{ # The suggestion chip message that the user can tap to quickly post a reply
# to the conversation.
"title": "A String", # Required. The text shown the in the suggestion chip.
},
],
},
"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
"phoneNumber": "A String", # 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).
},
"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
# For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout.
"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
# Image preview alignment for standalone cards with horizontal layout.
"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
#
# ## Image Types
#
# image/jpeg
# image/jpg'
# image/gif
# image/png
#
# ## Video Types
#
# video/h263
# video/m4v
# video/mp4
# video/mpeg
# video/mpeg4
# video/webm
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
# provide a thumbnail URI, the RBM platform displays a blank
# placeholder thumbnail until the user's device downloads the file.
# Depending on the user's setting, the file may not download
# automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
},
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
# (https://goo.gl/6GLJD2). If the user has an app installed that is
# registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI.
"uri": "A String", # Required. The uri to open on the user device
},
"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
# to send back to the agent (https://goo.gl/GXotJW).
},
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
# but does not dial automatically (https://goo.gl/ergbB2).
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
# +15556767888.
},
"text": "A String", # Text to display alongside the action.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
# instead of typing in their own response.
"text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
},
],
"description": "A String", # Optional. Description of the card (at most 2000 bytes).
#
# At least one of the title, description or media must be set.
"title": "A String", # Optional. Title of the card (at most 200 bytes).
#
# At least one of the title, description or media must be set.
},
"cardOrientation": "A String", # Required. Orientation of the card.
},
"card": { # The card response message. # Displays a card.
"buttons": [ # Optional. The collection of card buttons.
{ # Optional. Contains information about a button.
"text": "A String", # Optional. The text to show on the button.
"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
# open.
},
],
"imageUri": "A String", # Optional. The public URI to an image file for the card.
"subtitle": "A String", # Optional. The subtitle of the card.
"title": "A String", # Optional. The title of the card.
},
"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
"rows": [ # Optional. Rows in this table of data.
{ # Row of TableCard.
"cells": [ # Optional. List of cells that make up this row.
{ # Cell of TableCardRow.
"text": "A String", # Required. Text in this cell.
},
],
"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
},
],
"subtitle": "A String", # Optional. Subtitle to the title.
"title": "A String", # Required. Title of the card.
"image": { # The image response message. # Optional. Image which should be displayed on the card.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"columnProperties": [ # Optional. Display properties for the columns in this table.
{ # Column properties for TableCard.
"header": "A String", # Required. Column heading.
"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
},
],
"buttons": [ # Optional. List of buttons for the card.
{ # The button object that appears at the bottom of a card.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
"title": "A String", # Required. The title of the button.
},
],
},
},
],
"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
# session when this intent is matched.
"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
"A String",
],
"priority": 42, # The priority of this intent. Higher numbers represent higher
# priorities.
#
# - If the supplied value is unspecified or 0, the service
# translates the value to 500,000, which corresponds to the
# `Normal` priority in the console.
# - If the supplied value is negative, the intent is ignored
# in runtime detect intent requests.
"rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
# followup intents. It identifies the correct followup intents chain for
# this intent. We populate this field only in the output.
#
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"trainingPhrases": [ # Optional. The collection of examples that the agent is
# trained on.
{ # Represents an example that the agent is trained on.
"parts": [ # Required. The ordered list of training phrase parts.
# The parts are concatenated in order to form the training phrase.
#
# Note: The API does not automatically annotate training phrases like the
# Dialogflow Console does.
#
# Note: Do not forget to include whitespace at part boundaries,
# so the training phrase is well formatted when the parts are concatenated.
#
# If the training phrase does not need to be annotated with parameters,
# you just need a single part with only the Part.text field set.
#
# If you want to annotate the training phrase, you must create multiple
# parts, where the fields of each part are populated in one of two ways:
#
# - `Part.text` is set to a part of the phrase that has no parameters.
# - `Part.text` is set to a part of the phrase that you want to annotate,
# and the `entity_type`, `alias`, and `user_defined` fields are all
# set.
{ # Represents a part of a training phrase.
"alias": "A String", # Optional. The parameter name for the value extracted from the
# annotated part of the example.
# This field is required for annotated parts of the training phrase.
"entityType": "A String", # Optional. The entity type name prefixed with `@`.
# This field is required for annotated parts of the training phrase.
"text": "A String", # Required. The text for this part.
"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
# This field is set to true when the Dialogflow Console is used to
# manually annotate the part. When creating an annotated part with the
# API, you must set this to true.
},
],
"type": "A String", # Required. The type of the training phrase.
"name": "A String", # Output only. The unique identifier of this training phrase.
"timesAddedCount": 42, # Optional. Indicates how many times this example was added to
# the intent. Each time a developer adds an existing sample by editing an
# intent or training, this counter is increased.
},
],
"inputContextNames": [ # Optional. The list of context names required for this intent to be
# triggered.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
"A String",
],
"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
# Note: If `ml_enabled` setting is set to false, then this intent is not
# taken into account during inference in `ML ONLY` match mode. Also,
# auto-markup in the UI is turned off.
# DEPRECATED! Please use `ml_disabled` field instead.
# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
# then the default value is determined as follows:
# - Before April 15th, 2018 the default is:
# ml_enabled = false / ml_disabled = true.
# - After April 15th, 2018 the default is:
# ml_enabled = true / ml_disabled = false.
"action": "A String", # Optional. The name of the action associated with the intent.
# Note: The action name must not contain whitespaces.
"outputContexts": [ # Optional. The collection of contexts that are activated when the intent
# is matched. Context messages in this collection should not set the
# parameters field. Setting the `lifespan_count` to 0 will reset the context
# when the intent is matched.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
{ # Represents a context.
"parameters": { # Optional. The collection of parameters associated with this context.
# Refer to [this
# doc](https://cloud.google.com/dialogflow/docs/intents-actions-parameters)
# for syntax.
"a_key": "", # Properties of the object.
},
"name": "A String", # Required. The unique identifier of the context. Format:
# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,
# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
# ID>/sessions/<Session ID>/contexts/<Context ID>`.
#
# The `Context ID` is always converted to lowercase, may only contain
# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
#
# If `Environment ID` is not specified, we assume default 'draft'
# environment. If `User ID` is not specified, we assume default '-' user.
#
# The following context names are reserved for internal use by Dialogflow.
# You should not use these contexts or create contexts with these names:
#
# * `__system_counters__`
# * `*_id_dialog_context`
# * `*_dialog_params_size`
"lifespanCount": 42, # Optional. The number of conversational query requests after which the
# context expires. If set to `0` (the default) the context expires
# immediately. Contexts expire automatically after 20 minutes if there
# are no matching queries.
},
],
"events": [ # Optional. The collection of event names that trigger the intent.
# If the collection of input contexts is not empty, all of the contexts must
# be present in the active user session for an event to trigger this intent.
# Event names are limited to 50 characters.
"A String",
],
}
languageCode: string, Optional. The language of training phrases, parameters and rich messages
defined in `intent`. If not specified, the agent's default language is
used. [Many
languages](https://cloud.google.com/dialogflow/docs/reference/language)
are supported. Note: languages must be enabled in the agent before they can
be used.
intentView: string, Optional. The resource view to apply to the returned intent.
updateMask: string, Optional. The mask to control which fields get updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents an intent.
# Intents convert a number of user expressions or patterns into an action. An
# action is an extraction of a user command or sentence semantics.
"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
# Note: If `ml_disabled` setting is set to true, then this intent is not
# taken into account during inference in `ML ONLY` match mode. Also,
# auto-markup in the UI is turned off.
"displayName": "A String", # Required. The name of this intent.
"name": "A String", # The unique identifier of this intent.
# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
# methods.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
# whether the intent cannot be completed without collecting the parameter
# value.
"name": "A String", # The unique identifier of this parameter.
"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
# result.
# Default values can be extracted from contexts by using the following
# syntax: `#context_name.parameter_name`.
"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
# describes values of the parameter. If the parameter is
# required, this must be provided.
"value": "A String", # Optional. The definition of the parameter value. It can be:
# - a constant string,
# - a parameter value defined as `$parameter_name`,
# - an original parameter value defined as `$parameter_name.original`,
# - a parameter value from some context defined as
# `#context_name.parameter_name`.
"prompts": [ # Optional. The collection of prompts that the agent can present to the
# user in order to collect a value for the parameter.
"A String",
],
"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
"displayName": "A String", # Required. The name of the parameter.
},
],
"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
# (e.g., Actions on Google or Dialogflow phone gateway) use this information
# to close interaction with an end user. Default is false.
"followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
# a direct or indirect parent. We populate this field only in the output.
{ # Represents a single followup intent in the chain.
"followupIntentName": "A String", # The unique identifier of the followup intent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
},
],
"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
"parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
# chain of followup intents. You can set this field when creating an intent,
# for example with CreateIntent or
# BatchUpdateIntents, in order to make this
# intent a followup intent.
#
# It identifies the parent followup intent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"messages": [ # Optional. The collection of rich messages corresponding to the
# `Response` field in the Dialogflow console.
{ # Corresponds to the `Response` field in the Dialogflow console.
"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
# This message in `QueryResult.fulfillment_messages` and
# `WebhookResponse.fulfillment_messages` should contain only one
# `SimpleResponse`.
"simpleResponses": [ # Required. The list of simple responses.
{ # The simple response message containing speech or text.
"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
# response to the user in the SSML format. Mutually exclusive with
# text_to_speech.
"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
# speech output. Mutually exclusive with ssml.
"displayText": "A String", # Optional. The text to display.
},
],
},
"quickReplies": { # The quick replies response message. # Displays quick replies.
"quickReplies": [ # Optional. The collection of quick replies.
"A String",
],
"title": "A String", # Optional. The title of the collection of quick replies.
},
"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.
# or website associated with this agent.
"uri": "A String", # Required. The URI of the app or site to open when the user taps the
# suggestion chip.
"destinationName": "A String", # Required. The name of the app or site this chip is linking to.
},
"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
"items": [ # Required. List items.
{ # An item in the list.
"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
# dialog.
"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
# item in dialog.
"A String",
],
"key": "A String", # Required. A unique key that will be sent back to the agent if this
# response is given.
},
"image": { # The image response message. # Optional. The image to display.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"description": "A String", # Optional. The main text describing the item.
"title": "A String", # Required. The title of the list item.
},
],
"subtitle": "A String", # Optional. Subtitle of the list.
"title": "A String", # Optional. The overall title of the list.
},
"text": { # The text response message. # Returns a text response.
"text": [ # Optional. The collection of the agent's responses.
"A String",
],
},
"image": { # The image response message. # Displays an image.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
#
# RBM allows businesses to send enriched and branded versions of SMS. See
# https://jibe.google.com/business-messaging.
"text": "A String", # Required. Text sent and displayed to the user.
"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
# (https://goo.gl/6GLJD2). If the user has an app installed that is
# registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI.
"uri": "A String", # Required. The uri to open on the user device
},
"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
# to send back to the agent (https://goo.gl/GXotJW).
},
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
# but does not dial automatically (https://goo.gl/ergbB2).
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
# +15556767888.
},
"text": "A String", # Text to display alongside the action.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
# instead of typing in their own response.
"text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
},
],
},
"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
# For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead.
"cardContents": [ # Required. The cards in the carousel. A carousel must have at least
# 2 cards and at most 10.
{ # Rich Business Messaging (RBM) Card content
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
#
# ## Image Types
#
# image/jpeg
# image/jpg'
# image/gif
# image/png
#
# ## Video Types
#
# video/h263
# video/m4v
# video/mp4
# video/mpeg
# video/mpeg4
# video/webm
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
# provide a thumbnail URI, the RBM platform displays a blank
# placeholder thumbnail until the user's device downloads the file.
# Depending on the user's setting, the file may not download
# automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
},
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
# (https://goo.gl/6GLJD2). If the user has an app installed that is
# registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI.
"uri": "A String", # Required. The uri to open on the user device
},
"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
# to send back to the agent (https://goo.gl/GXotJW).
},
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
# but does not dial automatically (https://goo.gl/ergbB2).
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
# +15556767888.
},
"text": "A String", # Text to display alongside the action.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
# instead of typing in their own response.
"text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
},
],
"description": "A String", # Optional. Description of the card (at most 2000 bytes).
#
# At least one of the title, description or media must be set.
"title": "A String", # Optional. Title of the card (at most 200 bytes).
#
# At least one of the title, description or media must be set.
},
],
"cardWidth": "A String", # Required. The width of the cards in the carousel.
},
"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
"audioUri": "A String", # 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 <Project Number> 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.
},
"payload": { # Returns a response containing a custom, platform-specific payload.
# See the Intent.Message.Platform type for a description of the
# structure that may be required for your platform.
"a_key": "", # Properties of the object.
},
"platform": "A String", # Optional. The platform that this message is intended for.
"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
# 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.
"ssml": "A String", # The SSML to be synthesized. For more information, see
# [SSML](https://developers.google.com/actions/reference/ssml).
"text": "A String", # The raw text to be synthesized.
},
"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
"buttons": [ # Optional. The collection of card buttons.
{ # The button object that appears at the bottom of a card.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
"title": "A String", # Required. The title of the button.
},
],
"subtitle": "A String", # Optional. The subtitle of the card.
"image": { # The image response message. # Optional. The image for the card.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"formattedText": "A String", # Required, unless image is present. The body text of the card.
"title": "A String", # Optional. The title of the card.
},
"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
"mediaObjects": [ # Required. List of media objects.
{ # Response media object for media content card.
"contentUrl": "A String", # Required. Url where the media is stored.
"description": "A String", # Optional. Description of media card.
"name": "A String", # Required. Name of media card.
"largeImage": { # The image response message. # Optional. Image to display above media content.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"icon": { # The image response message. # Optional. Icon to display above media content.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
},
],
"mediaType": "A String", # Optional. What type of media is the content (ie "audio").
},
"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
"items": [ # Required. Carousel items.
{ # An item in the carousel.
"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
# dialog.
"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
# item in dialog.
"A String",
],
"key": "A String", # Required. A unique key that will be sent back to the agent if this
# response is given.
},
"image": { # The image response message. # Optional. The image to display.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"description": "A String", # Optional. The body text of the card.
"title": "A String", # Required. Title of the carousel item.
},
],
},
"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
# https://developers.google.com/actions/assistant/responses#browsing_carousel
"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
# items, maximum of ten.
{ # Browsing carousel tile
"image": { # The image response message. # Optional. Hero image for the carousel item.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
# Card. Maximum of one line of text.
"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
# text.
"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
"url": "A String", # Required. URL
"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
# the URL. Defaults to opening via web browser.
},
"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
},
],
"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
# items.
},
"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
"suggestions": [ # Required. The list of suggested replies.
{ # The suggestion chip message that the user can tap to quickly post a reply
# to the conversation.
"title": "A String", # Required. The text shown the in the suggestion chip.
},
],
},
"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
"phoneNumber": "A String", # 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).
},
"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
# For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout.
"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
# Image preview alignment for standalone cards with horizontal layout.
"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
#
# ## Image Types
#
# image/jpeg
# image/jpg'
# image/gif
# image/png
#
# ## Video Types
#
# video/h263
# video/m4v
# video/mp4
# video/mpeg
# video/mpeg4
# video/webm
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
# provide a thumbnail URI, the RBM platform displays a blank
# placeholder thumbnail until the user's device downloads the file.
# Depending on the user's setting, the file may not download
# automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
},
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
# (https://goo.gl/6GLJD2). If the user has an app installed that is
# registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI.
"uri": "A String", # Required. The uri to open on the user device
},
"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
# to send back to the agent (https://goo.gl/GXotJW).
},
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
# but does not dial automatically (https://goo.gl/ergbB2).
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
# +15556767888.
},
"text": "A String", # Text to display alongside the action.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
# instead of typing in their own response.
"text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
},
},
],
"description": "A String", # Optional. Description of the card (at most 2000 bytes).
#
# At least one of the title, description or media must be set.
"title": "A String", # Optional. Title of the card (at most 200 bytes).
#
# At least one of the title, description or media must be set.
},
"cardOrientation": "A String", # Required. Orientation of the card.
},
"card": { # The card response message. # Displays a card.
"buttons": [ # Optional. The collection of card buttons.
{ # Optional. Contains information about a button.
"text": "A String", # Optional. The text to show on the button.
"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
# open.
},
],
"imageUri": "A String", # Optional. The public URI to an image file for the card.
"subtitle": "A String", # Optional. The subtitle of the card.
"title": "A String", # Optional. The title of the card.
},
"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
"rows": [ # Optional. Rows in this table of data.
{ # Row of TableCard.
"cells": [ # Optional. List of cells that make up this row.
{ # Cell of TableCardRow.
"text": "A String", # Required. Text in this cell.
},
],
"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
},
],
"subtitle": "A String", # Optional. Subtitle to the title.
"title": "A String", # Required. Title of the card.
"image": { # The image response message. # Optional. Image which should be displayed on the card.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
"imageUri": "A String", # Optional. The public URI to an image file.
},
"columnProperties": [ # Optional. Display properties for the columns in this table.
{ # Column properties for TableCard.
"header": "A String", # Required. Column heading.
"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
},
],
"buttons": [ # Optional. List of buttons for the card.
{ # The button object that appears at the bottom of a card.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
"title": "A String", # Required. The title of the button.
},
],
},
},
],
"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
# session when this intent is matched.
"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
"A String",
],
"priority": 42, # The priority of this intent. Higher numbers represent higher
# priorities.
#
# - If the supplied value is unspecified or 0, the service
# translates the value to 500,000, which corresponds to the
# `Normal` priority in the console.
# - If the supplied value is negative, the intent is ignored
# in runtime detect intent requests.
"rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
# followup intents. It identifies the correct followup intents chain for
# this intent. We populate this field only in the output.
#
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"trainingPhrases": [ # Optional. The collection of examples that the agent is
# trained on.
{ # Represents an example that the agent is trained on.
"parts": [ # Required. The ordered list of training phrase parts.
# The parts are concatenated in order to form the training phrase.
#
# Note: The API does not automatically annotate training phrases like the
# Dialogflow Console does.
#
# Note: Do not forget to include whitespace at part boundaries,
# so the training phrase is well formatted when the parts are concatenated.
#
# If the training phrase does not need to be annotated with parameters,
# you just need a single part with only the Part.text field set.
#
# If you want to annotate the training phrase, you must create multiple
# parts, where the fields of each part are populated in one of two ways:
#
# - `Part.text` is set to a part of the phrase that has no parameters.
# - `Part.text` is set to a part of the phrase that you want to annotate,
# and the `entity_type`, `alias`, and `user_defined` fields are all
# set.
{ # Represents a part of a training phrase.
"alias": "A String", # Optional. The parameter name for the value extracted from the
# annotated part of the example.
# This field is required for annotated parts of the training phrase.
"entityType": "A String", # Optional. The entity type name prefixed with `@`.
# This field is required for annotated parts of the training phrase.
"text": "A String", # Required. The text for this part.
"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
# This field is set to true when the Dialogflow Console is used to
# manually annotate the part. When creating an annotated part with the
# API, you must set this to true.
},
],
"type": "A String", # Required. The type of the training phrase.
"name": "A String", # Output only. The unique identifier of this training phrase.
"timesAddedCount": 42, # Optional. Indicates how many times this example was added to
# the intent. Each time a developer adds an existing sample by editing an
# intent or training, this counter is increased.
},
],
"inputContextNames": [ # Optional. The list of context names required for this intent to be
# triggered.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
"A String",
],
"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
# Note: If `ml_enabled` setting is set to false, then this intent is not
# taken into account during inference in `ML ONLY` match mode. Also,
# auto-markup in the UI is turned off.
# DEPRECATED! Please use `ml_disabled` field instead.
# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
# then the default value is determined as follows:
# - Before April 15th, 2018 the default is:
# ml_enabled = false / ml_disabled = true.
# - After April 15th, 2018 the default is:
# ml_enabled = true / ml_disabled = false.
"action": "A String", # Optional. The name of the action associated with the intent.
# Note: The action name must not contain whitespaces.
"outputContexts": [ # Optional. The collection of contexts that are activated when the intent
# is matched. Context messages in this collection should not set the
# parameters field. Setting the `lifespan_count` to 0 will reset the context
# when the intent is matched.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
{ # Represents a context.
"parameters": { # Optional. The collection of parameters associated with this context.
# Refer to [this
# doc](https://cloud.google.com/dialogflow/docs/intents-actions-parameters)
# for syntax.
"a_key": "", # Properties of the object.
},
"name": "A String", # Required. The unique identifier of the context. Format:
# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,
# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
# ID>/sessions/<Session ID>/contexts/<Context ID>`.
#
# The `Context ID` is always converted to lowercase, may only contain
# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
#
# If `Environment ID` is not specified, we assume default 'draft'
# environment. If `User ID` is not specified, we assume default '-' user.
#
# The following context names are reserved for internal use by Dialogflow.
# You should not use these contexts or create contexts with these names:
#
# * `__system_counters__`
# * `*_id_dialog_context`
# * `*_dialog_params_size`
"lifespanCount": 42, # Optional. The number of conversational query requests after which the
# context expires. If set to `0` (the default) the context expires
# immediately. Contexts expire automatically after 20 minutes if there
# are no matching queries.
},
],
"events": [ # Optional. The collection of event names that trigger the intent.
# If the collection of input contexts is not empty, all of the contexts must
# be present in the active user session for an event to trigger this intent.
# Event names are limited to 50 characters.
"A String",
],
}