chore: regens API reference docs (#889)
diff --git a/docs/dyn/dialogflow_v2.projects.agent.intents.html b/docs/dyn/dialogflow_v2.projects.agent.intents.html
index 93f01d8..f79300f 100644
--- a/docs/dyn/dialogflow_v2.projects.agent.intents.html
+++ b/docs/dyn/dialogflow_v2.projects.agent.intents.html
@@ -75,13 +75,13 @@
<h1><a href="dialogflow_v2.html">Dialogflow API</a> . <a href="dialogflow_v2.projects.html">projects</a> . <a href="dialogflow_v2.projects.agent.html">agent</a> . <a href="dialogflow_v2.projects.agent.intents.html">intents</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#batchDelete">batchDelete(parent, body, x__xgafv=None)</a></code></p>
+ <code><a href="#batchDelete">batchDelete(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes intents in the specified agent.</p>
<p class="toc_element">
- <code><a href="#batchUpdate">batchUpdate(parent, body, x__xgafv=None)</a></code></p>
+ <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, languageCode=None, intentView=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>
@@ -96,19 +96,19 @@
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#patch">patch(name, body, languageCode=None, intentView=None, updateMask=None, x__xgafv=None)</a></code></p>
+ <code><a href="#patch">patch(name, body=None, languageCode=None, intentView=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the specified intent.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="batchDelete">batchDelete(parent, body, x__xgafv=None)</code>
+ <code class="details" id="batchDelete">batchDelete(parent, body=None, x__xgafv=None)</code>
<pre>Deletes intents in the specified agent.
-Operation <response: google.protobuf.Empty>
+Operation <response: google.protobuf.Empty>
Args:
parent: string, Required. The name of the agent to delete all entities types for. Format:
-`projects/<Project ID>/agent`. (required)
- body: object, The request body. (required)
+`projects/<Project ID>/agent`. (required)
+ body: object, The request body.
The object takes the form of:
{ # The request message for Intents.BatchDeleteIntents.
@@ -119,14 +119,14 @@
# action is an extraction of a user command or sentence semantics.
"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
- # Note: If `ml_diabled` setting is set to true, then this intent is not
+ # Note: If `ml_disabled` setting is set to true, then this intent is not
# taken into account during inference in `ML ONLY` match mode. Also,
# auto-markup in the UI is turned off.
"displayName": "A String", # Required. The name of this intent.
- "name": "A String", # The unique identifier of this intent.
+ "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>`.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
"displayName": "A String", # Required. The name of the parameter.
@@ -145,7 +145,7 @@
# - a parameter value from some context defined as
# `#context_name.parameter_name`.
"prompts": [ # Optional. The collection of prompts that the agent can present to the
- # user in order to collect value for the parameter.
+ # user in order to collect a value for the parameter.
"A String",
],
"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
@@ -200,17 +200,27 @@
# 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>`.
+ # 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>`.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
},
],
"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
- "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>`.
"messages": [ # Optional. The collection of rich messages corresponding to the
# `Response` field in the Dialogflow console.
- { # Corresponds to the `Response` field in the Dialogflow console.
+ { # 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).
"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
@@ -243,6 +253,26 @@
# e.g., screen readers.
"imageUri": "A String", # Optional. The public URI to an image file.
},
+ "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
+ "mediaObjects": [ # Required. List of media objects.
+ { # Response media object for media content card.
+ "contentUrl": "A String", # Required. Url where the media is stored.
+ "description": "A String", # Optional. Description of media card.
+ "name": "A String", # Required. Name of media card.
+ "largeImage": { # The image response message. # Optional. Image to display above media content.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ "icon": { # The image response message. # Optional. Icon to display above media content.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ },
+ ],
+ "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
+ },
"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
@@ -257,6 +287,31 @@
# suggestion chip.
"destinationName": "A String", # Required. The name of the app or site this chip is linking to.
},
+ "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
+ # https://developers.google.com/actions/assistant/responses#browsing_carousel
+ "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
+ # items, maximum of ten.
+ { # Browsing carousel tile
+ "image": { # The image response message. # Optional. Hero image for the carousel item.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
+ "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
+ # text.
+ "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
+ "url": "A String", # Required. URL
+ "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
+ # the URL. Defaults to opening via web browser.
+ },
+ "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
+ # Card. Maximum of one line of text.
+ },
+ ],
+ "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
+ # items.
+ },
"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.
@@ -275,6 +330,39 @@
"formattedText": "A String", # Required, unless image is present. The body text of the card.
"title": "A String", # Optional. The title of the card.
},
+ "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "rows": [ # Optional. Rows in this table of data.
+ { # Row of TableCard.
+ "cells": [ # Optional. List of cells that make up this row.
+ { # Cell of TableCardRow.
+ "text": "A String", # Required. Text in this cell.
+ },
+ ],
+ "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
+ },
+ ],
+ "subtitle": "A String", # Optional. Subtitle to the title.
+ "title": "A String", # Required. Title of the card.
+ "image": { # The image response message. # Optional. Image which should be displayed on the card.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ "columnProperties": [ # Optional. Display properties for the columns in this table.
+ { # Column properties for TableCard.
+ "header": "A String", # Required. Column heading.
+ "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
+ },
+ ],
+ "buttons": [ # Optional. List of buttons for the card.
+ { # The button object that appears at the bottom of a card.
+ "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
+ "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
+ },
+ "title": "A String", # Required. The title of the button.
+ },
+ ],
+ },
"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.
@@ -318,16 +406,15 @@
"title": "A String", # Required. The title of the list item.
},
],
+ "subtitle": "A String", # Optional. Subtitle of the list.
"title": "A String", # Optional. The overall title of the list.
},
- "payload": { # Returns a response containing a custom, platform-specific payload.
- # See the Intent.Message.Platform type for a description of the
- # structure that may be required for your platform.
+ "payload": { # A custom platform-specific response.
"a_key": "", # Properties of the object.
},
"card": { # The card response message. # The card response.
"buttons": [ # Optional. The collection of card buttons.
- { # Optional. Contains information about a button.
+ { # 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.
@@ -339,60 +426,82 @@
},
},
],
- "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",
],
"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
- # priorities. If this is zero or unspecified, we use the default
- # priority 500000.
+ # priorities.
#
- # Negative numbers mean that the intent is disabled.
+ # - 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>`.
- "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",
- ],
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"action": "A String", # Optional. The name of the action associated with the intent.
# Note: The action name must not contain whitespaces.
+ "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
+ # session when this intent is matched.
"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>`.
+ # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
{ # Represents a context.
- "parameters": { # Optional. The collection of parameters associated with this context.
- # Refer to [this
- # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
- # for syntax.
- "a_key": "", # Properties of the object.
- },
"name": "A String", # Required. The unique identifier of the context. Format:
- # `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`.
+ # `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.
+ # 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`
+ "parameters": { # Optional. The collection of parameters associated with this context.
+ #
+ # Depending on your protocol or client library language, this is a
+ # map, associative array, symbol table, dictionary, or JSON object
+ # composed of a collection of (MapKey, MapValue) pairs:
+ #
+ # - MapKey type: string
+ # - MapKey value: parameter name
+ # - MapValue type:
+ # - If parameter's entity type is a composite entity: map
+ # - Else: string or number, depending on parameter value type
+ # - MapValue value:
+ # - If parameter's entity type is a composite entity:
+ # map from composite entity property names to property values
+ # - Else: parameter value
+ "a_key": "", # Properties of the object.
+ },
"lifespanCount": 42, # Optional. The number of conversational query requests after which the
- # context expires. If set to `0` (the default) the context expires
+ # 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.
},
],
+ "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",
+ ],
"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",
],
},
@@ -409,12 +518,28 @@
{ # 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.
+ },
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
# long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
+ "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}`.
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -433,44 +558,27 @@
},
],
},
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
- # If `true`, the operation is completed, and either `error` or `response` is
- # available.
- "response": { # The normal response of the operation in case of success. If the original
- # method returns no data on success, such as `Delete`, the response is
- # `google.protobuf.Empty`. If the original method is standard
- # `Get`/`Create`/`Update`, the response should be the resource. For other
- # methods, the response should have the type `XxxResponse`, where `Xxx`
- # is the original method name. For example, if the original method name
- # is `TakeSnapshot()`, the inferred response type is
- # `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
}</pre>
</div>
<div class="method">
- <code class="details" id="batchUpdate">batchUpdate(parent, body, x__xgafv=None)</code>
+ <code class="details" id="batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</code>
<pre>Updates/Creates multiple intents in the specified agent.
-Operation <response: BatchUpdateIntentsResponse>
+Operation <response: BatchUpdateIntentsResponse>
Args:
parent: string, Required. The name of the agent to update or create intents in.
-Format: `projects/<Project ID>/agent`. (required)
- body: object, The request body. (required)
+Format: `projects/<Project ID>/agent`. (required)
+ body: object, The request body.
The object takes the form of:
-{ # The request message for Intents.BatchUpdateIntents.
- "languageCode": "A String", # Optional. The language of training phrases, parameters and rich messages
- # defined in `intents`. If not specified, the agent's default language is
- # used. [Many
- # languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)
- # are supported. Note: languages must be enabled in the agent before they can
- # be used.
+{
+ "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://".
@@ -481,14 +589,14 @@
# action is an extraction of a user command or sentence semantics.
"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
- # Note: If `ml_diabled` setting is set to true, then this intent is not
+ # Note: If `ml_disabled` setting is set to true, then this intent is not
# taken into account during inference in `ML ONLY` match mode. Also,
# auto-markup in the UI is turned off.
"displayName": "A String", # Required. The name of this intent.
- "name": "A String", # The unique identifier of this intent.
+ "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>`.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
"displayName": "A String", # Required. The name of the parameter.
@@ -507,7 +615,7 @@
# - a parameter value from some context defined as
# `#context_name.parameter_name`.
"prompts": [ # Optional. The collection of prompts that the agent can present to the
- # user in order to collect value for the parameter.
+ # user in order to collect a value for the parameter.
"A String",
],
"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
@@ -562,17 +670,27 @@
# 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>`.
+ # 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>`.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
},
],
"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
- "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>`.
"messages": [ # Optional. The collection of rich messages corresponding to the
# `Response` field in the Dialogflow console.
- { # Corresponds to the `Response` field in the Dialogflow console.
+ { # 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).
"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
@@ -605,6 +723,26 @@
# e.g., screen readers.
"imageUri": "A String", # Optional. The public URI to an image file.
},
+ "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
+ "mediaObjects": [ # Required. List of media objects.
+ { # Response media object for media content card.
+ "contentUrl": "A String", # Required. Url where the media is stored.
+ "description": "A String", # Optional. Description of media card.
+ "name": "A String", # Required. Name of media card.
+ "largeImage": { # The image response message. # Optional. Image to display above media content.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ "icon": { # The image response message. # Optional. Icon to display above media content.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ },
+ ],
+ "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
+ },
"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
@@ -619,6 +757,31 @@
# suggestion chip.
"destinationName": "A String", # Required. The name of the app or site this chip is linking to.
},
+ "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
+ # https://developers.google.com/actions/assistant/responses#browsing_carousel
+ "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
+ # items, maximum of ten.
+ { # Browsing carousel tile
+ "image": { # The image response message. # Optional. Hero image for the carousel item.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
+ "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
+ # text.
+ "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
+ "url": "A String", # Required. URL
+ "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
+ # the URL. Defaults to opening via web browser.
+ },
+ "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
+ # Card. Maximum of one line of text.
+ },
+ ],
+ "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
+ # items.
+ },
"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.
@@ -637,6 +800,39 @@
"formattedText": "A String", # Required, unless image is present. The body text of the card.
"title": "A String", # Optional. The title of the card.
},
+ "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "rows": [ # Optional. Rows in this table of data.
+ { # Row of TableCard.
+ "cells": [ # Optional. List of cells that make up this row.
+ { # Cell of TableCardRow.
+ "text": "A String", # Required. Text in this cell.
+ },
+ ],
+ "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
+ },
+ ],
+ "subtitle": "A String", # Optional. Subtitle to the title.
+ "title": "A String", # Required. Title of the card.
+ "image": { # The image response message. # Optional. Image which should be displayed on the card.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ "columnProperties": [ # Optional. Display properties for the columns in this table.
+ { # Column properties for TableCard.
+ "header": "A String", # Required. Column heading.
+ "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
+ },
+ ],
+ "buttons": [ # Optional. List of buttons for the card.
+ { # The button object that appears at the bottom of a card.
+ "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
+ "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
+ },
+ "title": "A String", # Required. The title of the button.
+ },
+ ],
+ },
"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.
@@ -680,16 +876,15 @@
"title": "A String", # Required. The title of the list item.
},
],
+ "subtitle": "A String", # Optional. Subtitle of the list.
"title": "A String", # Optional. The overall title of the list.
},
- "payload": { # Returns a response containing a custom, platform-specific payload.
- # See the Intent.Message.Platform type for a description of the
- # structure that may be required for your platform.
+ "payload": { # A custom platform-specific response.
"a_key": "", # Properties of the object.
},
"card": { # The card response message. # The card response.
"buttons": [ # Optional. The collection of card buttons.
- { # Optional. Contains information about a button.
+ { # 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.
@@ -701,60 +896,82 @@
},
},
],
- "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",
],
"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
- # priorities. If this is zero or unspecified, we use the default
- # priority 500000.
+ # priorities.
#
- # Negative numbers mean that the intent is disabled.
+ # - 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>`.
- "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",
- ],
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"action": "A String", # Optional. The name of the action associated with the intent.
# Note: The action name must not contain whitespaces.
+ "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
+ # session when this intent is matched.
"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>`.
+ # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
{ # Represents a context.
- "parameters": { # Optional. The collection of parameters associated with this context.
- # Refer to [this
- # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
- # for syntax.
- "a_key": "", # Properties of the object.
- },
"name": "A String", # Required. The unique identifier of the context. Format:
- # `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`.
+ # `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.
+ # 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`
+ "parameters": { # Optional. The collection of parameters associated with this context.
+ #
+ # Depending on your protocol or client library language, this is a
+ # map, associative array, symbol table, dictionary, or JSON object
+ # composed of a collection of (MapKey, MapValue) pairs:
+ #
+ # - MapKey type: string
+ # - MapKey value: parameter name
+ # - MapValue type:
+ # - If parameter's entity type is a composite entity: map
+ # - Else: string or number, depending on parameter value type
+ # - MapValue value:
+ # - If parameter's entity type is a composite entity:
+ # map from composite entity property names to property values
+ # - Else: parameter value
+ "a_key": "", # Properties of the object.
+ },
"lifespanCount": 42, # Optional. The number of conversational query requests after which the
- # context expires. If set to `0` (the default) the context expires
+ # 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.
},
],
+ "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",
+ ],
"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",
],
},
@@ -774,12 +991,28 @@
{ # 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.
+ },
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
# long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
+ "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}`.
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -798,33 +1031,17 @@
},
],
},
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
- # If `true`, the operation is completed, and either `error` or `response` is
- # available.
- "response": { # The normal response of the operation in case of success. If the original
- # method returns no data on success, such as `Delete`, the response is
- # `google.protobuf.Empty`. If the original method is standard
- # `Get`/`Create`/`Update`, the response should be the resource. For other
- # methods, the response should have the type `XxxResponse`, where `Xxx`
- # is the original method name. For example, if the original method name
- # is `TakeSnapshot()`, the inferred response type is
- # `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
}</pre>
</div>
<div class="method">
- <code class="details" id="create">create(parent, body, languageCode=None, intentView=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:
parent: string, Required. The agent to create a intent for.
-Format: `projects/<Project ID>/agent`. (required)
- body: object, The request body. (required)
+Format: `projects/<Project ID>/agent`. (required)
+ body: object, The request body.
The object takes the form of:
{ # Represents an intent.
@@ -832,14 +1049,14 @@
# action is an extraction of a user command or sentence semantics.
"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
- # Note: If `ml_diabled` setting is set to true, then this intent is not
+ # Note: If `ml_disabled` setting is set to true, then this intent is not
# taken into account during inference in `ML ONLY` match mode. Also,
# auto-markup in the UI is turned off.
"displayName": "A String", # Required. The name of this intent.
- "name": "A String", # The unique identifier of this intent.
+ "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>`.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
"displayName": "A String", # Required. The name of the parameter.
@@ -858,7 +1075,7 @@
# - a parameter value from some context defined as
# `#context_name.parameter_name`.
"prompts": [ # Optional. The collection of prompts that the agent can present to the
- # user in order to collect value for the parameter.
+ # user in order to collect a value for the parameter.
"A String",
],
"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
@@ -913,17 +1130,27 @@
# 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>`.
+ # 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>`.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
},
],
"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
- "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>`.
"messages": [ # Optional. The collection of rich messages corresponding to the
# `Response` field in the Dialogflow console.
- { # Corresponds to the `Response` field in the Dialogflow console.
+ { # 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).
"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
@@ -956,6 +1183,26 @@
# e.g., screen readers.
"imageUri": "A String", # Optional. The public URI to an image file.
},
+ "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
+ "mediaObjects": [ # Required. List of media objects.
+ { # Response media object for media content card.
+ "contentUrl": "A String", # Required. Url where the media is stored.
+ "description": "A String", # Optional. Description of media card.
+ "name": "A String", # Required. Name of media card.
+ "largeImage": { # The image response message. # Optional. Image to display above media content.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ "icon": { # The image response message. # Optional. Icon to display above media content.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ },
+ ],
+ "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
+ },
"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
@@ -970,6 +1217,31 @@
# suggestion chip.
"destinationName": "A String", # Required. The name of the app or site this chip is linking to.
},
+ "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
+ # https://developers.google.com/actions/assistant/responses#browsing_carousel
+ "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
+ # items, maximum of ten.
+ { # Browsing carousel tile
+ "image": { # The image response message. # Optional. Hero image for the carousel item.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
+ "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
+ # text.
+ "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
+ "url": "A String", # Required. URL
+ "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
+ # the URL. Defaults to opening via web browser.
+ },
+ "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
+ # Card. Maximum of one line of text.
+ },
+ ],
+ "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
+ # items.
+ },
"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.
@@ -988,6 +1260,39 @@
"formattedText": "A String", # Required, unless image is present. The body text of the card.
"title": "A String", # Optional. The title of the card.
},
+ "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "rows": [ # Optional. Rows in this table of data.
+ { # Row of TableCard.
+ "cells": [ # Optional. List of cells that make up this row.
+ { # Cell of TableCardRow.
+ "text": "A String", # Required. Text in this cell.
+ },
+ ],
+ "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
+ },
+ ],
+ "subtitle": "A String", # Optional. Subtitle to the title.
+ "title": "A String", # Required. Title of the card.
+ "image": { # The image response message. # Optional. Image which should be displayed on the card.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ "columnProperties": [ # Optional. Display properties for the columns in this table.
+ { # Column properties for TableCard.
+ "header": "A String", # Required. Column heading.
+ "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
+ },
+ ],
+ "buttons": [ # Optional. List of buttons for the card.
+ { # The button object that appears at the bottom of a card.
+ "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
+ "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
+ },
+ "title": "A String", # Required. The title of the button.
+ },
+ ],
+ },
"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.
@@ -1031,16 +1336,15 @@
"title": "A String", # Required. The title of the list item.
},
],
+ "subtitle": "A String", # Optional. Subtitle of the list.
"title": "A String", # Optional. The overall title of the list.
},
- "payload": { # Returns a response containing a custom, platform-specific payload.
- # See the Intent.Message.Platform type for a description of the
- # structure that may be required for your platform.
+ "payload": { # A custom platform-specific response.
"a_key": "", # Properties of the object.
},
"card": { # The card response message. # The card response.
"buttons": [ # Optional. The collection of card buttons.
- { # Optional. Contains information about a button.
+ { # 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.
@@ -1052,70 +1356,91 @@
},
},
],
- "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",
],
"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
- # priorities. If this is zero or unspecified, we use the default
- # priority 500000.
+ # priorities.
#
- # Negative numbers mean that the intent is disabled.
+ # - 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>`.
- "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",
- ],
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"action": "A String", # Optional. The name of the action associated with the intent.
# Note: The action name must not contain whitespaces.
+ "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
+ # session when this intent is matched.
"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>`.
+ # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
{ # Represents a context.
- "parameters": { # Optional. The collection of parameters associated with this context.
- # Refer to [this
- # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
- # for syntax.
- "a_key": "", # Properties of the object.
- },
"name": "A String", # Required. The unique identifier of the context. Format:
- # `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`.
+ # `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.
+ # 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`
+ "parameters": { # Optional. The collection of parameters associated with this context.
+ #
+ # Depending on your protocol or client library language, this is a
+ # map, associative array, symbol table, dictionary, or JSON object
+ # composed of a collection of (MapKey, MapValue) pairs:
+ #
+ # - MapKey type: string
+ # - MapKey value: parameter name
+ # - MapValue type:
+ # - If parameter's entity type is a composite entity: map
+ # - Else: string or number, depending on parameter value type
+ # - MapValue value:
+ # - If parameter's entity type is a composite entity:
+ # map from composite entity property names to property values
+ # - Else: parameter value
+ "a_key": "", # Properties of the object.
+ },
"lifespanCount": 42, # Optional. The number of conversational query requests after which the
- # context expires. If set to `0` (the default) the context expires
+ # 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.
},
],
+ "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",
+ ],
"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",
],
}
- languageCode: string, Optional. The language of training phrases, parameters and rich messages
-defined in `intent`. If not specified, the agent's default language is
-used. [Many
-languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)
-are supported. Note: languages must be enabled in the agent before they can
-be used.
+ 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
@@ -1130,14 +1455,14 @@
# action is an extraction of a user command or sentence semantics.
"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
- # Note: If `ml_diabled` setting is set to true, then this intent is not
+ # Note: If `ml_disabled` setting is set to true, then this intent is not
# taken into account during inference in `ML ONLY` match mode. Also,
# auto-markup in the UI is turned off.
"displayName": "A String", # Required. The name of this intent.
- "name": "A String", # The unique identifier of this intent.
+ "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>`.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
"displayName": "A String", # Required. The name of the parameter.
@@ -1156,7 +1481,7 @@
# - a parameter value from some context defined as
# `#context_name.parameter_name`.
"prompts": [ # Optional. The collection of prompts that the agent can present to the
- # user in order to collect value for the parameter.
+ # user in order to collect a value for the parameter.
"A String",
],
"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
@@ -1211,17 +1536,27 @@
# 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>`.
+ # 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>`.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
},
],
"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
- "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>`.
"messages": [ # Optional. The collection of rich messages corresponding to the
# `Response` field in the Dialogflow console.
- { # Corresponds to the `Response` field in the Dialogflow console.
+ { # 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).
"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
@@ -1254,6 +1589,26 @@
# e.g., screen readers.
"imageUri": "A String", # Optional. The public URI to an image file.
},
+ "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
+ "mediaObjects": [ # Required. List of media objects.
+ { # Response media object for media content card.
+ "contentUrl": "A String", # Required. Url where the media is stored.
+ "description": "A String", # Optional. Description of media card.
+ "name": "A String", # Required. Name of media card.
+ "largeImage": { # The image response message. # Optional. Image to display above media content.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ "icon": { # The image response message. # Optional. Icon to display above media content.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ },
+ ],
+ "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
+ },
"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
@@ -1268,6 +1623,31 @@
# suggestion chip.
"destinationName": "A String", # Required. The name of the app or site this chip is linking to.
},
+ "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
+ # https://developers.google.com/actions/assistant/responses#browsing_carousel
+ "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
+ # items, maximum of ten.
+ { # Browsing carousel tile
+ "image": { # The image response message. # Optional. Hero image for the carousel item.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
+ "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
+ # text.
+ "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
+ "url": "A String", # Required. URL
+ "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
+ # the URL. Defaults to opening via web browser.
+ },
+ "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
+ # Card. Maximum of one line of text.
+ },
+ ],
+ "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
+ # items.
+ },
"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.
@@ -1286,6 +1666,39 @@
"formattedText": "A String", # Required, unless image is present. The body text of the card.
"title": "A String", # Optional. The title of the card.
},
+ "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "rows": [ # Optional. Rows in this table of data.
+ { # Row of TableCard.
+ "cells": [ # Optional. List of cells that make up this row.
+ { # Cell of TableCardRow.
+ "text": "A String", # Required. Text in this cell.
+ },
+ ],
+ "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
+ },
+ ],
+ "subtitle": "A String", # Optional. Subtitle to the title.
+ "title": "A String", # Required. Title of the card.
+ "image": { # The image response message. # Optional. Image which should be displayed on the card.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ "columnProperties": [ # Optional. Display properties for the columns in this table.
+ { # Column properties for TableCard.
+ "header": "A String", # Required. Column heading.
+ "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
+ },
+ ],
+ "buttons": [ # Optional. List of buttons for the card.
+ { # The button object that appears at the bottom of a card.
+ "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
+ "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
+ },
+ "title": "A String", # Required. The title of the button.
+ },
+ ],
+ },
"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.
@@ -1329,16 +1742,15 @@
"title": "A String", # Required. The title of the list item.
},
],
+ "subtitle": "A String", # Optional. Subtitle of the list.
"title": "A String", # Optional. The overall title of the list.
},
- "payload": { # Returns a response containing a custom, platform-specific payload.
- # See the Intent.Message.Platform type for a description of the
- # structure that may be required for your platform.
+ "payload": { # A custom platform-specific response.
"a_key": "", # Properties of the object.
},
"card": { # The card response message. # The card response.
"buttons": [ # Optional. The collection of card buttons.
- { # Optional. Contains information about a button.
+ { # 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.
@@ -1350,60 +1762,82 @@
},
},
],
- "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",
],
"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
- # priorities. If this is zero or unspecified, we use the default
- # priority 500000.
+ # priorities.
#
- # Negative numbers mean that the intent is disabled.
+ # - 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>`.
- "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",
- ],
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"action": "A String", # Optional. The name of the action associated with the intent.
# Note: The action name must not contain whitespaces.
+ "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
+ # session when this intent is matched.
"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>`.
+ # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
{ # Represents a context.
- "parameters": { # Optional. The collection of parameters associated with this context.
- # Refer to [this
- # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
- # for syntax.
- "a_key": "", # Properties of the object.
- },
"name": "A String", # Required. The unique identifier of the context. Format:
- # `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`.
+ # `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.
+ # 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`
+ "parameters": { # Optional. The collection of parameters associated with this context.
+ #
+ # Depending on your protocol or client library language, this is a
+ # map, associative array, symbol table, dictionary, or JSON object
+ # composed of a collection of (MapKey, MapValue) pairs:
+ #
+ # - MapKey type: string
+ # - MapKey value: parameter name
+ # - MapValue type:
+ # - If parameter's entity type is a composite entity: map
+ # - Else: string or number, depending on parameter value type
+ # - MapValue value:
+ # - If parameter's entity type is a composite entity:
+ # map from composite entity property names to property values
+ # - Else: parameter value
+ "a_key": "", # Properties of the object.
+ },
"lifespanCount": 42, # Optional. The number of conversational query requests after which the
- # context expires. If set to `0` (the default) the context expires
+ # 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.
},
],
+ "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",
+ ],
"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",
],
}</pre>
@@ -1416,7 +1850,7 @@
Args:
name: string, Required. The name of the intent to delete. If this intent has direct or
indirect followup intents, we also delete them.
-Format: `projects/<Project ID>/agent/intents/<Intent ID>`. (required)
+Format: `projects/<Project ID>/agent/intents/<Intent ID>`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -1443,13 +1877,12 @@
Args:
name: string, Required. The name of the intent.
-Format: `projects/<Project ID>/agent/intents/<Intent ID>`. (required)
- languageCode: string, Optional. The language to retrieve training phrases, parameters and rich
-messages for. If not specified, the agent's default language is used.
-[Many
-languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)
-are supported. Note: languages must be enabled in the agent before they can
-be used.
+Format: `projects/<Project ID>/agent/intents/<Intent ID>`. (required)
+ 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
@@ -1464,14 +1897,14 @@
# action is an extraction of a user command or sentence semantics.
"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
- # Note: If `ml_diabled` setting is set to true, then this intent is not
+ # Note: If `ml_disabled` setting is set to true, then this intent is not
# taken into account during inference in `ML ONLY` match mode. Also,
# auto-markup in the UI is turned off.
"displayName": "A String", # Required. The name of this intent.
- "name": "A String", # The unique identifier of this intent.
+ "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>`.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
"displayName": "A String", # Required. The name of the parameter.
@@ -1490,7 +1923,7 @@
# - a parameter value from some context defined as
# `#context_name.parameter_name`.
"prompts": [ # Optional. The collection of prompts that the agent can present to the
- # user in order to collect value for the parameter.
+ # user in order to collect a value for the parameter.
"A String",
],
"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
@@ -1545,17 +1978,27 @@
# 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>`.
+ # 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>`.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
},
],
"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
- "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>`.
"messages": [ # Optional. The collection of rich messages corresponding to the
# `Response` field in the Dialogflow console.
- { # Corresponds to the `Response` field in the Dialogflow console.
+ { # 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).
"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
@@ -1588,6 +2031,26 @@
# e.g., screen readers.
"imageUri": "A String", # Optional. The public URI to an image file.
},
+ "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
+ "mediaObjects": [ # Required. List of media objects.
+ { # Response media object for media content card.
+ "contentUrl": "A String", # Required. Url where the media is stored.
+ "description": "A String", # Optional. Description of media card.
+ "name": "A String", # Required. Name of media card.
+ "largeImage": { # The image response message. # Optional. Image to display above media content.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ "icon": { # The image response message. # Optional. Icon to display above media content.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ },
+ ],
+ "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
+ },
"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
@@ -1602,6 +2065,31 @@
# suggestion chip.
"destinationName": "A String", # Required. The name of the app or site this chip is linking to.
},
+ "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
+ # https://developers.google.com/actions/assistant/responses#browsing_carousel
+ "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
+ # items, maximum of ten.
+ { # Browsing carousel tile
+ "image": { # The image response message. # Optional. Hero image for the carousel item.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
+ "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
+ # text.
+ "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
+ "url": "A String", # Required. URL
+ "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
+ # the URL. Defaults to opening via web browser.
+ },
+ "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
+ # Card. Maximum of one line of text.
+ },
+ ],
+ "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
+ # items.
+ },
"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.
@@ -1620,6 +2108,39 @@
"formattedText": "A String", # Required, unless image is present. The body text of the card.
"title": "A String", # Optional. The title of the card.
},
+ "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "rows": [ # Optional. Rows in this table of data.
+ { # Row of TableCard.
+ "cells": [ # Optional. List of cells that make up this row.
+ { # Cell of TableCardRow.
+ "text": "A String", # Required. Text in this cell.
+ },
+ ],
+ "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
+ },
+ ],
+ "subtitle": "A String", # Optional. Subtitle to the title.
+ "title": "A String", # Required. Title of the card.
+ "image": { # The image response message. # Optional. Image which should be displayed on the card.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ "columnProperties": [ # Optional. Display properties for the columns in this table.
+ { # Column properties for TableCard.
+ "header": "A String", # Required. Column heading.
+ "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
+ },
+ ],
+ "buttons": [ # Optional. List of buttons for the card.
+ { # The button object that appears at the bottom of a card.
+ "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
+ "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
+ },
+ "title": "A String", # Required. The title of the button.
+ },
+ ],
+ },
"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.
@@ -1663,16 +2184,15 @@
"title": "A String", # Required. The title of the list item.
},
],
+ "subtitle": "A String", # Optional. Subtitle of the list.
"title": "A String", # Optional. The overall title of the list.
},
- "payload": { # Returns a response containing a custom, platform-specific payload.
- # See the Intent.Message.Platform type for a description of the
- # structure that may be required for your platform.
+ "payload": { # A custom platform-specific response.
"a_key": "", # Properties of the object.
},
"card": { # The card response message. # The card response.
"buttons": [ # Optional. The collection of card buttons.
- { # Optional. Contains information about a button.
+ { # 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.
@@ -1684,60 +2204,82 @@
},
},
],
- "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",
],
"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
- # priorities. If this is zero or unspecified, we use the default
- # priority 500000.
+ # priorities.
#
- # Negative numbers mean that the intent is disabled.
+ # - 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>`.
- "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",
- ],
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"action": "A String", # Optional. The name of the action associated with the intent.
# Note: The action name must not contain whitespaces.
+ "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
+ # session when this intent is matched.
"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>`.
+ # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
{ # Represents a context.
- "parameters": { # Optional. The collection of parameters associated with this context.
- # Refer to [this
- # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
- # for syntax.
- "a_key": "", # Properties of the object.
- },
"name": "A String", # Required. The unique identifier of the context. Format:
- # `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`.
+ # `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.
+ # 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`
+ "parameters": { # Optional. The collection of parameters associated with this context.
+ #
+ # Depending on your protocol or client library language, this is a
+ # map, associative array, symbol table, dictionary, or JSON object
+ # composed of a collection of (MapKey, MapValue) pairs:
+ #
+ # - MapKey type: string
+ # - MapKey value: parameter name
+ # - MapValue type:
+ # - If parameter's entity type is a composite entity: map
+ # - Else: string or number, depending on parameter value type
+ # - MapValue value:
+ # - If parameter's entity type is a composite entity:
+ # map from composite entity property names to property values
+ # - Else: parameter value
+ "a_key": "", # Properties of the object.
+ },
"lifespanCount": 42, # Optional. The number of conversational query requests after which the
- # context expires. If set to `0` (the default) the context expires
+ # 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.
},
],
+ "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",
+ ],
"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",
],
}</pre>
@@ -1749,13 +2291,12 @@
Args:
parent: string, Required. The agent to list all intents from.
-Format: `projects/<Project ID>/agent`. (required)
- languageCode: string, Optional. The language to list training phrases, parameters and rich
-messages for. If not specified, the agent's default language is used.
-[Many
-languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)
-are supported. Note: languages must be enabled in the agent before they can
-be used.
+Format: `projects/<Project ID>/agent`. (required)
+ 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).
pageSize: integer, Optional. The maximum number of items to return in a single page. By
default 100 and at most 1000.
intentView: string, Optional. The resource view to apply to the returned intent.
@@ -1778,14 +2319,14 @@
# action is an extraction of a user command or sentence semantics.
"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
- # Note: If `ml_diabled` setting is set to true, then this intent is not
+ # Note: If `ml_disabled` setting is set to true, then this intent is not
# taken into account during inference in `ML ONLY` match mode. Also,
# auto-markup in the UI is turned off.
"displayName": "A String", # Required. The name of this intent.
- "name": "A String", # The unique identifier of this intent.
+ "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>`.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
"displayName": "A String", # Required. The name of the parameter.
@@ -1804,7 +2345,7 @@
# - a parameter value from some context defined as
# `#context_name.parameter_name`.
"prompts": [ # Optional. The collection of prompts that the agent can present to the
- # user in order to collect value for the parameter.
+ # user in order to collect a value for the parameter.
"A String",
],
"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
@@ -1859,17 +2400,27 @@
# 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>`.
+ # 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>`.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
},
],
"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
- "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>`.
"messages": [ # Optional. The collection of rich messages corresponding to the
# `Response` field in the Dialogflow console.
- { # Corresponds to the `Response` field in the Dialogflow console.
+ { # 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).
"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
@@ -1902,6 +2453,26 @@
# e.g., screen readers.
"imageUri": "A String", # Optional. The public URI to an image file.
},
+ "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
+ "mediaObjects": [ # Required. List of media objects.
+ { # Response media object for media content card.
+ "contentUrl": "A String", # Required. Url where the media is stored.
+ "description": "A String", # Optional. Description of media card.
+ "name": "A String", # Required. Name of media card.
+ "largeImage": { # The image response message. # Optional. Image to display above media content.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ "icon": { # The image response message. # Optional. Icon to display above media content.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ },
+ ],
+ "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
+ },
"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
@@ -1916,6 +2487,31 @@
# suggestion chip.
"destinationName": "A String", # Required. The name of the app or site this chip is linking to.
},
+ "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
+ # https://developers.google.com/actions/assistant/responses#browsing_carousel
+ "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
+ # items, maximum of ten.
+ { # Browsing carousel tile
+ "image": { # The image response message. # Optional. Hero image for the carousel item.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
+ "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
+ # text.
+ "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
+ "url": "A String", # Required. URL
+ "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
+ # the URL. Defaults to opening via web browser.
+ },
+ "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
+ # Card. Maximum of one line of text.
+ },
+ ],
+ "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
+ # items.
+ },
"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.
@@ -1934,6 +2530,39 @@
"formattedText": "A String", # Required, unless image is present. The body text of the card.
"title": "A String", # Optional. The title of the card.
},
+ "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "rows": [ # Optional. Rows in this table of data.
+ { # Row of TableCard.
+ "cells": [ # Optional. List of cells that make up this row.
+ { # Cell of TableCardRow.
+ "text": "A String", # Required. Text in this cell.
+ },
+ ],
+ "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
+ },
+ ],
+ "subtitle": "A String", # Optional. Subtitle to the title.
+ "title": "A String", # Required. Title of the card.
+ "image": { # The image response message. # Optional. Image which should be displayed on the card.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ "columnProperties": [ # Optional. Display properties for the columns in this table.
+ { # Column properties for TableCard.
+ "header": "A String", # Required. Column heading.
+ "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
+ },
+ ],
+ "buttons": [ # Optional. List of buttons for the card.
+ { # The button object that appears at the bottom of a card.
+ "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
+ "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
+ },
+ "title": "A String", # Required. The title of the button.
+ },
+ ],
+ },
"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.
@@ -1977,16 +2606,15 @@
"title": "A String", # Required. The title of the list item.
},
],
+ "subtitle": "A String", # Optional. Subtitle of the list.
"title": "A String", # Optional. The overall title of the list.
},
- "payload": { # Returns a response containing a custom, platform-specific payload.
- # See the Intent.Message.Platform type for a description of the
- # structure that may be required for your platform.
+ "payload": { # A custom platform-specific response.
"a_key": "", # Properties of the object.
},
"card": { # The card response message. # The card response.
"buttons": [ # Optional. The collection of card buttons.
- { # Optional. Contains information about a button.
+ { # 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.
@@ -1998,60 +2626,82 @@
},
},
],
- "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",
],
"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
- # priorities. If this is zero or unspecified, we use the default
- # priority 500000.
+ # priorities.
#
- # Negative numbers mean that the intent is disabled.
+ # - 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>`.
- "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",
- ],
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"action": "A String", # Optional. The name of the action associated with the intent.
# Note: The action name must not contain whitespaces.
+ "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
+ # session when this intent is matched.
"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>`.
+ # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
{ # Represents a context.
- "parameters": { # Optional. The collection of parameters associated with this context.
- # Refer to [this
- # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
- # for syntax.
- "a_key": "", # Properties of the object.
- },
"name": "A String", # Required. The unique identifier of the context. Format:
- # `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`.
+ # `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.
+ # 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`
+ "parameters": { # Optional. The collection of parameters associated with this context.
+ #
+ # Depending on your protocol or client library language, this is a
+ # map, associative array, symbol table, dictionary, or JSON object
+ # composed of a collection of (MapKey, MapValue) pairs:
+ #
+ # - MapKey type: string
+ # - MapKey value: parameter name
+ # - MapValue type:
+ # - If parameter's entity type is a composite entity: map
+ # - Else: string or number, depending on parameter value type
+ # - MapValue value:
+ # - If parameter's entity type is a composite entity:
+ # map from composite entity property names to property values
+ # - Else: parameter value
+ "a_key": "", # Properties of the object.
+ },
"lifespanCount": 42, # Optional. The number of conversational query requests after which the
- # context expires. If set to `0` (the default) the context expires
+ # 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.
},
],
+ "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",
+ ],
"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",
],
},
@@ -2074,15 +2724,15 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(name, body, languageCode=None, intentView=None, updateMask=None, x__xgafv=None)</code>
+ <code class="details" id="patch">patch(name, body=None, languageCode=None, intentView=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the specified intent.
Args:
- name: string, The unique identifier of this intent.
+ name: string, Optional. The unique identifier of this intent.
Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
methods.
-Format: `projects/<Project ID>/agent/intents/<Intent ID>`. (required)
- body: object, The request body. (required)
+Format: `projects/<Project ID>/agent/intents/<Intent ID>`. (required)
+ body: object, The request body.
The object takes the form of:
{ # Represents an intent.
@@ -2090,14 +2740,14 @@
# action is an extraction of a user command or sentence semantics.
"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
- # Note: If `ml_diabled` setting is set to true, then this intent is not
+ # Note: If `ml_disabled` setting is set to true, then this intent is not
# taken into account during inference in `ML ONLY` match mode. Also,
# auto-markup in the UI is turned off.
"displayName": "A String", # Required. The name of this intent.
- "name": "A String", # The unique identifier of this intent.
+ "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>`.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
"displayName": "A String", # Required. The name of the parameter.
@@ -2116,7 +2766,7 @@
# - a parameter value from some context defined as
# `#context_name.parameter_name`.
"prompts": [ # Optional. The collection of prompts that the agent can present to the
- # user in order to collect value for the parameter.
+ # user in order to collect a value for the parameter.
"A String",
],
"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
@@ -2171,17 +2821,27 @@
# 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>`.
+ # 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>`.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
},
],
"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
- "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>`.
"messages": [ # Optional. The collection of rich messages corresponding to the
# `Response` field in the Dialogflow console.
- { # Corresponds to the `Response` field in the Dialogflow console.
+ { # 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).
"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
@@ -2214,6 +2874,26 @@
# e.g., screen readers.
"imageUri": "A String", # Optional. The public URI to an image file.
},
+ "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
+ "mediaObjects": [ # Required. List of media objects.
+ { # Response media object for media content card.
+ "contentUrl": "A String", # Required. Url where the media is stored.
+ "description": "A String", # Optional. Description of media card.
+ "name": "A String", # Required. Name of media card.
+ "largeImage": { # The image response message. # Optional. Image to display above media content.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ "icon": { # The image response message. # Optional. Icon to display above media content.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ },
+ ],
+ "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
+ },
"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
@@ -2228,6 +2908,31 @@
# suggestion chip.
"destinationName": "A String", # Required. The name of the app or site this chip is linking to.
},
+ "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
+ # https://developers.google.com/actions/assistant/responses#browsing_carousel
+ "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
+ # items, maximum of ten.
+ { # Browsing carousel tile
+ "image": { # The image response message. # Optional. Hero image for the carousel item.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
+ "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
+ # text.
+ "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
+ "url": "A String", # Required. URL
+ "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
+ # the URL. Defaults to opening via web browser.
+ },
+ "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
+ # Card. Maximum of one line of text.
+ },
+ ],
+ "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
+ # items.
+ },
"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.
@@ -2246,6 +2951,39 @@
"formattedText": "A String", # Required, unless image is present. The body text of the card.
"title": "A String", # Optional. The title of the card.
},
+ "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "rows": [ # Optional. Rows in this table of data.
+ { # Row of TableCard.
+ "cells": [ # Optional. List of cells that make up this row.
+ { # Cell of TableCardRow.
+ "text": "A String", # Required. Text in this cell.
+ },
+ ],
+ "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
+ },
+ ],
+ "subtitle": "A String", # Optional. Subtitle to the title.
+ "title": "A String", # Required. Title of the card.
+ "image": { # The image response message. # Optional. Image which should be displayed on the card.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ "columnProperties": [ # Optional. Display properties for the columns in this table.
+ { # Column properties for TableCard.
+ "header": "A String", # Required. Column heading.
+ "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
+ },
+ ],
+ "buttons": [ # Optional. List of buttons for the card.
+ { # The button object that appears at the bottom of a card.
+ "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
+ "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
+ },
+ "title": "A String", # Required. The title of the button.
+ },
+ ],
+ },
"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.
@@ -2289,16 +3027,15 @@
"title": "A String", # Required. The title of the list item.
},
],
+ "subtitle": "A String", # Optional. Subtitle of the list.
"title": "A String", # Optional. The overall title of the list.
},
- "payload": { # Returns a response containing a custom, platform-specific payload.
- # See the Intent.Message.Platform type for a description of the
- # structure that may be required for your platform.
+ "payload": { # A custom platform-specific response.
"a_key": "", # Properties of the object.
},
"card": { # The card response message. # The card response.
"buttons": [ # Optional. The collection of card buttons.
- { # Optional. Contains information about a button.
+ { # 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.
@@ -2310,70 +3047,91 @@
},
},
],
- "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",
],
"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
- # priorities. If this is zero or unspecified, we use the default
- # priority 500000.
+ # priorities.
#
- # Negative numbers mean that the intent is disabled.
+ # - 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>`.
- "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",
- ],
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"action": "A String", # Optional. The name of the action associated with the intent.
# Note: The action name must not contain whitespaces.
+ "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
+ # session when this intent is matched.
"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>`.
+ # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
{ # Represents a context.
- "parameters": { # Optional. The collection of parameters associated with this context.
- # Refer to [this
- # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
- # for syntax.
- "a_key": "", # Properties of the object.
- },
"name": "A String", # Required. The unique identifier of the context. Format:
- # `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`.
+ # `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.
+ # 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`
+ "parameters": { # Optional. The collection of parameters associated with this context.
+ #
+ # Depending on your protocol or client library language, this is a
+ # map, associative array, symbol table, dictionary, or JSON object
+ # composed of a collection of (MapKey, MapValue) pairs:
+ #
+ # - MapKey type: string
+ # - MapKey value: parameter name
+ # - MapValue type:
+ # - If parameter's entity type is a composite entity: map
+ # - Else: string or number, depending on parameter value type
+ # - MapValue value:
+ # - If parameter's entity type is a composite entity:
+ # map from composite entity property names to property values
+ # - Else: parameter value
+ "a_key": "", # Properties of the object.
+ },
"lifespanCount": 42, # Optional. The number of conversational query requests after which the
- # context expires. If set to `0` (the default) the context expires
+ # 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.
},
],
+ "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",
+ ],
"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",
],
}
- languageCode: string, Optional. The language of training phrases, parameters and rich messages
-defined in `intent`. If not specified, the agent's default language is
-used. [Many
-languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)
-are supported. Note: languages must be enabled in the agent before they can
-be used.
+ 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.
updateMask: string, Optional. The mask to control which fields get updated.
x__xgafv: string, V1 error format.
@@ -2389,14 +3147,14 @@
# action is an extraction of a user command or sentence semantics.
"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
- # Note: If `ml_diabled` setting is set to true, then this intent is not
+ # Note: If `ml_disabled` setting is set to true, then this intent is not
# taken into account during inference in `ML ONLY` match mode. Also,
# auto-markup in the UI is turned off.
"displayName": "A String", # Required. The name of this intent.
- "name": "A String", # The unique identifier of this intent.
+ "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>`.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
"displayName": "A String", # Required. The name of the parameter.
@@ -2415,7 +3173,7 @@
# - a parameter value from some context defined as
# `#context_name.parameter_name`.
"prompts": [ # Optional. The collection of prompts that the agent can present to the
- # user in order to collect value for the parameter.
+ # user in order to collect a value for the parameter.
"A String",
],
"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
@@ -2470,17 +3228,27 @@
# 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>`.
+ # 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>`.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
},
],
"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
- "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>`.
"messages": [ # Optional. The collection of rich messages corresponding to the
# `Response` field in the Dialogflow console.
- { # Corresponds to the `Response` field in the Dialogflow console.
+ { # 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).
"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
@@ -2513,6 +3281,26 @@
# e.g., screen readers.
"imageUri": "A String", # Optional. The public URI to an image file.
},
+ "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
+ "mediaObjects": [ # Required. List of media objects.
+ { # Response media object for media content card.
+ "contentUrl": "A String", # Required. Url where the media is stored.
+ "description": "A String", # Optional. Description of media card.
+ "name": "A String", # Required. Name of media card.
+ "largeImage": { # The image response message. # Optional. Image to display above media content.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ "icon": { # The image response message. # Optional. Icon to display above media content.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ },
+ ],
+ "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
+ },
"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
@@ -2527,6 +3315,31 @@
# suggestion chip.
"destinationName": "A String", # Required. The name of the app or site this chip is linking to.
},
+ "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
+ # https://developers.google.com/actions/assistant/responses#browsing_carousel
+ "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
+ # items, maximum of ten.
+ { # Browsing carousel tile
+ "image": { # The image response message. # Optional. Hero image for the carousel item.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
+ "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
+ # text.
+ "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
+ "url": "A String", # Required. URL
+ "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
+ # the URL. Defaults to opening via web browser.
+ },
+ "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
+ # Card. Maximum of one line of text.
+ },
+ ],
+ "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
+ # items.
+ },
"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.
@@ -2545,6 +3358,39 @@
"formattedText": "A String", # Required, unless image is present. The body text of the card.
"title": "A String", # Optional. The title of the card.
},
+ "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "rows": [ # Optional. Rows in this table of data.
+ { # Row of TableCard.
+ "cells": [ # Optional. List of cells that make up this row.
+ { # Cell of TableCardRow.
+ "text": "A String", # Required. Text in this cell.
+ },
+ ],
+ "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
+ },
+ ],
+ "subtitle": "A String", # Optional. Subtitle to the title.
+ "title": "A String", # Required. Title of the card.
+ "image": { # The image response message. # Optional. Image which should be displayed on the card.
+ "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
+ # e.g., screen readers.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ },
+ "columnProperties": [ # Optional. Display properties for the columns in this table.
+ { # Column properties for TableCard.
+ "header": "A String", # Required. Column heading.
+ "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
+ },
+ ],
+ "buttons": [ # Optional. List of buttons for the card.
+ { # The button object that appears at the bottom of a card.
+ "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
+ "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
+ },
+ "title": "A String", # Required. The title of the button.
+ },
+ ],
+ },
"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.
@@ -2588,16 +3434,15 @@
"title": "A String", # Required. The title of the list item.
},
],
+ "subtitle": "A String", # Optional. Subtitle of the list.
"title": "A String", # Optional. The overall title of the list.
},
- "payload": { # Returns a response containing a custom, platform-specific payload.
- # See the Intent.Message.Platform type for a description of the
- # structure that may be required for your platform.
+ "payload": { # A custom platform-specific response.
"a_key": "", # Properties of the object.
},
"card": { # The card response message. # The card response.
"buttons": [ # Optional. The collection of card buttons.
- { # Optional. Contains information about a button.
+ { # 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.
@@ -2609,60 +3454,82 @@
},
},
],
- "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",
],
"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
- # priorities. If this is zero or unspecified, we use the default
- # priority 500000.
+ # priorities.
#
- # Negative numbers mean that the intent is disabled.
+ # - 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>`.
- "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",
- ],
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
"action": "A String", # Optional. The name of the action associated with the intent.
# Note: The action name must not contain whitespaces.
+ "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
+ # session when this intent is matched.
"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>`.
+ # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
{ # Represents a context.
- "parameters": { # Optional. The collection of parameters associated with this context.
- # Refer to [this
- # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
- # for syntax.
- "a_key": "", # Properties of the object.
- },
"name": "A String", # Required. The unique identifier of the context. Format:
- # `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`.
+ # `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.
+ # 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`
+ "parameters": { # Optional. The collection of parameters associated with this context.
+ #
+ # Depending on your protocol or client library language, this is a
+ # map, associative array, symbol table, dictionary, or JSON object
+ # composed of a collection of (MapKey, MapValue) pairs:
+ #
+ # - MapKey type: string
+ # - MapKey value: parameter name
+ # - MapValue type:
+ # - If parameter's entity type is a composite entity: map
+ # - Else: string or number, depending on parameter value type
+ # - MapValue value:
+ # - If parameter's entity type is a composite entity:
+ # map from composite entity property names to property values
+ # - Else: parameter value
+ "a_key": "", # Properties of the object.
+ },
"lifespanCount": 42, # Optional. The number of conversational query requests after which the
- # context expires. If set to `0` (the default) the context expires
+ # 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.
},
],
+ "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",
+ ],
"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",
],
}</pre>