docs: update generated docs (#981)
diff --git a/docs/dyn/dialogflow_v2.projects.agent.intents.html b/docs/dyn/dialogflow_v2.projects.agent.intents.html
index 012afa4..f9d6c81 100644
--- a/docs/dyn/dialogflow_v2.projects.agent.intents.html
+++ b/docs/dyn/dialogflow_v2.projects.agent.intents.html
@@ -81,7 +81,7 @@
<code><a href="#batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates/Creates multiple intents in the specified agent.</p>
<p class="toc_element">
- <code><a href="#create">create(parent, body=None, intentView=None, languageCode=None, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent, body=None, languageCode=None, intentView=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an intent in the specified agent.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
@@ -114,58 +114,260 @@
{ # 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.
+ { # An intent categorizes an end-user's intention for one conversation turn. For
+ # each agent, you define many intents, where your combined intents can handle a
+ # complete conversation. When an end-user writes or says something, referred to
+ # as an end-user expression or end-user input, Dialogflow matches the end-user
+ # input to the best intent in your agent. Matching an intent is also known as
+ # intent classification.
+ #
+ # For more information, see the [intent
+ # guide](https://cloud.google.com/dialogflow/docs/intents-overview).
+ "name": "A String", # Optional. The unique identifier of this intent.
+ # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
+ # methods.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
+ "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
+ "displayName": "A String", # Required. The name of this intent.
+ "messages": [ # Optional. The collection of rich messages corresponding to the
+ # `Response` field in the Dialogflow console.
+ { # A rich response message.
+ # Corresponds to the intent `Response` field in the Dialogflow console.
+ # For more information, see
+ # [Rich response
+ # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).
+ "card": { # The card response message. # The card response.
+ "title": "A String", # Optional. The title of the card.
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # 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.
+ },
+ "text": { # The text response message. # The text response.
+ "text": [ # Optional. The collection of the agent's responses.
+ "A String",
+ ],
+ },
+ "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
+ "items": [ # Required. Carousel items.
+ { # An item in the carousel.
+ "description": "A String", # Optional. The body text of the card.
+ "title": "A String", # Required. Title of the carousel item.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ },
+ },
+ ],
+ },
+ "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses 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.
+ "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
+ # speech output. Mutually exclusive with ssml.
+ "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.
+ "displayText": "A String", # Optional. The text to display.
+ },
+ ],
+ },
+ "platform": "A String", # Optional. The platform that this message is intended for.
+ "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
+ "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
+ # Card. Maximum of one line of text.
+ "image": { # The image response message. # Optional. Hero image for the carousel item.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
+ # text.
+ "title": "A String", # Required. Title of the carousel item. Maximum of two 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.
+ },
+ },
+ ],
+ "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
+ # items.
+ },
+ "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The 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.
+ },
+ "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # The button object that appears at the bottom of a card.
+ "title": "A String", # Required. The title of the button.
+ "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.
+ },
+ },
+ ],
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "formattedText": "A String", # Required, unless image is present. The body text of the card.
+ "title": "A String", # Optional. The title of the card.
+ "image": { # The image response message. # Optional. The image for the card.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ },
+ "suggestions": { # The collection of suggestions. # The 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.
+ },
+ ],
+ },
+ "quickReplies": { # The quick replies response message. # The quick replies response.
+ "quickReplies": [ # Optional. The collection of quick replies.
+ "A String",
+ ],
+ "title": "A String", # Optional. The title of the collection of quick replies.
+ },
+ "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "title": "A String", # Required. Title of the card.
+ "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.
+ },
+ ],
+ "subtitle": "A String", # Optional. Subtitle to the title.
+ "image": { # The image response message. # Optional. Image which should be displayed on the card.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ },
+ ],
+ "buttons": [ # Optional. List of buttons for the card.
+ { # The button object that appears at the bottom of a card.
+ "title": "A String", # Required. The title of the button.
+ "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.
+ },
+ },
+ ],
+ },
+ "image": { # The image response message. # The image response.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ "largeImage": { # The image response message. # Optional. Image to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "contentUrl": "A String", # Required. Url where the media is stored.
+ "icon": { # The image response message. # Optional. Icon to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "name": "A String", # Required. Name of media card.
+ "description": "A String", # Optional. Description of media card.
+ },
+ ],
+ "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
+ },
+ "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
+ "title": "A String", # Optional. The overall title of the list.
+ "items": [ # Required. List items.
+ { # An item in the list.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ },
+ "title": "A String", # Required. The title of the list item.
+ "description": "A String", # Optional. The main text describing the item.
+ },
+ ],
+ "subtitle": "A String", # Optional. Subtitle of the list.
+ },
+ "payload": { # A custom platform-specific response.
+ "a_key": "", # Properties of the object.
+ },
+ },
+ ],
"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 150 characters.
"A String",
],
- "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>`.
- "priority": 42, # Optional. 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.
"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.
- "lifespanCount": 42, # Optional. The number of conversational query requests after which the
- # context expires. The default is `0`. If set to `0`, the context expires
- # immediately. Contexts expire automatically after 20 minutes if there
- # are no matching queries.
- "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`
+ { # Dialogflow contexts are similar to natural language context. If a person says
+ # to you "they are orange", you need context in order to understand what "they"
+ # is referring to. Similarly, for Dialogflow to handle an end-user expression
+ # like that, it needs to be provided with context in order to correctly match
+ # an intent.
+ #
+ # Using contexts, you can control the flow of a conversation. You can configure
+ # contexts for an intent by setting input and output contexts, which are
+ # identified by string names. When an intent is matched, any configured output
+ # contexts for that intent become active. While any contexts are active,
+ # Dialogflow is more likely to match intents that are configured with input
+ # contexts that correspond to the currently active contexts.
+ #
+ # For more information about context, see the
+ # [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).
"parameters": { # Optional. The collection of parameters associated with this context.
#
# Depending on your protocol or client library language, this is a
@@ -183,256 +385,53 @@
# - Else: parameter value
"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. The default is `0`. If set to `0`, the context expires
+ # immediately. Contexts expire automatically after 20 minutes if there
+ # are no matching queries.
},
],
- "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",
- ],
"action": "A String", # Optional. The name of the action associated with the intent.
# Note: The action name must not contain whitespaces.
- "name": "A String", # Optional. The unique identifier of this intent.
- # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
- # methods.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "messages": [ # Optional. The collection of rich messages corresponding to the
- # `Response` field in the Dialogflow console.
- { # A rich response message.
- # Corresponds to the intent `Response` field in the Dialogflow console.
- # For more information, see
- # [Rich response
- # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).
- "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
- "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
- "mediaObjects": [ # Required. List of media objects.
- { # Response media object for media content card.
- "name": "A String", # Required. Name of media card.
- "description": "A String", # Optional. Description of media card.
- "contentUrl": "A String", # Required. Url where the media is stored.
- "icon": { # The image response message. # Optional. Icon to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "largeImage": { # The image response message. # Optional. Image to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- },
- ],
- },
- "image": { # The image response message. # The image response.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "payload": { # A custom platform-specific response.
- "a_key": "", # Properties of the object.
- },
- "text": { # The text response message. # The text response.
- "text": [ # Optional. The collection of the agent's responses.
- "A String",
- ],
- },
- "platform": "A String", # Optional. The platform that this message is intended for.
- "suggestions": { # The collection of suggestions. # The 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.
- },
- ],
- },
- "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
- "subtitle": "A String", # Optional. Subtitle of the list.
- "items": [ # Required. List items.
- { # An item in the list.
- "title": "A String", # Required. The title of the list item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "description": "A String", # Optional. The main text describing the item.
- "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.
- },
- },
- ],
- "title": "A String", # Optional. The overall title of the list.
- },
- "quickReplies": { # The quick replies response message. # The quick replies response.
- "title": "A String", # Optional. The title of the collection of quick replies.
- "quickReplies": [ # Optional. The collection of quick replies.
- "A String",
- ],
- },
- "card": { # The card response message. # The card response.
- "imageUri": "A String", # Optional. The public URI to an image file for the card.
- "title": "A String", # Optional. The title of the card.
- "buttons": [ # Optional. The collection of card buttons.
- { # 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.
- },
- ],
- "subtitle": "A String", # Optional. The subtitle of the card.
- },
- "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
- "title": "A String", # Optional. The title of the card.
- "image": { # The image response message. # Optional. The image for the card.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "formattedText": "A String", # Required, unless image is present. The body text of the card.
- "buttons": [ # Optional. The collection of card buttons.
- { # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
- "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.
- },
- },
- ],
- "subtitle": "A String", # Optional. The subtitle of the card.
- },
- "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
- "title": "A String", # Required. Title of the card.
- "rows": [ # Optional. Rows in this table of data.
- { # Row of TableCard.
- "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
- "cells": [ # Optional. List of cells that make up this row.
- { # Cell of TableCardRow.
- "text": "A String", # Required. Text in this cell.
- },
- ],
- },
- ],
- "subtitle": "A String", # Optional. Subtitle to the title.
- "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.
- },
- ],
- "image": { # The image response message. # Optional. Image which should be displayed on the card.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "buttons": [ # Optional. List of buttons for the card.
- { # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
- "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.
- },
- },
- ],
- },
- "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
- "items": [ # Required. Carousel items.
- { # An item in the carousel.
- "description": "A String", # Optional. The body text of the card.
- "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.
- },
- "title": "A String", # Required. Title of the carousel item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- },
- ],
- },
- "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.
- # or website associated with this agent.
- "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
- "uri": "A String", # Required. The URI of the app or site to open when the user taps the
- # suggestion chip.
- },
- "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
- "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
- "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
- # the URL. Defaults to opening via web browser.
- "url": "A String", # Required. URL
- },
- "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
- # Card. Maximum of one line of text.
- "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
- "image": { # The image response message. # Optional. Hero image for the carousel item.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
- # text.
- },
- ],
- "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
- # items.
- },
- "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses 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.
- "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
- # speech output. Mutually exclusive with ssml.
- "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.
- "displayText": "A String", # Optional. The text to display.
- },
- ],
- },
- },
- ],
- "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
- "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",
- ],
- "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>`.
- },
- ],
+ "priority": 42, # Optional. 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>`.
- "displayName": "A String", # Required. The name of this 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.
- "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
+ "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.
+ "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "followupIntentName": "A String", # The unique identifier of the followup intent.
+ # 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.
@@ -440,7 +439,6 @@
"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.
- "type": "A String", # Required. The type of the training phrase.
"parts": [ # Required. The ordered list of training phrase parts.
# The parts are concatenated in order to form the training phrase.
#
@@ -461,9 +459,6 @@
# and the `entity_type`, `alias`, and `user_defined` fields are all
# set.
{ # Represents a part of a training phrase.
- "text": "A String", # Required. The text for this part.
- "entityType": "A String", # Optional. The entity type name prefixed with `@`.
- # This field is required for annotated parts of the 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.
@@ -471,12 +466,37 @@
# 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.
+ "text": "A String", # Required. The text for this part.
+ "entityType": "A String", # Optional. The entity type name prefixed with `@`.
+ # This field is required for annotated parts of the training phrase.
},
],
+ "type": "A String", # Required. The type of the training phrase.
},
],
+ "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",
+ ],
+ "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.
"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
# session when this intent is matched.
+ "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>`.
+ "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",
+ ],
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
"value": "A String", # Optional. The definition of the parameter value. It can be:
@@ -487,22 +507,22 @@
# - a parameter value from some context defined as
# `#context_name.parameter_name`.
"displayName": "A String", # Required. The name of the parameter.
- "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.
- "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",
- ],
"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
# whether the intent cannot be completed without collecting the parameter
# value.
+ "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
+ "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.
"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`.
"name": "A String", # The unique identifier of this parameter.
- "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
+ "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",
+ ],
},
],
},
@@ -519,16 +539,6 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "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}`.
@@ -539,16 +549,26 @@
#
# 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).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "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.
"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.
},
],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "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.
+ },
+ "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.
},
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
@@ -575,64 +595,267 @@
The object takes the form of:
{
- "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://".
- "intentView": "A String", # Optional. The resource view to apply to the returned intent.
+ "languageCode": "A String", # Optional. The language used to access language-specific data.
+ # If not specified, the agent's default language is used.
+ # For more information, see
+ # [Multilingual intent and entity
+ # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
"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.
+ { # An intent categorizes an end-user's intention for one conversation turn. For
+ # each agent, you define many intents, where your combined intents can handle a
+ # complete conversation. When an end-user writes or says something, referred to
+ # as an end-user expression or end-user input, Dialogflow matches the end-user
+ # input to the best intent in your agent. Matching an intent is also known as
+ # intent classification.
+ #
+ # For more information, see the [intent
+ # guide](https://cloud.google.com/dialogflow/docs/intents-overview).
+ "name": "A String", # Optional. The unique identifier of this intent.
+ # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
+ # methods.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
+ "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
+ "displayName": "A String", # Required. The name of this intent.
+ "messages": [ # Optional. The collection of rich messages corresponding to the
+ # `Response` field in the Dialogflow console.
+ { # A rich response message.
+ # Corresponds to the intent `Response` field in the Dialogflow console.
+ # For more information, see
+ # [Rich response
+ # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).
+ "card": { # The card response message. # The card response.
+ "title": "A String", # Optional. The title of the card.
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # 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.
+ },
+ "text": { # The text response message. # The text response.
+ "text": [ # Optional. The collection of the agent's responses.
+ "A String",
+ ],
+ },
+ "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
+ "items": [ # Required. Carousel items.
+ { # An item in the carousel.
+ "description": "A String", # Optional. The body text of the card.
+ "title": "A String", # Required. Title of the carousel item.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ },
+ },
+ ],
+ },
+ "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses 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.
+ "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
+ # speech output. Mutually exclusive with ssml.
+ "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.
+ "displayText": "A String", # Optional. The text to display.
+ },
+ ],
+ },
+ "platform": "A String", # Optional. The platform that this message is intended for.
+ "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
+ "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
+ # Card. Maximum of one line of text.
+ "image": { # The image response message. # Optional. Hero image for the carousel item.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
+ # text.
+ "title": "A String", # Required. Title of the carousel item. Maximum of two 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.
+ },
+ },
+ ],
+ "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
+ # items.
+ },
+ "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The 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.
+ },
+ "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # The button object that appears at the bottom of a card.
+ "title": "A String", # Required. The title of the button.
+ "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.
+ },
+ },
+ ],
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "formattedText": "A String", # Required, unless image is present. The body text of the card.
+ "title": "A String", # Optional. The title of the card.
+ "image": { # The image response message. # Optional. The image for the card.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ },
+ "suggestions": { # The collection of suggestions. # The 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.
+ },
+ ],
+ },
+ "quickReplies": { # The quick replies response message. # The quick replies response.
+ "quickReplies": [ # Optional. The collection of quick replies.
+ "A String",
+ ],
+ "title": "A String", # Optional. The title of the collection of quick replies.
+ },
+ "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "title": "A String", # Required. Title of the card.
+ "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.
+ },
+ ],
+ "subtitle": "A String", # Optional. Subtitle to the title.
+ "image": { # The image response message. # Optional. Image which should be displayed on the card.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ },
+ ],
+ "buttons": [ # Optional. List of buttons for the card.
+ { # The button object that appears at the bottom of a card.
+ "title": "A String", # Required. The title of the button.
+ "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.
+ },
+ },
+ ],
+ },
+ "image": { # The image response message. # The image response.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ "largeImage": { # The image response message. # Optional. Image to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "contentUrl": "A String", # Required. Url where the media is stored.
+ "icon": { # The image response message. # Optional. Icon to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "name": "A String", # Required. Name of media card.
+ "description": "A String", # Optional. Description of media card.
+ },
+ ],
+ "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
+ },
+ "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
+ "title": "A String", # Optional. The overall title of the list.
+ "items": [ # Required. List items.
+ { # An item in the list.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ },
+ "title": "A String", # Required. The title of the list item.
+ "description": "A String", # Optional. The main text describing the item.
+ },
+ ],
+ "subtitle": "A String", # Optional. Subtitle of the list.
+ },
+ "payload": { # A custom platform-specific response.
+ "a_key": "", # Properties of the object.
+ },
+ },
+ ],
"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 150 characters.
"A String",
],
- "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>`.
- "priority": 42, # Optional. 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.
"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.
- "lifespanCount": 42, # Optional. The number of conversational query requests after which the
- # context expires. The default is `0`. If set to `0`, the context expires
- # immediately. Contexts expire automatically after 20 minutes if there
- # are no matching queries.
- "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`
+ { # Dialogflow contexts are similar to natural language context. If a person says
+ # to you "they are orange", you need context in order to understand what "they"
+ # is referring to. Similarly, for Dialogflow to handle an end-user expression
+ # like that, it needs to be provided with context in order to correctly match
+ # an intent.
+ #
+ # Using contexts, you can control the flow of a conversation. You can configure
+ # contexts for an intent by setting input and output contexts, which are
+ # identified by string names. When an intent is matched, any configured output
+ # contexts for that intent become active. While any contexts are active,
+ # Dialogflow is more likely to match intents that are configured with input
+ # contexts that correspond to the currently active contexts.
+ #
+ # For more information about context, see the
+ # [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).
"parameters": { # Optional. The collection of parameters associated with this context.
#
# Depending on your protocol or client library language, this is a
@@ -650,256 +873,53 @@
# - Else: parameter value
"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. The default is `0`. If set to `0`, the context expires
+ # immediately. Contexts expire automatically after 20 minutes if there
+ # are no matching queries.
},
],
- "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",
- ],
"action": "A String", # Optional. The name of the action associated with the intent.
# Note: The action name must not contain whitespaces.
- "name": "A String", # Optional. The unique identifier of this intent.
- # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
- # methods.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "messages": [ # Optional. The collection of rich messages corresponding to the
- # `Response` field in the Dialogflow console.
- { # A rich response message.
- # Corresponds to the intent `Response` field in the Dialogflow console.
- # For more information, see
- # [Rich response
- # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).
- "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
- "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
- "mediaObjects": [ # Required. List of media objects.
- { # Response media object for media content card.
- "name": "A String", # Required. Name of media card.
- "description": "A String", # Optional. Description of media card.
- "contentUrl": "A String", # Required. Url where the media is stored.
- "icon": { # The image response message. # Optional. Icon to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "largeImage": { # The image response message. # Optional. Image to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- },
- ],
- },
- "image": { # The image response message. # The image response.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "payload": { # A custom platform-specific response.
- "a_key": "", # Properties of the object.
- },
- "text": { # The text response message. # The text response.
- "text": [ # Optional. The collection of the agent's responses.
- "A String",
- ],
- },
- "platform": "A String", # Optional. The platform that this message is intended for.
- "suggestions": { # The collection of suggestions. # The 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.
- },
- ],
- },
- "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
- "subtitle": "A String", # Optional. Subtitle of the list.
- "items": [ # Required. List items.
- { # An item in the list.
- "title": "A String", # Required. The title of the list item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "description": "A String", # Optional. The main text describing the item.
- "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.
- },
- },
- ],
- "title": "A String", # Optional. The overall title of the list.
- },
- "quickReplies": { # The quick replies response message. # The quick replies response.
- "title": "A String", # Optional. The title of the collection of quick replies.
- "quickReplies": [ # Optional. The collection of quick replies.
- "A String",
- ],
- },
- "card": { # The card response message. # The card response.
- "imageUri": "A String", # Optional. The public URI to an image file for the card.
- "title": "A String", # Optional. The title of the card.
- "buttons": [ # Optional. The collection of card buttons.
- { # 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.
- },
- ],
- "subtitle": "A String", # Optional. The subtitle of the card.
- },
- "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
- "title": "A String", # Optional. The title of the card.
- "image": { # The image response message. # Optional. The image for the card.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "formattedText": "A String", # Required, unless image is present. The body text of the card.
- "buttons": [ # Optional. The collection of card buttons.
- { # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
- "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.
- },
- },
- ],
- "subtitle": "A String", # Optional. The subtitle of the card.
- },
- "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
- "title": "A String", # Required. Title of the card.
- "rows": [ # Optional. Rows in this table of data.
- { # Row of TableCard.
- "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
- "cells": [ # Optional. List of cells that make up this row.
- { # Cell of TableCardRow.
- "text": "A String", # Required. Text in this cell.
- },
- ],
- },
- ],
- "subtitle": "A String", # Optional. Subtitle to the title.
- "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.
- },
- ],
- "image": { # The image response message. # Optional. Image which should be displayed on the card.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "buttons": [ # Optional. List of buttons for the card.
- { # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
- "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.
- },
- },
- ],
- },
- "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
- "items": [ # Required. Carousel items.
- { # An item in the carousel.
- "description": "A String", # Optional. The body text of the card.
- "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.
- },
- "title": "A String", # Required. Title of the carousel item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- },
- ],
- },
- "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.
- # or website associated with this agent.
- "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
- "uri": "A String", # Required. The URI of the app or site to open when the user taps the
- # suggestion chip.
- },
- "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
- "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
- "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
- # the URL. Defaults to opening via web browser.
- "url": "A String", # Required. URL
- },
- "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
- # Card. Maximum of one line of text.
- "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
- "image": { # The image response message. # Optional. Hero image for the carousel item.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
- # text.
- },
- ],
- "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
- # items.
- },
- "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses 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.
- "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
- # speech output. Mutually exclusive with ssml.
- "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.
- "displayText": "A String", # Optional. The text to display.
- },
- ],
- },
- },
- ],
- "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
- "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",
- ],
- "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>`.
- },
- ],
+ "priority": 42, # Optional. 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>`.
- "displayName": "A String", # Required. The name of this 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.
- "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
+ "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.
+ "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "followupIntentName": "A String", # The unique identifier of the followup intent.
+ # 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.
@@ -907,7 +927,6 @@
"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.
- "type": "A String", # Required. The type of the training phrase.
"parts": [ # Required. The ordered list of training phrase parts.
# The parts are concatenated in order to form the training phrase.
#
@@ -928,9 +947,6 @@
# and the `entity_type`, `alias`, and `user_defined` fields are all
# set.
{ # Represents a part of a training phrase.
- "text": "A String", # Required. The text for this part.
- "entityType": "A String", # Optional. The entity type name prefixed with `@`.
- # This field is required for annotated parts of the 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.
@@ -938,12 +954,37 @@
# 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.
+ "text": "A String", # Required. The text for this part.
+ "entityType": "A String", # Optional. The entity type name prefixed with `@`.
+ # This field is required for annotated parts of the training phrase.
},
],
+ "type": "A String", # Required. The type of the training phrase.
},
],
+ "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",
+ ],
+ "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.
"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
# session when this intent is matched.
+ "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>`.
+ "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",
+ ],
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
"value": "A String", # Optional. The definition of the parameter value. It can be:
@@ -954,33 +995,32 @@
# - a parameter value from some context defined as
# `#context_name.parameter_name`.
"displayName": "A String", # Required. The name of the parameter.
- "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.
- "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",
- ],
"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
# whether the intent cannot be completed without collecting the parameter
# value.
+ "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
+ "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.
"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`.
"name": "A String", # The unique identifier of this parameter.
- "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
+ "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",
+ ],
},
],
},
],
},
- "languageCode": "A String", # Optional. The language used to access language-specific data.
- # If not specified, the agent's default language is used.
- # For more information, see
- # [Multilingual intent and entity
- # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
+ "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://".
"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.
@@ -993,16 +1033,6 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "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}`.
@@ -1013,16 +1043,26 @@
#
# 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).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "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.
"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.
},
],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "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.
+ },
+ "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.
},
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
@@ -1037,7 +1077,7 @@
</div>
<div class="method">
- <code class="details" id="create">create(parent, body=None, intentView=None, languageCode=None, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent, body=None, languageCode=None, intentView=None, x__xgafv=None)</code>
<pre>Creates an intent in the specified agent.
Args:
@@ -1046,58 +1086,260 @@
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.
+{ # An intent categorizes an end-user's intention for one conversation turn. For
+ # each agent, you define many intents, where your combined intents can handle a
+ # complete conversation. When an end-user writes or says something, referred to
+ # as an end-user expression or end-user input, Dialogflow matches the end-user
+ # input to the best intent in your agent. Matching an intent is also known as
+ # intent classification.
+ #
+ # For more information, see the [intent
+ # guide](https://cloud.google.com/dialogflow/docs/intents-overview).
+ "name": "A String", # Optional. The unique identifier of this intent.
+ # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
+ # methods.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
+ "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
+ "displayName": "A String", # Required. The name of this intent.
+ "messages": [ # Optional. The collection of rich messages corresponding to the
+ # `Response` field in the Dialogflow console.
+ { # A rich response message.
+ # Corresponds to the intent `Response` field in the Dialogflow console.
+ # For more information, see
+ # [Rich response
+ # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).
+ "card": { # The card response message. # The card response.
+ "title": "A String", # Optional. The title of the card.
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # 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.
+ },
+ "text": { # The text response message. # The text response.
+ "text": [ # Optional. The collection of the agent's responses.
+ "A String",
+ ],
+ },
+ "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
+ "items": [ # Required. Carousel items.
+ { # An item in the carousel.
+ "description": "A String", # Optional. The body text of the card.
+ "title": "A String", # Required. Title of the carousel item.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ },
+ },
+ ],
+ },
+ "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses 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.
+ "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
+ # speech output. Mutually exclusive with ssml.
+ "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.
+ "displayText": "A String", # Optional. The text to display.
+ },
+ ],
+ },
+ "platform": "A String", # Optional. The platform that this message is intended for.
+ "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
+ "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
+ # Card. Maximum of one line of text.
+ "image": { # The image response message. # Optional. Hero image for the carousel item.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
+ # text.
+ "title": "A String", # Required. Title of the carousel item. Maximum of two 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.
+ },
+ },
+ ],
+ "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
+ # items.
+ },
+ "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The 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.
+ },
+ "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # The button object that appears at the bottom of a card.
+ "title": "A String", # Required. The title of the button.
+ "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.
+ },
+ },
+ ],
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "formattedText": "A String", # Required, unless image is present. The body text of the card.
+ "title": "A String", # Optional. The title of the card.
+ "image": { # The image response message. # Optional. The image for the card.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ },
+ "suggestions": { # The collection of suggestions. # The 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.
+ },
+ ],
+ },
+ "quickReplies": { # The quick replies response message. # The quick replies response.
+ "quickReplies": [ # Optional. The collection of quick replies.
+ "A String",
+ ],
+ "title": "A String", # Optional. The title of the collection of quick replies.
+ },
+ "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "title": "A String", # Required. Title of the card.
+ "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.
+ },
+ ],
+ "subtitle": "A String", # Optional. Subtitle to the title.
+ "image": { # The image response message. # Optional. Image which should be displayed on the card.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ },
+ ],
+ "buttons": [ # Optional. List of buttons for the card.
+ { # The button object that appears at the bottom of a card.
+ "title": "A String", # Required. The title of the button.
+ "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.
+ },
+ },
+ ],
+ },
+ "image": { # The image response message. # The image response.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ "largeImage": { # The image response message. # Optional. Image to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "contentUrl": "A String", # Required. Url where the media is stored.
+ "icon": { # The image response message. # Optional. Icon to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "name": "A String", # Required. Name of media card.
+ "description": "A String", # Optional. Description of media card.
+ },
+ ],
+ "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
+ },
+ "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
+ "title": "A String", # Optional. The overall title of the list.
+ "items": [ # Required. List items.
+ { # An item in the list.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ },
+ "title": "A String", # Required. The title of the list item.
+ "description": "A String", # Optional. The main text describing the item.
+ },
+ ],
+ "subtitle": "A String", # Optional. Subtitle of the list.
+ },
+ "payload": { # A custom platform-specific response.
+ "a_key": "", # Properties of the object.
+ },
+ },
+ ],
"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 150 characters.
"A String",
],
- "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>`.
- "priority": 42, # Optional. 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.
"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.
- "lifespanCount": 42, # Optional. The number of conversational query requests after which the
- # context expires. The default is `0`. If set to `0`, the context expires
- # immediately. Contexts expire automatically after 20 minutes if there
- # are no matching queries.
- "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`
+ { # Dialogflow contexts are similar to natural language context. If a person says
+ # to you "they are orange", you need context in order to understand what "they"
+ # is referring to. Similarly, for Dialogflow to handle an end-user expression
+ # like that, it needs to be provided with context in order to correctly match
+ # an intent.
+ #
+ # Using contexts, you can control the flow of a conversation. You can configure
+ # contexts for an intent by setting input and output contexts, which are
+ # identified by string names. When an intent is matched, any configured output
+ # contexts for that intent become active. While any contexts are active,
+ # Dialogflow is more likely to match intents that are configured with input
+ # contexts that correspond to the currently active contexts.
+ #
+ # For more information about context, see the
+ # [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).
"parameters": { # Optional. The collection of parameters associated with this context.
#
# Depending on your protocol or client library language, this is a
@@ -1115,256 +1357,53 @@
# - Else: parameter value
"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. The default is `0`. If set to `0`, the context expires
+ # immediately. Contexts expire automatically after 20 minutes if there
+ # are no matching queries.
},
],
- "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",
- ],
"action": "A String", # Optional. The name of the action associated with the intent.
# Note: The action name must not contain whitespaces.
- "name": "A String", # Optional. The unique identifier of this intent.
- # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
- # methods.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "messages": [ # Optional. The collection of rich messages corresponding to the
- # `Response` field in the Dialogflow console.
- { # A rich response message.
- # Corresponds to the intent `Response` field in the Dialogflow console.
- # For more information, see
- # [Rich response
- # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).
- "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
- "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
- "mediaObjects": [ # Required. List of media objects.
- { # Response media object for media content card.
- "name": "A String", # Required. Name of media card.
- "description": "A String", # Optional. Description of media card.
- "contentUrl": "A String", # Required. Url where the media is stored.
- "icon": { # The image response message. # Optional. Icon to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "largeImage": { # The image response message. # Optional. Image to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- },
- ],
- },
- "image": { # The image response message. # The image response.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "payload": { # A custom platform-specific response.
- "a_key": "", # Properties of the object.
- },
- "text": { # The text response message. # The text response.
- "text": [ # Optional. The collection of the agent's responses.
- "A String",
- ],
- },
- "platform": "A String", # Optional. The platform that this message is intended for.
- "suggestions": { # The collection of suggestions. # The 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.
- },
- ],
- },
- "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
- "subtitle": "A String", # Optional. Subtitle of the list.
- "items": [ # Required. List items.
- { # An item in the list.
- "title": "A String", # Required. The title of the list item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "description": "A String", # Optional. The main text describing the item.
- "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.
- },
- },
- ],
- "title": "A String", # Optional. The overall title of the list.
- },
- "quickReplies": { # The quick replies response message. # The quick replies response.
- "title": "A String", # Optional. The title of the collection of quick replies.
- "quickReplies": [ # Optional. The collection of quick replies.
- "A String",
- ],
- },
- "card": { # The card response message. # The card response.
- "imageUri": "A String", # Optional. The public URI to an image file for the card.
- "title": "A String", # Optional. The title of the card.
- "buttons": [ # Optional. The collection of card buttons.
- { # 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.
- },
- ],
- "subtitle": "A String", # Optional. The subtitle of the card.
- },
- "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
- "title": "A String", # Optional. The title of the card.
- "image": { # The image response message. # Optional. The image for the card.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "formattedText": "A String", # Required, unless image is present. The body text of the card.
- "buttons": [ # Optional. The collection of card buttons.
- { # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
- "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.
- },
- },
- ],
- "subtitle": "A String", # Optional. The subtitle of the card.
- },
- "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
- "title": "A String", # Required. Title of the card.
- "rows": [ # Optional. Rows in this table of data.
- { # Row of TableCard.
- "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
- "cells": [ # Optional. List of cells that make up this row.
- { # Cell of TableCardRow.
- "text": "A String", # Required. Text in this cell.
- },
- ],
- },
- ],
- "subtitle": "A String", # Optional. Subtitle to the title.
- "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.
- },
- ],
- "image": { # The image response message. # Optional. Image which should be displayed on the card.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "buttons": [ # Optional. List of buttons for the card.
- { # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
- "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.
- },
- },
- ],
- },
- "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
- "items": [ # Required. Carousel items.
- { # An item in the carousel.
- "description": "A String", # Optional. The body text of the card.
- "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.
- },
- "title": "A String", # Required. Title of the carousel item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- },
- ],
- },
- "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.
- # or website associated with this agent.
- "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
- "uri": "A String", # Required. The URI of the app or site to open when the user taps the
- # suggestion chip.
- },
- "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
- "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
- "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
- # the URL. Defaults to opening via web browser.
- "url": "A String", # Required. URL
- },
- "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
- # Card. Maximum of one line of text.
- "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
- "image": { # The image response message. # Optional. Hero image for the carousel item.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
- # text.
- },
- ],
- "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
- # items.
- },
- "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses 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.
- "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
- # speech output. Mutually exclusive with ssml.
- "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.
- "displayText": "A String", # Optional. The text to display.
- },
- ],
- },
- },
- ],
- "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
- "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",
- ],
- "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>`.
- },
- ],
+ "priority": 42, # Optional. 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>`.
- "displayName": "A String", # Required. The name of this 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.
- "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
+ "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.
+ "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "followupIntentName": "A String", # The unique identifier of the followup intent.
+ # 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.
@@ -1372,7 +1411,6 @@
"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.
- "type": "A String", # Required. The type of the training phrase.
"parts": [ # Required. The ordered list of training phrase parts.
# The parts are concatenated in order to form the training phrase.
#
@@ -1393,9 +1431,6 @@
# and the `entity_type`, `alias`, and `user_defined` fields are all
# set.
{ # Represents a part of a training phrase.
- "text": "A String", # Required. The text for this part.
- "entityType": "A String", # Optional. The entity type name prefixed with `@`.
- # This field is required for annotated parts of the 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.
@@ -1403,12 +1438,37 @@
# 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.
+ "text": "A String", # Required. The text for this part.
+ "entityType": "A String", # Optional. The entity type name prefixed with `@`.
+ # This field is required for annotated parts of the training phrase.
},
],
+ "type": "A String", # Required. The type of the training phrase.
},
],
+ "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",
+ ],
+ "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.
"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
# session when this intent is matched.
+ "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>`.
+ "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",
+ ],
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
"value": "A String", # Optional. The definition of the parameter value. It can be:
@@ -1419,32 +1479,32 @@
# - a parameter value from some context defined as
# `#context_name.parameter_name`.
"displayName": "A String", # Required. The name of the parameter.
- "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.
- "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",
- ],
"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
# whether the intent cannot be completed without collecting the parameter
# value.
+ "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
+ "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.
"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`.
"name": "A String", # The unique identifier of this parameter.
- "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
+ "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",
+ ],
},
],
}
- intentView: string, Optional. The resource view to apply to the returned intent.
languageCode: string, Optional. The language used to access language-specific data.
If not specified, the agent's default language is used.
For more information, see
[Multilingual intent and entity
data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
+ intentView: string, Optional. The resource view to apply to the returned intent.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -1453,58 +1513,260 @@
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.
+ { # An intent categorizes an end-user's intention for one conversation turn. For
+ # each agent, you define many intents, where your combined intents can handle a
+ # complete conversation. When an end-user writes or says something, referred to
+ # as an end-user expression or end-user input, Dialogflow matches the end-user
+ # input to the best intent in your agent. Matching an intent is also known as
+ # intent classification.
+ #
+ # For more information, see the [intent
+ # guide](https://cloud.google.com/dialogflow/docs/intents-overview).
+ "name": "A String", # Optional. The unique identifier of this intent.
+ # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
+ # methods.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
+ "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
+ "displayName": "A String", # Required. The name of this intent.
+ "messages": [ # Optional. The collection of rich messages corresponding to the
+ # `Response` field in the Dialogflow console.
+ { # A rich response message.
+ # Corresponds to the intent `Response` field in the Dialogflow console.
+ # For more information, see
+ # [Rich response
+ # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).
+ "card": { # The card response message. # The card response.
+ "title": "A String", # Optional. The title of the card.
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # 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.
+ },
+ "text": { # The text response message. # The text response.
+ "text": [ # Optional. The collection of the agent's responses.
+ "A String",
+ ],
+ },
+ "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
+ "items": [ # Required. Carousel items.
+ { # An item in the carousel.
+ "description": "A String", # Optional. The body text of the card.
+ "title": "A String", # Required. Title of the carousel item.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ },
+ },
+ ],
+ },
+ "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses 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.
+ "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
+ # speech output. Mutually exclusive with ssml.
+ "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.
+ "displayText": "A String", # Optional. The text to display.
+ },
+ ],
+ },
+ "platform": "A String", # Optional. The platform that this message is intended for.
+ "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
+ "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
+ # Card. Maximum of one line of text.
+ "image": { # The image response message. # Optional. Hero image for the carousel item.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
+ # text.
+ "title": "A String", # Required. Title of the carousel item. Maximum of two 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.
+ },
+ },
+ ],
+ "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
+ # items.
+ },
+ "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The 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.
+ },
+ "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # The button object that appears at the bottom of a card.
+ "title": "A String", # Required. The title of the button.
+ "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.
+ },
+ },
+ ],
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "formattedText": "A String", # Required, unless image is present. The body text of the card.
+ "title": "A String", # Optional. The title of the card.
+ "image": { # The image response message. # Optional. The image for the card.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ },
+ "suggestions": { # The collection of suggestions. # The 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.
+ },
+ ],
+ },
+ "quickReplies": { # The quick replies response message. # The quick replies response.
+ "quickReplies": [ # Optional. The collection of quick replies.
+ "A String",
+ ],
+ "title": "A String", # Optional. The title of the collection of quick replies.
+ },
+ "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "title": "A String", # Required. Title of the card.
+ "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.
+ },
+ ],
+ "subtitle": "A String", # Optional. Subtitle to the title.
+ "image": { # The image response message. # Optional. Image which should be displayed on the card.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ },
+ ],
+ "buttons": [ # Optional. List of buttons for the card.
+ { # The button object that appears at the bottom of a card.
+ "title": "A String", # Required. The title of the button.
+ "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.
+ },
+ },
+ ],
+ },
+ "image": { # The image response message. # The image response.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ "largeImage": { # The image response message. # Optional. Image to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "contentUrl": "A String", # Required. Url where the media is stored.
+ "icon": { # The image response message. # Optional. Icon to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "name": "A String", # Required. Name of media card.
+ "description": "A String", # Optional. Description of media card.
+ },
+ ],
+ "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
+ },
+ "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
+ "title": "A String", # Optional. The overall title of the list.
+ "items": [ # Required. List items.
+ { # An item in the list.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ },
+ "title": "A String", # Required. The title of the list item.
+ "description": "A String", # Optional. The main text describing the item.
+ },
+ ],
+ "subtitle": "A String", # Optional. Subtitle of the list.
+ },
+ "payload": { # A custom platform-specific response.
+ "a_key": "", # Properties of the object.
+ },
+ },
+ ],
"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 150 characters.
"A String",
],
- "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>`.
- "priority": 42, # Optional. 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.
"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.
- "lifespanCount": 42, # Optional. The number of conversational query requests after which the
- # context expires. The default is `0`. If set to `0`, the context expires
- # immediately. Contexts expire automatically after 20 minutes if there
- # are no matching queries.
- "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`
+ { # Dialogflow contexts are similar to natural language context. If a person says
+ # to you "they are orange", you need context in order to understand what "they"
+ # is referring to. Similarly, for Dialogflow to handle an end-user expression
+ # like that, it needs to be provided with context in order to correctly match
+ # an intent.
+ #
+ # Using contexts, you can control the flow of a conversation. You can configure
+ # contexts for an intent by setting input and output contexts, which are
+ # identified by string names. When an intent is matched, any configured output
+ # contexts for that intent become active. While any contexts are active,
+ # Dialogflow is more likely to match intents that are configured with input
+ # contexts that correspond to the currently active contexts.
+ #
+ # For more information about context, see the
+ # [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).
"parameters": { # Optional. The collection of parameters associated with this context.
#
# Depending on your protocol or client library language, this is a
@@ -1522,256 +1784,53 @@
# - Else: parameter value
"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. The default is `0`. If set to `0`, the context expires
+ # immediately. Contexts expire automatically after 20 minutes if there
+ # are no matching queries.
},
],
- "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",
- ],
"action": "A String", # Optional. The name of the action associated with the intent.
# Note: The action name must not contain whitespaces.
- "name": "A String", # Optional. The unique identifier of this intent.
- # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
- # methods.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "messages": [ # Optional. The collection of rich messages corresponding to the
- # `Response` field in the Dialogflow console.
- { # A rich response message.
- # Corresponds to the intent `Response` field in the Dialogflow console.
- # For more information, see
- # [Rich response
- # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).
- "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
- "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
- "mediaObjects": [ # Required. List of media objects.
- { # Response media object for media content card.
- "name": "A String", # Required. Name of media card.
- "description": "A String", # Optional. Description of media card.
- "contentUrl": "A String", # Required. Url where the media is stored.
- "icon": { # The image response message. # Optional. Icon to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "largeImage": { # The image response message. # Optional. Image to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- },
- ],
- },
- "image": { # The image response message. # The image response.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "payload": { # A custom platform-specific response.
- "a_key": "", # Properties of the object.
- },
- "text": { # The text response message. # The text response.
- "text": [ # Optional. The collection of the agent's responses.
- "A String",
- ],
- },
- "platform": "A String", # Optional. The platform that this message is intended for.
- "suggestions": { # The collection of suggestions. # The 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.
- },
- ],
- },
- "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
- "subtitle": "A String", # Optional. Subtitle of the list.
- "items": [ # Required. List items.
- { # An item in the list.
- "title": "A String", # Required. The title of the list item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "description": "A String", # Optional. The main text describing the item.
- "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.
- },
- },
- ],
- "title": "A String", # Optional. The overall title of the list.
- },
- "quickReplies": { # The quick replies response message. # The quick replies response.
- "title": "A String", # Optional. The title of the collection of quick replies.
- "quickReplies": [ # Optional. The collection of quick replies.
- "A String",
- ],
- },
- "card": { # The card response message. # The card response.
- "imageUri": "A String", # Optional. The public URI to an image file for the card.
- "title": "A String", # Optional. The title of the card.
- "buttons": [ # Optional. The collection of card buttons.
- { # 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.
- },
- ],
- "subtitle": "A String", # Optional. The subtitle of the card.
- },
- "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
- "title": "A String", # Optional. The title of the card.
- "image": { # The image response message. # Optional. The image for the card.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "formattedText": "A String", # Required, unless image is present. The body text of the card.
- "buttons": [ # Optional. The collection of card buttons.
- { # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
- "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.
- },
- },
- ],
- "subtitle": "A String", # Optional. The subtitle of the card.
- },
- "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
- "title": "A String", # Required. Title of the card.
- "rows": [ # Optional. Rows in this table of data.
- { # Row of TableCard.
- "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
- "cells": [ # Optional. List of cells that make up this row.
- { # Cell of TableCardRow.
- "text": "A String", # Required. Text in this cell.
- },
- ],
- },
- ],
- "subtitle": "A String", # Optional. Subtitle to the title.
- "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.
- },
- ],
- "image": { # The image response message. # Optional. Image which should be displayed on the card.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "buttons": [ # Optional. List of buttons for the card.
- { # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
- "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.
- },
- },
- ],
- },
- "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
- "items": [ # Required. Carousel items.
- { # An item in the carousel.
- "description": "A String", # Optional. The body text of the card.
- "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.
- },
- "title": "A String", # Required. Title of the carousel item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- },
- ],
- },
- "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.
- # or website associated with this agent.
- "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
- "uri": "A String", # Required. The URI of the app or site to open when the user taps the
- # suggestion chip.
- },
- "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
- "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
- "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
- # the URL. Defaults to opening via web browser.
- "url": "A String", # Required. URL
- },
- "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
- # Card. Maximum of one line of text.
- "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
- "image": { # The image response message. # Optional. Hero image for the carousel item.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
- # text.
- },
- ],
- "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
- # items.
- },
- "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses 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.
- "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
- # speech output. Mutually exclusive with ssml.
- "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.
- "displayText": "A String", # Optional. The text to display.
- },
- ],
- },
- },
- ],
- "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
- "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",
- ],
- "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>`.
- },
- ],
+ "priority": 42, # Optional. 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>`.
- "displayName": "A String", # Required. The name of this 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.
- "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
+ "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.
+ "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "followupIntentName": "A String", # The unique identifier of the followup intent.
+ # 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.
@@ -1779,7 +1838,6 @@
"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.
- "type": "A String", # Required. The type of the training phrase.
"parts": [ # Required. The ordered list of training phrase parts.
# The parts are concatenated in order to form the training phrase.
#
@@ -1800,9 +1858,6 @@
# and the `entity_type`, `alias`, and `user_defined` fields are all
# set.
{ # Represents a part of a training phrase.
- "text": "A String", # Required. The text for this part.
- "entityType": "A String", # Optional. The entity type name prefixed with `@`.
- # This field is required for annotated parts of the 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.
@@ -1810,12 +1865,37 @@
# 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.
+ "text": "A String", # Required. The text for this part.
+ "entityType": "A String", # Optional. The entity type name prefixed with `@`.
+ # This field is required for annotated parts of the training phrase.
},
],
+ "type": "A String", # Required. The type of the training phrase.
},
],
+ "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",
+ ],
+ "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.
"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
# session when this intent is matched.
+ "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>`.
+ "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",
+ ],
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
"value": "A String", # Optional. The definition of the parameter value. It can be:
@@ -1826,22 +1906,22 @@
# - a parameter value from some context defined as
# `#context_name.parameter_name`.
"displayName": "A String", # Required. The name of the parameter.
- "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.
- "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",
- ],
"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
# whether the intent cannot be completed without collecting the parameter
# value.
+ "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
+ "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.
"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`.
"name": "A String", # The unique identifier of this parameter.
- "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
+ "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",
+ ],
},
],
}</pre>
@@ -1896,58 +1976,260 @@
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.
+ { # An intent categorizes an end-user's intention for one conversation turn. For
+ # each agent, you define many intents, where your combined intents can handle a
+ # complete conversation. When an end-user writes or says something, referred to
+ # as an end-user expression or end-user input, Dialogflow matches the end-user
+ # input to the best intent in your agent. Matching an intent is also known as
+ # intent classification.
+ #
+ # For more information, see the [intent
+ # guide](https://cloud.google.com/dialogflow/docs/intents-overview).
+ "name": "A String", # Optional. The unique identifier of this intent.
+ # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
+ # methods.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
+ "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
+ "displayName": "A String", # Required. The name of this intent.
+ "messages": [ # Optional. The collection of rich messages corresponding to the
+ # `Response` field in the Dialogflow console.
+ { # A rich response message.
+ # Corresponds to the intent `Response` field in the Dialogflow console.
+ # For more information, see
+ # [Rich response
+ # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).
+ "card": { # The card response message. # The card response.
+ "title": "A String", # Optional. The title of the card.
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # 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.
+ },
+ "text": { # The text response message. # The text response.
+ "text": [ # Optional. The collection of the agent's responses.
+ "A String",
+ ],
+ },
+ "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
+ "items": [ # Required. Carousel items.
+ { # An item in the carousel.
+ "description": "A String", # Optional. The body text of the card.
+ "title": "A String", # Required. Title of the carousel item.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ },
+ },
+ ],
+ },
+ "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses 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.
+ "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
+ # speech output. Mutually exclusive with ssml.
+ "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.
+ "displayText": "A String", # Optional. The text to display.
+ },
+ ],
+ },
+ "platform": "A String", # Optional. The platform that this message is intended for.
+ "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
+ "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
+ # Card. Maximum of one line of text.
+ "image": { # The image response message. # Optional. Hero image for the carousel item.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
+ # text.
+ "title": "A String", # Required. Title of the carousel item. Maximum of two 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.
+ },
+ },
+ ],
+ "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
+ # items.
+ },
+ "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The 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.
+ },
+ "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # The button object that appears at the bottom of a card.
+ "title": "A String", # Required. The title of the button.
+ "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.
+ },
+ },
+ ],
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "formattedText": "A String", # Required, unless image is present. The body text of the card.
+ "title": "A String", # Optional. The title of the card.
+ "image": { # The image response message. # Optional. The image for the card.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ },
+ "suggestions": { # The collection of suggestions. # The 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.
+ },
+ ],
+ },
+ "quickReplies": { # The quick replies response message. # The quick replies response.
+ "quickReplies": [ # Optional. The collection of quick replies.
+ "A String",
+ ],
+ "title": "A String", # Optional. The title of the collection of quick replies.
+ },
+ "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "title": "A String", # Required. Title of the card.
+ "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.
+ },
+ ],
+ "subtitle": "A String", # Optional. Subtitle to the title.
+ "image": { # The image response message. # Optional. Image which should be displayed on the card.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ },
+ ],
+ "buttons": [ # Optional. List of buttons for the card.
+ { # The button object that appears at the bottom of a card.
+ "title": "A String", # Required. The title of the button.
+ "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.
+ },
+ },
+ ],
+ },
+ "image": { # The image response message. # The image response.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ "largeImage": { # The image response message. # Optional. Image to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "contentUrl": "A String", # Required. Url where the media is stored.
+ "icon": { # The image response message. # Optional. Icon to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "name": "A String", # Required. Name of media card.
+ "description": "A String", # Optional. Description of media card.
+ },
+ ],
+ "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
+ },
+ "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
+ "title": "A String", # Optional. The overall title of the list.
+ "items": [ # Required. List items.
+ { # An item in the list.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ },
+ "title": "A String", # Required. The title of the list item.
+ "description": "A String", # Optional. The main text describing the item.
+ },
+ ],
+ "subtitle": "A String", # Optional. Subtitle of the list.
+ },
+ "payload": { # A custom platform-specific response.
+ "a_key": "", # Properties of the object.
+ },
+ },
+ ],
"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 150 characters.
"A String",
],
- "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>`.
- "priority": 42, # Optional. 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.
"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.
- "lifespanCount": 42, # Optional. The number of conversational query requests after which the
- # context expires. The default is `0`. If set to `0`, the context expires
- # immediately. Contexts expire automatically after 20 minutes if there
- # are no matching queries.
- "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`
+ { # Dialogflow contexts are similar to natural language context. If a person says
+ # to you "they are orange", you need context in order to understand what "they"
+ # is referring to. Similarly, for Dialogflow to handle an end-user expression
+ # like that, it needs to be provided with context in order to correctly match
+ # an intent.
+ #
+ # Using contexts, you can control the flow of a conversation. You can configure
+ # contexts for an intent by setting input and output contexts, which are
+ # identified by string names. When an intent is matched, any configured output
+ # contexts for that intent become active. While any contexts are active,
+ # Dialogflow is more likely to match intents that are configured with input
+ # contexts that correspond to the currently active contexts.
+ #
+ # For more information about context, see the
+ # [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).
"parameters": { # Optional. The collection of parameters associated with this context.
#
# Depending on your protocol or client library language, this is a
@@ -1965,256 +2247,53 @@
# - Else: parameter value
"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. The default is `0`. If set to `0`, the context expires
+ # immediately. Contexts expire automatically after 20 minutes if there
+ # are no matching queries.
},
],
- "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",
- ],
"action": "A String", # Optional. The name of the action associated with the intent.
# Note: The action name must not contain whitespaces.
- "name": "A String", # Optional. The unique identifier of this intent.
- # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
- # methods.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "messages": [ # Optional. The collection of rich messages corresponding to the
- # `Response` field in the Dialogflow console.
- { # A rich response message.
- # Corresponds to the intent `Response` field in the Dialogflow console.
- # For more information, see
- # [Rich response
- # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).
- "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
- "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
- "mediaObjects": [ # Required. List of media objects.
- { # Response media object for media content card.
- "name": "A String", # Required. Name of media card.
- "description": "A String", # Optional. Description of media card.
- "contentUrl": "A String", # Required. Url where the media is stored.
- "icon": { # The image response message. # Optional. Icon to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "largeImage": { # The image response message. # Optional. Image to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- },
- ],
- },
- "image": { # The image response message. # The image response.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "payload": { # A custom platform-specific response.
- "a_key": "", # Properties of the object.
- },
- "text": { # The text response message. # The text response.
- "text": [ # Optional. The collection of the agent's responses.
- "A String",
- ],
- },
- "platform": "A String", # Optional. The platform that this message is intended for.
- "suggestions": { # The collection of suggestions. # The 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.
- },
- ],
- },
- "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
- "subtitle": "A String", # Optional. Subtitle of the list.
- "items": [ # Required. List items.
- { # An item in the list.
- "title": "A String", # Required. The title of the list item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "description": "A String", # Optional. The main text describing the item.
- "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.
- },
- },
- ],
- "title": "A String", # Optional. The overall title of the list.
- },
- "quickReplies": { # The quick replies response message. # The quick replies response.
- "title": "A String", # Optional. The title of the collection of quick replies.
- "quickReplies": [ # Optional. The collection of quick replies.
- "A String",
- ],
- },
- "card": { # The card response message. # The card response.
- "imageUri": "A String", # Optional. The public URI to an image file for the card.
- "title": "A String", # Optional. The title of the card.
- "buttons": [ # Optional. The collection of card buttons.
- { # 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.
- },
- ],
- "subtitle": "A String", # Optional. The subtitle of the card.
- },
- "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
- "title": "A String", # Optional. The title of the card.
- "image": { # The image response message. # Optional. The image for the card.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "formattedText": "A String", # Required, unless image is present. The body text of the card.
- "buttons": [ # Optional. The collection of card buttons.
- { # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
- "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.
- },
- },
- ],
- "subtitle": "A String", # Optional. The subtitle of the card.
- },
- "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
- "title": "A String", # Required. Title of the card.
- "rows": [ # Optional. Rows in this table of data.
- { # Row of TableCard.
- "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
- "cells": [ # Optional. List of cells that make up this row.
- { # Cell of TableCardRow.
- "text": "A String", # Required. Text in this cell.
- },
- ],
- },
- ],
- "subtitle": "A String", # Optional. Subtitle to the title.
- "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.
- },
- ],
- "image": { # The image response message. # Optional. Image which should be displayed on the card.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "buttons": [ # Optional. List of buttons for the card.
- { # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
- "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.
- },
- },
- ],
- },
- "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
- "items": [ # Required. Carousel items.
- { # An item in the carousel.
- "description": "A String", # Optional. The body text of the card.
- "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.
- },
- "title": "A String", # Required. Title of the carousel item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- },
- ],
- },
- "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.
- # or website associated with this agent.
- "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
- "uri": "A String", # Required. The URI of the app or site to open when the user taps the
- # suggestion chip.
- },
- "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
- "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
- "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
- # the URL. Defaults to opening via web browser.
- "url": "A String", # Required. URL
- },
- "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
- # Card. Maximum of one line of text.
- "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
- "image": { # The image response message. # Optional. Hero image for the carousel item.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
- # text.
- },
- ],
- "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
- # items.
- },
- "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses 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.
- "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
- # speech output. Mutually exclusive with ssml.
- "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.
- "displayText": "A String", # Optional. The text to display.
- },
- ],
- },
- },
- ],
- "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
- "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",
- ],
- "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>`.
- },
- ],
+ "priority": 42, # Optional. 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>`.
- "displayName": "A String", # Required. The name of this 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.
- "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
+ "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.
+ "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "followupIntentName": "A String", # The unique identifier of the followup intent.
+ # 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.
@@ -2222,7 +2301,6 @@
"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.
- "type": "A String", # Required. The type of the training phrase.
"parts": [ # Required. The ordered list of training phrase parts.
# The parts are concatenated in order to form the training phrase.
#
@@ -2243,9 +2321,6 @@
# and the `entity_type`, `alias`, and `user_defined` fields are all
# set.
{ # Represents a part of a training phrase.
- "text": "A String", # Required. The text for this part.
- "entityType": "A String", # Optional. The entity type name prefixed with `@`.
- # This field is required for annotated parts of the 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.
@@ -2253,12 +2328,37 @@
# 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.
+ "text": "A String", # Required. The text for this part.
+ "entityType": "A String", # Optional. The entity type name prefixed with `@`.
+ # This field is required for annotated parts of the training phrase.
},
],
+ "type": "A String", # Required. The type of the training phrase.
},
],
+ "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",
+ ],
+ "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.
"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
# session when this intent is matched.
+ "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>`.
+ "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",
+ ],
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
"value": "A String", # Optional. The definition of the parameter value. It can be:
@@ -2269,22 +2369,22 @@
# - a parameter value from some context defined as
# `#context_name.parameter_name`.
"displayName": "A String", # Required. The name of the parameter.
- "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.
- "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",
- ],
"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
# whether the intent cannot be completed without collecting the parameter
# value.
+ "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
+ "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.
"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`.
"name": "A String", # The unique identifier of this parameter.
- "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
+ "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",
+ ],
},
],
}</pre>
@@ -2315,60 +2415,264 @@
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.
+ { # An intent categorizes an end-user's intention for one conversation turn. For
+ # each agent, you define many intents, where your combined intents can handle a
+ # complete conversation. When an end-user writes or says something, referred to
+ # as an end-user expression or end-user input, Dialogflow matches the end-user
+ # input to the best intent in your agent. Matching an intent is also known as
+ # intent classification.
+ #
+ # For more information, see the [intent
+ # guide](https://cloud.google.com/dialogflow/docs/intents-overview).
+ "name": "A String", # Optional. The unique identifier of this intent.
+ # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
+ # methods.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
+ "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
+ "displayName": "A String", # Required. The name of this intent.
+ "messages": [ # Optional. The collection of rich messages corresponding to the
+ # `Response` field in the Dialogflow console.
+ { # A rich response message.
+ # Corresponds to the intent `Response` field in the Dialogflow console.
+ # For more information, see
+ # [Rich response
+ # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).
+ "card": { # The card response message. # The card response.
+ "title": "A String", # Optional. The title of the card.
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # 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.
+ },
+ "text": { # The text response message. # The text response.
+ "text": [ # Optional. The collection of the agent's responses.
+ "A String",
+ ],
+ },
+ "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
+ "items": [ # Required. Carousel items.
+ { # An item in the carousel.
+ "description": "A String", # Optional. The body text of the card.
+ "title": "A String", # Required. Title of the carousel item.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ },
+ },
+ ],
+ },
+ "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses 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.
+ "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
+ # speech output. Mutually exclusive with ssml.
+ "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.
+ "displayText": "A String", # Optional. The text to display.
+ },
+ ],
+ },
+ "platform": "A String", # Optional. The platform that this message is intended for.
+ "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
+ "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
+ # Card. Maximum of one line of text.
+ "image": { # The image response message. # Optional. Hero image for the carousel item.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
+ # text.
+ "title": "A String", # Required. Title of the carousel item. Maximum of two 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.
+ },
+ },
+ ],
+ "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
+ # items.
+ },
+ "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The 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.
+ },
+ "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # The button object that appears at the bottom of a card.
+ "title": "A String", # Required. The title of the button.
+ "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.
+ },
+ },
+ ],
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "formattedText": "A String", # Required, unless image is present. The body text of the card.
+ "title": "A String", # Optional. The title of the card.
+ "image": { # The image response message. # Optional. The image for the card.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ },
+ "suggestions": { # The collection of suggestions. # The 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.
+ },
+ ],
+ },
+ "quickReplies": { # The quick replies response message. # The quick replies response.
+ "quickReplies": [ # Optional. The collection of quick replies.
+ "A String",
+ ],
+ "title": "A String", # Optional. The title of the collection of quick replies.
+ },
+ "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "title": "A String", # Required. Title of the card.
+ "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.
+ },
+ ],
+ "subtitle": "A String", # Optional. Subtitle to the title.
+ "image": { # The image response message. # Optional. Image which should be displayed on the card.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ },
+ ],
+ "buttons": [ # Optional. List of buttons for the card.
+ { # The button object that appears at the bottom of a card.
+ "title": "A String", # Required. The title of the button.
+ "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.
+ },
+ },
+ ],
+ },
+ "image": { # The image response message. # The image response.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ "largeImage": { # The image response message. # Optional. Image to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "contentUrl": "A String", # Required. Url where the media is stored.
+ "icon": { # The image response message. # Optional. Icon to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "name": "A String", # Required. Name of media card.
+ "description": "A String", # Optional. Description of media card.
+ },
+ ],
+ "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
+ },
+ "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
+ "title": "A String", # Optional. The overall title of the list.
+ "items": [ # Required. List items.
+ { # An item in the list.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ },
+ "title": "A String", # Required. The title of the list item.
+ "description": "A String", # Optional. The main text describing the item.
+ },
+ ],
+ "subtitle": "A String", # Optional. Subtitle of the list.
+ },
+ "payload": { # A custom platform-specific response.
+ "a_key": "", # Properties of the object.
+ },
+ },
+ ],
"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 150 characters.
"A String",
],
- "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>`.
- "priority": 42, # Optional. 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.
"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.
- "lifespanCount": 42, # Optional. The number of conversational query requests after which the
- # context expires. The default is `0`. If set to `0`, the context expires
- # immediately. Contexts expire automatically after 20 minutes if there
- # are no matching queries.
- "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`
+ { # Dialogflow contexts are similar to natural language context. If a person says
+ # to you "they are orange", you need context in order to understand what "they"
+ # is referring to. Similarly, for Dialogflow to handle an end-user expression
+ # like that, it needs to be provided with context in order to correctly match
+ # an intent.
+ #
+ # Using contexts, you can control the flow of a conversation. You can configure
+ # contexts for an intent by setting input and output contexts, which are
+ # identified by string names. When an intent is matched, any configured output
+ # contexts for that intent become active. While any contexts are active,
+ # Dialogflow is more likely to match intents that are configured with input
+ # contexts that correspond to the currently active contexts.
+ #
+ # For more information about context, see the
+ # [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).
"parameters": { # Optional. The collection of parameters associated with this context.
#
# Depending on your protocol or client library language, this is a
@@ -2386,256 +2690,53 @@
# - Else: parameter value
"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. The default is `0`. If set to `0`, the context expires
+ # immediately. Contexts expire automatically after 20 minutes if there
+ # are no matching queries.
},
],
- "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",
- ],
"action": "A String", # Optional. The name of the action associated with the intent.
# Note: The action name must not contain whitespaces.
- "name": "A String", # Optional. The unique identifier of this intent.
- # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
- # methods.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "messages": [ # Optional. The collection of rich messages corresponding to the
- # `Response` field in the Dialogflow console.
- { # A rich response message.
- # Corresponds to the intent `Response` field in the Dialogflow console.
- # For more information, see
- # [Rich response
- # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).
- "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
- "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
- "mediaObjects": [ # Required. List of media objects.
- { # Response media object for media content card.
- "name": "A String", # Required. Name of media card.
- "description": "A String", # Optional. Description of media card.
- "contentUrl": "A String", # Required. Url where the media is stored.
- "icon": { # The image response message. # Optional. Icon to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "largeImage": { # The image response message. # Optional. Image to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- },
- ],
- },
- "image": { # The image response message. # The image response.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "payload": { # A custom platform-specific response.
- "a_key": "", # Properties of the object.
- },
- "text": { # The text response message. # The text response.
- "text": [ # Optional. The collection of the agent's responses.
- "A String",
- ],
- },
- "platform": "A String", # Optional. The platform that this message is intended for.
- "suggestions": { # The collection of suggestions. # The 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.
- },
- ],
- },
- "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
- "subtitle": "A String", # Optional. Subtitle of the list.
- "items": [ # Required. List items.
- { # An item in the list.
- "title": "A String", # Required. The title of the list item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "description": "A String", # Optional. The main text describing the item.
- "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.
- },
- },
- ],
- "title": "A String", # Optional. The overall title of the list.
- },
- "quickReplies": { # The quick replies response message. # The quick replies response.
- "title": "A String", # Optional. The title of the collection of quick replies.
- "quickReplies": [ # Optional. The collection of quick replies.
- "A String",
- ],
- },
- "card": { # The card response message. # The card response.
- "imageUri": "A String", # Optional. The public URI to an image file for the card.
- "title": "A String", # Optional. The title of the card.
- "buttons": [ # Optional. The collection of card buttons.
- { # 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.
- },
- ],
- "subtitle": "A String", # Optional. The subtitle of the card.
- },
- "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
- "title": "A String", # Optional. The title of the card.
- "image": { # The image response message. # Optional. The image for the card.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "formattedText": "A String", # Required, unless image is present. The body text of the card.
- "buttons": [ # Optional. The collection of card buttons.
- { # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
- "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.
- },
- },
- ],
- "subtitle": "A String", # Optional. The subtitle of the card.
- },
- "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
- "title": "A String", # Required. Title of the card.
- "rows": [ # Optional. Rows in this table of data.
- { # Row of TableCard.
- "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
- "cells": [ # Optional. List of cells that make up this row.
- { # Cell of TableCardRow.
- "text": "A String", # Required. Text in this cell.
- },
- ],
- },
- ],
- "subtitle": "A String", # Optional. Subtitle to the title.
- "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.
- },
- ],
- "image": { # The image response message. # Optional. Image which should be displayed on the card.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "buttons": [ # Optional. List of buttons for the card.
- { # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
- "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.
- },
- },
- ],
- },
- "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
- "items": [ # Required. Carousel items.
- { # An item in the carousel.
- "description": "A String", # Optional. The body text of the card.
- "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.
- },
- "title": "A String", # Required. Title of the carousel item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- },
- ],
- },
- "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.
- # or website associated with this agent.
- "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
- "uri": "A String", # Required. The URI of the app or site to open when the user taps the
- # suggestion chip.
- },
- "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
- "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
- "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
- # the URL. Defaults to opening via web browser.
- "url": "A String", # Required. URL
- },
- "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
- # Card. Maximum of one line of text.
- "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
- "image": { # The image response message. # Optional. Hero image for the carousel item.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
- # text.
- },
- ],
- "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
- # items.
- },
- "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses 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.
- "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
- # speech output. Mutually exclusive with ssml.
- "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.
- "displayText": "A String", # Optional. The text to display.
- },
- ],
- },
- },
- ],
- "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
- "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",
- ],
- "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>`.
- },
- ],
+ "priority": 42, # Optional. 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>`.
- "displayName": "A String", # Required. The name of this 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.
- "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
+ "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.
+ "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "followupIntentName": "A String", # The unique identifier of the followup intent.
+ # 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.
@@ -2643,7 +2744,6 @@
"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.
- "type": "A String", # Required. The type of the training phrase.
"parts": [ # Required. The ordered list of training phrase parts.
# The parts are concatenated in order to form the training phrase.
#
@@ -2664,9 +2764,6 @@
# and the `entity_type`, `alias`, and `user_defined` fields are all
# set.
{ # Represents a part of a training phrase.
- "text": "A String", # Required. The text for this part.
- "entityType": "A String", # Optional. The entity type name prefixed with `@`.
- # This field is required for annotated parts of the 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.
@@ -2674,12 +2771,37 @@
# 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.
+ "text": "A String", # Required. The text for this part.
+ "entityType": "A String", # Optional. The entity type name prefixed with `@`.
+ # This field is required for annotated parts of the training phrase.
},
],
+ "type": "A String", # Required. The type of the training phrase.
},
],
+ "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",
+ ],
+ "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.
"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
# session when this intent is matched.
+ "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>`.
+ "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",
+ ],
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
"value": "A String", # Optional. The definition of the parameter value. It can be:
@@ -2690,28 +2812,26 @@
# - a parameter value from some context defined as
# `#context_name.parameter_name`.
"displayName": "A String", # Required. The name of the parameter.
- "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.
- "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",
- ],
"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
# whether the intent cannot be completed without collecting the parameter
# value.
+ "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
+ "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.
"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`.
"name": "A String", # The unique identifier of this parameter.
- "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
+ "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",
+ ],
},
],
},
],
- "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
- # more results in the list.
}</pre>
</div>
@@ -2741,58 +2861,260 @@
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.
+{ # An intent categorizes an end-user's intention for one conversation turn. For
+ # each agent, you define many intents, where your combined intents can handle a
+ # complete conversation. When an end-user writes or says something, referred to
+ # as an end-user expression or end-user input, Dialogflow matches the end-user
+ # input to the best intent in your agent. Matching an intent is also known as
+ # intent classification.
+ #
+ # For more information, see the [intent
+ # guide](https://cloud.google.com/dialogflow/docs/intents-overview).
+ "name": "A String", # Optional. The unique identifier of this intent.
+ # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
+ # methods.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
+ "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
+ "displayName": "A String", # Required. The name of this intent.
+ "messages": [ # Optional. The collection of rich messages corresponding to the
+ # `Response` field in the Dialogflow console.
+ { # A rich response message.
+ # Corresponds to the intent `Response` field in the Dialogflow console.
+ # For more information, see
+ # [Rich response
+ # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).
+ "card": { # The card response message. # The card response.
+ "title": "A String", # Optional. The title of the card.
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # 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.
+ },
+ "text": { # The text response message. # The text response.
+ "text": [ # Optional. The collection of the agent's responses.
+ "A String",
+ ],
+ },
+ "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
+ "items": [ # Required. Carousel items.
+ { # An item in the carousel.
+ "description": "A String", # Optional. The body text of the card.
+ "title": "A String", # Required. Title of the carousel item.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ },
+ },
+ ],
+ },
+ "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses 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.
+ "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
+ # speech output. Mutually exclusive with ssml.
+ "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.
+ "displayText": "A String", # Optional. The text to display.
+ },
+ ],
+ },
+ "platform": "A String", # Optional. The platform that this message is intended for.
+ "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
+ "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
+ # Card. Maximum of one line of text.
+ "image": { # The image response message. # Optional. Hero image for the carousel item.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
+ # text.
+ "title": "A String", # Required. Title of the carousel item. Maximum of two 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.
+ },
+ },
+ ],
+ "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
+ # items.
+ },
+ "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The 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.
+ },
+ "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # The button object that appears at the bottom of a card.
+ "title": "A String", # Required. The title of the button.
+ "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.
+ },
+ },
+ ],
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "formattedText": "A String", # Required, unless image is present. The body text of the card.
+ "title": "A String", # Optional. The title of the card.
+ "image": { # The image response message. # Optional. The image for the card.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ },
+ "suggestions": { # The collection of suggestions. # The 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.
+ },
+ ],
+ },
+ "quickReplies": { # The quick replies response message. # The quick replies response.
+ "quickReplies": [ # Optional. The collection of quick replies.
+ "A String",
+ ],
+ "title": "A String", # Optional. The title of the collection of quick replies.
+ },
+ "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "title": "A String", # Required. Title of the card.
+ "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.
+ },
+ ],
+ "subtitle": "A String", # Optional. Subtitle to the title.
+ "image": { # The image response message. # Optional. Image which should be displayed on the card.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ },
+ ],
+ "buttons": [ # Optional. List of buttons for the card.
+ { # The button object that appears at the bottom of a card.
+ "title": "A String", # Required. The title of the button.
+ "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.
+ },
+ },
+ ],
+ },
+ "image": { # The image response message. # The image response.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ "largeImage": { # The image response message. # Optional. Image to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "contentUrl": "A String", # Required. Url where the media is stored.
+ "icon": { # The image response message. # Optional. Icon to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "name": "A String", # Required. Name of media card.
+ "description": "A String", # Optional. Description of media card.
+ },
+ ],
+ "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
+ },
+ "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
+ "title": "A String", # Optional. The overall title of the list.
+ "items": [ # Required. List items.
+ { # An item in the list.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ },
+ "title": "A String", # Required. The title of the list item.
+ "description": "A String", # Optional. The main text describing the item.
+ },
+ ],
+ "subtitle": "A String", # Optional. Subtitle of the list.
+ },
+ "payload": { # A custom platform-specific response.
+ "a_key": "", # Properties of the object.
+ },
+ },
+ ],
"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 150 characters.
"A String",
],
- "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>`.
- "priority": 42, # Optional. 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.
"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.
- "lifespanCount": 42, # Optional. The number of conversational query requests after which the
- # context expires. The default is `0`. If set to `0`, the context expires
- # immediately. Contexts expire automatically after 20 minutes if there
- # are no matching queries.
- "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`
+ { # Dialogflow contexts are similar to natural language context. If a person says
+ # to you "they are orange", you need context in order to understand what "they"
+ # is referring to. Similarly, for Dialogflow to handle an end-user expression
+ # like that, it needs to be provided with context in order to correctly match
+ # an intent.
+ #
+ # Using contexts, you can control the flow of a conversation. You can configure
+ # contexts for an intent by setting input and output contexts, which are
+ # identified by string names. When an intent is matched, any configured output
+ # contexts for that intent become active. While any contexts are active,
+ # Dialogflow is more likely to match intents that are configured with input
+ # contexts that correspond to the currently active contexts.
+ #
+ # For more information about context, see the
+ # [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).
"parameters": { # Optional. The collection of parameters associated with this context.
#
# Depending on your protocol or client library language, this is a
@@ -2810,256 +3132,53 @@
# - Else: parameter value
"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. The default is `0`. If set to `0`, the context expires
+ # immediately. Contexts expire automatically after 20 minutes if there
+ # are no matching queries.
},
],
- "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",
- ],
"action": "A String", # Optional. The name of the action associated with the intent.
# Note: The action name must not contain whitespaces.
- "name": "A String", # Optional. The unique identifier of this intent.
- # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
- # methods.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "messages": [ # Optional. The collection of rich messages corresponding to the
- # `Response` field in the Dialogflow console.
- { # A rich response message.
- # Corresponds to the intent `Response` field in the Dialogflow console.
- # For more information, see
- # [Rich response
- # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).
- "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
- "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
- "mediaObjects": [ # Required. List of media objects.
- { # Response media object for media content card.
- "name": "A String", # Required. Name of media card.
- "description": "A String", # Optional. Description of media card.
- "contentUrl": "A String", # Required. Url where the media is stored.
- "icon": { # The image response message. # Optional. Icon to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "largeImage": { # The image response message. # Optional. Image to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- },
- ],
- },
- "image": { # The image response message. # The image response.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "payload": { # A custom platform-specific response.
- "a_key": "", # Properties of the object.
- },
- "text": { # The text response message. # The text response.
- "text": [ # Optional. The collection of the agent's responses.
- "A String",
- ],
- },
- "platform": "A String", # Optional. The platform that this message is intended for.
- "suggestions": { # The collection of suggestions. # The 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.
- },
- ],
- },
- "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
- "subtitle": "A String", # Optional. Subtitle of the list.
- "items": [ # Required. List items.
- { # An item in the list.
- "title": "A String", # Required. The title of the list item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "description": "A String", # Optional. The main text describing the item.
- "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.
- },
- },
- ],
- "title": "A String", # Optional. The overall title of the list.
- },
- "quickReplies": { # The quick replies response message. # The quick replies response.
- "title": "A String", # Optional. The title of the collection of quick replies.
- "quickReplies": [ # Optional. The collection of quick replies.
- "A String",
- ],
- },
- "card": { # The card response message. # The card response.
- "imageUri": "A String", # Optional. The public URI to an image file for the card.
- "title": "A String", # Optional. The title of the card.
- "buttons": [ # Optional. The collection of card buttons.
- { # 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.
- },
- ],
- "subtitle": "A String", # Optional. The subtitle of the card.
- },
- "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
- "title": "A String", # Optional. The title of the card.
- "image": { # The image response message. # Optional. The image for the card.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "formattedText": "A String", # Required, unless image is present. The body text of the card.
- "buttons": [ # Optional. The collection of card buttons.
- { # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
- "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.
- },
- },
- ],
- "subtitle": "A String", # Optional. The subtitle of the card.
- },
- "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
- "title": "A String", # Required. Title of the card.
- "rows": [ # Optional. Rows in this table of data.
- { # Row of TableCard.
- "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
- "cells": [ # Optional. List of cells that make up this row.
- { # Cell of TableCardRow.
- "text": "A String", # Required. Text in this cell.
- },
- ],
- },
- ],
- "subtitle": "A String", # Optional. Subtitle to the title.
- "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.
- },
- ],
- "image": { # The image response message. # Optional. Image which should be displayed on the card.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "buttons": [ # Optional. List of buttons for the card.
- { # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
- "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.
- },
- },
- ],
- },
- "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
- "items": [ # Required. Carousel items.
- { # An item in the carousel.
- "description": "A String", # Optional. The body text of the card.
- "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.
- },
- "title": "A String", # Required. Title of the carousel item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- },
- ],
- },
- "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.
- # or website associated with this agent.
- "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
- "uri": "A String", # Required. The URI of the app or site to open when the user taps the
- # suggestion chip.
- },
- "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
- "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
- "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
- # the URL. Defaults to opening via web browser.
- "url": "A String", # Required. URL
- },
- "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
- # Card. Maximum of one line of text.
- "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
- "image": { # The image response message. # Optional. Hero image for the carousel item.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
- # text.
- },
- ],
- "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
- # items.
- },
- "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses 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.
- "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
- # speech output. Mutually exclusive with ssml.
- "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.
- "displayText": "A String", # Optional. The text to display.
- },
- ],
- },
- },
- ],
- "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
- "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",
- ],
- "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>`.
- },
- ],
+ "priority": 42, # Optional. 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>`.
- "displayName": "A String", # Required. The name of this 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.
- "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
+ "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.
+ "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "followupIntentName": "A String", # The unique identifier of the followup intent.
+ # 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.
@@ -3067,7 +3186,6 @@
"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.
- "type": "A String", # Required. The type of the training phrase.
"parts": [ # Required. The ordered list of training phrase parts.
# The parts are concatenated in order to form the training phrase.
#
@@ -3088,9 +3206,6 @@
# and the `entity_type`, `alias`, and `user_defined` fields are all
# set.
{ # Represents a part of a training phrase.
- "text": "A String", # Required. The text for this part.
- "entityType": "A String", # Optional. The entity type name prefixed with `@`.
- # This field is required for annotated parts of the 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.
@@ -3098,12 +3213,37 @@
# 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.
+ "text": "A String", # Required. The text for this part.
+ "entityType": "A String", # Optional. The entity type name prefixed with `@`.
+ # This field is required for annotated parts of the training phrase.
},
],
+ "type": "A String", # Required. The type of the training phrase.
},
],
+ "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",
+ ],
+ "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.
"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
# session when this intent is matched.
+ "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>`.
+ "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",
+ ],
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
"value": "A String", # Optional. The definition of the parameter value. It can be:
@@ -3114,22 +3254,22 @@
# - a parameter value from some context defined as
# `#context_name.parameter_name`.
"displayName": "A String", # Required. The name of the parameter.
- "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.
- "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",
- ],
"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
# whether the intent cannot be completed without collecting the parameter
# value.
+ "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
+ "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.
"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`.
"name": "A String", # The unique identifier of this parameter.
- "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
+ "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",
+ ],
},
],
}
@@ -3149,58 +3289,260 @@
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.
+ { # An intent categorizes an end-user's intention for one conversation turn. For
+ # each agent, you define many intents, where your combined intents can handle a
+ # complete conversation. When an end-user writes or says something, referred to
+ # as an end-user expression or end-user input, Dialogflow matches the end-user
+ # input to the best intent in your agent. Matching an intent is also known as
+ # intent classification.
+ #
+ # For more information, see the [intent
+ # guide](https://cloud.google.com/dialogflow/docs/intents-overview).
+ "name": "A String", # Optional. The unique identifier of this intent.
+ # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
+ # methods.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
+ "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
+ "displayName": "A String", # Required. The name of this intent.
+ "messages": [ # Optional. The collection of rich messages corresponding to the
+ # `Response` field in the Dialogflow console.
+ { # A rich response message.
+ # Corresponds to the intent `Response` field in the Dialogflow console.
+ # For more information, see
+ # [Rich response
+ # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).
+ "card": { # The card response message. # The card response.
+ "title": "A String", # Optional. The title of the card.
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # 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.
+ },
+ "text": { # The text response message. # The text response.
+ "text": [ # Optional. The collection of the agent's responses.
+ "A String",
+ ],
+ },
+ "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
+ "items": [ # Required. Carousel items.
+ { # An item in the carousel.
+ "description": "A String", # Optional. The body text of the card.
+ "title": "A String", # Required. Title of the carousel item.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ },
+ },
+ ],
+ },
+ "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses 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.
+ "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
+ # speech output. Mutually exclusive with ssml.
+ "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.
+ "displayText": "A String", # Optional. The text to display.
+ },
+ ],
+ },
+ "platform": "A String", # Optional. The platform that this message is intended for.
+ "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
+ "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
+ # Card. Maximum of one line of text.
+ "image": { # The image response message. # Optional. Hero image for the carousel item.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
+ # text.
+ "title": "A String", # Required. Title of the carousel item. Maximum of two 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.
+ },
+ },
+ ],
+ "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
+ # items.
+ },
+ "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The 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.
+ },
+ "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # The button object that appears at the bottom of a card.
+ "title": "A String", # Required. The title of the button.
+ "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.
+ },
+ },
+ ],
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "formattedText": "A String", # Required, unless image is present. The body text of the card.
+ "title": "A String", # Optional. The title of the card.
+ "image": { # The image response message. # Optional. The image for the card.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ },
+ "suggestions": { # The collection of suggestions. # The 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.
+ },
+ ],
+ },
+ "quickReplies": { # The quick replies response message. # The quick replies response.
+ "quickReplies": [ # Optional. The collection of quick replies.
+ "A String",
+ ],
+ "title": "A String", # Optional. The title of the collection of quick replies.
+ },
+ "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "title": "A String", # Required. Title of the card.
+ "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.
+ },
+ ],
+ "subtitle": "A String", # Optional. Subtitle to the title.
+ "image": { # The image response message. # Optional. Image which should be displayed on the card.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ },
+ ],
+ "buttons": [ # Optional. List of buttons for the card.
+ { # The button object that appears at the bottom of a card.
+ "title": "A String", # Required. The title of the button.
+ "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.
+ },
+ },
+ ],
+ },
+ "image": { # The image response message. # The image response.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ "largeImage": { # The image response message. # Optional. Image to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "contentUrl": "A String", # Required. Url where the media is stored.
+ "icon": { # The image response message. # Optional. Icon to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "name": "A String", # Required. Name of media card.
+ "description": "A String", # Optional. Description of media card.
+ },
+ ],
+ "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
+ },
+ "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
+ "title": "A String", # Optional. The overall title of the list.
+ "items": [ # Required. List items.
+ { # An item in the list.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ },
+ "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.
+ },
+ "title": "A String", # Required. The title of the list item.
+ "description": "A String", # Optional. The main text describing the item.
+ },
+ ],
+ "subtitle": "A String", # Optional. Subtitle of the list.
+ },
+ "payload": { # A custom platform-specific response.
+ "a_key": "", # Properties of the object.
+ },
+ },
+ ],
"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 150 characters.
"A String",
],
- "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>`.
- "priority": 42, # Optional. 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.
"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.
- "lifespanCount": 42, # Optional. The number of conversational query requests after which the
- # context expires. The default is `0`. If set to `0`, the context expires
- # immediately. Contexts expire automatically after 20 minutes if there
- # are no matching queries.
- "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`
+ { # Dialogflow contexts are similar to natural language context. If a person says
+ # to you "they are orange", you need context in order to understand what "they"
+ # is referring to. Similarly, for Dialogflow to handle an end-user expression
+ # like that, it needs to be provided with context in order to correctly match
+ # an intent.
+ #
+ # Using contexts, you can control the flow of a conversation. You can configure
+ # contexts for an intent by setting input and output contexts, which are
+ # identified by string names. When an intent is matched, any configured output
+ # contexts for that intent become active. While any contexts are active,
+ # Dialogflow is more likely to match intents that are configured with input
+ # contexts that correspond to the currently active contexts.
+ #
+ # For more information about context, see the
+ # [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).
"parameters": { # Optional. The collection of parameters associated with this context.
#
# Depending on your protocol or client library language, this is a
@@ -3218,256 +3560,53 @@
# - Else: parameter value
"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. The default is `0`. If set to `0`, the context expires
+ # immediately. Contexts expire automatically after 20 minutes if there
+ # are no matching queries.
},
],
- "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",
- ],
"action": "A String", # Optional. The name of the action associated with the intent.
# Note: The action name must not contain whitespaces.
- "name": "A String", # Optional. The unique identifier of this intent.
- # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
- # methods.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "messages": [ # Optional. The collection of rich messages corresponding to the
- # `Response` field in the Dialogflow console.
- { # A rich response message.
- # Corresponds to the intent `Response` field in the Dialogflow console.
- # For more information, see
- # [Rich response
- # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).
- "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
- "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
- "mediaObjects": [ # Required. List of media objects.
- { # Response media object for media content card.
- "name": "A String", # Required. Name of media card.
- "description": "A String", # Optional. Description of media card.
- "contentUrl": "A String", # Required. Url where the media is stored.
- "icon": { # The image response message. # Optional. Icon to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "largeImage": { # The image response message. # Optional. Image to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- },
- ],
- },
- "image": { # The image response message. # The image response.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "payload": { # A custom platform-specific response.
- "a_key": "", # Properties of the object.
- },
- "text": { # The text response message. # The text response.
- "text": [ # Optional. The collection of the agent's responses.
- "A String",
- ],
- },
- "platform": "A String", # Optional. The platform that this message is intended for.
- "suggestions": { # The collection of suggestions. # The 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.
- },
- ],
- },
- "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
- "subtitle": "A String", # Optional. Subtitle of the list.
- "items": [ # Required. List items.
- { # An item in the list.
- "title": "A String", # Required. The title of the list item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "description": "A String", # Optional. The main text describing the item.
- "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.
- },
- },
- ],
- "title": "A String", # Optional. The overall title of the list.
- },
- "quickReplies": { # The quick replies response message. # The quick replies response.
- "title": "A String", # Optional. The title of the collection of quick replies.
- "quickReplies": [ # Optional. The collection of quick replies.
- "A String",
- ],
- },
- "card": { # The card response message. # The card response.
- "imageUri": "A String", # Optional. The public URI to an image file for the card.
- "title": "A String", # Optional. The title of the card.
- "buttons": [ # Optional. The collection of card buttons.
- { # 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.
- },
- ],
- "subtitle": "A String", # Optional. The subtitle of the card.
- },
- "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
- "title": "A String", # Optional. The title of the card.
- "image": { # The image response message. # Optional. The image for the card.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "formattedText": "A String", # Required, unless image is present. The body text of the card.
- "buttons": [ # Optional. The collection of card buttons.
- { # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
- "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.
- },
- },
- ],
- "subtitle": "A String", # Optional. The subtitle of the card.
- },
- "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
- "title": "A String", # Required. Title of the card.
- "rows": [ # Optional. Rows in this table of data.
- { # Row of TableCard.
- "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
- "cells": [ # Optional. List of cells that make up this row.
- { # Cell of TableCardRow.
- "text": "A String", # Required. Text in this cell.
- },
- ],
- },
- ],
- "subtitle": "A String", # Optional. Subtitle to the title.
- "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.
- },
- ],
- "image": { # The image response message. # Optional. Image which should be displayed on the card.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "buttons": [ # Optional. List of buttons for the card.
- { # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
- "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.
- },
- },
- ],
- },
- "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
- "items": [ # Required. Carousel items.
- { # An item in the carousel.
- "description": "A String", # Optional. The body text of the card.
- "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.
- },
- "title": "A String", # Required. Title of the carousel item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- },
- ],
- },
- "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.
- # or website associated with this agent.
- "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
- "uri": "A String", # Required. The URI of the app or site to open when the user taps the
- # suggestion chip.
- },
- "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
- "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
- "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
- # the URL. Defaults to opening via web browser.
- "url": "A String", # Required. URL
- },
- "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
- # Card. Maximum of one line of text.
- "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
- "image": { # The image response message. # Optional. Hero image for the carousel item.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
- # e.g., screen readers.
- },
- "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
- # text.
- },
- ],
- "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
- # items.
- },
- "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses 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.
- "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
- # speech output. Mutually exclusive with ssml.
- "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.
- "displayText": "A String", # Optional. The text to display.
- },
- ],
- },
- },
- ],
- "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
- "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",
- ],
- "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>`.
- },
- ],
+ "priority": 42, # Optional. 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>`.
- "displayName": "A String", # Required. The name of this 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.
- "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
+ "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.
+ "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "followupIntentName": "A String", # The unique identifier of the followup intent.
+ # 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.
@@ -3475,7 +3614,6 @@
"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.
- "type": "A String", # Required. The type of the training phrase.
"parts": [ # Required. The ordered list of training phrase parts.
# The parts are concatenated in order to form the training phrase.
#
@@ -3496,9 +3634,6 @@
# and the `entity_type`, `alias`, and `user_defined` fields are all
# set.
{ # Represents a part of a training phrase.
- "text": "A String", # Required. The text for this part.
- "entityType": "A String", # Optional. The entity type name prefixed with `@`.
- # This field is required for annotated parts of the 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.
@@ -3506,12 +3641,37 @@
# 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.
+ "text": "A String", # Required. The text for this part.
+ "entityType": "A String", # Optional. The entity type name prefixed with `@`.
+ # This field is required for annotated parts of the training phrase.
},
],
+ "type": "A String", # Required. The type of the training phrase.
},
],
+ "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",
+ ],
+ "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.
"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
# session when this intent is matched.
+ "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>`.
+ "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",
+ ],
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
"value": "A String", # Optional. The definition of the parameter value. It can be:
@@ -3522,22 +3682,22 @@
# - a parameter value from some context defined as
# `#context_name.parameter_name`.
"displayName": "A String", # Required. The name of the parameter.
- "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.
- "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",
- ],
"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
# whether the intent cannot be completed without collecting the parameter
# value.
+ "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
+ "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.
"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`.
"name": "A String", # The unique identifier of this parameter.
- "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
+ "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",
+ ],
},
],
}</pre>