docs: update generated docs (#981)
diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.intents.html b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.intents.html
index 3793f5e..42ed924 100644
--- a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.intents.html
+++ b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.intents.html
@@ -81,7 +81,7 @@
<code><a href="#batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates/Creates multiple intents in the specified agent.</p>
<p class="toc_element">
- <code><a href="#create">create(parent, body=None, intentView=None, languageCode=None, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent, body=None, languageCode=None, intentView=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an intent in the specified agent.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
@@ -90,13 +90,13 @@
<code><a href="#get">get(name, intentView=None, languageCode=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the specified intent.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageToken=None, pageSize=None, intentView=None, languageCode=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageSize=None, pageToken=None, intentView=None, languageCode=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the list of all intents in the specified agent.</p>
<p class="toc_element">
<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=None, intentView=None, languageCode=None, updateMask=None, x__xgafv=None)</a></code></p>
+ <code><a href="#patch">patch(name, body=None, languageCode=None, updateMask=None, intentView=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the specified intent.</p>
<h3>Method Details</h3>
<div class="method">
@@ -114,134 +114,58 @@
{ # The request message for Intents.BatchDeleteIntents.
"intents": [ # Required. The collection of intents to delete. Only intent `name` must be
# filled in.
- { # Represents an intent.
- # Intents convert a number of user expressions or patterns into an action. An
- # action is an extraction of a user command or sentence semantics.
- "displayName": "A String", # Required. The name of this intent.
- "rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of
- # followup intents. It identifies the correct followup intents chain for
- # this intent.
- #
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
- # Note: If `ml_disabled` setting is set to true, then this intent is not
- # taken into account during inference in `ML ONLY` match mode. Also,
- # auto-markup in the UI is turned off.
- "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
- "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
- # Note: If `ml_enabled` setting is set to false, then this intent is not
- # taken into account during inference in `ML ONLY` match mode. Also,
- # auto-markup in the UI is turned off.
- # DEPRECATED! Please use `ml_disabled` field instead.
- # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
- # then the default value is determined as follows:
- # - Before April 15th, 2018 the default is:
- # ml_enabled = false / ml_disabled = true.
- # - After April 15th, 2018 the default is:
- # ml_enabled = true / ml_disabled = false.
- "trainingPhrases": [ # Optional. The collection of examples that the agent is
- # trained on.
- { # Represents an example that the agent is trained on.
- "parts": [ # Required. The ordered list of training phrase parts.
- # The parts are concatenated in order to form the training phrase.
- #
- # Note: The API does not automatically annotate training phrases like the
- # Dialogflow Console does.
- #
- # Note: Do not forget to include whitespace at part boundaries,
- # so the training phrase is well formatted when the parts are concatenated.
- #
- # If the training phrase does not need to be annotated with parameters,
- # you just need a single part with only the Part.text field set.
- #
- # If you want to annotate the training phrase, you must create multiple
- # parts, where the fields of each part are populated in one of two ways:
- #
- # - `Part.text` is set to a part of the phrase that has no parameters.
- # - `Part.text` is set to a part of the phrase that you want to annotate,
- # and the `entity_type`, `alias`, and `user_defined` fields are all
- # set.
- { # Represents a part of a training phrase.
- "alias": "A String", # Optional. The parameter name for the value extracted from the
- # annotated part of the example.
- # This field is required for annotated parts of the training phrase.
- "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
- # This field is set to true when the Dialogflow Console is used to
- # manually annotate the part. When creating an annotated part with the
- # API, you must set this to true.
- "text": "A String", # Required. The text for this part.
- "entityType": "A String", # Optional. The entity type name prefixed with `@`.
- # This field is required for annotated parts of the training phrase.
- },
- ],
- "name": "A String", # Output only. The unique identifier of this training phrase.
- "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
- # the intent. Each time a developer adds an existing sample by editing an
- # intent or training, this counter is increased.
- "type": "A String", # Required. The type of the training phrase.
- },
- ],
- "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
- # session when this intent is matched.
- "parameters": [ # Optional. The collection of parameters associated with the intent.
- { # Represents intent parameters.
- "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
- # describes values of the parameter. If the parameter is
- # required, this must be provided.
- "prompts": [ # Optional. The collection of prompts that the agent can present to the
- # user in order to collect a value for the parameter.
- "A String",
- ],
- "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
- # whether the intent cannot be completed without collecting the parameter
- # value.
- "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
- # result.
- # Default values can be extracted from contexts by using the following
- # syntax: `#context_name.parameter_name`.
- "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
- "name": "A String", # The unique identifier of this parameter.
- "value": "A String", # Optional. The definition of the parameter value. It can be:
- #
- # - a constant string,
- # - a parameter value defined as `$parameter_name`,
- # - an original parameter value defined as `$parameter_name.original`,
- # - a parameter value from some context defined as
- # `#context_name.parameter_name`.
- "displayName": "A String", # Required. The name of the parameter.
- },
- ],
- "events": [ # Optional. The collection of event names that trigger the intent.
- # If the collection of input contexts is not empty, all of the contexts must
- # be present in the active user session for an event to trigger this intent.
- # Event names are limited to 150 characters.
- "A String",
- ],
- "parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the
- # chain of followup intents. You can set this field when creating an intent,
- # for example with CreateIntent or
- # BatchUpdateIntents, in order to make this
- # intent a followup intent.
- #
- # It identifies the parent followup intent.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
- # priorities.
- #
- # - If the supplied value is unspecified or 0, the service
- # translates the value to 500,000, which corresponds to the
- # `Normal` priority in the console.
- # - If the supplied value is negative, the intent is ignored
- # in runtime detect intent requests.
+ { # An intent categorizes an end-user's intention for one conversation turn. For
+ # each agent, you define many intents, where your combined intents can handle a
+ # complete conversation. When an end-user writes or says something, referred to
+ # as an end-user expression or end-user input, Dialogflow matches the end-user
+ # input to the best intent in your agent. Matching an intent is also known as
+ # intent classification.
+ #
+ # For more information, see the [intent
+ # guide](https://cloud.google.com/dialogflow/docs/intents-overview).
"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
# (e.g., Actions on Google or Dialogflow phone gateway) use this information
# to close interaction with an end user. Default is false.
+ "action": "A String", # Optional. The name of the action associated with the intent.
+ # Note: The action name must not contain whitespaces.
+ "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
"outputContexts": [ # Optional. The collection of contexts that are activated when the intent
# is matched. Context messages in this collection should not set the
# parameters field. Setting the `lifespan_count` to 0 will reset the context
# when the intent is matched.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
- { # Represents a context.
+ { # Dialogflow contexts are similar to natural language context. If a person says
+ # to you "they are orange", you need context in order to understand what "they"
+ # is referring to. Similarly, for Dialogflow to handle an end-user expression
+ # like that, it needs to be provided with context in order to correctly match
+ # an intent.
+ #
+ # Using contexts, you can control the flow of a conversation. You can configure
+ # contexts for an intent by setting input and output contexts, which are
+ # identified by string names. When an intent is matched, any configured output
+ # contexts for that intent become active. While any contexts are active,
+ # Dialogflow is more likely to match intents that are configured with input
+ # contexts that correspond to the currently active contexts.
+ #
+ # For more information about context, see the
+ # [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).
+ "parameters": { # Optional. The collection of parameters associated with this context.
+ #
+ # Depending on your protocol or client library language, this is a
+ # 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. The default is `0`. If set to `0`, the context expires
# immediately. Contexts expire automatically after 20 minutes if there
@@ -263,46 +187,189 @@
# * `__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.
- },
},
],
- "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",
+ "displayName": "A String", # Required. The name of this intent.
+ "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
+ # session when this intent is matched.
+ "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
+ # Note: If `ml_disabled` setting is set to true, then this intent is not
+ # taken into account during inference in `ML ONLY` match mode. Also,
+ # auto-markup in the UI is turned off.
+ "rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of
+ # followup intents. It identifies the correct followup intents chain for
+ # this intent.
+ #
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "trainingPhrases": [ # Optional. The collection of examples that the agent is
+ # trained on.
+ { # Represents an example that the agent is trained on.
+ "type": "A String", # Required. The type of the training phrase.
+ "name": "A String", # Output only. The unique identifier of this training phrase.
+ "parts": [ # Required. The ordered list of training phrase parts.
+ # The parts are concatenated in order to form the training phrase.
+ #
+ # Note: The API does not automatically annotate training phrases like the
+ # Dialogflow Console does.
+ #
+ # Note: Do not forget to include whitespace at part boundaries,
+ # so the training phrase is well formatted when the parts are concatenated.
+ #
+ # If the training phrase does not need to be annotated with parameters,
+ # you just need a single part with only the Part.text field set.
+ #
+ # If you want to annotate the training phrase, you must create multiple
+ # parts, where the fields of each part are populated in one of two ways:
+ #
+ # - `Part.text` is set to a part of the phrase that has no parameters.
+ # - `Part.text` is set to a part of the phrase that you want to annotate,
+ # and the `entity_type`, `alias`, and `user_defined` fields are all
+ # set.
+ { # Represents a part of a training phrase.
+ "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
+ # This field is set to true when the Dialogflow Console is used to
+ # manually annotate the part. When creating an annotated part with the
+ # API, you must set this to true.
+ "alias": "A String", # Optional. The parameter name for the value extracted from the
+ # annotated part of the example.
+ # This field is required for annotated parts of the training phrase.
+ "entityType": "A String", # Optional. The entity type name prefixed with `@`.
+ # This field is required for annotated parts of the training phrase.
+ "text": "A String", # Required. The text for this part.
+ },
+ ],
+ "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
+ # the intent. Each time a developer adds an existing sample by editing an
+ # intent or training, this counter is increased.
+ },
],
"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.
- "text": { # The text response message. # Returns a text response.
- "text": [ # Optional. The collection of the agent's responses.
+ "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
+ "suggestions": [ # Required. The list of suggested replies.
+ { # The suggestion chip message that the user can tap to quickly post a reply
+ # to the conversation.
+ "title": "A String", # Required. The text shown the in the suggestion chip.
+ },
+ ],
+ },
+ "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
+ "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
+ "mediaObjects": [ # Required. List of media objects.
+ { # Response media object for media content card.
+ "description": "A String", # Optional. Description of media card.
+ "icon": { # The image response message. # Optional. Icon to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "contentUrl": "A String", # Required. Url where the media is stored.
+ "name": "A String", # Required. Name of media card.
+ "largeImage": { # The image response message. # Optional. Image to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ },
+ ],
+ },
+ "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
+ "phoneNumber": "A String", # Required. The phone number to transfer the call to
+ # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+ #
+ # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
+ },
+ "platform": "A String", # Optional. The platform that this message is intended for.
+ "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
+ # Telephony Gateway.
+ #
+ # Telephony Gateway takes the synthesizer settings from
+ # `DetectIntentResponse.output_audio_config` which can either be set
+ # at request-level or can come from the agent-level synthesizer config.
+ "text": "A String", # The raw text to be synthesized.
+ "ssml": "A String", # The SSML to be synthesized. For more information, see
+ # [SSML](https://developers.google.com/actions/reference/ssml).
+ },
+ "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.
+ # or website associated with this agent.
+ "uri": "A String", # Required. The URI of the app or site to open when the user taps the
+ # suggestion chip.
+ "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
+ },
+ "quickReplies": { # The quick replies response message. # Displays quick replies.
+ "quickReplies": [ # Optional. The collection of quick replies.
"A String",
],
+ "title": "A String", # Optional. The title of the collection of quick replies.
+ },
+ "card": { # The card response message. # Displays a card.
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # Optional. Contains information about a button.
+ "text": "A String", # Optional. The text to show on the button.
+ "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
+ # open.
+ },
+ ],
+ "imageUri": "A String", # Optional. The public URI to an image file for the card.
+ "title": "A String", # Optional. The title of the card.
+ },
+ "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
+ "subtitle": "A String", # Optional. Subtitle of the list.
+ "title": "A String", # Optional. The overall title of the list.
+ "items": [ # Required. List items.
+ { # An item in the list.
+ "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
+ # dialog.
+ "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
+ # item in dialog.
+ "A String",
+ ],
+ "key": "A String", # Required. A unique key that will be sent back to the agent if this
+ # response is given.
+ },
+ "description": "A String", # Optional. The main text describing the item.
+ "title": "A String", # Required. The title of the list item.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ },
+ ],
+ },
+ "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # The button object that appears at the bottom of a card.
+ "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
+ "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
+ },
+ "title": "A String", # Required. The title of the button.
+ },
+ ],
+ "title": "A String", # Optional. The title of the card.
+ "image": { # The image response message. # Optional. The image for the card.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "formattedText": "A String", # Required, unless image is present. The body text of the card.
+ },
+ "image": { # The image response message. # Displays an image.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
},
"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
- # For more details about RBM rich cards, please see:
- # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead.
+ "cardWidth": "A String", # Required. The width of the cards in the carousel.
"cardContents": [ # Required. The cards in the carousel. A carousel must have at least
# 2 cards and at most 10.
{ # Rich Business Messaging (RBM) Card content
@@ -325,35 +392,44 @@
# * video/mpeg
# * video/mpeg4
# * video/webm
- "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
- # provide a thumbnail URI, the RBM platform displays a blank
- # placeholder thumbnail until the user's device downloads the file.
- # Depending on the user's setting, the file may not download
- # automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
- # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
+ # within a rich card with a vertical layout.
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
+ "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
+ # provide a thumbnail URI, the RBM platform displays a blank
+ # placeholder thumbnail until the user's device downloads the file.
+ # Depending on the user's setting, the file may not download
+ # automatically and may require the user to tap a download button.
},
+ "title": "A String", # Optional. Title of the card (at most 200 bytes).
+ #
+ # At least one of the title, description or media must be set.
+ "description": "A String", # Optional. Description of the card (at most 2000 bytes).
+ #
+ # At least one of the title, description or media must be set.
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
- "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
- # instead of typing in their own response.
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested reply. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "text": "A String", # Suggested reply text.
- },
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
+ "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
+ # If the user has an app installed that is
+ # registered as the default handler for the URL, then this app will be
+ # opened instead, and its icon will be used in the suggested action UI.
+ "uri": "A String", # Required. The uri to open on the user device
+ },
+ "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
+ # to send back to the agent.
+ },
+ "text": "A String", # Text to display alongside the action.
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
- # but does not dial automatically (https://goo.gl/ergbB2).
+ # but does not dial automatically.
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
@@ -362,180 +438,34 @@
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
- "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
- # to send back to the agent (https://goo.gl/GXotJW).
- },
- "text": "A String", # Text to display alongside the action.
- "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
- # (https://goo.gl/6GLJD2). If the user has an app installed that is
- # registered as the default handler for the URL, then this app will be
- # opened instead, and its icon will be used in the suggested action UI.
- "uri": "A String", # Required. The uri to open on the user device
- },
+ },
+ "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
+ # instead of typing in their own response.
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested reply. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
+ "text": "A String", # Suggested reply text.
},
},
],
- "title": "A String", # Optional. Title of the card (at most 200 bytes).
- #
- # At least one of the title, description or media must be set.
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
- },
- ],
- "cardWidth": "A String", # Required. The width of the cards in the carousel.
- },
- "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
- "suggestions": [ # Required. The list of suggested replies.
- { # The suggestion chip message that the user can tap to quickly post a reply
- # to the conversation.
- "title": "A String", # Required. The text shown the in the suggestion chip.
},
],
},
- "platform": "A String", # Optional. The platform that this message is intended for.
- "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
- "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
- # play, e.g., "gs://bucket/object". The object must contain a single
- # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
- #
- # This object must be readable by the `service-<Project
- # Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
- # where <Project Number> is the number of the Telephony Gateway project
- # (usually the same as the Dialogflow agent project). If the Google Cloud
- # Storage bucket is in the Telephony Gateway project, this permission is
- # added by default when enabling the Dialogflow V2 API.
- #
- # For audio from other sources, consider using the
- # `TelephonySynthesizeSpeech` message with SSML.
- },
- "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
- "title": "A String", # Optional. The overall title of the list.
- "subtitle": "A String", # Optional. Subtitle of the list.
- "items": [ # Required. List items.
- { # An item in the list.
- "description": "A String", # Optional. The main text describing the item.
- "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
- # dialog.
- "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
- # item in dialog.
- "A String",
- ],
- "key": "A String", # Required. A unique key that will be sent back to the agent if this
- # response is given.
- },
- "title": "A String", # Required. The title of the list item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- },
- ],
- },
- "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
- #
- # RBM allows businesses to send enriched and branded versions of SMS. See
- # https://jibe.google.com/business-messaging.
- "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
- { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
- # easily select/click a predefined response or perform an action (like
- # opening a web uri).
- "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
- # instead of typing in their own response.
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested reply. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "text": "A String", # Suggested reply text.
- },
- "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
- # can choose from the card.
- "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
- # but does not dial automatically (https://goo.gl/ergbB2).
- "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
- # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
- # format. An example of a correctly formatted phone number:
- # +15556767888.
- },
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested action. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
- # to send back to the agent (https://goo.gl/GXotJW).
- },
- "text": "A String", # Text to display alongside the action.
- "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
- # (https://goo.gl/6GLJD2). If the user has an app installed that is
- # registered as the default handler for the URL, then this app will be
- # opened instead, and its icon will be used in the suggested action UI.
- "uri": "A String", # Required. The uri to open on the user device
- },
- },
- },
- ],
- "text": "A String", # Required. Text sent and displayed to the user.
- },
- "quickReplies": { # The quick replies response message. # Displays quick replies.
- "title": "A String", # Optional. The title of the collection of quick replies.
- "quickReplies": [ # Optional. The collection of quick replies.
- "A String",
- ],
- },
- "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
- # Telephony Gateway.
- #
- # Telephony Gateway takes the synthesizer settings from
- # `DetectIntentResponse.output_audio_config` which can either be set
- # at request-level or can come from the agent-level synthesizer config.
- "text": "A String", # The raw text to be synthesized.
- "ssml": "A String", # The SSML to be synthesized. For more information, see
- # [SSML](https://developers.google.com/actions/reference/ssml).
- },
- "card": { # The card response message. # Displays a card.
- "title": "A String", # Optional. The title of the card.
- "buttons": [ # Optional. The collection of card buttons.
- { # Optional. Contains information about a button.
- "text": "A String", # Optional. The text to show on the button.
- "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
- # open.
- },
- ],
- "subtitle": "A String", # Optional. The subtitle of the card.
- "imageUri": "A String", # Optional. The public URI to an image file for the card.
- },
- "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
- "title": "A String", # Optional. The title of the card.
- "image": { # The image response message. # Optional. The image for the card.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- "formattedText": "A String", # Required, unless image is present. The body text of the card.
- "buttons": [ # Optional. The collection of card buttons.
+ "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "buttons": [ # Optional. List of buttons for the card.
{ # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
+ "title": "A String", # Required. The title of the button.
},
],
- "subtitle": "A String", # Optional. The subtitle of the card.
- },
- "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "subtitle": "A String", # Optional. Subtitle to the title.
"image": { # The image response message. # Optional. Image which should be displayed on the card.
"imageUri": "A String", # Optional. The public URI to an image file.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
},
- "buttons": [ # Optional. List of buttons for the card.
- { # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
- "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
- "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
- },
- },
- ],
- "title": "A String", # Required. Title of the card.
"rows": [ # Optional. Rows in this table of data.
{ # Row of TableCard.
"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
@@ -546,7 +476,7 @@
],
},
],
- "subtitle": "A String", # Optional. Subtitle to the title.
+ "title": "A String", # Required. Title of the card.
"columnProperties": [ # Optional. Display properties for the columns in this table.
{ # Column properties for TableCard.
"header": "A String", # Required. Column heading.
@@ -554,117 +484,63 @@
},
],
},
- "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
- "items": [ # Required. Carousel items.
- { # An item in the carousel.
- "description": "A String", # Optional. The body text of the card.
- "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
- # dialog.
- "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
- # item in dialog.
- "A String",
- ],
- "key": "A String", # Required. A unique key that will be sent back to the agent if this
- # response is given.
+ "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
+ #
+ # RBM allows businesses to send enriched and branded versions of SMS. See
+ # https://jibe.google.com/business-messaging.
+ "text": "A String", # Required. Text sent and displayed to the user.
+ "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
+ { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
+ # easily select/click a predefined response or perform an action (like
+ # opening a web uri).
+ "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
+ # can choose from the card.
+ "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
+ # If the user has an app installed that is
+ # registered as the default handler for the URL, then this app will be
+ # opened instead, and its icon will be used in the suggested action UI.
+ "uri": "A String", # Required. The uri to open on the user device
+ },
+ "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
+ # to send back to the agent.
+ },
+ "text": "A String", # Text to display alongside the action.
+ "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
+ # but does not dial automatically.
+ "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
+ # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
+ # format. An example of a correctly formatted phone number:
+ # +15556767888.
+ },
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested action. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
},
- "title": "A String", # Required. Title of the carousel item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
+ # instead of typing in their own response.
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested reply. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
+ "text": "A String", # Suggested reply text.
},
},
],
},
- "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.
- # or website associated with this agent.
- "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
- "uri": "A String", # Required. The URI of the app or site to open when the user taps the
- # suggestion chip.
+ "payload": { # A custom platform-specific response.
+ "a_key": "", # Properties of the object.
},
- "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
- # https://developers.google.com/actions/assistant/responses#browsing_carousel
- "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
- # items.
- "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
- # items, maximum of ten.
- { # Browsing carousel tile
- "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.
- "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
- # the URL. Defaults to opening via web browser.
- "url": "A String", # Required. URL
- },
- "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
- # Card. Maximum of one line of text.
- "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
- "image": { # The image response message. # Optional. Hero image for the carousel item.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- },
+ "text": { # The text response message. # Returns a text response.
+ "text": [ # Optional. The collection of the agent's responses.
+ "A String",
],
},
- "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
- # This message in `QueryResult.fulfillment_messages` and
- # `WebhookResponse.fulfillment_messages` should contain only one
- # `SimpleResponse`.
- "simpleResponses": [ # Required. The list of simple responses.
- { # The simple response message containing speech or text.
- "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
- # response to the user in the SSML format. Mutually exclusive with
- # text_to_speech.
- "displayText": "A String", # Optional. The text to display.
- "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
- # speech output. Mutually exclusive with ssml.
- },
- ],
- },
- "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
- "phoneNumber": "A String", # Required. The phone number to transfer the call to
- # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
- #
- # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
- },
- "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.
- "name": "A String", # Required. Name of media card.
- "description": "A String", # Optional. Description of media card.
- "contentUrl": "A String", # Required. Url where the media is stored.
- "icon": { # The image response message. # Optional. Icon to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- "largeImage": { # The image response message. # Optional. Image to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- },
- ],
- "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
- },
- "image": { # The image response message. # Displays an image.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
- # For more details about RBM rich cards, please see:
- # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout.
- "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
- # Image preview alignment for standalone cards with horizontal layout.
- "cardOrientation": "A String", # Required. Orientation of the card.
"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
@@ -685,35 +561,44 @@
# * video/mpeg
# * video/mpeg4
# * video/webm
- "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
- # provide a thumbnail URI, the RBM platform displays a blank
- # placeholder thumbnail until the user's device downloads the file.
- # Depending on the user's setting, the file may not download
- # automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
- # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
+ # within a rich card with a vertical layout.
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
+ "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
+ # provide a thumbnail URI, the RBM platform displays a blank
+ # placeholder thumbnail until the user's device downloads the file.
+ # Depending on the user's setting, the file may not download
+ # automatically and may require the user to tap a download button.
},
+ "title": "A String", # Optional. Title of the card (at most 200 bytes).
+ #
+ # At least one of the title, description or media must be set.
+ "description": "A String", # Optional. Description of the card (at most 2000 bytes).
+ #
+ # At least one of the title, description or media must be set.
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
- "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
- # instead of typing in their own response.
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested reply. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "text": "A String", # Suggested reply text.
- },
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
+ "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
+ # If the user has an app installed that is
+ # registered as the default handler for the URL, then this app will be
+ # opened instead, and its icon will be used in the suggested action UI.
+ "uri": "A String", # Required. The uri to open on the user device
+ },
+ "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
+ # to send back to the agent.
+ },
+ "text": "A String", # Text to display alongside the action.
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
- # but does not dial automatically (https://goo.gl/ergbB2).
+ # but does not dial automatically.
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
@@ -722,53 +607,184 @@
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
- "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
- # to send back to the agent (https://goo.gl/GXotJW).
- },
- "text": "A String", # Text to display alongside the action.
- "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
- # (https://goo.gl/6GLJD2). If the user has an app installed that is
- # registered as the default handler for the URL, then this app will be
- # opened instead, and its icon will be used in the suggested action UI.
- "uri": "A String", # Required. The uri to open on the user device
- },
+ },
+ "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
+ # instead of typing in their own response.
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested reply. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
+ "text": "A String", # Suggested reply text.
},
},
],
- "title": "A String", # Optional. Title of the card (at most 200 bytes).
- #
- # At least one of the title, description or media must be set.
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
},
+ "cardOrientation": "A String", # Required. Orientation of the card.
+ "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
+ # Image preview alignment for standalone cards with horizontal layout.
},
- "payload": { # A custom platform-specific response.
- "a_key": "", # Properties of the object.
+ "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
+ "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
+ # play, e.g., "gs://bucket/object". The object must contain a single
+ # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
+ #
+ # This object must be readable by the `service-<Project
+ # Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
+ # where <Project Number> is the number of the Telephony Gateway project
+ # (usually the same as the Dialogflow agent project). If the Google Cloud
+ # Storage bucket is in the Telephony Gateway project, this permission is
+ # added by default when enabling the Dialogflow V2 API.
+ #
+ # For audio from other sources, consider using the
+ # `TelephonySynthesizeSpeech` message with SSML.
+ },
+ "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
+ "items": [ # Required. Carousel items.
+ { # An item in the carousel.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
+ # dialog.
+ "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
+ # item in dialog.
+ "A String",
+ ],
+ "key": "A String", # Required. A unique key that will be sent back to the agent if this
+ # response is given.
+ },
+ "title": "A String", # Required. Title of the carousel item.
+ "description": "A String", # Optional. The body text of the card.
+ },
+ ],
+ },
+ "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
+ # This message in `QueryResult.fulfillment_messages` and
+ # `WebhookResponse.fulfillment_messages` should contain only one
+ # `SimpleResponse`.
+ "simpleResponses": [ # Required. The list of simple responses.
+ { # The simple response message containing speech or text.
+ "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
+ # response to the user in the SSML format. Mutually exclusive with
+ # text_to_speech.
+ "displayText": "A String", # Optional. The text to display.
+ "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
+ # speech output. Mutually exclusive with ssml.
+ },
+ ],
+ },
+ "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
+ # https://developers.google.com/actions/assistant/responses#browsing_carousel
+ "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
+ # items.
+ "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
+ # items, maximum of ten.
+ { # Browsing carousel tile
+ "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
+ # Card. Maximum of one line of text.
+ "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.
+ "image": { # The image response message. # Optional. Hero image for the carousel item.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
+ "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
+ # the URL. Defaults to opening via web browser.
+ "url": "A String", # Required. URL
+ },
+ },
+ ],
},
},
],
- "action": "A String", # Optional. The name of the action associated with the intent.
- # Note: The action name must not contain whitespaces.
+ "parentFollowupIntentName": "A String", # Optional. 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>`.
+ "parameters": [ # Optional. The collection of parameters associated with the intent.
+ { # Represents intent parameters.
+ "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
+ "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
+ # whether the intent cannot be completed without collecting the parameter
+ # value.
+ "prompts": [ # Optional. The collection of prompts that the agent can present to the
+ # user in order to collect a value for the parameter.
+ "A String",
+ ],
+ "name": "A String", # The unique identifier of this parameter.
+ "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
+ # describes values of the parameter. If the parameter is
+ # required, this must be provided.
+ "displayName": "A String", # Required. The name of the parameter.
+ "value": "A String", # Optional. The definition of the parameter value. It can be:
+ #
+ # - a constant string,
+ # - a parameter value defined as `$parameter_name`,
+ # - an original parameter value defined as `$parameter_name.original`,
+ # - a parameter value from some context defined as
+ # `#context_name.parameter_name`.
+ "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
+ # result.
+ # Default values can be extracted from contexts by using the following
+ # syntax: `#context_name.parameter_name`.
+ },
+ ],
+ "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",
+ ],
+ "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the 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>`.
- "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
+ "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
+ # Note: If `ml_enabled` setting is set to false, then this intent is not
+ # taken into account during inference in `ML ONLY` match mode. Also,
+ # auto-markup in the UI is turned off.
+ # DEPRECATED! Please use `ml_disabled` field instead.
+ # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
+ # then the default value is determined as follows:
+ # - Before April 15th, 2018 the default is:
+ # ml_enabled = false / ml_disabled = true.
+ # - After April 15th, 2018 the default is:
+ # ml_enabled = true / ml_disabled = false.
+ "followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as
+ # a direct or indirect parent. We populate this field only in the output.
+ { # Represents a single followup intent in the chain.
+ "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "followupIntentName": "A String", # The unique identifier of the followup intent.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ },
+ ],
+ "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",
+ ],
"inputContextNames": [ # Optional. The list of context names required for this intent to be
# triggered.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
"A String",
],
- "followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as
- # a direct or indirect parent. We populate this field only in the output.
- { # Represents a single followup intent in the chain.
- "followupIntentName": "A String", # The unique identifier of the followup intent.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- },
- ],
+ "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
+ # priorities.
+ #
+ # - If the supplied value is unspecified or 0, the service
+ # translates the value to 500,000, which corresponds to the
+ # `Normal` priority in the console.
+ # - If the supplied value is negative, the intent is ignored
+ # in runtime detect intent requests.
},
],
}
@@ -786,33 +802,6 @@
"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
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- },
- "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.
"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
@@ -823,6 +812,33 @@
# `TakeSnapshotResponse`.
"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.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "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.
+ },
}</pre>
</div>
@@ -839,136 +855,70 @@
The object takes the form of:
{ # The request message for Intents.BatchUpdateIntents.
+ "intentBatchUri": "A String", # The URI to a Google Cloud Storage file containing intents to update or
+ # create. The file format can either be a serialized proto (of IntentBatch
+ # type) or JSON object. Note: The URI must start with "gs://".
+ "updateMask": "A String", # Optional. The mask to control which fields get updated.
+ "intentView": "A String", # Optional. The resource view to apply to the returned intent.
+ "languageCode": "A String", # Optional. The language used to access language-specific data.
+ # If not specified, the agent's default language is used.
+ # For more information, see
+ # [Multilingual intent and entity
+ # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
"intentBatchInline": { # This message is a wrapper around a collection of intents. # The collection of intents to update or create.
"intents": [ # A collection of intents.
- { # Represents an intent.
- # Intents convert a number of user expressions or patterns into an action. An
- # action is an extraction of a user command or sentence semantics.
- "displayName": "A String", # Required. The name of this intent.
- "rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of
- # followup intents. It identifies the correct followup intents chain for
- # this intent.
- #
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
- # Note: If `ml_disabled` setting is set to true, then this intent is not
- # taken into account during inference in `ML ONLY` match mode. Also,
- # auto-markup in the UI is turned off.
- "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
- "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
- # Note: If `ml_enabled` setting is set to false, then this intent is not
- # taken into account during inference in `ML ONLY` match mode. Also,
- # auto-markup in the UI is turned off.
- # DEPRECATED! Please use `ml_disabled` field instead.
- # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
- # then the default value is determined as follows:
- # - Before April 15th, 2018 the default is:
- # ml_enabled = false / ml_disabled = true.
- # - After April 15th, 2018 the default is:
- # ml_enabled = true / ml_disabled = false.
- "trainingPhrases": [ # Optional. The collection of examples that the agent is
- # trained on.
- { # Represents an example that the agent is trained on.
- "parts": [ # Required. The ordered list of training phrase parts.
- # The parts are concatenated in order to form the training phrase.
- #
- # Note: The API does not automatically annotate training phrases like the
- # Dialogflow Console does.
- #
- # Note: Do not forget to include whitespace at part boundaries,
- # so the training phrase is well formatted when the parts are concatenated.
- #
- # If the training phrase does not need to be annotated with parameters,
- # you just need a single part with only the Part.text field set.
- #
- # If you want to annotate the training phrase, you must create multiple
- # parts, where the fields of each part are populated in one of two ways:
- #
- # - `Part.text` is set to a part of the phrase that has no parameters.
- # - `Part.text` is set to a part of the phrase that you want to annotate,
- # and the `entity_type`, `alias`, and `user_defined` fields are all
- # set.
- { # Represents a part of a training phrase.
- "alias": "A String", # Optional. The parameter name for the value extracted from the
- # annotated part of the example.
- # This field is required for annotated parts of the training phrase.
- "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
- # This field is set to true when the Dialogflow Console is used to
- # manually annotate the part. When creating an annotated part with the
- # API, you must set this to true.
- "text": "A String", # Required. The text for this part.
- "entityType": "A String", # Optional. The entity type name prefixed with `@`.
- # This field is required for annotated parts of the training phrase.
- },
- ],
- "name": "A String", # Output only. The unique identifier of this training phrase.
- "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
- # the intent. Each time a developer adds an existing sample by editing an
- # intent or training, this counter is increased.
- "type": "A String", # Required. The type of the training phrase.
- },
- ],
- "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
- # session when this intent is matched.
- "parameters": [ # Optional. The collection of parameters associated with the intent.
- { # Represents intent parameters.
- "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
- # describes values of the parameter. If the parameter is
- # required, this must be provided.
- "prompts": [ # Optional. The collection of prompts that the agent can present to the
- # user in order to collect a value for the parameter.
- "A String",
- ],
- "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
- # whether the intent cannot be completed without collecting the parameter
- # value.
- "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
- # result.
- # Default values can be extracted from contexts by using the following
- # syntax: `#context_name.parameter_name`.
- "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
- "name": "A String", # The unique identifier of this parameter.
- "value": "A String", # Optional. The definition of the parameter value. It can be:
- #
- # - a constant string,
- # - a parameter value defined as `$parameter_name`,
- # - an original parameter value defined as `$parameter_name.original`,
- # - a parameter value from some context defined as
- # `#context_name.parameter_name`.
- "displayName": "A String", # Required. The name of the parameter.
- },
- ],
- "events": [ # Optional. The collection of event names that trigger the intent.
- # If the collection of input contexts is not empty, all of the contexts must
- # be present in the active user session for an event to trigger this intent.
- # Event names are limited to 150 characters.
- "A String",
- ],
- "parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the
- # chain of followup intents. You can set this field when creating an intent,
- # for example with CreateIntent or
- # BatchUpdateIntents, in order to make this
- # intent a followup intent.
- #
- # It identifies the parent followup intent.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
- # priorities.
- #
- # - If the supplied value is unspecified or 0, the service
- # translates the value to 500,000, which corresponds to the
- # `Normal` priority in the console.
- # - If the supplied value is negative, the intent is ignored
- # in runtime detect intent requests.
+ { # An intent categorizes an end-user's intention for one conversation turn. For
+ # each agent, you define many intents, where your combined intents can handle a
+ # complete conversation. When an end-user writes or says something, referred to
+ # as an end-user expression or end-user input, Dialogflow matches the end-user
+ # input to the best intent in your agent. Matching an intent is also known as
+ # intent classification.
+ #
+ # For more information, see the [intent
+ # guide](https://cloud.google.com/dialogflow/docs/intents-overview).
"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
# (e.g., Actions on Google or Dialogflow phone gateway) use this information
# to close interaction with an end user. Default is false.
+ "action": "A String", # Optional. The name of the action associated with the intent.
+ # Note: The action name must not contain whitespaces.
+ "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
"outputContexts": [ # Optional. The collection of contexts that are activated when the intent
# is matched. Context messages in this collection should not set the
# parameters field. Setting the `lifespan_count` to 0 will reset the context
# when the intent is matched.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
- { # Represents a context.
+ { # Dialogflow contexts are similar to natural language context. If a person says
+ # to you "they are orange", you need context in order to understand what "they"
+ # is referring to. Similarly, for Dialogflow to handle an end-user expression
+ # like that, it needs to be provided with context in order to correctly match
+ # an intent.
+ #
+ # Using contexts, you can control the flow of a conversation. You can configure
+ # contexts for an intent by setting input and output contexts, which are
+ # identified by string names. When an intent is matched, any configured output
+ # contexts for that intent become active. While any contexts are active,
+ # Dialogflow is more likely to match intents that are configured with input
+ # contexts that correspond to the currently active contexts.
+ #
+ # For more information about context, see the
+ # [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).
+ "parameters": { # Optional. The collection of parameters associated with this context.
+ #
+ # Depending on your protocol or client library language, this is a
+ # 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. The default is `0`. If set to `0`, the context expires
# immediately. Contexts expire automatically after 20 minutes if there
@@ -990,46 +940,189 @@
# * `__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.
- },
},
],
- "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",
+ "displayName": "A String", # Required. The name of this intent.
+ "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
+ # session when this intent is matched.
+ "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
+ # Note: If `ml_disabled` setting is set to true, then this intent is not
+ # taken into account during inference in `ML ONLY` match mode. Also,
+ # auto-markup in the UI is turned off.
+ "rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of
+ # followup intents. It identifies the correct followup intents chain for
+ # this intent.
+ #
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "trainingPhrases": [ # Optional. The collection of examples that the agent is
+ # trained on.
+ { # Represents an example that the agent is trained on.
+ "type": "A String", # Required. The type of the training phrase.
+ "name": "A String", # Output only. The unique identifier of this training phrase.
+ "parts": [ # Required. The ordered list of training phrase parts.
+ # The parts are concatenated in order to form the training phrase.
+ #
+ # Note: The API does not automatically annotate training phrases like the
+ # Dialogflow Console does.
+ #
+ # Note: Do not forget to include whitespace at part boundaries,
+ # so the training phrase is well formatted when the parts are concatenated.
+ #
+ # If the training phrase does not need to be annotated with parameters,
+ # you just need a single part with only the Part.text field set.
+ #
+ # If you want to annotate the training phrase, you must create multiple
+ # parts, where the fields of each part are populated in one of two ways:
+ #
+ # - `Part.text` is set to a part of the phrase that has no parameters.
+ # - `Part.text` is set to a part of the phrase that you want to annotate,
+ # and the `entity_type`, `alias`, and `user_defined` fields are all
+ # set.
+ { # Represents a part of a training phrase.
+ "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
+ # This field is set to true when the Dialogflow Console is used to
+ # manually annotate the part. When creating an annotated part with the
+ # API, you must set this to true.
+ "alias": "A String", # Optional. The parameter name for the value extracted from the
+ # annotated part of the example.
+ # This field is required for annotated parts of the training phrase.
+ "entityType": "A String", # Optional. The entity type name prefixed with `@`.
+ # This field is required for annotated parts of the training phrase.
+ "text": "A String", # Required. The text for this part.
+ },
+ ],
+ "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
+ # the intent. Each time a developer adds an existing sample by editing an
+ # intent or training, this counter is increased.
+ },
],
"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.
- "text": { # The text response message. # Returns a text response.
- "text": [ # Optional. The collection of the agent's responses.
+ "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
+ "suggestions": [ # Required. The list of suggested replies.
+ { # The suggestion chip message that the user can tap to quickly post a reply
+ # to the conversation.
+ "title": "A String", # Required. The text shown the in the suggestion chip.
+ },
+ ],
+ },
+ "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
+ "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
+ "mediaObjects": [ # Required. List of media objects.
+ { # Response media object for media content card.
+ "description": "A String", # Optional. Description of media card.
+ "icon": { # The image response message. # Optional. Icon to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "contentUrl": "A String", # Required. Url where the media is stored.
+ "name": "A String", # Required. Name of media card.
+ "largeImage": { # The image response message. # Optional. Image to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ },
+ ],
+ },
+ "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
+ "phoneNumber": "A String", # Required. The phone number to transfer the call to
+ # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+ #
+ # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
+ },
+ "platform": "A String", # Optional. The platform that this message is intended for.
+ "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
+ # Telephony Gateway.
+ #
+ # Telephony Gateway takes the synthesizer settings from
+ # `DetectIntentResponse.output_audio_config` which can either be set
+ # at request-level or can come from the agent-level synthesizer config.
+ "text": "A String", # The raw text to be synthesized.
+ "ssml": "A String", # The SSML to be synthesized. For more information, see
+ # [SSML](https://developers.google.com/actions/reference/ssml).
+ },
+ "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.
+ # or website associated with this agent.
+ "uri": "A String", # Required. The URI of the app or site to open when the user taps the
+ # suggestion chip.
+ "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
+ },
+ "quickReplies": { # The quick replies response message. # Displays quick replies.
+ "quickReplies": [ # Optional. The collection of quick replies.
"A String",
],
+ "title": "A String", # Optional. The title of the collection of quick replies.
+ },
+ "card": { # The card response message. # Displays a card.
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # Optional. Contains information about a button.
+ "text": "A String", # Optional. The text to show on the button.
+ "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
+ # open.
+ },
+ ],
+ "imageUri": "A String", # Optional. The public URI to an image file for the card.
+ "title": "A String", # Optional. The title of the card.
+ },
+ "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
+ "subtitle": "A String", # Optional. Subtitle of the list.
+ "title": "A String", # Optional. The overall title of the list.
+ "items": [ # Required. List items.
+ { # An item in the list.
+ "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
+ # dialog.
+ "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
+ # item in dialog.
+ "A String",
+ ],
+ "key": "A String", # Required. A unique key that will be sent back to the agent if this
+ # response is given.
+ },
+ "description": "A String", # Optional. The main text describing the item.
+ "title": "A String", # Required. The title of the list item.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ },
+ ],
+ },
+ "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # The button object that appears at the bottom of a card.
+ "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
+ "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
+ },
+ "title": "A String", # Required. The title of the button.
+ },
+ ],
+ "title": "A String", # Optional. The title of the card.
+ "image": { # The image response message. # Optional. The image for the card.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "formattedText": "A String", # Required, unless image is present. The body text of the card.
+ },
+ "image": { # The image response message. # Displays an image.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
},
"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
- # For more details about RBM rich cards, please see:
- # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead.
+ "cardWidth": "A String", # Required. The width of the cards in the carousel.
"cardContents": [ # Required. The cards in the carousel. A carousel must have at least
# 2 cards and at most 10.
{ # Rich Business Messaging (RBM) Card content
@@ -1052,35 +1145,44 @@
# * video/mpeg
# * video/mpeg4
# * video/webm
- "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
- # provide a thumbnail URI, the RBM platform displays a blank
- # placeholder thumbnail until the user's device downloads the file.
- # Depending on the user's setting, the file may not download
- # automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
- # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
+ # within a rich card with a vertical layout.
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
+ "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
+ # provide a thumbnail URI, the RBM platform displays a blank
+ # placeholder thumbnail until the user's device downloads the file.
+ # Depending on the user's setting, the file may not download
+ # automatically and may require the user to tap a download button.
},
+ "title": "A String", # Optional. Title of the card (at most 200 bytes).
+ #
+ # At least one of the title, description or media must be set.
+ "description": "A String", # Optional. Description of the card (at most 2000 bytes).
+ #
+ # At least one of the title, description or media must be set.
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
- "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
- # instead of typing in their own response.
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested reply. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "text": "A String", # Suggested reply text.
- },
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
+ "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
+ # If the user has an app installed that is
+ # registered as the default handler for the URL, then this app will be
+ # opened instead, and its icon will be used in the suggested action UI.
+ "uri": "A String", # Required. The uri to open on the user device
+ },
+ "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
+ # to send back to the agent.
+ },
+ "text": "A String", # Text to display alongside the action.
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
- # but does not dial automatically (https://goo.gl/ergbB2).
+ # but does not dial automatically.
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
@@ -1089,180 +1191,34 @@
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
- "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
- # to send back to the agent (https://goo.gl/GXotJW).
- },
- "text": "A String", # Text to display alongside the action.
- "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
- # (https://goo.gl/6GLJD2). If the user has an app installed that is
- # registered as the default handler for the URL, then this app will be
- # opened instead, and its icon will be used in the suggested action UI.
- "uri": "A String", # Required. The uri to open on the user device
- },
+ },
+ "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
+ # instead of typing in their own response.
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested reply. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
+ "text": "A String", # Suggested reply text.
},
},
],
- "title": "A String", # Optional. Title of the card (at most 200 bytes).
- #
- # At least one of the title, description or media must be set.
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
- },
- ],
- "cardWidth": "A String", # Required. The width of the cards in the carousel.
- },
- "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
- "suggestions": [ # Required. The list of suggested replies.
- { # The suggestion chip message that the user can tap to quickly post a reply
- # to the conversation.
- "title": "A String", # Required. The text shown the in the suggestion chip.
},
],
},
- "platform": "A String", # Optional. The platform that this message is intended for.
- "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
- "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
- # play, e.g., "gs://bucket/object". The object must contain a single
- # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
- #
- # This object must be readable by the `service-<Project
- # Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
- # where <Project Number> is the number of the Telephony Gateway project
- # (usually the same as the Dialogflow agent project). If the Google Cloud
- # Storage bucket is in the Telephony Gateway project, this permission is
- # added by default when enabling the Dialogflow V2 API.
- #
- # For audio from other sources, consider using the
- # `TelephonySynthesizeSpeech` message with SSML.
- },
- "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
- "title": "A String", # Optional. The overall title of the list.
- "subtitle": "A String", # Optional. Subtitle of the list.
- "items": [ # Required. List items.
- { # An item in the list.
- "description": "A String", # Optional. The main text describing the item.
- "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
- # dialog.
- "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
- # item in dialog.
- "A String",
- ],
- "key": "A String", # Required. A unique key that will be sent back to the agent if this
- # response is given.
- },
- "title": "A String", # Required. The title of the list item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- },
- ],
- },
- "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
- #
- # RBM allows businesses to send enriched and branded versions of SMS. See
- # https://jibe.google.com/business-messaging.
- "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
- { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
- # easily select/click a predefined response or perform an action (like
- # opening a web uri).
- "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
- # instead of typing in their own response.
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested reply. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "text": "A String", # Suggested reply text.
- },
- "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
- # can choose from the card.
- "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
- # but does not dial automatically (https://goo.gl/ergbB2).
- "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
- # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
- # format. An example of a correctly formatted phone number:
- # +15556767888.
- },
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested action. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
- # to send back to the agent (https://goo.gl/GXotJW).
- },
- "text": "A String", # Text to display alongside the action.
- "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
- # (https://goo.gl/6GLJD2). If the user has an app installed that is
- # registered as the default handler for the URL, then this app will be
- # opened instead, and its icon will be used in the suggested action UI.
- "uri": "A String", # Required. The uri to open on the user device
- },
- },
- },
- ],
- "text": "A String", # Required. Text sent and displayed to the user.
- },
- "quickReplies": { # The quick replies response message. # Displays quick replies.
- "title": "A String", # Optional. The title of the collection of quick replies.
- "quickReplies": [ # Optional. The collection of quick replies.
- "A String",
- ],
- },
- "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
- # Telephony Gateway.
- #
- # Telephony Gateway takes the synthesizer settings from
- # `DetectIntentResponse.output_audio_config` which can either be set
- # at request-level or can come from the agent-level synthesizer config.
- "text": "A String", # The raw text to be synthesized.
- "ssml": "A String", # The SSML to be synthesized. For more information, see
- # [SSML](https://developers.google.com/actions/reference/ssml).
- },
- "card": { # The card response message. # Displays a card.
- "title": "A String", # Optional. The title of the card.
- "buttons": [ # Optional. The collection of card buttons.
- { # Optional. Contains information about a button.
- "text": "A String", # Optional. The text to show on the button.
- "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
- # open.
- },
- ],
- "subtitle": "A String", # Optional. The subtitle of the card.
- "imageUri": "A String", # Optional. The public URI to an image file for the card.
- },
- "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
- "title": "A String", # Optional. The title of the card.
- "image": { # The image response message. # Optional. The image for the card.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- "formattedText": "A String", # Required, unless image is present. The body text of the card.
- "buttons": [ # Optional. The collection of card buttons.
+ "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "buttons": [ # Optional. List of buttons for the card.
{ # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
+ "title": "A String", # Required. The title of the button.
},
],
- "subtitle": "A String", # Optional. The subtitle of the card.
- },
- "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "subtitle": "A String", # Optional. Subtitle to the title.
"image": { # The image response message. # Optional. Image which should be displayed on the card.
"imageUri": "A String", # Optional. The public URI to an image file.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
},
- "buttons": [ # Optional. List of buttons for the card.
- { # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
- "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
- "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
- },
- },
- ],
- "title": "A String", # Required. Title of the card.
"rows": [ # Optional. Rows in this table of data.
{ # Row of TableCard.
"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
@@ -1273,7 +1229,7 @@
],
},
],
- "subtitle": "A String", # Optional. Subtitle to the title.
+ "title": "A String", # Required. Title of the card.
"columnProperties": [ # Optional. Display properties for the columns in this table.
{ # Column properties for TableCard.
"header": "A String", # Required. Column heading.
@@ -1281,117 +1237,63 @@
},
],
},
- "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
- "items": [ # Required. Carousel items.
- { # An item in the carousel.
- "description": "A String", # Optional. The body text of the card.
- "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
- # dialog.
- "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
- # item in dialog.
- "A String",
- ],
- "key": "A String", # Required. A unique key that will be sent back to the agent if this
- # response is given.
+ "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
+ #
+ # RBM allows businesses to send enriched and branded versions of SMS. See
+ # https://jibe.google.com/business-messaging.
+ "text": "A String", # Required. Text sent and displayed to the user.
+ "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
+ { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
+ # easily select/click a predefined response or perform an action (like
+ # opening a web uri).
+ "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
+ # can choose from the card.
+ "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
+ # If the user has an app installed that is
+ # registered as the default handler for the URL, then this app will be
+ # opened instead, and its icon will be used in the suggested action UI.
+ "uri": "A String", # Required. The uri to open on the user device
+ },
+ "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
+ # to send back to the agent.
+ },
+ "text": "A String", # Text to display alongside the action.
+ "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
+ # but does not dial automatically.
+ "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
+ # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
+ # format. An example of a correctly formatted phone number:
+ # +15556767888.
+ },
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested action. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
},
- "title": "A String", # Required. Title of the carousel item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
+ # instead of typing in their own response.
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested reply. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
+ "text": "A String", # Suggested reply text.
},
},
],
},
- "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.
- # or website associated with this agent.
- "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
- "uri": "A String", # Required. The URI of the app or site to open when the user taps the
- # suggestion chip.
+ "payload": { # A custom platform-specific response.
+ "a_key": "", # Properties of the object.
},
- "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
- # https://developers.google.com/actions/assistant/responses#browsing_carousel
- "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
- # items.
- "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
- # items, maximum of ten.
- { # Browsing carousel tile
- "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.
- "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
- # the URL. Defaults to opening via web browser.
- "url": "A String", # Required. URL
- },
- "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
- # Card. Maximum of one line of text.
- "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
- "image": { # The image response message. # Optional. Hero image for the carousel item.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- },
+ "text": { # The text response message. # Returns a text response.
+ "text": [ # Optional. The collection of the agent's responses.
+ "A String",
],
},
- "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
- # This message in `QueryResult.fulfillment_messages` and
- # `WebhookResponse.fulfillment_messages` should contain only one
- # `SimpleResponse`.
- "simpleResponses": [ # Required. The list of simple responses.
- { # The simple response message containing speech or text.
- "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
- # response to the user in the SSML format. Mutually exclusive with
- # text_to_speech.
- "displayText": "A String", # Optional. The text to display.
- "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
- # speech output. Mutually exclusive with ssml.
- },
- ],
- },
- "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
- "phoneNumber": "A String", # Required. The phone number to transfer the call to
- # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
- #
- # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
- },
- "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.
- "name": "A String", # Required. Name of media card.
- "description": "A String", # Optional. Description of media card.
- "contentUrl": "A String", # Required. Url where the media is stored.
- "icon": { # The image response message. # Optional. Icon to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- "largeImage": { # The image response message. # Optional. Image to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- },
- ],
- "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
- },
- "image": { # The image response message. # Displays an image.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
- # For more details about RBM rich cards, please see:
- # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout.
- "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
- # Image preview alignment for standalone cards with horizontal layout.
- "cardOrientation": "A String", # Required. Orientation of the card.
"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
@@ -1412,35 +1314,44 @@
# * video/mpeg
# * video/mpeg4
# * video/webm
- "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
- # provide a thumbnail URI, the RBM platform displays a blank
- # placeholder thumbnail until the user's device downloads the file.
- # Depending on the user's setting, the file may not download
- # automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
- # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
+ # within a rich card with a vertical layout.
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
+ "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
+ # provide a thumbnail URI, the RBM platform displays a blank
+ # placeholder thumbnail until the user's device downloads the file.
+ # Depending on the user's setting, the file may not download
+ # automatically and may require the user to tap a download button.
},
+ "title": "A String", # Optional. Title of the card (at most 200 bytes).
+ #
+ # At least one of the title, description or media must be set.
+ "description": "A String", # Optional. Description of the card (at most 2000 bytes).
+ #
+ # At least one of the title, description or media must be set.
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
- "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
- # instead of typing in their own response.
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested reply. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "text": "A String", # Suggested reply text.
- },
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
+ "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
+ # If the user has an app installed that is
+ # registered as the default handler for the URL, then this app will be
+ # opened instead, and its icon will be used in the suggested action UI.
+ "uri": "A String", # Required. The uri to open on the user device
+ },
+ "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
+ # to send back to the agent.
+ },
+ "text": "A String", # Text to display alongside the action.
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
- # but does not dial automatically (https://goo.gl/ergbB2).
+ # but does not dial automatically.
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
@@ -1449,66 +1360,187 @@
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
- "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
- # to send back to the agent (https://goo.gl/GXotJW).
- },
- "text": "A String", # Text to display alongside the action.
- "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
- # (https://goo.gl/6GLJD2). If the user has an app installed that is
- # registered as the default handler for the URL, then this app will be
- # opened instead, and its icon will be used in the suggested action UI.
- "uri": "A String", # Required. The uri to open on the user device
- },
+ },
+ "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
+ # instead of typing in their own response.
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested reply. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
+ "text": "A String", # Suggested reply text.
},
},
],
- "title": "A String", # Optional. Title of the card (at most 200 bytes).
- #
- # At least one of the title, description or media must be set.
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
},
+ "cardOrientation": "A String", # Required. Orientation of the card.
+ "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
+ # Image preview alignment for standalone cards with horizontal layout.
},
- "payload": { # A custom platform-specific response.
- "a_key": "", # Properties of the object.
+ "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
+ "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
+ # play, e.g., "gs://bucket/object". The object must contain a single
+ # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
+ #
+ # This object must be readable by the `service-<Project
+ # Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
+ # where <Project Number> is the number of the Telephony Gateway project
+ # (usually the same as the Dialogflow agent project). If the Google Cloud
+ # Storage bucket is in the Telephony Gateway project, this permission is
+ # added by default when enabling the Dialogflow V2 API.
+ #
+ # For audio from other sources, consider using the
+ # `TelephonySynthesizeSpeech` message with SSML.
+ },
+ "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
+ "items": [ # Required. Carousel items.
+ { # An item in the carousel.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
+ # dialog.
+ "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
+ # item in dialog.
+ "A String",
+ ],
+ "key": "A String", # Required. A unique key that will be sent back to the agent if this
+ # response is given.
+ },
+ "title": "A String", # Required. Title of the carousel item.
+ "description": "A String", # Optional. The body text of the card.
+ },
+ ],
+ },
+ "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
+ # This message in `QueryResult.fulfillment_messages` and
+ # `WebhookResponse.fulfillment_messages` should contain only one
+ # `SimpleResponse`.
+ "simpleResponses": [ # Required. The list of simple responses.
+ { # The simple response message containing speech or text.
+ "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
+ # response to the user in the SSML format. Mutually exclusive with
+ # text_to_speech.
+ "displayText": "A String", # Optional. The text to display.
+ "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
+ # speech output. Mutually exclusive with ssml.
+ },
+ ],
+ },
+ "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
+ # https://developers.google.com/actions/assistant/responses#browsing_carousel
+ "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
+ # items.
+ "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
+ # items, maximum of ten.
+ { # Browsing carousel tile
+ "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
+ # Card. Maximum of one line of text.
+ "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.
+ "image": { # The image response message. # Optional. Hero image for the carousel item.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
+ "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
+ # the URL. Defaults to opening via web browser.
+ "url": "A String", # Required. URL
+ },
+ },
+ ],
},
},
],
- "action": "A String", # Optional. The name of the action associated with the intent.
- # Note: The action name must not contain whitespaces.
+ "parentFollowupIntentName": "A String", # Optional. 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>`.
+ "parameters": [ # Optional. The collection of parameters associated with the intent.
+ { # Represents intent parameters.
+ "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
+ "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
+ # whether the intent cannot be completed without collecting the parameter
+ # value.
+ "prompts": [ # Optional. The collection of prompts that the agent can present to the
+ # user in order to collect a value for the parameter.
+ "A String",
+ ],
+ "name": "A String", # The unique identifier of this parameter.
+ "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
+ # describes values of the parameter. If the parameter is
+ # required, this must be provided.
+ "displayName": "A String", # Required. The name of the parameter.
+ "value": "A String", # Optional. The definition of the parameter value. It can be:
+ #
+ # - a constant string,
+ # - a parameter value defined as `$parameter_name`,
+ # - an original parameter value defined as `$parameter_name.original`,
+ # - a parameter value from some context defined as
+ # `#context_name.parameter_name`.
+ "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
+ # result.
+ # Default values can be extracted from contexts by using the following
+ # syntax: `#context_name.parameter_name`.
+ },
+ ],
+ "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",
+ ],
+ "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the 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>`.
- "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
+ "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
+ # Note: If `ml_enabled` setting is set to false, then this intent is not
+ # taken into account during inference in `ML ONLY` match mode. Also,
+ # auto-markup in the UI is turned off.
+ # DEPRECATED! Please use `ml_disabled` field instead.
+ # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
+ # then the default value is determined as follows:
+ # - Before April 15th, 2018 the default is:
+ # ml_enabled = false / ml_disabled = true.
+ # - After April 15th, 2018 the default is:
+ # ml_enabled = true / ml_disabled = false.
+ "followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as
+ # a direct or indirect parent. We populate this field only in the output.
+ { # Represents a single followup intent in the chain.
+ "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "followupIntentName": "A String", # The unique identifier of the followup intent.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ },
+ ],
+ "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",
+ ],
"inputContextNames": [ # Optional. The list of context names required for this intent to be
# triggered.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
"A String",
],
- "followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as
- # a direct or indirect parent. We populate this field only in the output.
- { # Represents a single followup intent in the chain.
- "followupIntentName": "A String", # The unique identifier of the followup intent.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- },
- ],
+ "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
+ # priorities.
+ #
+ # - If the supplied value is unspecified or 0, the service
+ # translates the value to 500,000, which corresponds to the
+ # `Normal` priority in the console.
+ # - If the supplied value is negative, the intent is ignored
+ # in runtime detect intent requests.
},
],
},
- "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).
- "updateMask": "A String", # Optional. The mask to control which fields get updated.
- "intentBatchUri": "A String", # The URI to a Google Cloud Storage file containing intents to update or
- # create. The file format can either be a serialized proto (of IntentBatch
- # type) or JSON object. Note: The URI must start with "gs://".
- "intentView": "A String", # Optional. The resource view to apply to the returned intent.
}
x__xgafv: string, V1 error format.
@@ -1524,33 +1556,6 @@
"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
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- },
- "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.
"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
@@ -1561,11 +1566,38 @@
# `TakeSnapshotResponse`.
"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.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "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.
+ },
}</pre>
</div>
<div class="method">
- <code class="details" id="create">create(parent, body=None, intentView=None, languageCode=None, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent, body=None, languageCode=None, intentView=None, x__xgafv=None)</code>
<pre>Creates an intent in the specified agent.
Args:
@@ -1574,134 +1606,58 @@
body: object, The request body.
The object takes the form of:
-{ # Represents an intent.
- # Intents convert a number of user expressions or patterns into an action. An
- # action is an extraction of a user command or sentence semantics.
- "displayName": "A String", # Required. The name of this intent.
- "rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of
- # followup intents. It identifies the correct followup intents chain for
- # this intent.
- #
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
- # Note: If `ml_disabled` setting is set to true, then this intent is not
- # taken into account during inference in `ML ONLY` match mode. Also,
- # auto-markup in the UI is turned off.
- "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
- "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
- # Note: If `ml_enabled` setting is set to false, then this intent is not
- # taken into account during inference in `ML ONLY` match mode. Also,
- # auto-markup in the UI is turned off.
- # DEPRECATED! Please use `ml_disabled` field instead.
- # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
- # then the default value is determined as follows:
- # - Before April 15th, 2018 the default is:
- # ml_enabled = false / ml_disabled = true.
- # - After April 15th, 2018 the default is:
- # ml_enabled = true / ml_disabled = false.
- "trainingPhrases": [ # Optional. The collection of examples that the agent is
- # trained on.
- { # Represents an example that the agent is trained on.
- "parts": [ # Required. The ordered list of training phrase parts.
- # The parts are concatenated in order to form the training phrase.
- #
- # Note: The API does not automatically annotate training phrases like the
- # Dialogflow Console does.
- #
- # Note: Do not forget to include whitespace at part boundaries,
- # so the training phrase is well formatted when the parts are concatenated.
- #
- # If the training phrase does not need to be annotated with parameters,
- # you just need a single part with only the Part.text field set.
- #
- # If you want to annotate the training phrase, you must create multiple
- # parts, where the fields of each part are populated in one of two ways:
- #
- # - `Part.text` is set to a part of the phrase that has no parameters.
- # - `Part.text` is set to a part of the phrase that you want to annotate,
- # and the `entity_type`, `alias`, and `user_defined` fields are all
- # set.
- { # Represents a part of a training phrase.
- "alias": "A String", # Optional. The parameter name for the value extracted from the
- # annotated part of the example.
- # This field is required for annotated parts of the training phrase.
- "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
- # This field is set to true when the Dialogflow Console is used to
- # manually annotate the part. When creating an annotated part with the
- # API, you must set this to true.
- "text": "A String", # Required. The text for this part.
- "entityType": "A String", # Optional. The entity type name prefixed with `@`.
- # This field is required for annotated parts of the training phrase.
- },
- ],
- "name": "A String", # Output only. The unique identifier of this training phrase.
- "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
- # the intent. Each time a developer adds an existing sample by editing an
- # intent or training, this counter is increased.
- "type": "A String", # Required. The type of the training phrase.
- },
- ],
- "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
- # session when this intent is matched.
- "parameters": [ # Optional. The collection of parameters associated with the intent.
- { # Represents intent parameters.
- "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
- # describes values of the parameter. If the parameter is
- # required, this must be provided.
- "prompts": [ # Optional. The collection of prompts that the agent can present to the
- # user in order to collect a value for the parameter.
- "A String",
- ],
- "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
- # whether the intent cannot be completed without collecting the parameter
- # value.
- "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
- # result.
- # Default values can be extracted from contexts by using the following
- # syntax: `#context_name.parameter_name`.
- "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
- "name": "A String", # The unique identifier of this parameter.
- "value": "A String", # Optional. The definition of the parameter value. It can be:
- #
- # - a constant string,
- # - a parameter value defined as `$parameter_name`,
- # - an original parameter value defined as `$parameter_name.original`,
- # - a parameter value from some context defined as
- # `#context_name.parameter_name`.
- "displayName": "A String", # Required. The name of the parameter.
- },
- ],
- "events": [ # Optional. The collection of event names that trigger the intent.
- # If the collection of input contexts is not empty, all of the contexts must
- # be present in the active user session for an event to trigger this intent.
- # Event names are limited to 150 characters.
- "A String",
- ],
- "parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the
- # chain of followup intents. You can set this field when creating an intent,
- # for example with CreateIntent or
- # BatchUpdateIntents, in order to make this
- # intent a followup intent.
- #
- # It identifies the parent followup intent.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
- # priorities.
- #
- # - If the supplied value is unspecified or 0, the service
- # translates the value to 500,000, which corresponds to the
- # `Normal` priority in the console.
- # - If the supplied value is negative, the intent is ignored
- # in runtime detect intent requests.
+{ # An intent categorizes an end-user's intention for one conversation turn. For
+ # each agent, you define many intents, where your combined intents can handle a
+ # complete conversation. When an end-user writes or says something, referred to
+ # as an end-user expression or end-user input, Dialogflow matches the end-user
+ # input to the best intent in your agent. Matching an intent is also known as
+ # intent classification.
+ #
+ # For more information, see the [intent
+ # guide](https://cloud.google.com/dialogflow/docs/intents-overview).
"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
# (e.g., Actions on Google or Dialogflow phone gateway) use this information
# to close interaction with an end user. Default is false.
+ "action": "A String", # Optional. The name of the action associated with the intent.
+ # Note: The action name must not contain whitespaces.
+ "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
"outputContexts": [ # Optional. The collection of contexts that are activated when the intent
# is matched. Context messages in this collection should not set the
# parameters field. Setting the `lifespan_count` to 0 will reset the context
# when the intent is matched.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
- { # Represents a context.
+ { # Dialogflow contexts are similar to natural language context. If a person says
+ # to you "they are orange", you need context in order to understand what "they"
+ # is referring to. Similarly, for Dialogflow to handle an end-user expression
+ # like that, it needs to be provided with context in order to correctly match
+ # an intent.
+ #
+ # Using contexts, you can control the flow of a conversation. You can configure
+ # contexts for an intent by setting input and output contexts, which are
+ # identified by string names. When an intent is matched, any configured output
+ # contexts for that intent become active. While any contexts are active,
+ # Dialogflow is more likely to match intents that are configured with input
+ # contexts that correspond to the currently active contexts.
+ #
+ # For more information about context, see the
+ # [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).
+ "parameters": { # Optional. The collection of parameters associated with this context.
+ #
+ # Depending on your protocol or client library language, this is a
+ # 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. The default is `0`. If set to `0`, the context expires
# immediately. Contexts expire automatically after 20 minutes if there
@@ -1723,46 +1679,189 @@
# * `__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.
- },
},
],
- "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",
+ "displayName": "A String", # Required. The name of this intent.
+ "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
+ # session when this intent is matched.
+ "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
+ # Note: If `ml_disabled` setting is set to true, then this intent is not
+ # taken into account during inference in `ML ONLY` match mode. Also,
+ # auto-markup in the UI is turned off.
+ "rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of
+ # followup intents. It identifies the correct followup intents chain for
+ # this intent.
+ #
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "trainingPhrases": [ # Optional. The collection of examples that the agent is
+ # trained on.
+ { # Represents an example that the agent is trained on.
+ "type": "A String", # Required. The type of the training phrase.
+ "name": "A String", # Output only. The unique identifier of this training phrase.
+ "parts": [ # Required. The ordered list of training phrase parts.
+ # The parts are concatenated in order to form the training phrase.
+ #
+ # Note: The API does not automatically annotate training phrases like the
+ # Dialogflow Console does.
+ #
+ # Note: Do not forget to include whitespace at part boundaries,
+ # so the training phrase is well formatted when the parts are concatenated.
+ #
+ # If the training phrase does not need to be annotated with parameters,
+ # you just need a single part with only the Part.text field set.
+ #
+ # If you want to annotate the training phrase, you must create multiple
+ # parts, where the fields of each part are populated in one of two ways:
+ #
+ # - `Part.text` is set to a part of the phrase that has no parameters.
+ # - `Part.text` is set to a part of the phrase that you want to annotate,
+ # and the `entity_type`, `alias`, and `user_defined` fields are all
+ # set.
+ { # Represents a part of a training phrase.
+ "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
+ # This field is set to true when the Dialogflow Console is used to
+ # manually annotate the part. When creating an annotated part with the
+ # API, you must set this to true.
+ "alias": "A String", # Optional. The parameter name for the value extracted from the
+ # annotated part of the example.
+ # This field is required for annotated parts of the training phrase.
+ "entityType": "A String", # Optional. The entity type name prefixed with `@`.
+ # This field is required for annotated parts of the training phrase.
+ "text": "A String", # Required. The text for this part.
+ },
+ ],
+ "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
+ # the intent. Each time a developer adds an existing sample by editing an
+ # intent or training, this counter is increased.
+ },
],
"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.
- "text": { # The text response message. # Returns a text response.
- "text": [ # Optional. The collection of the agent's responses.
+ "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
+ "suggestions": [ # Required. The list of suggested replies.
+ { # The suggestion chip message that the user can tap to quickly post a reply
+ # to the conversation.
+ "title": "A String", # Required. The text shown the in the suggestion chip.
+ },
+ ],
+ },
+ "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
+ "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
+ "mediaObjects": [ # Required. List of media objects.
+ { # Response media object for media content card.
+ "description": "A String", # Optional. Description of media card.
+ "icon": { # The image response message. # Optional. Icon to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "contentUrl": "A String", # Required. Url where the media is stored.
+ "name": "A String", # Required. Name of media card.
+ "largeImage": { # The image response message. # Optional. Image to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ },
+ ],
+ },
+ "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
+ "phoneNumber": "A String", # Required. The phone number to transfer the call to
+ # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+ #
+ # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
+ },
+ "platform": "A String", # Optional. The platform that this message is intended for.
+ "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
+ # Telephony Gateway.
+ #
+ # Telephony Gateway takes the synthesizer settings from
+ # `DetectIntentResponse.output_audio_config` which can either be set
+ # at request-level or can come from the agent-level synthesizer config.
+ "text": "A String", # The raw text to be synthesized.
+ "ssml": "A String", # The SSML to be synthesized. For more information, see
+ # [SSML](https://developers.google.com/actions/reference/ssml).
+ },
+ "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.
+ # or website associated with this agent.
+ "uri": "A String", # Required. The URI of the app or site to open when the user taps the
+ # suggestion chip.
+ "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
+ },
+ "quickReplies": { # The quick replies response message. # Displays quick replies.
+ "quickReplies": [ # Optional. The collection of quick replies.
"A String",
],
+ "title": "A String", # Optional. The title of the collection of quick replies.
+ },
+ "card": { # The card response message. # Displays a card.
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # Optional. Contains information about a button.
+ "text": "A String", # Optional. The text to show on the button.
+ "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
+ # open.
+ },
+ ],
+ "imageUri": "A String", # Optional. The public URI to an image file for the card.
+ "title": "A String", # Optional. The title of the card.
+ },
+ "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
+ "subtitle": "A String", # Optional. Subtitle of the list.
+ "title": "A String", # Optional. The overall title of the list.
+ "items": [ # Required. List items.
+ { # An item in the list.
+ "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
+ # dialog.
+ "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
+ # item in dialog.
+ "A String",
+ ],
+ "key": "A String", # Required. A unique key that will be sent back to the agent if this
+ # response is given.
+ },
+ "description": "A String", # Optional. The main text describing the item.
+ "title": "A String", # Required. The title of the list item.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ },
+ ],
+ },
+ "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # The button object that appears at the bottom of a card.
+ "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
+ "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
+ },
+ "title": "A String", # Required. The title of the button.
+ },
+ ],
+ "title": "A String", # Optional. The title of the card.
+ "image": { # The image response message. # Optional. The image for the card.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "formattedText": "A String", # Required, unless image is present. The body text of the card.
+ },
+ "image": { # The image response message. # Displays an image.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
},
"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
- # For more details about RBM rich cards, please see:
- # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead.
+ "cardWidth": "A String", # Required. The width of the cards in the carousel.
"cardContents": [ # Required. The cards in the carousel. A carousel must have at least
# 2 cards and at most 10.
{ # Rich Business Messaging (RBM) Card content
@@ -1785,35 +1884,44 @@
# * video/mpeg
# * video/mpeg4
# * video/webm
- "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
- # provide a thumbnail URI, the RBM platform displays a blank
- # placeholder thumbnail until the user's device downloads the file.
- # Depending on the user's setting, the file may not download
- # automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
- # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
+ # within a rich card with a vertical layout.
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
+ "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
+ # provide a thumbnail URI, the RBM platform displays a blank
+ # placeholder thumbnail until the user's device downloads the file.
+ # Depending on the user's setting, the file may not download
+ # automatically and may require the user to tap a download button.
},
+ "title": "A String", # Optional. Title of the card (at most 200 bytes).
+ #
+ # At least one of the title, description or media must be set.
+ "description": "A String", # Optional. Description of the card (at most 2000 bytes).
+ #
+ # At least one of the title, description or media must be set.
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
- "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
- # instead of typing in their own response.
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested reply. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "text": "A String", # Suggested reply text.
- },
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
+ "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
+ # If the user has an app installed that is
+ # registered as the default handler for the URL, then this app will be
+ # opened instead, and its icon will be used in the suggested action UI.
+ "uri": "A String", # Required. The uri to open on the user device
+ },
+ "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
+ # to send back to the agent.
+ },
+ "text": "A String", # Text to display alongside the action.
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
- # but does not dial automatically (https://goo.gl/ergbB2).
+ # but does not dial automatically.
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
@@ -1822,180 +1930,34 @@
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
- "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
- # to send back to the agent (https://goo.gl/GXotJW).
- },
- "text": "A String", # Text to display alongside the action.
- "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
- # (https://goo.gl/6GLJD2). If the user has an app installed that is
- # registered as the default handler for the URL, then this app will be
- # opened instead, and its icon will be used in the suggested action UI.
- "uri": "A String", # Required. The uri to open on the user device
- },
+ },
+ "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
+ # instead of typing in their own response.
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested reply. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
+ "text": "A String", # Suggested reply text.
},
},
],
- "title": "A String", # Optional. Title of the card (at most 200 bytes).
- #
- # At least one of the title, description or media must be set.
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
- },
- ],
- "cardWidth": "A String", # Required. The width of the cards in the carousel.
- },
- "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
- "suggestions": [ # Required. The list of suggested replies.
- { # The suggestion chip message that the user can tap to quickly post a reply
- # to the conversation.
- "title": "A String", # Required. The text shown the in the suggestion chip.
},
],
},
- "platform": "A String", # Optional. The platform that this message is intended for.
- "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
- "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
- # play, e.g., "gs://bucket/object". The object must contain a single
- # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
- #
- # This object must be readable by the `service-<Project
- # Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
- # where <Project Number> is the number of the Telephony Gateway project
- # (usually the same as the Dialogflow agent project). If the Google Cloud
- # Storage bucket is in the Telephony Gateway project, this permission is
- # added by default when enabling the Dialogflow V2 API.
- #
- # For audio from other sources, consider using the
- # `TelephonySynthesizeSpeech` message with SSML.
- },
- "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
- "title": "A String", # Optional. The overall title of the list.
- "subtitle": "A String", # Optional. Subtitle of the list.
- "items": [ # Required. List items.
- { # An item in the list.
- "description": "A String", # Optional. The main text describing the item.
- "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
- # dialog.
- "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
- # item in dialog.
- "A String",
- ],
- "key": "A String", # Required. A unique key that will be sent back to the agent if this
- # response is given.
- },
- "title": "A String", # Required. The title of the list item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- },
- ],
- },
- "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
- #
- # RBM allows businesses to send enriched and branded versions of SMS. See
- # https://jibe.google.com/business-messaging.
- "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
- { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
- # easily select/click a predefined response or perform an action (like
- # opening a web uri).
- "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
- # instead of typing in their own response.
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested reply. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "text": "A String", # Suggested reply text.
- },
- "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
- # can choose from the card.
- "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
- # but does not dial automatically (https://goo.gl/ergbB2).
- "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
- # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
- # format. An example of a correctly formatted phone number:
- # +15556767888.
- },
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested action. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
- # to send back to the agent (https://goo.gl/GXotJW).
- },
- "text": "A String", # Text to display alongside the action.
- "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
- # (https://goo.gl/6GLJD2). If the user has an app installed that is
- # registered as the default handler for the URL, then this app will be
- # opened instead, and its icon will be used in the suggested action UI.
- "uri": "A String", # Required. The uri to open on the user device
- },
- },
- },
- ],
- "text": "A String", # Required. Text sent and displayed to the user.
- },
- "quickReplies": { # The quick replies response message. # Displays quick replies.
- "title": "A String", # Optional. The title of the collection of quick replies.
- "quickReplies": [ # Optional. The collection of quick replies.
- "A String",
- ],
- },
- "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
- # Telephony Gateway.
- #
- # Telephony Gateway takes the synthesizer settings from
- # `DetectIntentResponse.output_audio_config` which can either be set
- # at request-level or can come from the agent-level synthesizer config.
- "text": "A String", # The raw text to be synthesized.
- "ssml": "A String", # The SSML to be synthesized. For more information, see
- # [SSML](https://developers.google.com/actions/reference/ssml).
- },
- "card": { # The card response message. # Displays a card.
- "title": "A String", # Optional. The title of the card.
- "buttons": [ # Optional. The collection of card buttons.
- { # Optional. Contains information about a button.
- "text": "A String", # Optional. The text to show on the button.
- "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
- # open.
- },
- ],
- "subtitle": "A String", # Optional. The subtitle of the card.
- "imageUri": "A String", # Optional. The public URI to an image file for the card.
- },
- "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
- "title": "A String", # Optional. The title of the card.
- "image": { # The image response message. # Optional. The image for the card.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- "formattedText": "A String", # Required, unless image is present. The body text of the card.
- "buttons": [ # Optional. The collection of card buttons.
+ "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "buttons": [ # Optional. List of buttons for the card.
{ # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
+ "title": "A String", # Required. The title of the button.
},
],
- "subtitle": "A String", # Optional. The subtitle of the card.
- },
- "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "subtitle": "A String", # Optional. Subtitle to the title.
"image": { # The image response message. # Optional. Image which should be displayed on the card.
"imageUri": "A String", # Optional. The public URI to an image file.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
},
- "buttons": [ # Optional. List of buttons for the card.
- { # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
- "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
- "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
- },
- },
- ],
- "title": "A String", # Required. Title of the card.
"rows": [ # Optional. Rows in this table of data.
{ # Row of TableCard.
"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
@@ -2006,7 +1968,7 @@
],
},
],
- "subtitle": "A String", # Optional. Subtitle to the title.
+ "title": "A String", # Required. Title of the card.
"columnProperties": [ # Optional. Display properties for the columns in this table.
{ # Column properties for TableCard.
"header": "A String", # Required. Column heading.
@@ -2014,117 +1976,63 @@
},
],
},
- "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
- "items": [ # Required. Carousel items.
- { # An item in the carousel.
- "description": "A String", # Optional. The body text of the card.
- "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
- # dialog.
- "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
- # item in dialog.
- "A String",
- ],
- "key": "A String", # Required. A unique key that will be sent back to the agent if this
- # response is given.
+ "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
+ #
+ # RBM allows businesses to send enriched and branded versions of SMS. See
+ # https://jibe.google.com/business-messaging.
+ "text": "A String", # Required. Text sent and displayed to the user.
+ "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
+ { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
+ # easily select/click a predefined response or perform an action (like
+ # opening a web uri).
+ "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
+ # can choose from the card.
+ "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
+ # If the user has an app installed that is
+ # registered as the default handler for the URL, then this app will be
+ # opened instead, and its icon will be used in the suggested action UI.
+ "uri": "A String", # Required. The uri to open on the user device
+ },
+ "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
+ # to send back to the agent.
+ },
+ "text": "A String", # Text to display alongside the action.
+ "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
+ # but does not dial automatically.
+ "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
+ # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
+ # format. An example of a correctly formatted phone number:
+ # +15556767888.
+ },
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested action. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
},
- "title": "A String", # Required. Title of the carousel item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
+ # instead of typing in their own response.
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested reply. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
+ "text": "A String", # Suggested reply text.
},
},
],
},
- "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.
- # or website associated with this agent.
- "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
- "uri": "A String", # Required. The URI of the app or site to open when the user taps the
- # suggestion chip.
+ "payload": { # A custom platform-specific response.
+ "a_key": "", # Properties of the object.
},
- "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
- # https://developers.google.com/actions/assistant/responses#browsing_carousel
- "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
- # items.
- "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
- # items, maximum of ten.
- { # Browsing carousel tile
- "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.
- "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
- # the URL. Defaults to opening via web browser.
- "url": "A String", # Required. URL
- },
- "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
- # Card. Maximum of one line of text.
- "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
- "image": { # The image response message. # Optional. Hero image for the carousel item.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- },
+ "text": { # The text response message. # Returns a text response.
+ "text": [ # Optional. The collection of the agent's responses.
+ "A String",
],
},
- "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
- # This message in `QueryResult.fulfillment_messages` and
- # `WebhookResponse.fulfillment_messages` should contain only one
- # `SimpleResponse`.
- "simpleResponses": [ # Required. The list of simple responses.
- { # The simple response message containing speech or text.
- "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
- # response to the user in the SSML format. Mutually exclusive with
- # text_to_speech.
- "displayText": "A String", # Optional. The text to display.
- "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
- # speech output. Mutually exclusive with ssml.
- },
- ],
- },
- "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
- "phoneNumber": "A String", # Required. The phone number to transfer the call to
- # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
- #
- # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
- },
- "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.
- "name": "A String", # Required. Name of media card.
- "description": "A String", # Optional. Description of media card.
- "contentUrl": "A String", # Required. Url where the media is stored.
- "icon": { # The image response message. # Optional. Icon to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- "largeImage": { # The image response message. # Optional. Image to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- },
- ],
- "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
- },
- "image": { # The image response message. # Displays an image.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
- # For more details about RBM rich cards, please see:
- # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout.
- "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
- # Image preview alignment for standalone cards with horizontal layout.
- "cardOrientation": "A String", # Required. Orientation of the card.
"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
@@ -2145,35 +2053,44 @@
# * video/mpeg
# * video/mpeg4
# * video/webm
- "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
- # provide a thumbnail URI, the RBM platform displays a blank
- # placeholder thumbnail until the user's device downloads the file.
- # Depending on the user's setting, the file may not download
- # automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
- # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
+ # within a rich card with a vertical layout.
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
+ "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
+ # provide a thumbnail URI, the RBM platform displays a blank
+ # placeholder thumbnail until the user's device downloads the file.
+ # Depending on the user's setting, the file may not download
+ # automatically and may require the user to tap a download button.
},
+ "title": "A String", # Optional. Title of the card (at most 200 bytes).
+ #
+ # At least one of the title, description or media must be set.
+ "description": "A String", # Optional. Description of the card (at most 2000 bytes).
+ #
+ # At least one of the title, description or media must be set.
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
- "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
- # instead of typing in their own response.
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested reply. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "text": "A String", # Suggested reply text.
- },
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
+ "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
+ # If the user has an app installed that is
+ # registered as the default handler for the URL, then this app will be
+ # opened instead, and its icon will be used in the suggested action UI.
+ "uri": "A String", # Required. The uri to open on the user device
+ },
+ "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
+ # to send back to the agent.
+ },
+ "text": "A String", # Text to display alongside the action.
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
- # but does not dial automatically (https://goo.gl/ergbB2).
+ # but does not dial automatically.
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
@@ -2182,61 +2099,192 @@
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
- "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
- # to send back to the agent (https://goo.gl/GXotJW).
- },
- "text": "A String", # Text to display alongside the action.
- "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
- # (https://goo.gl/6GLJD2). If the user has an app installed that is
- # registered as the default handler for the URL, then this app will be
- # opened instead, and its icon will be used in the suggested action UI.
- "uri": "A String", # Required. The uri to open on the user device
- },
+ },
+ "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
+ # instead of typing in their own response.
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested reply. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
+ "text": "A String", # Suggested reply text.
},
},
],
- "title": "A String", # Optional. Title of the card (at most 200 bytes).
- #
- # At least one of the title, description or media must be set.
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
},
+ "cardOrientation": "A String", # Required. Orientation of the card.
+ "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
+ # Image preview alignment for standalone cards with horizontal layout.
},
- "payload": { # A custom platform-specific response.
- "a_key": "", # Properties of the object.
+ "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
+ "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
+ # play, e.g., "gs://bucket/object". The object must contain a single
+ # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
+ #
+ # This object must be readable by the `service-<Project
+ # Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
+ # where <Project Number> is the number of the Telephony Gateway project
+ # (usually the same as the Dialogflow agent project). If the Google Cloud
+ # Storage bucket is in the Telephony Gateway project, this permission is
+ # added by default when enabling the Dialogflow V2 API.
+ #
+ # For audio from other sources, consider using the
+ # `TelephonySynthesizeSpeech` message with SSML.
+ },
+ "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
+ "items": [ # Required. Carousel items.
+ { # An item in the carousel.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
+ # dialog.
+ "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
+ # item in dialog.
+ "A String",
+ ],
+ "key": "A String", # Required. A unique key that will be sent back to the agent if this
+ # response is given.
+ },
+ "title": "A String", # Required. Title of the carousel item.
+ "description": "A String", # Optional. The body text of the card.
+ },
+ ],
+ },
+ "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
+ # This message in `QueryResult.fulfillment_messages` and
+ # `WebhookResponse.fulfillment_messages` should contain only one
+ # `SimpleResponse`.
+ "simpleResponses": [ # Required. The list of simple responses.
+ { # The simple response message containing speech or text.
+ "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
+ # response to the user in the SSML format. Mutually exclusive with
+ # text_to_speech.
+ "displayText": "A String", # Optional. The text to display.
+ "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
+ # speech output. Mutually exclusive with ssml.
+ },
+ ],
+ },
+ "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
+ # https://developers.google.com/actions/assistant/responses#browsing_carousel
+ "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
+ # items.
+ "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
+ # items, maximum of ten.
+ { # Browsing carousel tile
+ "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
+ # Card. Maximum of one line of text.
+ "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.
+ "image": { # The image response message. # Optional. Hero image for the carousel item.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
+ "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
+ # the URL. Defaults to opening via web browser.
+ "url": "A String", # Required. URL
+ },
+ },
+ ],
},
},
],
- "action": "A String", # Optional. The name of the action associated with the intent.
- # Note: The action name must not contain whitespaces.
+ "parentFollowupIntentName": "A String", # Optional. 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>`.
+ "parameters": [ # Optional. The collection of parameters associated with the intent.
+ { # Represents intent parameters.
+ "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
+ "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
+ # whether the intent cannot be completed without collecting the parameter
+ # value.
+ "prompts": [ # Optional. The collection of prompts that the agent can present to the
+ # user in order to collect a value for the parameter.
+ "A String",
+ ],
+ "name": "A String", # The unique identifier of this parameter.
+ "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
+ # describes values of the parameter. If the parameter is
+ # required, this must be provided.
+ "displayName": "A String", # Required. The name of the parameter.
+ "value": "A String", # Optional. The definition of the parameter value. It can be:
+ #
+ # - a constant string,
+ # - a parameter value defined as `$parameter_name`,
+ # - an original parameter value defined as `$parameter_name.original`,
+ # - a parameter value from some context defined as
+ # `#context_name.parameter_name`.
+ "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
+ # result.
+ # Default values can be extracted from contexts by using the following
+ # syntax: `#context_name.parameter_name`.
+ },
+ ],
+ "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",
+ ],
+ "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the 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>`.
- "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
+ "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
+ # Note: If `ml_enabled` setting is set to false, then this intent is not
+ # taken into account during inference in `ML ONLY` match mode. Also,
+ # auto-markup in the UI is turned off.
+ # DEPRECATED! Please use `ml_disabled` field instead.
+ # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
+ # then the default value is determined as follows:
+ # - Before April 15th, 2018 the default is:
+ # ml_enabled = false / ml_disabled = true.
+ # - After April 15th, 2018 the default is:
+ # ml_enabled = true / ml_disabled = false.
+ "followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as
+ # a direct or indirect parent. We populate this field only in the output.
+ { # Represents a single followup intent in the chain.
+ "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "followupIntentName": "A String", # The unique identifier of the followup intent.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ },
+ ],
+ "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",
+ ],
"inputContextNames": [ # Optional. The list of context names required for this intent to be
# triggered.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
"A String",
],
- "followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as
- # a direct or indirect parent. We populate this field only in the output.
- { # Represents a single followup intent in the chain.
- "followupIntentName": "A String", # The unique identifier of the followup intent.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- },
- ],
+ "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
+ # priorities.
+ #
+ # - If the supplied value is unspecified or 0, the service
+ # translates the value to 500,000, which corresponds to the
+ # `Normal` priority in the console.
+ # - If the supplied value is negative, the intent is ignored
+ # in runtime detect intent requests.
}
- intentView: string, Optional. The resource view to apply to the returned intent.
languageCode: string, Optional. The language used to access language-specific data.
If not specified, the agent's default language is used.
For more information, see
[Multilingual intent and entity
data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
+ intentView: string, Optional. The resource view to apply to the returned intent.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -2245,134 +2293,58 @@
Returns:
An object of the form:
- { # Represents an intent.
- # Intents convert a number of user expressions or patterns into an action. An
- # action is an extraction of a user command or sentence semantics.
- "displayName": "A String", # Required. The name of this intent.
- "rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of
- # followup intents. It identifies the correct followup intents chain for
- # this intent.
- #
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
- # Note: If `ml_disabled` setting is set to true, then this intent is not
- # taken into account during inference in `ML ONLY` match mode. Also,
- # auto-markup in the UI is turned off.
- "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
- "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
- # Note: If `ml_enabled` setting is set to false, then this intent is not
- # taken into account during inference in `ML ONLY` match mode. Also,
- # auto-markup in the UI is turned off.
- # DEPRECATED! Please use `ml_disabled` field instead.
- # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
- # then the default value is determined as follows:
- # - Before April 15th, 2018 the default is:
- # ml_enabled = false / ml_disabled = true.
- # - After April 15th, 2018 the default is:
- # ml_enabled = true / ml_disabled = false.
- "trainingPhrases": [ # Optional. The collection of examples that the agent is
- # trained on.
- { # Represents an example that the agent is trained on.
- "parts": [ # Required. The ordered list of training phrase parts.
- # The parts are concatenated in order to form the training phrase.
- #
- # Note: The API does not automatically annotate training phrases like the
- # Dialogflow Console does.
- #
- # Note: Do not forget to include whitespace at part boundaries,
- # so the training phrase is well formatted when the parts are concatenated.
- #
- # If the training phrase does not need to be annotated with parameters,
- # you just need a single part with only the Part.text field set.
- #
- # If you want to annotate the training phrase, you must create multiple
- # parts, where the fields of each part are populated in one of two ways:
- #
- # - `Part.text` is set to a part of the phrase that has no parameters.
- # - `Part.text` is set to a part of the phrase that you want to annotate,
- # and the `entity_type`, `alias`, and `user_defined` fields are all
- # set.
- { # Represents a part of a training phrase.
- "alias": "A String", # Optional. The parameter name for the value extracted from the
- # annotated part of the example.
- # This field is required for annotated parts of the training phrase.
- "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
- # This field is set to true when the Dialogflow Console is used to
- # manually annotate the part. When creating an annotated part with the
- # API, you must set this to true.
- "text": "A String", # Required. The text for this part.
- "entityType": "A String", # Optional. The entity type name prefixed with `@`.
- # This field is required for annotated parts of the training phrase.
- },
- ],
- "name": "A String", # Output only. The unique identifier of this training phrase.
- "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
- # the intent. Each time a developer adds an existing sample by editing an
- # intent or training, this counter is increased.
- "type": "A String", # Required. The type of the training phrase.
- },
- ],
- "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
- # session when this intent is matched.
- "parameters": [ # Optional. The collection of parameters associated with the intent.
- { # Represents intent parameters.
- "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
- # describes values of the parameter. If the parameter is
- # required, this must be provided.
- "prompts": [ # Optional. The collection of prompts that the agent can present to the
- # user in order to collect a value for the parameter.
- "A String",
- ],
- "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
- # whether the intent cannot be completed without collecting the parameter
- # value.
- "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
- # result.
- # Default values can be extracted from contexts by using the following
- # syntax: `#context_name.parameter_name`.
- "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
- "name": "A String", # The unique identifier of this parameter.
- "value": "A String", # Optional. The definition of the parameter value. It can be:
- #
- # - a constant string,
- # - a parameter value defined as `$parameter_name`,
- # - an original parameter value defined as `$parameter_name.original`,
- # - a parameter value from some context defined as
- # `#context_name.parameter_name`.
- "displayName": "A String", # Required. The name of the parameter.
- },
- ],
- "events": [ # Optional. The collection of event names that trigger the intent.
- # If the collection of input contexts is not empty, all of the contexts must
- # be present in the active user session for an event to trigger this intent.
- # Event names are limited to 150 characters.
- "A String",
- ],
- "parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the
- # chain of followup intents. You can set this field when creating an intent,
- # for example with CreateIntent or
- # BatchUpdateIntents, in order to make this
- # intent a followup intent.
- #
- # It identifies the parent followup intent.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
- # priorities.
- #
- # - If the supplied value is unspecified or 0, the service
- # translates the value to 500,000, which corresponds to the
- # `Normal` priority in the console.
- # - If the supplied value is negative, the intent is ignored
- # in runtime detect intent requests.
+ { # An intent categorizes an end-user's intention for one conversation turn. For
+ # each agent, you define many intents, where your combined intents can handle a
+ # complete conversation. When an end-user writes or says something, referred to
+ # as an end-user expression or end-user input, Dialogflow matches the end-user
+ # input to the best intent in your agent. Matching an intent is also known as
+ # intent classification.
+ #
+ # For more information, see the [intent
+ # guide](https://cloud.google.com/dialogflow/docs/intents-overview).
"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
# (e.g., Actions on Google or Dialogflow phone gateway) use this information
# to close interaction with an end user. Default is false.
+ "action": "A String", # Optional. The name of the action associated with the intent.
+ # Note: The action name must not contain whitespaces.
+ "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
"outputContexts": [ # Optional. The collection of contexts that are activated when the intent
# is matched. Context messages in this collection should not set the
# parameters field. Setting the `lifespan_count` to 0 will reset the context
# when the intent is matched.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
- { # Represents a context.
+ { # Dialogflow contexts are similar to natural language context. If a person says
+ # to you "they are orange", you need context in order to understand what "they"
+ # is referring to. Similarly, for Dialogflow to handle an end-user expression
+ # like that, it needs to be provided with context in order to correctly match
+ # an intent.
+ #
+ # Using contexts, you can control the flow of a conversation. You can configure
+ # contexts for an intent by setting input and output contexts, which are
+ # identified by string names. When an intent is matched, any configured output
+ # contexts for that intent become active. While any contexts are active,
+ # Dialogflow is more likely to match intents that are configured with input
+ # contexts that correspond to the currently active contexts.
+ #
+ # For more information about context, see the
+ # [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).
+ "parameters": { # Optional. The collection of parameters associated with this context.
+ #
+ # Depending on your protocol or client library language, this is a
+ # 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. The default is `0`. If set to `0`, the context expires
# immediately. Contexts expire automatically after 20 minutes if there
@@ -2394,46 +2366,189 @@
# * `__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.
- },
},
],
- "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",
+ "displayName": "A String", # Required. The name of this intent.
+ "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
+ # session when this intent is matched.
+ "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
+ # Note: If `ml_disabled` setting is set to true, then this intent is not
+ # taken into account during inference in `ML ONLY` match mode. Also,
+ # auto-markup in the UI is turned off.
+ "rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of
+ # followup intents. It identifies the correct followup intents chain for
+ # this intent.
+ #
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "trainingPhrases": [ # Optional. The collection of examples that the agent is
+ # trained on.
+ { # Represents an example that the agent is trained on.
+ "type": "A String", # Required. The type of the training phrase.
+ "name": "A String", # Output only. The unique identifier of this training phrase.
+ "parts": [ # Required. The ordered list of training phrase parts.
+ # The parts are concatenated in order to form the training phrase.
+ #
+ # Note: The API does not automatically annotate training phrases like the
+ # Dialogflow Console does.
+ #
+ # Note: Do not forget to include whitespace at part boundaries,
+ # so the training phrase is well formatted when the parts are concatenated.
+ #
+ # If the training phrase does not need to be annotated with parameters,
+ # you just need a single part with only the Part.text field set.
+ #
+ # If you want to annotate the training phrase, you must create multiple
+ # parts, where the fields of each part are populated in one of two ways:
+ #
+ # - `Part.text` is set to a part of the phrase that has no parameters.
+ # - `Part.text` is set to a part of the phrase that you want to annotate,
+ # and the `entity_type`, `alias`, and `user_defined` fields are all
+ # set.
+ { # Represents a part of a training phrase.
+ "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
+ # This field is set to true when the Dialogflow Console is used to
+ # manually annotate the part. When creating an annotated part with the
+ # API, you must set this to true.
+ "alias": "A String", # Optional. The parameter name for the value extracted from the
+ # annotated part of the example.
+ # This field is required for annotated parts of the training phrase.
+ "entityType": "A String", # Optional. The entity type name prefixed with `@`.
+ # This field is required for annotated parts of the training phrase.
+ "text": "A String", # Required. The text for this part.
+ },
+ ],
+ "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
+ # the intent. Each time a developer adds an existing sample by editing an
+ # intent or training, this counter is increased.
+ },
],
"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.
- "text": { # The text response message. # Returns a text response.
- "text": [ # Optional. The collection of the agent's responses.
+ "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
+ "suggestions": [ # Required. The list of suggested replies.
+ { # The suggestion chip message that the user can tap to quickly post a reply
+ # to the conversation.
+ "title": "A String", # Required. The text shown the in the suggestion chip.
+ },
+ ],
+ },
+ "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
+ "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
+ "mediaObjects": [ # Required. List of media objects.
+ { # Response media object for media content card.
+ "description": "A String", # Optional. Description of media card.
+ "icon": { # The image response message. # Optional. Icon to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "contentUrl": "A String", # Required. Url where the media is stored.
+ "name": "A String", # Required. Name of media card.
+ "largeImage": { # The image response message. # Optional. Image to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ },
+ ],
+ },
+ "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
+ "phoneNumber": "A String", # Required. The phone number to transfer the call to
+ # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+ #
+ # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
+ },
+ "platform": "A String", # Optional. The platform that this message is intended for.
+ "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
+ # Telephony Gateway.
+ #
+ # Telephony Gateway takes the synthesizer settings from
+ # `DetectIntentResponse.output_audio_config` which can either be set
+ # at request-level or can come from the agent-level synthesizer config.
+ "text": "A String", # The raw text to be synthesized.
+ "ssml": "A String", # The SSML to be synthesized. For more information, see
+ # [SSML](https://developers.google.com/actions/reference/ssml).
+ },
+ "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.
+ # or website associated with this agent.
+ "uri": "A String", # Required. The URI of the app or site to open when the user taps the
+ # suggestion chip.
+ "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
+ },
+ "quickReplies": { # The quick replies response message. # Displays quick replies.
+ "quickReplies": [ # Optional. The collection of quick replies.
"A String",
],
+ "title": "A String", # Optional. The title of the collection of quick replies.
+ },
+ "card": { # The card response message. # Displays a card.
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # Optional. Contains information about a button.
+ "text": "A String", # Optional. The text to show on the button.
+ "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
+ # open.
+ },
+ ],
+ "imageUri": "A String", # Optional. The public URI to an image file for the card.
+ "title": "A String", # Optional. The title of the card.
+ },
+ "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
+ "subtitle": "A String", # Optional. Subtitle of the list.
+ "title": "A String", # Optional. The overall title of the list.
+ "items": [ # Required. List items.
+ { # An item in the list.
+ "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
+ # dialog.
+ "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
+ # item in dialog.
+ "A String",
+ ],
+ "key": "A String", # Required. A unique key that will be sent back to the agent if this
+ # response is given.
+ },
+ "description": "A String", # Optional. The main text describing the item.
+ "title": "A String", # Required. The title of the list item.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ },
+ ],
+ },
+ "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # The button object that appears at the bottom of a card.
+ "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
+ "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
+ },
+ "title": "A String", # Required. The title of the button.
+ },
+ ],
+ "title": "A String", # Optional. The title of the card.
+ "image": { # The image response message. # Optional. The image for the card.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "formattedText": "A String", # Required, unless image is present. The body text of the card.
+ },
+ "image": { # The image response message. # Displays an image.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
},
"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
- # For more details about RBM rich cards, please see:
- # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead.
+ "cardWidth": "A String", # Required. The width of the cards in the carousel.
"cardContents": [ # Required. The cards in the carousel. A carousel must have at least
# 2 cards and at most 10.
{ # Rich Business Messaging (RBM) Card content
@@ -2456,35 +2571,44 @@
# * video/mpeg
# * video/mpeg4
# * video/webm
- "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
- # provide a thumbnail URI, the RBM platform displays a blank
- # placeholder thumbnail until the user's device downloads the file.
- # Depending on the user's setting, the file may not download
- # automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
- # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
+ # within a rich card with a vertical layout.
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
+ "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
+ # provide a thumbnail URI, the RBM platform displays a blank
+ # placeholder thumbnail until the user's device downloads the file.
+ # Depending on the user's setting, the file may not download
+ # automatically and may require the user to tap a download button.
},
+ "title": "A String", # Optional. Title of the card (at most 200 bytes).
+ #
+ # At least one of the title, description or media must be set.
+ "description": "A String", # Optional. Description of the card (at most 2000 bytes).
+ #
+ # At least one of the title, description or media must be set.
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
- "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
- # instead of typing in their own response.
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested reply. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "text": "A String", # Suggested reply text.
- },
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
+ "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
+ # If the user has an app installed that is
+ # registered as the default handler for the URL, then this app will be
+ # opened instead, and its icon will be used in the suggested action UI.
+ "uri": "A String", # Required. The uri to open on the user device
+ },
+ "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
+ # to send back to the agent.
+ },
+ "text": "A String", # Text to display alongside the action.
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
- # but does not dial automatically (https://goo.gl/ergbB2).
+ # but does not dial automatically.
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
@@ -2493,180 +2617,34 @@
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
- "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
- # to send back to the agent (https://goo.gl/GXotJW).
- },
- "text": "A String", # Text to display alongside the action.
- "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
- # (https://goo.gl/6GLJD2). If the user has an app installed that is
- # registered as the default handler for the URL, then this app will be
- # opened instead, and its icon will be used in the suggested action UI.
- "uri": "A String", # Required. The uri to open on the user device
- },
+ },
+ "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
+ # instead of typing in their own response.
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested reply. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
+ "text": "A String", # Suggested reply text.
},
},
],
- "title": "A String", # Optional. Title of the card (at most 200 bytes).
- #
- # At least one of the title, description or media must be set.
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
- },
- ],
- "cardWidth": "A String", # Required. The width of the cards in the carousel.
- },
- "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
- "suggestions": [ # Required. The list of suggested replies.
- { # The suggestion chip message that the user can tap to quickly post a reply
- # to the conversation.
- "title": "A String", # Required. The text shown the in the suggestion chip.
},
],
},
- "platform": "A String", # Optional. The platform that this message is intended for.
- "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
- "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
- # play, e.g., "gs://bucket/object". The object must contain a single
- # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
- #
- # This object must be readable by the `service-<Project
- # Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
- # where <Project Number> is the number of the Telephony Gateway project
- # (usually the same as the Dialogflow agent project). If the Google Cloud
- # Storage bucket is in the Telephony Gateway project, this permission is
- # added by default when enabling the Dialogflow V2 API.
- #
- # For audio from other sources, consider using the
- # `TelephonySynthesizeSpeech` message with SSML.
- },
- "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
- "title": "A String", # Optional. The overall title of the list.
- "subtitle": "A String", # Optional. Subtitle of the list.
- "items": [ # Required. List items.
- { # An item in the list.
- "description": "A String", # Optional. The main text describing the item.
- "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
- # dialog.
- "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
- # item in dialog.
- "A String",
- ],
- "key": "A String", # Required. A unique key that will be sent back to the agent if this
- # response is given.
- },
- "title": "A String", # Required. The title of the list item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- },
- ],
- },
- "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
- #
- # RBM allows businesses to send enriched and branded versions of SMS. See
- # https://jibe.google.com/business-messaging.
- "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
- { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
- # easily select/click a predefined response or perform an action (like
- # opening a web uri).
- "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
- # instead of typing in their own response.
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested reply. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "text": "A String", # Suggested reply text.
- },
- "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
- # can choose from the card.
- "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
- # but does not dial automatically (https://goo.gl/ergbB2).
- "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
- # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
- # format. An example of a correctly formatted phone number:
- # +15556767888.
- },
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested action. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
- # to send back to the agent (https://goo.gl/GXotJW).
- },
- "text": "A String", # Text to display alongside the action.
- "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
- # (https://goo.gl/6GLJD2). If the user has an app installed that is
- # registered as the default handler for the URL, then this app will be
- # opened instead, and its icon will be used in the suggested action UI.
- "uri": "A String", # Required. The uri to open on the user device
- },
- },
- },
- ],
- "text": "A String", # Required. Text sent and displayed to the user.
- },
- "quickReplies": { # The quick replies response message. # Displays quick replies.
- "title": "A String", # Optional. The title of the collection of quick replies.
- "quickReplies": [ # Optional. The collection of quick replies.
- "A String",
- ],
- },
- "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
- # Telephony Gateway.
- #
- # Telephony Gateway takes the synthesizer settings from
- # `DetectIntentResponse.output_audio_config` which can either be set
- # at request-level or can come from the agent-level synthesizer config.
- "text": "A String", # The raw text to be synthesized.
- "ssml": "A String", # The SSML to be synthesized. For more information, see
- # [SSML](https://developers.google.com/actions/reference/ssml).
- },
- "card": { # The card response message. # Displays a card.
- "title": "A String", # Optional. The title of the card.
- "buttons": [ # Optional. The collection of card buttons.
- { # Optional. Contains information about a button.
- "text": "A String", # Optional. The text to show on the button.
- "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
- # open.
- },
- ],
- "subtitle": "A String", # Optional. The subtitle of the card.
- "imageUri": "A String", # Optional. The public URI to an image file for the card.
- },
- "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
- "title": "A String", # Optional. The title of the card.
- "image": { # The image response message. # Optional. The image for the card.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- "formattedText": "A String", # Required, unless image is present. The body text of the card.
- "buttons": [ # Optional. The collection of card buttons.
+ "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "buttons": [ # Optional. List of buttons for the card.
{ # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
+ "title": "A String", # Required. The title of the button.
},
],
- "subtitle": "A String", # Optional. The subtitle of the card.
- },
- "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "subtitle": "A String", # Optional. Subtitle to the title.
"image": { # The image response message. # Optional. Image which should be displayed on the card.
"imageUri": "A String", # Optional. The public URI to an image file.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
},
- "buttons": [ # Optional. List of buttons for the card.
- { # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
- "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
- "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
- },
- },
- ],
- "title": "A String", # Required. Title of the card.
"rows": [ # Optional. Rows in this table of data.
{ # Row of TableCard.
"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
@@ -2677,7 +2655,7 @@
],
},
],
- "subtitle": "A String", # Optional. Subtitle to the title.
+ "title": "A String", # Required. Title of the card.
"columnProperties": [ # Optional. Display properties for the columns in this table.
{ # Column properties for TableCard.
"header": "A String", # Required. Column heading.
@@ -2685,117 +2663,63 @@
},
],
},
- "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
- "items": [ # Required. Carousel items.
- { # An item in the carousel.
- "description": "A String", # Optional. The body text of the card.
- "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
- # dialog.
- "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
- # item in dialog.
- "A String",
- ],
- "key": "A String", # Required. A unique key that will be sent back to the agent if this
- # response is given.
+ "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
+ #
+ # RBM allows businesses to send enriched and branded versions of SMS. See
+ # https://jibe.google.com/business-messaging.
+ "text": "A String", # Required. Text sent and displayed to the user.
+ "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
+ { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
+ # easily select/click a predefined response or perform an action (like
+ # opening a web uri).
+ "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
+ # can choose from the card.
+ "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
+ # If the user has an app installed that is
+ # registered as the default handler for the URL, then this app will be
+ # opened instead, and its icon will be used in the suggested action UI.
+ "uri": "A String", # Required. The uri to open on the user device
+ },
+ "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
+ # to send back to the agent.
+ },
+ "text": "A String", # Text to display alongside the action.
+ "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
+ # but does not dial automatically.
+ "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
+ # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
+ # format. An example of a correctly formatted phone number:
+ # +15556767888.
+ },
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested action. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
},
- "title": "A String", # Required. Title of the carousel item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
+ # instead of typing in their own response.
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested reply. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
+ "text": "A String", # Suggested reply text.
},
},
],
},
- "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.
- # or website associated with this agent.
- "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
- "uri": "A String", # Required. The URI of the app or site to open when the user taps the
- # suggestion chip.
+ "payload": { # A custom platform-specific response.
+ "a_key": "", # Properties of the object.
},
- "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
- # https://developers.google.com/actions/assistant/responses#browsing_carousel
- "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
- # items.
- "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
- # items, maximum of ten.
- { # Browsing carousel tile
- "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.
- "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
- # the URL. Defaults to opening via web browser.
- "url": "A String", # Required. URL
- },
- "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
- # Card. Maximum of one line of text.
- "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
- "image": { # The image response message. # Optional. Hero image for the carousel item.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- },
+ "text": { # The text response message. # Returns a text response.
+ "text": [ # Optional. The collection of the agent's responses.
+ "A String",
],
},
- "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
- # This message in `QueryResult.fulfillment_messages` and
- # `WebhookResponse.fulfillment_messages` should contain only one
- # `SimpleResponse`.
- "simpleResponses": [ # Required. The list of simple responses.
- { # The simple response message containing speech or text.
- "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
- # response to the user in the SSML format. Mutually exclusive with
- # text_to_speech.
- "displayText": "A String", # Optional. The text to display.
- "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
- # speech output. Mutually exclusive with ssml.
- },
- ],
- },
- "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
- "phoneNumber": "A String", # Required. The phone number to transfer the call to
- # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
- #
- # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
- },
- "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.
- "name": "A String", # Required. Name of media card.
- "description": "A String", # Optional. Description of media card.
- "contentUrl": "A String", # Required. Url where the media is stored.
- "icon": { # The image response message. # Optional. Icon to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- "largeImage": { # The image response message. # Optional. Image to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- },
- ],
- "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
- },
- "image": { # The image response message. # Displays an image.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
- # For more details about RBM rich cards, please see:
- # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout.
- "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
- # Image preview alignment for standalone cards with horizontal layout.
- "cardOrientation": "A String", # Required. Orientation of the card.
"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
@@ -2816,35 +2740,44 @@
# * video/mpeg
# * video/mpeg4
# * video/webm
- "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
- # provide a thumbnail URI, the RBM platform displays a blank
- # placeholder thumbnail until the user's device downloads the file.
- # Depending on the user's setting, the file may not download
- # automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
- # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
+ # within a rich card with a vertical layout.
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
+ "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
+ # provide a thumbnail URI, the RBM platform displays a blank
+ # placeholder thumbnail until the user's device downloads the file.
+ # Depending on the user's setting, the file may not download
+ # automatically and may require the user to tap a download button.
},
+ "title": "A String", # Optional. Title of the card (at most 200 bytes).
+ #
+ # At least one of the title, description or media must be set.
+ "description": "A String", # Optional. Description of the card (at most 2000 bytes).
+ #
+ # At least one of the title, description or media must be set.
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
- "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
- # instead of typing in their own response.
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested reply. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "text": "A String", # Suggested reply text.
- },
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
+ "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
+ # If the user has an app installed that is
+ # registered as the default handler for the URL, then this app will be
+ # opened instead, and its icon will be used in the suggested action UI.
+ "uri": "A String", # Required. The uri to open on the user device
+ },
+ "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
+ # to send back to the agent.
+ },
+ "text": "A String", # Text to display alongside the action.
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
- # but does not dial automatically (https://goo.gl/ergbB2).
+ # but does not dial automatically.
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
@@ -2853,53 +2786,184 @@
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
- "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
- # to send back to the agent (https://goo.gl/GXotJW).
- },
- "text": "A String", # Text to display alongside the action.
- "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
- # (https://goo.gl/6GLJD2). If the user has an app installed that is
- # registered as the default handler for the URL, then this app will be
- # opened instead, and its icon will be used in the suggested action UI.
- "uri": "A String", # Required. The uri to open on the user device
- },
+ },
+ "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
+ # instead of typing in their own response.
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested reply. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
+ "text": "A String", # Suggested reply text.
},
},
],
- "title": "A String", # Optional. Title of the card (at most 200 bytes).
- #
- # At least one of the title, description or media must be set.
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
},
+ "cardOrientation": "A String", # Required. Orientation of the card.
+ "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
+ # Image preview alignment for standalone cards with horizontal layout.
},
- "payload": { # A custom platform-specific response.
- "a_key": "", # Properties of the object.
+ "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
+ "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
+ # play, e.g., "gs://bucket/object". The object must contain a single
+ # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
+ #
+ # This object must be readable by the `service-<Project
+ # Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
+ # where <Project Number> is the number of the Telephony Gateway project
+ # (usually the same as the Dialogflow agent project). If the Google Cloud
+ # Storage bucket is in the Telephony Gateway project, this permission is
+ # added by default when enabling the Dialogflow V2 API.
+ #
+ # For audio from other sources, consider using the
+ # `TelephonySynthesizeSpeech` message with SSML.
+ },
+ "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
+ "items": [ # Required. Carousel items.
+ { # An item in the carousel.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
+ # dialog.
+ "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
+ # item in dialog.
+ "A String",
+ ],
+ "key": "A String", # Required. A unique key that will be sent back to the agent if this
+ # response is given.
+ },
+ "title": "A String", # Required. Title of the carousel item.
+ "description": "A String", # Optional. The body text of the card.
+ },
+ ],
+ },
+ "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
+ # This message in `QueryResult.fulfillment_messages` and
+ # `WebhookResponse.fulfillment_messages` should contain only one
+ # `SimpleResponse`.
+ "simpleResponses": [ # Required. The list of simple responses.
+ { # The simple response message containing speech or text.
+ "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
+ # response to the user in the SSML format. Mutually exclusive with
+ # text_to_speech.
+ "displayText": "A String", # Optional. The text to display.
+ "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
+ # speech output. Mutually exclusive with ssml.
+ },
+ ],
+ },
+ "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
+ # https://developers.google.com/actions/assistant/responses#browsing_carousel
+ "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
+ # items.
+ "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
+ # items, maximum of ten.
+ { # Browsing carousel tile
+ "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
+ # Card. Maximum of one line of text.
+ "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.
+ "image": { # The image response message. # Optional. Hero image for the carousel item.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
+ "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
+ # the URL. Defaults to opening via web browser.
+ "url": "A String", # Required. URL
+ },
+ },
+ ],
},
},
],
- "action": "A String", # Optional. The name of the action associated with the intent.
- # Note: The action name must not contain whitespaces.
+ "parentFollowupIntentName": "A String", # Optional. 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>`.
+ "parameters": [ # Optional. The collection of parameters associated with the intent.
+ { # Represents intent parameters.
+ "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
+ "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
+ # whether the intent cannot be completed without collecting the parameter
+ # value.
+ "prompts": [ # Optional. The collection of prompts that the agent can present to the
+ # user in order to collect a value for the parameter.
+ "A String",
+ ],
+ "name": "A String", # The unique identifier of this parameter.
+ "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
+ # describes values of the parameter. If the parameter is
+ # required, this must be provided.
+ "displayName": "A String", # Required. The name of the parameter.
+ "value": "A String", # Optional. The definition of the parameter value. It can be:
+ #
+ # - a constant string,
+ # - a parameter value defined as `$parameter_name`,
+ # - an original parameter value defined as `$parameter_name.original`,
+ # - a parameter value from some context defined as
+ # `#context_name.parameter_name`.
+ "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
+ # result.
+ # Default values can be extracted from contexts by using the following
+ # syntax: `#context_name.parameter_name`.
+ },
+ ],
+ "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",
+ ],
+ "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the 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>`.
- "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
+ "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
+ # Note: If `ml_enabled` setting is set to false, then this intent is not
+ # taken into account during inference in `ML ONLY` match mode. Also,
+ # auto-markup in the UI is turned off.
+ # DEPRECATED! Please use `ml_disabled` field instead.
+ # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
+ # then the default value is determined as follows:
+ # - Before April 15th, 2018 the default is:
+ # ml_enabled = false / ml_disabled = true.
+ # - After April 15th, 2018 the default is:
+ # ml_enabled = true / ml_disabled = false.
+ "followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as
+ # a direct or indirect parent. We populate this field only in the output.
+ { # Represents a single followup intent in the chain.
+ "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "followupIntentName": "A String", # The unique identifier of the followup intent.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ },
+ ],
+ "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",
+ ],
"inputContextNames": [ # Optional. The list of context names required for this intent to be
# triggered.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
"A String",
],
- "followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as
- # a direct or indirect parent. We populate this field only in the output.
- { # Represents a single followup intent in the chain.
- "followupIntentName": "A String", # The unique identifier of the followup intent.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- },
- ],
+ "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
+ # priorities.
+ #
+ # - If the supplied value is unspecified or 0, the service
+ # translates the value to 500,000, which corresponds to the
+ # `Normal` priority in the console.
+ # - If the supplied value is negative, the intent is ignored
+ # in runtime detect intent requests.
}</pre>
</div>
@@ -2953,134 +3017,58 @@
Returns:
An object of the form:
- { # Represents an intent.
- # Intents convert a number of user expressions or patterns into an action. An
- # action is an extraction of a user command or sentence semantics.
- "displayName": "A String", # Required. The name of this intent.
- "rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of
- # followup intents. It identifies the correct followup intents chain for
- # this intent.
- #
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
- # Note: If `ml_disabled` setting is set to true, then this intent is not
- # taken into account during inference in `ML ONLY` match mode. Also,
- # auto-markup in the UI is turned off.
- "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
- "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
- # Note: If `ml_enabled` setting is set to false, then this intent is not
- # taken into account during inference in `ML ONLY` match mode. Also,
- # auto-markup in the UI is turned off.
- # DEPRECATED! Please use `ml_disabled` field instead.
- # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
- # then the default value is determined as follows:
- # - Before April 15th, 2018 the default is:
- # ml_enabled = false / ml_disabled = true.
- # - After April 15th, 2018 the default is:
- # ml_enabled = true / ml_disabled = false.
- "trainingPhrases": [ # Optional. The collection of examples that the agent is
- # trained on.
- { # Represents an example that the agent is trained on.
- "parts": [ # Required. The ordered list of training phrase parts.
- # The parts are concatenated in order to form the training phrase.
- #
- # Note: The API does not automatically annotate training phrases like the
- # Dialogflow Console does.
- #
- # Note: Do not forget to include whitespace at part boundaries,
- # so the training phrase is well formatted when the parts are concatenated.
- #
- # If the training phrase does not need to be annotated with parameters,
- # you just need a single part with only the Part.text field set.
- #
- # If you want to annotate the training phrase, you must create multiple
- # parts, where the fields of each part are populated in one of two ways:
- #
- # - `Part.text` is set to a part of the phrase that has no parameters.
- # - `Part.text` is set to a part of the phrase that you want to annotate,
- # and the `entity_type`, `alias`, and `user_defined` fields are all
- # set.
- { # Represents a part of a training phrase.
- "alias": "A String", # Optional. The parameter name for the value extracted from the
- # annotated part of the example.
- # This field is required for annotated parts of the training phrase.
- "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
- # This field is set to true when the Dialogflow Console is used to
- # manually annotate the part. When creating an annotated part with the
- # API, you must set this to true.
- "text": "A String", # Required. The text for this part.
- "entityType": "A String", # Optional. The entity type name prefixed with `@`.
- # This field is required for annotated parts of the training phrase.
- },
- ],
- "name": "A String", # Output only. The unique identifier of this training phrase.
- "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
- # the intent. Each time a developer adds an existing sample by editing an
- # intent or training, this counter is increased.
- "type": "A String", # Required. The type of the training phrase.
- },
- ],
- "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
- # session when this intent is matched.
- "parameters": [ # Optional. The collection of parameters associated with the intent.
- { # Represents intent parameters.
- "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
- # describes values of the parameter. If the parameter is
- # required, this must be provided.
- "prompts": [ # Optional. The collection of prompts that the agent can present to the
- # user in order to collect a value for the parameter.
- "A String",
- ],
- "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
- # whether the intent cannot be completed without collecting the parameter
- # value.
- "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
- # result.
- # Default values can be extracted from contexts by using the following
- # syntax: `#context_name.parameter_name`.
- "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
- "name": "A String", # The unique identifier of this parameter.
- "value": "A String", # Optional. The definition of the parameter value. It can be:
- #
- # - a constant string,
- # - a parameter value defined as `$parameter_name`,
- # - an original parameter value defined as `$parameter_name.original`,
- # - a parameter value from some context defined as
- # `#context_name.parameter_name`.
- "displayName": "A String", # Required. The name of the parameter.
- },
- ],
- "events": [ # Optional. The collection of event names that trigger the intent.
- # If the collection of input contexts is not empty, all of the contexts must
- # be present in the active user session for an event to trigger this intent.
- # Event names are limited to 150 characters.
- "A String",
- ],
- "parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the
- # chain of followup intents. You can set this field when creating an intent,
- # for example with CreateIntent or
- # BatchUpdateIntents, in order to make this
- # intent a followup intent.
- #
- # It identifies the parent followup intent.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
- # priorities.
- #
- # - If the supplied value is unspecified or 0, the service
- # translates the value to 500,000, which corresponds to the
- # `Normal` priority in the console.
- # - If the supplied value is negative, the intent is ignored
- # in runtime detect intent requests.
+ { # An intent categorizes an end-user's intention for one conversation turn. For
+ # each agent, you define many intents, where your combined intents can handle a
+ # complete conversation. When an end-user writes or says something, referred to
+ # as an end-user expression or end-user input, Dialogflow matches the end-user
+ # input to the best intent in your agent. Matching an intent is also known as
+ # intent classification.
+ #
+ # For more information, see the [intent
+ # guide](https://cloud.google.com/dialogflow/docs/intents-overview).
"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
# (e.g., Actions on Google or Dialogflow phone gateway) use this information
# to close interaction with an end user. Default is false.
+ "action": "A String", # Optional. The name of the action associated with the intent.
+ # Note: The action name must not contain whitespaces.
+ "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
"outputContexts": [ # Optional. The collection of contexts that are activated when the intent
# is matched. Context messages in this collection should not set the
# parameters field. Setting the `lifespan_count` to 0 will reset the context
# when the intent is matched.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
- { # Represents a context.
+ { # Dialogflow contexts are similar to natural language context. If a person says
+ # to you "they are orange", you need context in order to understand what "they"
+ # is referring to. Similarly, for Dialogflow to handle an end-user expression
+ # like that, it needs to be provided with context in order to correctly match
+ # an intent.
+ #
+ # Using contexts, you can control the flow of a conversation. You can configure
+ # contexts for an intent by setting input and output contexts, which are
+ # identified by string names. When an intent is matched, any configured output
+ # contexts for that intent become active. While any contexts are active,
+ # Dialogflow is more likely to match intents that are configured with input
+ # contexts that correspond to the currently active contexts.
+ #
+ # For more information about context, see the
+ # [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).
+ "parameters": { # Optional. The collection of parameters associated with this context.
+ #
+ # Depending on your protocol or client library language, this is a
+ # 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. The default is `0`. If set to `0`, the context expires
# immediately. Contexts expire automatically after 20 minutes if there
@@ -3102,46 +3090,189 @@
# * `__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.
- },
},
],
- "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",
+ "displayName": "A String", # Required. The name of this intent.
+ "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
+ # session when this intent is matched.
+ "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
+ # Note: If `ml_disabled` setting is set to true, then this intent is not
+ # taken into account during inference in `ML ONLY` match mode. Also,
+ # auto-markup in the UI is turned off.
+ "rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of
+ # followup intents. It identifies the correct followup intents chain for
+ # this intent.
+ #
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "trainingPhrases": [ # Optional. The collection of examples that the agent is
+ # trained on.
+ { # Represents an example that the agent is trained on.
+ "type": "A String", # Required. The type of the training phrase.
+ "name": "A String", # Output only. The unique identifier of this training phrase.
+ "parts": [ # Required. The ordered list of training phrase parts.
+ # The parts are concatenated in order to form the training phrase.
+ #
+ # Note: The API does not automatically annotate training phrases like the
+ # Dialogflow Console does.
+ #
+ # Note: Do not forget to include whitespace at part boundaries,
+ # so the training phrase is well formatted when the parts are concatenated.
+ #
+ # If the training phrase does not need to be annotated with parameters,
+ # you just need a single part with only the Part.text field set.
+ #
+ # If you want to annotate the training phrase, you must create multiple
+ # parts, where the fields of each part are populated in one of two ways:
+ #
+ # - `Part.text` is set to a part of the phrase that has no parameters.
+ # - `Part.text` is set to a part of the phrase that you want to annotate,
+ # and the `entity_type`, `alias`, and `user_defined` fields are all
+ # set.
+ { # Represents a part of a training phrase.
+ "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
+ # This field is set to true when the Dialogflow Console is used to
+ # manually annotate the part. When creating an annotated part with the
+ # API, you must set this to true.
+ "alias": "A String", # Optional. The parameter name for the value extracted from the
+ # annotated part of the example.
+ # This field is required for annotated parts of the training phrase.
+ "entityType": "A String", # Optional. The entity type name prefixed with `@`.
+ # This field is required for annotated parts of the training phrase.
+ "text": "A String", # Required. The text for this part.
+ },
+ ],
+ "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
+ # the intent. Each time a developer adds an existing sample by editing an
+ # intent or training, this counter is increased.
+ },
],
"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.
- "text": { # The text response message. # Returns a text response.
- "text": [ # Optional. The collection of the agent's responses.
+ "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
+ "suggestions": [ # Required. The list of suggested replies.
+ { # The suggestion chip message that the user can tap to quickly post a reply
+ # to the conversation.
+ "title": "A String", # Required. The text shown the in the suggestion chip.
+ },
+ ],
+ },
+ "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
+ "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
+ "mediaObjects": [ # Required. List of media objects.
+ { # Response media object for media content card.
+ "description": "A String", # Optional. Description of media card.
+ "icon": { # The image response message. # Optional. Icon to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "contentUrl": "A String", # Required. Url where the media is stored.
+ "name": "A String", # Required. Name of media card.
+ "largeImage": { # The image response message. # Optional. Image to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ },
+ ],
+ },
+ "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
+ "phoneNumber": "A String", # Required. The phone number to transfer the call to
+ # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+ #
+ # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
+ },
+ "platform": "A String", # Optional. The platform that this message is intended for.
+ "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
+ # Telephony Gateway.
+ #
+ # Telephony Gateway takes the synthesizer settings from
+ # `DetectIntentResponse.output_audio_config` which can either be set
+ # at request-level or can come from the agent-level synthesizer config.
+ "text": "A String", # The raw text to be synthesized.
+ "ssml": "A String", # The SSML to be synthesized. For more information, see
+ # [SSML](https://developers.google.com/actions/reference/ssml).
+ },
+ "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.
+ # or website associated with this agent.
+ "uri": "A String", # Required. The URI of the app or site to open when the user taps the
+ # suggestion chip.
+ "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
+ },
+ "quickReplies": { # The quick replies response message. # Displays quick replies.
+ "quickReplies": [ # Optional. The collection of quick replies.
"A String",
],
+ "title": "A String", # Optional. The title of the collection of quick replies.
+ },
+ "card": { # The card response message. # Displays a card.
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # Optional. Contains information about a button.
+ "text": "A String", # Optional. The text to show on the button.
+ "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
+ # open.
+ },
+ ],
+ "imageUri": "A String", # Optional. The public URI to an image file for the card.
+ "title": "A String", # Optional. The title of the card.
+ },
+ "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
+ "subtitle": "A String", # Optional. Subtitle of the list.
+ "title": "A String", # Optional. The overall title of the list.
+ "items": [ # Required. List items.
+ { # An item in the list.
+ "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
+ # dialog.
+ "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
+ # item in dialog.
+ "A String",
+ ],
+ "key": "A String", # Required. A unique key that will be sent back to the agent if this
+ # response is given.
+ },
+ "description": "A String", # Optional. The main text describing the item.
+ "title": "A String", # Required. The title of the list item.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ },
+ ],
+ },
+ "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # The button object that appears at the bottom of a card.
+ "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
+ "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
+ },
+ "title": "A String", # Required. The title of the button.
+ },
+ ],
+ "title": "A String", # Optional. The title of the card.
+ "image": { # The image response message. # Optional. The image for the card.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "formattedText": "A String", # Required, unless image is present. The body text of the card.
+ },
+ "image": { # The image response message. # Displays an image.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
},
"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
- # For more details about RBM rich cards, please see:
- # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead.
+ "cardWidth": "A String", # Required. The width of the cards in the carousel.
"cardContents": [ # Required. The cards in the carousel. A carousel must have at least
# 2 cards and at most 10.
{ # Rich Business Messaging (RBM) Card content
@@ -3164,35 +3295,44 @@
# * video/mpeg
# * video/mpeg4
# * video/webm
- "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
- # provide a thumbnail URI, the RBM platform displays a blank
- # placeholder thumbnail until the user's device downloads the file.
- # Depending on the user's setting, the file may not download
- # automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
- # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
+ # within a rich card with a vertical layout.
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
+ "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
+ # provide a thumbnail URI, the RBM platform displays a blank
+ # placeholder thumbnail until the user's device downloads the file.
+ # Depending on the user's setting, the file may not download
+ # automatically and may require the user to tap a download button.
},
+ "title": "A String", # Optional. Title of the card (at most 200 bytes).
+ #
+ # At least one of the title, description or media must be set.
+ "description": "A String", # Optional. Description of the card (at most 2000 bytes).
+ #
+ # At least one of the title, description or media must be set.
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
- "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
- # instead of typing in their own response.
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested reply. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "text": "A String", # Suggested reply text.
- },
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
+ "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
+ # If the user has an app installed that is
+ # registered as the default handler for the URL, then this app will be
+ # opened instead, and its icon will be used in the suggested action UI.
+ "uri": "A String", # Required. The uri to open on the user device
+ },
+ "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
+ # to send back to the agent.
+ },
+ "text": "A String", # Text to display alongside the action.
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
- # but does not dial automatically (https://goo.gl/ergbB2).
+ # but does not dial automatically.
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
@@ -3201,180 +3341,34 @@
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
- "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
- # to send back to the agent (https://goo.gl/GXotJW).
- },
- "text": "A String", # Text to display alongside the action.
- "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
- # (https://goo.gl/6GLJD2). If the user has an app installed that is
- # registered as the default handler for the URL, then this app will be
- # opened instead, and its icon will be used in the suggested action UI.
- "uri": "A String", # Required. The uri to open on the user device
- },
+ },
+ "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
+ # instead of typing in their own response.
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested reply. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
+ "text": "A String", # Suggested reply text.
},
},
],
- "title": "A String", # Optional. Title of the card (at most 200 bytes).
- #
- # At least one of the title, description or media must be set.
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
- },
- ],
- "cardWidth": "A String", # Required. The width of the cards in the carousel.
- },
- "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
- "suggestions": [ # Required. The list of suggested replies.
- { # The suggestion chip message that the user can tap to quickly post a reply
- # to the conversation.
- "title": "A String", # Required. The text shown the in the suggestion chip.
},
],
},
- "platform": "A String", # Optional. The platform that this message is intended for.
- "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
- "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
- # play, e.g., "gs://bucket/object". The object must contain a single
- # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
- #
- # This object must be readable by the `service-<Project
- # Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
- # where <Project Number> is the number of the Telephony Gateway project
- # (usually the same as the Dialogflow agent project). If the Google Cloud
- # Storage bucket is in the Telephony Gateway project, this permission is
- # added by default when enabling the Dialogflow V2 API.
- #
- # For audio from other sources, consider using the
- # `TelephonySynthesizeSpeech` message with SSML.
- },
- "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
- "title": "A String", # Optional. The overall title of the list.
- "subtitle": "A String", # Optional. Subtitle of the list.
- "items": [ # Required. List items.
- { # An item in the list.
- "description": "A String", # Optional. The main text describing the item.
- "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
- # dialog.
- "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
- # item in dialog.
- "A String",
- ],
- "key": "A String", # Required. A unique key that will be sent back to the agent if this
- # response is given.
- },
- "title": "A String", # Required. The title of the list item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- },
- ],
- },
- "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
- #
- # RBM allows businesses to send enriched and branded versions of SMS. See
- # https://jibe.google.com/business-messaging.
- "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
- { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
- # easily select/click a predefined response or perform an action (like
- # opening a web uri).
- "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
- # instead of typing in their own response.
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested reply. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "text": "A String", # Suggested reply text.
- },
- "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
- # can choose from the card.
- "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
- # but does not dial automatically (https://goo.gl/ergbB2).
- "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
- # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
- # format. An example of a correctly formatted phone number:
- # +15556767888.
- },
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested action. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
- # to send back to the agent (https://goo.gl/GXotJW).
- },
- "text": "A String", # Text to display alongside the action.
- "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
- # (https://goo.gl/6GLJD2). If the user has an app installed that is
- # registered as the default handler for the URL, then this app will be
- # opened instead, and its icon will be used in the suggested action UI.
- "uri": "A String", # Required. The uri to open on the user device
- },
- },
- },
- ],
- "text": "A String", # Required. Text sent and displayed to the user.
- },
- "quickReplies": { # The quick replies response message. # Displays quick replies.
- "title": "A String", # Optional. The title of the collection of quick replies.
- "quickReplies": [ # Optional. The collection of quick replies.
- "A String",
- ],
- },
- "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
- # Telephony Gateway.
- #
- # Telephony Gateway takes the synthesizer settings from
- # `DetectIntentResponse.output_audio_config` which can either be set
- # at request-level or can come from the agent-level synthesizer config.
- "text": "A String", # The raw text to be synthesized.
- "ssml": "A String", # The SSML to be synthesized. For more information, see
- # [SSML](https://developers.google.com/actions/reference/ssml).
- },
- "card": { # The card response message. # Displays a card.
- "title": "A String", # Optional. The title of the card.
- "buttons": [ # Optional. The collection of card buttons.
- { # Optional. Contains information about a button.
- "text": "A String", # Optional. The text to show on the button.
- "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
- # open.
- },
- ],
- "subtitle": "A String", # Optional. The subtitle of the card.
- "imageUri": "A String", # Optional. The public URI to an image file for the card.
- },
- "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
- "title": "A String", # Optional. The title of the card.
- "image": { # The image response message. # Optional. The image for the card.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- "formattedText": "A String", # Required, unless image is present. The body text of the card.
- "buttons": [ # Optional. The collection of card buttons.
+ "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "buttons": [ # Optional. List of buttons for the card.
{ # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
+ "title": "A String", # Required. The title of the button.
},
],
- "subtitle": "A String", # Optional. The subtitle of the card.
- },
- "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "subtitle": "A String", # Optional. Subtitle to the title.
"image": { # The image response message. # Optional. Image which should be displayed on the card.
"imageUri": "A String", # Optional. The public URI to an image file.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
},
- "buttons": [ # Optional. List of buttons for the card.
- { # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
- "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
- "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
- },
- },
- ],
- "title": "A String", # Required. Title of the card.
"rows": [ # Optional. Rows in this table of data.
{ # Row of TableCard.
"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
@@ -3385,7 +3379,7 @@
],
},
],
- "subtitle": "A String", # Optional. Subtitle to the title.
+ "title": "A String", # Required. Title of the card.
"columnProperties": [ # Optional. Display properties for the columns in this table.
{ # Column properties for TableCard.
"header": "A String", # Required. Column heading.
@@ -3393,117 +3387,63 @@
},
],
},
- "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
- "items": [ # Required. Carousel items.
- { # An item in the carousel.
- "description": "A String", # Optional. The body text of the card.
- "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
- # dialog.
- "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
- # item in dialog.
- "A String",
- ],
- "key": "A String", # Required. A unique key that will be sent back to the agent if this
- # response is given.
+ "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
+ #
+ # RBM allows businesses to send enriched and branded versions of SMS. See
+ # https://jibe.google.com/business-messaging.
+ "text": "A String", # Required. Text sent and displayed to the user.
+ "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
+ { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
+ # easily select/click a predefined response or perform an action (like
+ # opening a web uri).
+ "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
+ # can choose from the card.
+ "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
+ # If the user has an app installed that is
+ # registered as the default handler for the URL, then this app will be
+ # opened instead, and its icon will be used in the suggested action UI.
+ "uri": "A String", # Required. The uri to open on the user device
+ },
+ "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
+ # to send back to the agent.
+ },
+ "text": "A String", # Text to display alongside the action.
+ "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
+ # but does not dial automatically.
+ "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
+ # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
+ # format. An example of a correctly formatted phone number:
+ # +15556767888.
+ },
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested action. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
},
- "title": "A String", # Required. Title of the carousel item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
+ # instead of typing in their own response.
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested reply. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
+ "text": "A String", # Suggested reply text.
},
},
],
},
- "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.
- # or website associated with this agent.
- "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
- "uri": "A String", # Required. The URI of the app or site to open when the user taps the
- # suggestion chip.
+ "payload": { # A custom platform-specific response.
+ "a_key": "", # Properties of the object.
},
- "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
- # https://developers.google.com/actions/assistant/responses#browsing_carousel
- "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
- # items.
- "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
- # items, maximum of ten.
- { # Browsing carousel tile
- "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.
- "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
- # the URL. Defaults to opening via web browser.
- "url": "A String", # Required. URL
- },
- "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
- # Card. Maximum of one line of text.
- "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
- "image": { # The image response message. # Optional. Hero image for the carousel item.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- },
+ "text": { # The text response message. # Returns a text response.
+ "text": [ # Optional. The collection of the agent's responses.
+ "A String",
],
},
- "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
- # This message in `QueryResult.fulfillment_messages` and
- # `WebhookResponse.fulfillment_messages` should contain only one
- # `SimpleResponse`.
- "simpleResponses": [ # Required. The list of simple responses.
- { # The simple response message containing speech or text.
- "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
- # response to the user in the SSML format. Mutually exclusive with
- # text_to_speech.
- "displayText": "A String", # Optional. The text to display.
- "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
- # speech output. Mutually exclusive with ssml.
- },
- ],
- },
- "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
- "phoneNumber": "A String", # Required. The phone number to transfer the call to
- # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
- #
- # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
- },
- "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.
- "name": "A String", # Required. Name of media card.
- "description": "A String", # Optional. Description of media card.
- "contentUrl": "A String", # Required. Url where the media is stored.
- "icon": { # The image response message. # Optional. Icon to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- "largeImage": { # The image response message. # Optional. Image to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- },
- ],
- "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
- },
- "image": { # The image response message. # Displays an image.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
- # For more details about RBM rich cards, please see:
- # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout.
- "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
- # Image preview alignment for standalone cards with horizontal layout.
- "cardOrientation": "A String", # Required. Orientation of the card.
"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
@@ -3524,35 +3464,44 @@
# * video/mpeg
# * video/mpeg4
# * video/webm
- "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
- # provide a thumbnail URI, the RBM platform displays a blank
- # placeholder thumbnail until the user's device downloads the file.
- # Depending on the user's setting, the file may not download
- # automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
- # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
+ # within a rich card with a vertical layout.
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
+ "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
+ # provide a thumbnail URI, the RBM platform displays a blank
+ # placeholder thumbnail until the user's device downloads the file.
+ # Depending on the user's setting, the file may not download
+ # automatically and may require the user to tap a download button.
},
+ "title": "A String", # Optional. Title of the card (at most 200 bytes).
+ #
+ # At least one of the title, description or media must be set.
+ "description": "A String", # Optional. Description of the card (at most 2000 bytes).
+ #
+ # At least one of the title, description or media must be set.
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
- "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
- # instead of typing in their own response.
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested reply. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "text": "A String", # Suggested reply text.
- },
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
+ "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
+ # If the user has an app installed that is
+ # registered as the default handler for the URL, then this app will be
+ # opened instead, and its icon will be used in the suggested action UI.
+ "uri": "A String", # Required. The uri to open on the user device
+ },
+ "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
+ # to send back to the agent.
+ },
+ "text": "A String", # Text to display alongside the action.
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
- # but does not dial automatically (https://goo.gl/ergbB2).
+ # but does not dial automatically.
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
@@ -3561,66 +3510,197 @@
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
- "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
- # to send back to the agent (https://goo.gl/GXotJW).
- },
- "text": "A String", # Text to display alongside the action.
- "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
- # (https://goo.gl/6GLJD2). If the user has an app installed that is
- # registered as the default handler for the URL, then this app will be
- # opened instead, and its icon will be used in the suggested action UI.
- "uri": "A String", # Required. The uri to open on the user device
- },
+ },
+ "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
+ # instead of typing in their own response.
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested reply. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
+ "text": "A String", # Suggested reply text.
},
},
],
- "title": "A String", # Optional. Title of the card (at most 200 bytes).
- #
- # At least one of the title, description or media must be set.
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
},
+ "cardOrientation": "A String", # Required. Orientation of the card.
+ "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
+ # Image preview alignment for standalone cards with horizontal layout.
},
- "payload": { # A custom platform-specific response.
- "a_key": "", # Properties of the object.
+ "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
+ "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
+ # play, e.g., "gs://bucket/object". The object must contain a single
+ # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
+ #
+ # This object must be readable by the `service-<Project
+ # Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
+ # where <Project Number> is the number of the Telephony Gateway project
+ # (usually the same as the Dialogflow agent project). If the Google Cloud
+ # Storage bucket is in the Telephony Gateway project, this permission is
+ # added by default when enabling the Dialogflow V2 API.
+ #
+ # For audio from other sources, consider using the
+ # `TelephonySynthesizeSpeech` message with SSML.
+ },
+ "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
+ "items": [ # Required. Carousel items.
+ { # An item in the carousel.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
+ # dialog.
+ "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
+ # item in dialog.
+ "A String",
+ ],
+ "key": "A String", # Required. A unique key that will be sent back to the agent if this
+ # response is given.
+ },
+ "title": "A String", # Required. Title of the carousel item.
+ "description": "A String", # Optional. The body text of the card.
+ },
+ ],
+ },
+ "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
+ # This message in `QueryResult.fulfillment_messages` and
+ # `WebhookResponse.fulfillment_messages` should contain only one
+ # `SimpleResponse`.
+ "simpleResponses": [ # Required. The list of simple responses.
+ { # The simple response message containing speech or text.
+ "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
+ # response to the user in the SSML format. Mutually exclusive with
+ # text_to_speech.
+ "displayText": "A String", # Optional. The text to display.
+ "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
+ # speech output. Mutually exclusive with ssml.
+ },
+ ],
+ },
+ "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
+ # https://developers.google.com/actions/assistant/responses#browsing_carousel
+ "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
+ # items.
+ "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
+ # items, maximum of ten.
+ { # Browsing carousel tile
+ "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
+ # Card. Maximum of one line of text.
+ "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.
+ "image": { # The image response message. # Optional. Hero image for the carousel item.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
+ "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
+ # the URL. Defaults to opening via web browser.
+ "url": "A String", # Required. URL
+ },
+ },
+ ],
},
},
],
- "action": "A String", # Optional. The name of the action associated with the intent.
- # Note: The action name must not contain whitespaces.
+ "parentFollowupIntentName": "A String", # Optional. 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>`.
+ "parameters": [ # Optional. The collection of parameters associated with the intent.
+ { # Represents intent parameters.
+ "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
+ "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
+ # whether the intent cannot be completed without collecting the parameter
+ # value.
+ "prompts": [ # Optional. The collection of prompts that the agent can present to the
+ # user in order to collect a value for the parameter.
+ "A String",
+ ],
+ "name": "A String", # The unique identifier of this parameter.
+ "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
+ # describes values of the parameter. If the parameter is
+ # required, this must be provided.
+ "displayName": "A String", # Required. The name of the parameter.
+ "value": "A String", # Optional. The definition of the parameter value. It can be:
+ #
+ # - a constant string,
+ # - a parameter value defined as `$parameter_name`,
+ # - an original parameter value defined as `$parameter_name.original`,
+ # - a parameter value from some context defined as
+ # `#context_name.parameter_name`.
+ "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
+ # result.
+ # Default values can be extracted from contexts by using the following
+ # syntax: `#context_name.parameter_name`.
+ },
+ ],
+ "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",
+ ],
+ "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the 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>`.
- "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
+ "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
+ # Note: If `ml_enabled` setting is set to false, then this intent is not
+ # taken into account during inference in `ML ONLY` match mode. Also,
+ # auto-markup in the UI is turned off.
+ # DEPRECATED! Please use `ml_disabled` field instead.
+ # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
+ # then the default value is determined as follows:
+ # - Before April 15th, 2018 the default is:
+ # ml_enabled = false / ml_disabled = true.
+ # - After April 15th, 2018 the default is:
+ # ml_enabled = true / ml_disabled = false.
+ "followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as
+ # a direct or indirect parent. We populate this field only in the output.
+ { # Represents a single followup intent in the chain.
+ "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "followupIntentName": "A String", # The unique identifier of the followup intent.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ },
+ ],
+ "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",
+ ],
"inputContextNames": [ # Optional. The list of context names required for this intent to be
# triggered.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
"A String",
],
- "followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as
- # a direct or indirect parent. We populate this field only in the output.
- { # Represents a single followup intent in the chain.
- "followupIntentName": "A String", # The unique identifier of the followup intent.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- },
- ],
+ "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
+ # priorities.
+ #
+ # - If the supplied value is unspecified or 0, the service
+ # translates the value to 500,000, which corresponds to the
+ # `Normal` priority in the console.
+ # - If the supplied value is negative, the intent is ignored
+ # in runtime detect intent requests.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, pageSize=None, intentView=None, languageCode=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageSize=None, pageToken=None, intentView=None, languageCode=None, x__xgafv=None)</code>
<pre>Returns the list of all intents in the specified agent.
Args:
parent: string, Required. The agent to list all intents from.
Format: `projects/<Project ID>/agent`. (required)
- pageToken: string, Optional. The next_page_token value returned from a previous list request.
pageSize: integer, Optional. The maximum number of items to return in a single page. By
default 100 and at most 1000.
+ pageToken: string, Optional. The next_page_token value returned from a previous list request.
intentView: string, Optional. The resource view to apply to the returned intent.
languageCode: string, Optional. The language used to access language-specific data.
If not specified, the agent's default language is used.
@@ -3636,136 +3716,62 @@
An object of the form:
{ # The response message for Intents.ListIntents.
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
+ # more results in the list.
"intents": [ # The list of agent intents. There will be a maximum number of items
# returned based on the page_size field in the request.
- { # Represents an intent.
- # Intents convert a number of user expressions or patterns into an action. An
- # action is an extraction of a user command or sentence semantics.
- "displayName": "A String", # Required. The name of this intent.
- "rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of
- # followup intents. It identifies the correct followup intents chain for
- # this intent.
- #
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
- # Note: If `ml_disabled` setting is set to true, then this intent is not
- # taken into account during inference in `ML ONLY` match mode. Also,
- # auto-markup in the UI is turned off.
- "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
- "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
- # Note: If `ml_enabled` setting is set to false, then this intent is not
- # taken into account during inference in `ML ONLY` match mode. Also,
- # auto-markup in the UI is turned off.
- # DEPRECATED! Please use `ml_disabled` field instead.
- # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
- # then the default value is determined as follows:
- # - Before April 15th, 2018 the default is:
- # ml_enabled = false / ml_disabled = true.
- # - After April 15th, 2018 the default is:
- # ml_enabled = true / ml_disabled = false.
- "trainingPhrases": [ # Optional. The collection of examples that the agent is
- # trained on.
- { # Represents an example that the agent is trained on.
- "parts": [ # Required. The ordered list of training phrase parts.
- # The parts are concatenated in order to form the training phrase.
- #
- # Note: The API does not automatically annotate training phrases like the
- # Dialogflow Console does.
- #
- # Note: Do not forget to include whitespace at part boundaries,
- # so the training phrase is well formatted when the parts are concatenated.
- #
- # If the training phrase does not need to be annotated with parameters,
- # you just need a single part with only the Part.text field set.
- #
- # If you want to annotate the training phrase, you must create multiple
- # parts, where the fields of each part are populated in one of two ways:
- #
- # - `Part.text` is set to a part of the phrase that has no parameters.
- # - `Part.text` is set to a part of the phrase that you want to annotate,
- # and the `entity_type`, `alias`, and `user_defined` fields are all
- # set.
- { # Represents a part of a training phrase.
- "alias": "A String", # Optional. The parameter name for the value extracted from the
- # annotated part of the example.
- # This field is required for annotated parts of the training phrase.
- "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
- # This field is set to true when the Dialogflow Console is used to
- # manually annotate the part. When creating an annotated part with the
- # API, you must set this to true.
- "text": "A String", # Required. The text for this part.
- "entityType": "A String", # Optional. The entity type name prefixed with `@`.
- # This field is required for annotated parts of the training phrase.
- },
- ],
- "name": "A String", # Output only. The unique identifier of this training phrase.
- "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
- # the intent. Each time a developer adds an existing sample by editing an
- # intent or training, this counter is increased.
- "type": "A String", # Required. The type of the training phrase.
- },
- ],
- "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
- # session when this intent is matched.
- "parameters": [ # Optional. The collection of parameters associated with the intent.
- { # Represents intent parameters.
- "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
- # describes values of the parameter. If the parameter is
- # required, this must be provided.
- "prompts": [ # Optional. The collection of prompts that the agent can present to the
- # user in order to collect a value for the parameter.
- "A String",
- ],
- "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
- # whether the intent cannot be completed without collecting the parameter
- # value.
- "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
- # result.
- # Default values can be extracted from contexts by using the following
- # syntax: `#context_name.parameter_name`.
- "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
- "name": "A String", # The unique identifier of this parameter.
- "value": "A String", # Optional. The definition of the parameter value. It can be:
- #
- # - a constant string,
- # - a parameter value defined as `$parameter_name`,
- # - an original parameter value defined as `$parameter_name.original`,
- # - a parameter value from some context defined as
- # `#context_name.parameter_name`.
- "displayName": "A String", # Required. The name of the parameter.
- },
- ],
- "events": [ # Optional. The collection of event names that trigger the intent.
- # If the collection of input contexts is not empty, all of the contexts must
- # be present in the active user session for an event to trigger this intent.
- # Event names are limited to 150 characters.
- "A String",
- ],
- "parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the
- # chain of followup intents. You can set this field when creating an intent,
- # for example with CreateIntent or
- # BatchUpdateIntents, in order to make this
- # intent a followup intent.
- #
- # It identifies the parent followup intent.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
- # priorities.
- #
- # - If the supplied value is unspecified or 0, the service
- # translates the value to 500,000, which corresponds to the
- # `Normal` priority in the console.
- # - If the supplied value is negative, the intent is ignored
- # in runtime detect intent requests.
+ { # An intent categorizes an end-user's intention for one conversation turn. For
+ # each agent, you define many intents, where your combined intents can handle a
+ # complete conversation. When an end-user writes or says something, referred to
+ # as an end-user expression or end-user input, Dialogflow matches the end-user
+ # input to the best intent in your agent. Matching an intent is also known as
+ # intent classification.
+ #
+ # For more information, see the [intent
+ # guide](https://cloud.google.com/dialogflow/docs/intents-overview).
"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
# (e.g., Actions on Google or Dialogflow phone gateway) use this information
# to close interaction with an end user. Default is false.
+ "action": "A String", # Optional. The name of the action associated with the intent.
+ # Note: The action name must not contain whitespaces.
+ "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
"outputContexts": [ # Optional. The collection of contexts that are activated when the intent
# is matched. Context messages in this collection should not set the
# parameters field. Setting the `lifespan_count` to 0 will reset the context
# when the intent is matched.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
- { # Represents a context.
+ { # Dialogflow contexts are similar to natural language context. If a person says
+ # to you "they are orange", you need context in order to understand what "they"
+ # is referring to. Similarly, for Dialogflow to handle an end-user expression
+ # like that, it needs to be provided with context in order to correctly match
+ # an intent.
+ #
+ # Using contexts, you can control the flow of a conversation. You can configure
+ # contexts for an intent by setting input and output contexts, which are
+ # identified by string names. When an intent is matched, any configured output
+ # contexts for that intent become active. While any contexts are active,
+ # Dialogflow is more likely to match intents that are configured with input
+ # contexts that correspond to the currently active contexts.
+ #
+ # For more information about context, see the
+ # [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).
+ "parameters": { # Optional. The collection of parameters associated with this context.
+ #
+ # Depending on your protocol or client library language, this is a
+ # 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. The default is `0`. If set to `0`, the context expires
# immediately. Contexts expire automatically after 20 minutes if there
@@ -3787,46 +3793,189 @@
# * `__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.
- },
},
],
- "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",
+ "displayName": "A String", # Required. The name of this intent.
+ "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
+ # session when this intent is matched.
+ "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
+ # Note: If `ml_disabled` setting is set to true, then this intent is not
+ # taken into account during inference in `ML ONLY` match mode. Also,
+ # auto-markup in the UI is turned off.
+ "rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of
+ # followup intents. It identifies the correct followup intents chain for
+ # this intent.
+ #
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "trainingPhrases": [ # Optional. The collection of examples that the agent is
+ # trained on.
+ { # Represents an example that the agent is trained on.
+ "type": "A String", # Required. The type of the training phrase.
+ "name": "A String", # Output only. The unique identifier of this training phrase.
+ "parts": [ # Required. The ordered list of training phrase parts.
+ # The parts are concatenated in order to form the training phrase.
+ #
+ # Note: The API does not automatically annotate training phrases like the
+ # Dialogflow Console does.
+ #
+ # Note: Do not forget to include whitespace at part boundaries,
+ # so the training phrase is well formatted when the parts are concatenated.
+ #
+ # If the training phrase does not need to be annotated with parameters,
+ # you just need a single part with only the Part.text field set.
+ #
+ # If you want to annotate the training phrase, you must create multiple
+ # parts, where the fields of each part are populated in one of two ways:
+ #
+ # - `Part.text` is set to a part of the phrase that has no parameters.
+ # - `Part.text` is set to a part of the phrase that you want to annotate,
+ # and the `entity_type`, `alias`, and `user_defined` fields are all
+ # set.
+ { # Represents a part of a training phrase.
+ "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
+ # This field is set to true when the Dialogflow Console is used to
+ # manually annotate the part. When creating an annotated part with the
+ # API, you must set this to true.
+ "alias": "A String", # Optional. The parameter name for the value extracted from the
+ # annotated part of the example.
+ # This field is required for annotated parts of the training phrase.
+ "entityType": "A String", # Optional. The entity type name prefixed with `@`.
+ # This field is required for annotated parts of the training phrase.
+ "text": "A String", # Required. The text for this part.
+ },
+ ],
+ "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
+ # the intent. Each time a developer adds an existing sample by editing an
+ # intent or training, this counter is increased.
+ },
],
"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.
- "text": { # The text response message. # Returns a text response.
- "text": [ # Optional. The collection of the agent's responses.
+ "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
+ "suggestions": [ # Required. The list of suggested replies.
+ { # The suggestion chip message that the user can tap to quickly post a reply
+ # to the conversation.
+ "title": "A String", # Required. The text shown the in the suggestion chip.
+ },
+ ],
+ },
+ "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
+ "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
+ "mediaObjects": [ # Required. List of media objects.
+ { # Response media object for media content card.
+ "description": "A String", # Optional. Description of media card.
+ "icon": { # The image response message. # Optional. Icon to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "contentUrl": "A String", # Required. Url where the media is stored.
+ "name": "A String", # Required. Name of media card.
+ "largeImage": { # The image response message. # Optional. Image to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ },
+ ],
+ },
+ "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
+ "phoneNumber": "A String", # Required. The phone number to transfer the call to
+ # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+ #
+ # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
+ },
+ "platform": "A String", # Optional. The platform that this message is intended for.
+ "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
+ # Telephony Gateway.
+ #
+ # Telephony Gateway takes the synthesizer settings from
+ # `DetectIntentResponse.output_audio_config` which can either be set
+ # at request-level or can come from the agent-level synthesizer config.
+ "text": "A String", # The raw text to be synthesized.
+ "ssml": "A String", # The SSML to be synthesized. For more information, see
+ # [SSML](https://developers.google.com/actions/reference/ssml).
+ },
+ "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.
+ # or website associated with this agent.
+ "uri": "A String", # Required. The URI of the app or site to open when the user taps the
+ # suggestion chip.
+ "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
+ },
+ "quickReplies": { # The quick replies response message. # Displays quick replies.
+ "quickReplies": [ # Optional. The collection of quick replies.
"A String",
],
+ "title": "A String", # Optional. The title of the collection of quick replies.
+ },
+ "card": { # The card response message. # Displays a card.
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # Optional. Contains information about a button.
+ "text": "A String", # Optional. The text to show on the button.
+ "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
+ # open.
+ },
+ ],
+ "imageUri": "A String", # Optional. The public URI to an image file for the card.
+ "title": "A String", # Optional. The title of the card.
+ },
+ "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
+ "subtitle": "A String", # Optional. Subtitle of the list.
+ "title": "A String", # Optional. The overall title of the list.
+ "items": [ # Required. List items.
+ { # An item in the list.
+ "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
+ # dialog.
+ "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
+ # item in dialog.
+ "A String",
+ ],
+ "key": "A String", # Required. A unique key that will be sent back to the agent if this
+ # response is given.
+ },
+ "description": "A String", # Optional. The main text describing the item.
+ "title": "A String", # Required. The title of the list item.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ },
+ ],
+ },
+ "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # The button object that appears at the bottom of a card.
+ "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
+ "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
+ },
+ "title": "A String", # Required. The title of the button.
+ },
+ ],
+ "title": "A String", # Optional. The title of the card.
+ "image": { # The image response message. # Optional. The image for the card.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "formattedText": "A String", # Required, unless image is present. The body text of the card.
+ },
+ "image": { # The image response message. # Displays an image.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
},
"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
- # For more details about RBM rich cards, please see:
- # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead.
+ "cardWidth": "A String", # Required. The width of the cards in the carousel.
"cardContents": [ # Required. The cards in the carousel. A carousel must have at least
# 2 cards and at most 10.
{ # Rich Business Messaging (RBM) Card content
@@ -3849,35 +3998,44 @@
# * video/mpeg
# * video/mpeg4
# * video/webm
- "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
- # provide a thumbnail URI, the RBM platform displays a blank
- # placeholder thumbnail until the user's device downloads the file.
- # Depending on the user's setting, the file may not download
- # automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
- # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
+ # within a rich card with a vertical layout.
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
+ "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
+ # provide a thumbnail URI, the RBM platform displays a blank
+ # placeholder thumbnail until the user's device downloads the file.
+ # Depending on the user's setting, the file may not download
+ # automatically and may require the user to tap a download button.
},
+ "title": "A String", # Optional. Title of the card (at most 200 bytes).
+ #
+ # At least one of the title, description or media must be set.
+ "description": "A String", # Optional. Description of the card (at most 2000 bytes).
+ #
+ # At least one of the title, description or media must be set.
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
- "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
- # instead of typing in their own response.
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested reply. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "text": "A String", # Suggested reply text.
- },
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
+ "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
+ # If the user has an app installed that is
+ # registered as the default handler for the URL, then this app will be
+ # opened instead, and its icon will be used in the suggested action UI.
+ "uri": "A String", # Required. The uri to open on the user device
+ },
+ "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
+ # to send back to the agent.
+ },
+ "text": "A String", # Text to display alongside the action.
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
- # but does not dial automatically (https://goo.gl/ergbB2).
+ # but does not dial automatically.
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
@@ -3886,180 +4044,34 @@
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
- "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
- # to send back to the agent (https://goo.gl/GXotJW).
- },
- "text": "A String", # Text to display alongside the action.
- "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
- # (https://goo.gl/6GLJD2). If the user has an app installed that is
- # registered as the default handler for the URL, then this app will be
- # opened instead, and its icon will be used in the suggested action UI.
- "uri": "A String", # Required. The uri to open on the user device
- },
+ },
+ "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
+ # instead of typing in their own response.
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested reply. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
+ "text": "A String", # Suggested reply text.
},
},
],
- "title": "A String", # Optional. Title of the card (at most 200 bytes).
- #
- # At least one of the title, description or media must be set.
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
- },
- ],
- "cardWidth": "A String", # Required. The width of the cards in the carousel.
- },
- "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
- "suggestions": [ # Required. The list of suggested replies.
- { # The suggestion chip message that the user can tap to quickly post a reply
- # to the conversation.
- "title": "A String", # Required. The text shown the in the suggestion chip.
},
],
},
- "platform": "A String", # Optional. The platform that this message is intended for.
- "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
- "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
- # play, e.g., "gs://bucket/object". The object must contain a single
- # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
- #
- # This object must be readable by the `service-<Project
- # Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
- # where <Project Number> is the number of the Telephony Gateway project
- # (usually the same as the Dialogflow agent project). If the Google Cloud
- # Storage bucket is in the Telephony Gateway project, this permission is
- # added by default when enabling the Dialogflow V2 API.
- #
- # For audio from other sources, consider using the
- # `TelephonySynthesizeSpeech` message with SSML.
- },
- "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
- "title": "A String", # Optional. The overall title of the list.
- "subtitle": "A String", # Optional. Subtitle of the list.
- "items": [ # Required. List items.
- { # An item in the list.
- "description": "A String", # Optional. The main text describing the item.
- "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
- # dialog.
- "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
- # item in dialog.
- "A String",
- ],
- "key": "A String", # Required. A unique key that will be sent back to the agent if this
- # response is given.
- },
- "title": "A String", # Required. The title of the list item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- },
- ],
- },
- "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
- #
- # RBM allows businesses to send enriched and branded versions of SMS. See
- # https://jibe.google.com/business-messaging.
- "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
- { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
- # easily select/click a predefined response or perform an action (like
- # opening a web uri).
- "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
- # instead of typing in their own response.
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested reply. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "text": "A String", # Suggested reply text.
- },
- "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
- # can choose from the card.
- "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
- # but does not dial automatically (https://goo.gl/ergbB2).
- "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
- # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
- # format. An example of a correctly formatted phone number:
- # +15556767888.
- },
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested action. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
- # to send back to the agent (https://goo.gl/GXotJW).
- },
- "text": "A String", # Text to display alongside the action.
- "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
- # (https://goo.gl/6GLJD2). If the user has an app installed that is
- # registered as the default handler for the URL, then this app will be
- # opened instead, and its icon will be used in the suggested action UI.
- "uri": "A String", # Required. The uri to open on the user device
- },
- },
- },
- ],
- "text": "A String", # Required. Text sent and displayed to the user.
- },
- "quickReplies": { # The quick replies response message. # Displays quick replies.
- "title": "A String", # Optional. The title of the collection of quick replies.
- "quickReplies": [ # Optional. The collection of quick replies.
- "A String",
- ],
- },
- "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
- # Telephony Gateway.
- #
- # Telephony Gateway takes the synthesizer settings from
- # `DetectIntentResponse.output_audio_config` which can either be set
- # at request-level or can come from the agent-level synthesizer config.
- "text": "A String", # The raw text to be synthesized.
- "ssml": "A String", # The SSML to be synthesized. For more information, see
- # [SSML](https://developers.google.com/actions/reference/ssml).
- },
- "card": { # The card response message. # Displays a card.
- "title": "A String", # Optional. The title of the card.
- "buttons": [ # Optional. The collection of card buttons.
- { # Optional. Contains information about a button.
- "text": "A String", # Optional. The text to show on the button.
- "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
- # open.
- },
- ],
- "subtitle": "A String", # Optional. The subtitle of the card.
- "imageUri": "A String", # Optional. The public URI to an image file for the card.
- },
- "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
- "title": "A String", # Optional. The title of the card.
- "image": { # The image response message. # Optional. The image for the card.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- "formattedText": "A String", # Required, unless image is present. The body text of the card.
- "buttons": [ # Optional. The collection of card buttons.
+ "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "buttons": [ # Optional. List of buttons for the card.
{ # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
+ "title": "A String", # Required. The title of the button.
},
],
- "subtitle": "A String", # Optional. The subtitle of the card.
- },
- "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "subtitle": "A String", # Optional. Subtitle to the title.
"image": { # The image response message. # Optional. Image which should be displayed on the card.
"imageUri": "A String", # Optional. The public URI to an image file.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
},
- "buttons": [ # Optional. List of buttons for the card.
- { # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
- "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
- "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
- },
- },
- ],
- "title": "A String", # Required. Title of the card.
"rows": [ # Optional. Rows in this table of data.
{ # Row of TableCard.
"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
@@ -4070,7 +4082,7 @@
],
},
],
- "subtitle": "A String", # Optional. Subtitle to the title.
+ "title": "A String", # Required. Title of the card.
"columnProperties": [ # Optional. Display properties for the columns in this table.
{ # Column properties for TableCard.
"header": "A String", # Required. Column heading.
@@ -4078,117 +4090,63 @@
},
],
},
- "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
- "items": [ # Required. Carousel items.
- { # An item in the carousel.
- "description": "A String", # Optional. The body text of the card.
- "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
- # dialog.
- "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
- # item in dialog.
- "A String",
- ],
- "key": "A String", # Required. A unique key that will be sent back to the agent if this
- # response is given.
+ "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
+ #
+ # RBM allows businesses to send enriched and branded versions of SMS. See
+ # https://jibe.google.com/business-messaging.
+ "text": "A String", # Required. Text sent and displayed to the user.
+ "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
+ { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
+ # easily select/click a predefined response or perform an action (like
+ # opening a web uri).
+ "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
+ # can choose from the card.
+ "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
+ # If the user has an app installed that is
+ # registered as the default handler for the URL, then this app will be
+ # opened instead, and its icon will be used in the suggested action UI.
+ "uri": "A String", # Required. The uri to open on the user device
+ },
+ "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
+ # to send back to the agent.
+ },
+ "text": "A String", # Text to display alongside the action.
+ "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
+ # but does not dial automatically.
+ "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
+ # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
+ # format. An example of a correctly formatted phone number:
+ # +15556767888.
+ },
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested action. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
},
- "title": "A String", # Required. Title of the carousel item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
+ # instead of typing in their own response.
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested reply. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
+ "text": "A String", # Suggested reply text.
},
},
],
},
- "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.
- # or website associated with this agent.
- "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
- "uri": "A String", # Required. The URI of the app or site to open when the user taps the
- # suggestion chip.
+ "payload": { # A custom platform-specific response.
+ "a_key": "", # Properties of the object.
},
- "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
- # https://developers.google.com/actions/assistant/responses#browsing_carousel
- "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
- # items.
- "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
- # items, maximum of ten.
- { # Browsing carousel tile
- "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.
- "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
- # the URL. Defaults to opening via web browser.
- "url": "A String", # Required. URL
- },
- "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
- # Card. Maximum of one line of text.
- "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
- "image": { # The image response message. # Optional. Hero image for the carousel item.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- },
+ "text": { # The text response message. # Returns a text response.
+ "text": [ # Optional. The collection of the agent's responses.
+ "A String",
],
},
- "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
- # This message in `QueryResult.fulfillment_messages` and
- # `WebhookResponse.fulfillment_messages` should contain only one
- # `SimpleResponse`.
- "simpleResponses": [ # Required. The list of simple responses.
- { # The simple response message containing speech or text.
- "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
- # response to the user in the SSML format. Mutually exclusive with
- # text_to_speech.
- "displayText": "A String", # Optional. The text to display.
- "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
- # speech output. Mutually exclusive with ssml.
- },
- ],
- },
- "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
- "phoneNumber": "A String", # Required. The phone number to transfer the call to
- # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
- #
- # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
- },
- "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.
- "name": "A String", # Required. Name of media card.
- "description": "A String", # Optional. Description of media card.
- "contentUrl": "A String", # Required. Url where the media is stored.
- "icon": { # The image response message. # Optional. Icon to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- "largeImage": { # The image response message. # Optional. Image to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- },
- ],
- "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
- },
- "image": { # The image response message. # Displays an image.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
- # For more details about RBM rich cards, please see:
- # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout.
- "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
- # Image preview alignment for standalone cards with horizontal layout.
- "cardOrientation": "A String", # Required. Orientation of the card.
"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
@@ -4209,35 +4167,44 @@
# * video/mpeg
# * video/mpeg4
# * video/webm
- "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
- # provide a thumbnail URI, the RBM platform displays a blank
- # placeholder thumbnail until the user's device downloads the file.
- # Depending on the user's setting, the file may not download
- # automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
- # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
+ # within a rich card with a vertical layout.
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
+ "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
+ # provide a thumbnail URI, the RBM platform displays a blank
+ # placeholder thumbnail until the user's device downloads the file.
+ # Depending on the user's setting, the file may not download
+ # automatically and may require the user to tap a download button.
},
+ "title": "A String", # Optional. Title of the card (at most 200 bytes).
+ #
+ # At least one of the title, description or media must be set.
+ "description": "A String", # Optional. Description of the card (at most 2000 bytes).
+ #
+ # At least one of the title, description or media must be set.
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
- "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
- # instead of typing in their own response.
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested reply. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "text": "A String", # Suggested reply text.
- },
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
+ "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
+ # If the user has an app installed that is
+ # registered as the default handler for the URL, then this app will be
+ # opened instead, and its icon will be used in the suggested action UI.
+ "uri": "A String", # Required. The uri to open on the user device
+ },
+ "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
+ # to send back to the agent.
+ },
+ "text": "A String", # Text to display alongside the action.
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
- # but does not dial automatically (https://goo.gl/ergbB2).
+ # but does not dial automatically.
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
@@ -4246,57 +4213,186 @@
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
- "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
- # to send back to the agent (https://goo.gl/GXotJW).
- },
- "text": "A String", # Text to display alongside the action.
- "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
- # (https://goo.gl/6GLJD2). If the user has an app installed that is
- # registered as the default handler for the URL, then this app will be
- # opened instead, and its icon will be used in the suggested action UI.
- "uri": "A String", # Required. The uri to open on the user device
- },
+ },
+ "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
+ # instead of typing in their own response.
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested reply. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
+ "text": "A String", # Suggested reply text.
},
},
],
- "title": "A String", # Optional. Title of the card (at most 200 bytes).
- #
- # At least one of the title, description or media must be set.
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
},
+ "cardOrientation": "A String", # Required. Orientation of the card.
+ "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
+ # Image preview alignment for standalone cards with horizontal layout.
},
- "payload": { # A custom platform-specific response.
- "a_key": "", # Properties of the object.
+ "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
+ "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
+ # play, e.g., "gs://bucket/object". The object must contain a single
+ # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
+ #
+ # This object must be readable by the `service-<Project
+ # Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
+ # where <Project Number> is the number of the Telephony Gateway project
+ # (usually the same as the Dialogflow agent project). If the Google Cloud
+ # Storage bucket is in the Telephony Gateway project, this permission is
+ # added by default when enabling the Dialogflow V2 API.
+ #
+ # For audio from other sources, consider using the
+ # `TelephonySynthesizeSpeech` message with SSML.
+ },
+ "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
+ "items": [ # Required. Carousel items.
+ { # An item in the carousel.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
+ # dialog.
+ "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
+ # item in dialog.
+ "A String",
+ ],
+ "key": "A String", # Required. A unique key that will be sent back to the agent if this
+ # response is given.
+ },
+ "title": "A String", # Required. Title of the carousel item.
+ "description": "A String", # Optional. The body text of the card.
+ },
+ ],
+ },
+ "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
+ # This message in `QueryResult.fulfillment_messages` and
+ # `WebhookResponse.fulfillment_messages` should contain only one
+ # `SimpleResponse`.
+ "simpleResponses": [ # Required. The list of simple responses.
+ { # The simple response message containing speech or text.
+ "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
+ # response to the user in the SSML format. Mutually exclusive with
+ # text_to_speech.
+ "displayText": "A String", # Optional. The text to display.
+ "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
+ # speech output. Mutually exclusive with ssml.
+ },
+ ],
+ },
+ "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
+ # https://developers.google.com/actions/assistant/responses#browsing_carousel
+ "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
+ # items.
+ "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
+ # items, maximum of ten.
+ { # Browsing carousel tile
+ "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
+ # Card. Maximum of one line of text.
+ "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.
+ "image": { # The image response message. # Optional. Hero image for the carousel item.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
+ "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
+ # the URL. Defaults to opening via web browser.
+ "url": "A String", # Required. URL
+ },
+ },
+ ],
},
},
],
- "action": "A String", # Optional. The name of the action associated with the intent.
- # Note: The action name must not contain whitespaces.
+ "parentFollowupIntentName": "A String", # Optional. 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>`.
+ "parameters": [ # Optional. The collection of parameters associated with the intent.
+ { # Represents intent parameters.
+ "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
+ "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
+ # whether the intent cannot be completed without collecting the parameter
+ # value.
+ "prompts": [ # Optional. The collection of prompts that the agent can present to the
+ # user in order to collect a value for the parameter.
+ "A String",
+ ],
+ "name": "A String", # The unique identifier of this parameter.
+ "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
+ # describes values of the parameter. If the parameter is
+ # required, this must be provided.
+ "displayName": "A String", # Required. The name of the parameter.
+ "value": "A String", # Optional. The definition of the parameter value. It can be:
+ #
+ # - a constant string,
+ # - a parameter value defined as `$parameter_name`,
+ # - an original parameter value defined as `$parameter_name.original`,
+ # - a parameter value from some context defined as
+ # `#context_name.parameter_name`.
+ "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
+ # result.
+ # Default values can be extracted from contexts by using the following
+ # syntax: `#context_name.parameter_name`.
+ },
+ ],
+ "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",
+ ],
+ "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the 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>`.
- "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
+ "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
+ # Note: If `ml_enabled` setting is set to false, then this intent is not
+ # taken into account during inference in `ML ONLY` match mode. Also,
+ # auto-markup in the UI is turned off.
+ # DEPRECATED! Please use `ml_disabled` field instead.
+ # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
+ # then the default value is determined as follows:
+ # - Before April 15th, 2018 the default is:
+ # ml_enabled = false / ml_disabled = true.
+ # - After April 15th, 2018 the default is:
+ # ml_enabled = true / ml_disabled = false.
+ "followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as
+ # a direct or indirect parent. We populate this field only in the output.
+ { # Represents a single followup intent in the chain.
+ "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "followupIntentName": "A String", # The unique identifier of the followup intent.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ },
+ ],
+ "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",
+ ],
"inputContextNames": [ # Optional. The list of context names required for this intent to be
# triggered.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
"A String",
],
- "followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as
- # a direct or indirect parent. We populate this field only in the output.
- { # Represents a single followup intent in the chain.
- "followupIntentName": "A String", # The unique identifier of the followup intent.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- },
- ],
+ "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
+ # priorities.
+ #
+ # - If the supplied value is unspecified or 0, the service
+ # translates the value to 500,000, which corresponds to the
+ # `Normal` priority in the console.
+ # - If the supplied value is negative, the intent is ignored
+ # in runtime detect intent requests.
},
],
- "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
- # more results in the list.
}</pre>
</div>
@@ -4315,7 +4411,7 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(name, body=None, intentView=None, languageCode=None, updateMask=None, x__xgafv=None)</code>
+ <code class="details" id="patch">patch(name, body=None, languageCode=None, updateMask=None, intentView=None, x__xgafv=None)</code>
<pre>Updates the specified intent.
Args:
@@ -4326,134 +4422,58 @@
body: object, The request body.
The object takes the form of:
-{ # Represents an intent.
- # Intents convert a number of user expressions or patterns into an action. An
- # action is an extraction of a user command or sentence semantics.
- "displayName": "A String", # Required. The name of this intent.
- "rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of
- # followup intents. It identifies the correct followup intents chain for
- # this intent.
- #
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
- # Note: If `ml_disabled` setting is set to true, then this intent is not
- # taken into account during inference in `ML ONLY` match mode. Also,
- # auto-markup in the UI is turned off.
- "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
- "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
- # Note: If `ml_enabled` setting is set to false, then this intent is not
- # taken into account during inference in `ML ONLY` match mode. Also,
- # auto-markup in the UI is turned off.
- # DEPRECATED! Please use `ml_disabled` field instead.
- # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
- # then the default value is determined as follows:
- # - Before April 15th, 2018 the default is:
- # ml_enabled = false / ml_disabled = true.
- # - After April 15th, 2018 the default is:
- # ml_enabled = true / ml_disabled = false.
- "trainingPhrases": [ # Optional. The collection of examples that the agent is
- # trained on.
- { # Represents an example that the agent is trained on.
- "parts": [ # Required. The ordered list of training phrase parts.
- # The parts are concatenated in order to form the training phrase.
- #
- # Note: The API does not automatically annotate training phrases like the
- # Dialogflow Console does.
- #
- # Note: Do not forget to include whitespace at part boundaries,
- # so the training phrase is well formatted when the parts are concatenated.
- #
- # If the training phrase does not need to be annotated with parameters,
- # you just need a single part with only the Part.text field set.
- #
- # If you want to annotate the training phrase, you must create multiple
- # parts, where the fields of each part are populated in one of two ways:
- #
- # - `Part.text` is set to a part of the phrase that has no parameters.
- # - `Part.text` is set to a part of the phrase that you want to annotate,
- # and the `entity_type`, `alias`, and `user_defined` fields are all
- # set.
- { # Represents a part of a training phrase.
- "alias": "A String", # Optional. The parameter name for the value extracted from the
- # annotated part of the example.
- # This field is required for annotated parts of the training phrase.
- "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
- # This field is set to true when the Dialogflow Console is used to
- # manually annotate the part. When creating an annotated part with the
- # API, you must set this to true.
- "text": "A String", # Required. The text for this part.
- "entityType": "A String", # Optional. The entity type name prefixed with `@`.
- # This field is required for annotated parts of the training phrase.
- },
- ],
- "name": "A String", # Output only. The unique identifier of this training phrase.
- "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
- # the intent. Each time a developer adds an existing sample by editing an
- # intent or training, this counter is increased.
- "type": "A String", # Required. The type of the training phrase.
- },
- ],
- "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
- # session when this intent is matched.
- "parameters": [ # Optional. The collection of parameters associated with the intent.
- { # Represents intent parameters.
- "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
- # describes values of the parameter. If the parameter is
- # required, this must be provided.
- "prompts": [ # Optional. The collection of prompts that the agent can present to the
- # user in order to collect a value for the parameter.
- "A String",
- ],
- "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
- # whether the intent cannot be completed without collecting the parameter
- # value.
- "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
- # result.
- # Default values can be extracted from contexts by using the following
- # syntax: `#context_name.parameter_name`.
- "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
- "name": "A String", # The unique identifier of this parameter.
- "value": "A String", # Optional. The definition of the parameter value. It can be:
- #
- # - a constant string,
- # - a parameter value defined as `$parameter_name`,
- # - an original parameter value defined as `$parameter_name.original`,
- # - a parameter value from some context defined as
- # `#context_name.parameter_name`.
- "displayName": "A String", # Required. The name of the parameter.
- },
- ],
- "events": [ # Optional. The collection of event names that trigger the intent.
- # If the collection of input contexts is not empty, all of the contexts must
- # be present in the active user session for an event to trigger this intent.
- # Event names are limited to 150 characters.
- "A String",
- ],
- "parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the
- # chain of followup intents. You can set this field when creating an intent,
- # for example with CreateIntent or
- # BatchUpdateIntents, in order to make this
- # intent a followup intent.
- #
- # It identifies the parent followup intent.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
- # priorities.
- #
- # - If the supplied value is unspecified or 0, the service
- # translates the value to 500,000, which corresponds to the
- # `Normal` priority in the console.
- # - If the supplied value is negative, the intent is ignored
- # in runtime detect intent requests.
+{ # An intent categorizes an end-user's intention for one conversation turn. For
+ # each agent, you define many intents, where your combined intents can handle a
+ # complete conversation. When an end-user writes or says something, referred to
+ # as an end-user expression or end-user input, Dialogflow matches the end-user
+ # input to the best intent in your agent. Matching an intent is also known as
+ # intent classification.
+ #
+ # For more information, see the [intent
+ # guide](https://cloud.google.com/dialogflow/docs/intents-overview).
"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
# (e.g., Actions on Google or Dialogflow phone gateway) use this information
# to close interaction with an end user. Default is false.
+ "action": "A String", # Optional. The name of the action associated with the intent.
+ # Note: The action name must not contain whitespaces.
+ "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
"outputContexts": [ # Optional. The collection of contexts that are activated when the intent
# is matched. Context messages in this collection should not set the
# parameters field. Setting the `lifespan_count` to 0 will reset the context
# when the intent is matched.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
- { # Represents a context.
+ { # Dialogflow contexts are similar to natural language context. If a person says
+ # to you "they are orange", you need context in order to understand what "they"
+ # is referring to. Similarly, for Dialogflow to handle an end-user expression
+ # like that, it needs to be provided with context in order to correctly match
+ # an intent.
+ #
+ # Using contexts, you can control the flow of a conversation. You can configure
+ # contexts for an intent by setting input and output contexts, which are
+ # identified by string names. When an intent is matched, any configured output
+ # contexts for that intent become active. While any contexts are active,
+ # Dialogflow is more likely to match intents that are configured with input
+ # contexts that correspond to the currently active contexts.
+ #
+ # For more information about context, see the
+ # [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).
+ "parameters": { # Optional. The collection of parameters associated with this context.
+ #
+ # Depending on your protocol or client library language, this is a
+ # 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. The default is `0`. If set to `0`, the context expires
# immediately. Contexts expire automatically after 20 minutes if there
@@ -4475,46 +4495,189 @@
# * `__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.
- },
},
],
- "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",
+ "displayName": "A String", # Required. The name of this intent.
+ "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
+ # session when this intent is matched.
+ "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
+ # Note: If `ml_disabled` setting is set to true, then this intent is not
+ # taken into account during inference in `ML ONLY` match mode. Also,
+ # auto-markup in the UI is turned off.
+ "rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of
+ # followup intents. It identifies the correct followup intents chain for
+ # this intent.
+ #
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "trainingPhrases": [ # Optional. The collection of examples that the agent is
+ # trained on.
+ { # Represents an example that the agent is trained on.
+ "type": "A String", # Required. The type of the training phrase.
+ "name": "A String", # Output only. The unique identifier of this training phrase.
+ "parts": [ # Required. The ordered list of training phrase parts.
+ # The parts are concatenated in order to form the training phrase.
+ #
+ # Note: The API does not automatically annotate training phrases like the
+ # Dialogflow Console does.
+ #
+ # Note: Do not forget to include whitespace at part boundaries,
+ # so the training phrase is well formatted when the parts are concatenated.
+ #
+ # If the training phrase does not need to be annotated with parameters,
+ # you just need a single part with only the Part.text field set.
+ #
+ # If you want to annotate the training phrase, you must create multiple
+ # parts, where the fields of each part are populated in one of two ways:
+ #
+ # - `Part.text` is set to a part of the phrase that has no parameters.
+ # - `Part.text` is set to a part of the phrase that you want to annotate,
+ # and the `entity_type`, `alias`, and `user_defined` fields are all
+ # set.
+ { # Represents a part of a training phrase.
+ "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
+ # This field is set to true when the Dialogflow Console is used to
+ # manually annotate the part. When creating an annotated part with the
+ # API, you must set this to true.
+ "alias": "A String", # Optional. The parameter name for the value extracted from the
+ # annotated part of the example.
+ # This field is required for annotated parts of the training phrase.
+ "entityType": "A String", # Optional. The entity type name prefixed with `@`.
+ # This field is required for annotated parts of the training phrase.
+ "text": "A String", # Required. The text for this part.
+ },
+ ],
+ "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
+ # the intent. Each time a developer adds an existing sample by editing an
+ # intent or training, this counter is increased.
+ },
],
"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.
- "text": { # The text response message. # Returns a text response.
- "text": [ # Optional. The collection of the agent's responses.
+ "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
+ "suggestions": [ # Required. The list of suggested replies.
+ { # The suggestion chip message that the user can tap to quickly post a reply
+ # to the conversation.
+ "title": "A String", # Required. The text shown the in the suggestion chip.
+ },
+ ],
+ },
+ "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
+ "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
+ "mediaObjects": [ # Required. List of media objects.
+ { # Response media object for media content card.
+ "description": "A String", # Optional. Description of media card.
+ "icon": { # The image response message. # Optional. Icon to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "contentUrl": "A String", # Required. Url where the media is stored.
+ "name": "A String", # Required. Name of media card.
+ "largeImage": { # The image response message. # Optional. Image to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ },
+ ],
+ },
+ "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
+ "phoneNumber": "A String", # Required. The phone number to transfer the call to
+ # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+ #
+ # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
+ },
+ "platform": "A String", # Optional. The platform that this message is intended for.
+ "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
+ # Telephony Gateway.
+ #
+ # Telephony Gateway takes the synthesizer settings from
+ # `DetectIntentResponse.output_audio_config` which can either be set
+ # at request-level or can come from the agent-level synthesizer config.
+ "text": "A String", # The raw text to be synthesized.
+ "ssml": "A String", # The SSML to be synthesized. For more information, see
+ # [SSML](https://developers.google.com/actions/reference/ssml).
+ },
+ "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.
+ # or website associated with this agent.
+ "uri": "A String", # Required. The URI of the app or site to open when the user taps the
+ # suggestion chip.
+ "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
+ },
+ "quickReplies": { # The quick replies response message. # Displays quick replies.
+ "quickReplies": [ # Optional. The collection of quick replies.
"A String",
],
+ "title": "A String", # Optional. The title of the collection of quick replies.
+ },
+ "card": { # The card response message. # Displays a card.
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # Optional. Contains information about a button.
+ "text": "A String", # Optional. The text to show on the button.
+ "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
+ # open.
+ },
+ ],
+ "imageUri": "A String", # Optional. The public URI to an image file for the card.
+ "title": "A String", # Optional. The title of the card.
+ },
+ "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
+ "subtitle": "A String", # Optional. Subtitle of the list.
+ "title": "A String", # Optional. The overall title of the list.
+ "items": [ # Required. List items.
+ { # An item in the list.
+ "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
+ # dialog.
+ "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
+ # item in dialog.
+ "A String",
+ ],
+ "key": "A String", # Required. A unique key that will be sent back to the agent if this
+ # response is given.
+ },
+ "description": "A String", # Optional. The main text describing the item.
+ "title": "A String", # Required. The title of the list item.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ },
+ ],
+ },
+ "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # The button object that appears at the bottom of a card.
+ "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
+ "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
+ },
+ "title": "A String", # Required. The title of the button.
+ },
+ ],
+ "title": "A String", # Optional. The title of the card.
+ "image": { # The image response message. # Optional. The image for the card.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "formattedText": "A String", # Required, unless image is present. The body text of the card.
+ },
+ "image": { # The image response message. # Displays an image.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
},
"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
- # For more details about RBM rich cards, please see:
- # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead.
+ "cardWidth": "A String", # Required. The width of the cards in the carousel.
"cardContents": [ # Required. The cards in the carousel. A carousel must have at least
# 2 cards and at most 10.
{ # Rich Business Messaging (RBM) Card content
@@ -4537,35 +4700,44 @@
# * video/mpeg
# * video/mpeg4
# * video/webm
- "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
- # provide a thumbnail URI, the RBM platform displays a blank
- # placeholder thumbnail until the user's device downloads the file.
- # Depending on the user's setting, the file may not download
- # automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
- # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
+ # within a rich card with a vertical layout.
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
+ "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
+ # provide a thumbnail URI, the RBM platform displays a blank
+ # placeholder thumbnail until the user's device downloads the file.
+ # Depending on the user's setting, the file may not download
+ # automatically and may require the user to tap a download button.
},
+ "title": "A String", # Optional. Title of the card (at most 200 bytes).
+ #
+ # At least one of the title, description or media must be set.
+ "description": "A String", # Optional. Description of the card (at most 2000 bytes).
+ #
+ # At least one of the title, description or media must be set.
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
- "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
- # instead of typing in their own response.
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested reply. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "text": "A String", # Suggested reply text.
- },
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
+ "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
+ # If the user has an app installed that is
+ # registered as the default handler for the URL, then this app will be
+ # opened instead, and its icon will be used in the suggested action UI.
+ "uri": "A String", # Required. The uri to open on the user device
+ },
+ "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
+ # to send back to the agent.
+ },
+ "text": "A String", # Text to display alongside the action.
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
- # but does not dial automatically (https://goo.gl/ergbB2).
+ # but does not dial automatically.
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
@@ -4574,180 +4746,34 @@
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
- "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
- # to send back to the agent (https://goo.gl/GXotJW).
- },
- "text": "A String", # Text to display alongside the action.
- "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
- # (https://goo.gl/6GLJD2). If the user has an app installed that is
- # registered as the default handler for the URL, then this app will be
- # opened instead, and its icon will be used in the suggested action UI.
- "uri": "A String", # Required. The uri to open on the user device
- },
+ },
+ "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
+ # instead of typing in their own response.
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested reply. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
+ "text": "A String", # Suggested reply text.
},
},
],
- "title": "A String", # Optional. Title of the card (at most 200 bytes).
- #
- # At least one of the title, description or media must be set.
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
- },
- ],
- "cardWidth": "A String", # Required. The width of the cards in the carousel.
- },
- "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
- "suggestions": [ # Required. The list of suggested replies.
- { # The suggestion chip message that the user can tap to quickly post a reply
- # to the conversation.
- "title": "A String", # Required. The text shown the in the suggestion chip.
},
],
},
- "platform": "A String", # Optional. The platform that this message is intended for.
- "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
- "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
- # play, e.g., "gs://bucket/object". The object must contain a single
- # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
- #
- # This object must be readable by the `service-<Project
- # Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
- # where <Project Number> is the number of the Telephony Gateway project
- # (usually the same as the Dialogflow agent project). If the Google Cloud
- # Storage bucket is in the Telephony Gateway project, this permission is
- # added by default when enabling the Dialogflow V2 API.
- #
- # For audio from other sources, consider using the
- # `TelephonySynthesizeSpeech` message with SSML.
- },
- "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
- "title": "A String", # Optional. The overall title of the list.
- "subtitle": "A String", # Optional. Subtitle of the list.
- "items": [ # Required. List items.
- { # An item in the list.
- "description": "A String", # Optional. The main text describing the item.
- "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
- # dialog.
- "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
- # item in dialog.
- "A String",
- ],
- "key": "A String", # Required. A unique key that will be sent back to the agent if this
- # response is given.
- },
- "title": "A String", # Required. The title of the list item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- },
- ],
- },
- "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
- #
- # RBM allows businesses to send enriched and branded versions of SMS. See
- # https://jibe.google.com/business-messaging.
- "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
- { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
- # easily select/click a predefined response or perform an action (like
- # opening a web uri).
- "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
- # instead of typing in their own response.
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested reply. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "text": "A String", # Suggested reply text.
- },
- "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
- # can choose from the card.
- "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
- # but does not dial automatically (https://goo.gl/ergbB2).
- "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
- # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
- # format. An example of a correctly formatted phone number:
- # +15556767888.
- },
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested action. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
- # to send back to the agent (https://goo.gl/GXotJW).
- },
- "text": "A String", # Text to display alongside the action.
- "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
- # (https://goo.gl/6GLJD2). If the user has an app installed that is
- # registered as the default handler for the URL, then this app will be
- # opened instead, and its icon will be used in the suggested action UI.
- "uri": "A String", # Required. The uri to open on the user device
- },
- },
- },
- ],
- "text": "A String", # Required. Text sent and displayed to the user.
- },
- "quickReplies": { # The quick replies response message. # Displays quick replies.
- "title": "A String", # Optional. The title of the collection of quick replies.
- "quickReplies": [ # Optional. The collection of quick replies.
- "A String",
- ],
- },
- "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
- # Telephony Gateway.
- #
- # Telephony Gateway takes the synthesizer settings from
- # `DetectIntentResponse.output_audio_config` which can either be set
- # at request-level or can come from the agent-level synthesizer config.
- "text": "A String", # The raw text to be synthesized.
- "ssml": "A String", # The SSML to be synthesized. For more information, see
- # [SSML](https://developers.google.com/actions/reference/ssml).
- },
- "card": { # The card response message. # Displays a card.
- "title": "A String", # Optional. The title of the card.
- "buttons": [ # Optional. The collection of card buttons.
- { # Optional. Contains information about a button.
- "text": "A String", # Optional. The text to show on the button.
- "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
- # open.
- },
- ],
- "subtitle": "A String", # Optional. The subtitle of the card.
- "imageUri": "A String", # Optional. The public URI to an image file for the card.
- },
- "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
- "title": "A String", # Optional. The title of the card.
- "image": { # The image response message. # Optional. The image for the card.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- "formattedText": "A String", # Required, unless image is present. The body text of the card.
- "buttons": [ # Optional. The collection of card buttons.
+ "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "buttons": [ # Optional. List of buttons for the card.
{ # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
+ "title": "A String", # Required. The title of the button.
},
],
- "subtitle": "A String", # Optional. The subtitle of the card.
- },
- "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "subtitle": "A String", # Optional. Subtitle to the title.
"image": { # The image response message. # Optional. Image which should be displayed on the card.
"imageUri": "A String", # Optional. The public URI to an image file.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
},
- "buttons": [ # Optional. List of buttons for the card.
- { # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
- "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
- "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
- },
- },
- ],
- "title": "A String", # Required. Title of the card.
"rows": [ # Optional. Rows in this table of data.
{ # Row of TableCard.
"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
@@ -4758,7 +4784,7 @@
],
},
],
- "subtitle": "A String", # Optional. Subtitle to the title.
+ "title": "A String", # Required. Title of the card.
"columnProperties": [ # Optional. Display properties for the columns in this table.
{ # Column properties for TableCard.
"header": "A String", # Required. Column heading.
@@ -4766,117 +4792,63 @@
},
],
},
- "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
- "items": [ # Required. Carousel items.
- { # An item in the carousel.
- "description": "A String", # Optional. The body text of the card.
- "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
- # dialog.
- "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
- # item in dialog.
- "A String",
- ],
- "key": "A String", # Required. A unique key that will be sent back to the agent if this
- # response is given.
+ "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
+ #
+ # RBM allows businesses to send enriched and branded versions of SMS. See
+ # https://jibe.google.com/business-messaging.
+ "text": "A String", # Required. Text sent and displayed to the user.
+ "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
+ { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
+ # easily select/click a predefined response or perform an action (like
+ # opening a web uri).
+ "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
+ # can choose from the card.
+ "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
+ # If the user has an app installed that is
+ # registered as the default handler for the URL, then this app will be
+ # opened instead, and its icon will be used in the suggested action UI.
+ "uri": "A String", # Required. The uri to open on the user device
+ },
+ "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
+ # to send back to the agent.
+ },
+ "text": "A String", # Text to display alongside the action.
+ "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
+ # but does not dial automatically.
+ "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
+ # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
+ # format. An example of a correctly formatted phone number:
+ # +15556767888.
+ },
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested action. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
},
- "title": "A String", # Required. Title of the carousel item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
+ # instead of typing in their own response.
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested reply. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
+ "text": "A String", # Suggested reply text.
},
},
],
},
- "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.
- # or website associated with this agent.
- "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
- "uri": "A String", # Required. The URI of the app or site to open when the user taps the
- # suggestion chip.
+ "payload": { # A custom platform-specific response.
+ "a_key": "", # Properties of the object.
},
- "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
- # https://developers.google.com/actions/assistant/responses#browsing_carousel
- "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
- # items.
- "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
- # items, maximum of ten.
- { # Browsing carousel tile
- "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.
- "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
- # the URL. Defaults to opening via web browser.
- "url": "A String", # Required. URL
- },
- "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
- # Card. Maximum of one line of text.
- "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
- "image": { # The image response message. # Optional. Hero image for the carousel item.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- },
+ "text": { # The text response message. # Returns a text response.
+ "text": [ # Optional. The collection of the agent's responses.
+ "A String",
],
},
- "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
- # This message in `QueryResult.fulfillment_messages` and
- # `WebhookResponse.fulfillment_messages` should contain only one
- # `SimpleResponse`.
- "simpleResponses": [ # Required. The list of simple responses.
- { # The simple response message containing speech or text.
- "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
- # response to the user in the SSML format. Mutually exclusive with
- # text_to_speech.
- "displayText": "A String", # Optional. The text to display.
- "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
- # speech output. Mutually exclusive with ssml.
- },
- ],
- },
- "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
- "phoneNumber": "A String", # Required. The phone number to transfer the call to
- # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
- #
- # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
- },
- "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.
- "name": "A String", # Required. Name of media card.
- "description": "A String", # Optional. Description of media card.
- "contentUrl": "A String", # Required. Url where the media is stored.
- "icon": { # The image response message. # Optional. Icon to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- "largeImage": { # The image response message. # Optional. Image to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- },
- ],
- "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
- },
- "image": { # The image response message. # Displays an image.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
- # For more details about RBM rich cards, please see:
- # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout.
- "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
- # Image preview alignment for standalone cards with horizontal layout.
- "cardOrientation": "A String", # Required. Orientation of the card.
"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
@@ -4897,35 +4869,44 @@
# * video/mpeg
# * video/mpeg4
# * video/webm
- "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
- # provide a thumbnail URI, the RBM platform displays a blank
- # placeholder thumbnail until the user's device downloads the file.
- # Depending on the user's setting, the file may not download
- # automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
- # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
+ # within a rich card with a vertical layout.
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
+ "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
+ # provide a thumbnail URI, the RBM platform displays a blank
+ # placeholder thumbnail until the user's device downloads the file.
+ # Depending on the user's setting, the file may not download
+ # automatically and may require the user to tap a download button.
},
+ "title": "A String", # Optional. Title of the card (at most 200 bytes).
+ #
+ # At least one of the title, description or media must be set.
+ "description": "A String", # Optional. Description of the card (at most 2000 bytes).
+ #
+ # At least one of the title, description or media must be set.
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
- "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
- # instead of typing in their own response.
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested reply. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "text": "A String", # Suggested reply text.
- },
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
+ "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
+ # If the user has an app installed that is
+ # registered as the default handler for the URL, then this app will be
+ # opened instead, and its icon will be used in the suggested action UI.
+ "uri": "A String", # Required. The uri to open on the user device
+ },
+ "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
+ # to send back to the agent.
+ },
+ "text": "A String", # Text to display alongside the action.
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
- # but does not dial automatically (https://goo.gl/ergbB2).
+ # but does not dial automatically.
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
@@ -4934,62 +4915,193 @@
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
- "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
- # to send back to the agent (https://goo.gl/GXotJW).
- },
- "text": "A String", # Text to display alongside the action.
- "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
- # (https://goo.gl/6GLJD2). If the user has an app installed that is
- # registered as the default handler for the URL, then this app will be
- # opened instead, and its icon will be used in the suggested action UI.
- "uri": "A String", # Required. The uri to open on the user device
- },
+ },
+ "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
+ # instead of typing in their own response.
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested reply. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
+ "text": "A String", # Suggested reply text.
},
},
],
- "title": "A String", # Optional. Title of the card (at most 200 bytes).
- #
- # At least one of the title, description or media must be set.
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
},
+ "cardOrientation": "A String", # Required. Orientation of the card.
+ "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
+ # Image preview alignment for standalone cards with horizontal layout.
},
- "payload": { # A custom platform-specific response.
- "a_key": "", # Properties of the object.
+ "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
+ "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
+ # play, e.g., "gs://bucket/object". The object must contain a single
+ # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
+ #
+ # This object must be readable by the `service-<Project
+ # Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
+ # where <Project Number> is the number of the Telephony Gateway project
+ # (usually the same as the Dialogflow agent project). If the Google Cloud
+ # Storage bucket is in the Telephony Gateway project, this permission is
+ # added by default when enabling the Dialogflow V2 API.
+ #
+ # For audio from other sources, consider using the
+ # `TelephonySynthesizeSpeech` message with SSML.
+ },
+ "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
+ "items": [ # Required. Carousel items.
+ { # An item in the carousel.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
+ # dialog.
+ "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
+ # item in dialog.
+ "A String",
+ ],
+ "key": "A String", # Required. A unique key that will be sent back to the agent if this
+ # response is given.
+ },
+ "title": "A String", # Required. Title of the carousel item.
+ "description": "A String", # Optional. The body text of the card.
+ },
+ ],
+ },
+ "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
+ # This message in `QueryResult.fulfillment_messages` and
+ # `WebhookResponse.fulfillment_messages` should contain only one
+ # `SimpleResponse`.
+ "simpleResponses": [ # Required. The list of simple responses.
+ { # The simple response message containing speech or text.
+ "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
+ # response to the user in the SSML format. Mutually exclusive with
+ # text_to_speech.
+ "displayText": "A String", # Optional. The text to display.
+ "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
+ # speech output. Mutually exclusive with ssml.
+ },
+ ],
+ },
+ "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
+ # https://developers.google.com/actions/assistant/responses#browsing_carousel
+ "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
+ # items.
+ "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
+ # items, maximum of ten.
+ { # Browsing carousel tile
+ "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
+ # Card. Maximum of one line of text.
+ "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.
+ "image": { # The image response message. # Optional. Hero image for the carousel item.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
+ "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
+ # the URL. Defaults to opening via web browser.
+ "url": "A String", # Required. URL
+ },
+ },
+ ],
},
},
],
- "action": "A String", # Optional. The name of the action associated with the intent.
- # Note: The action name must not contain whitespaces.
+ "parentFollowupIntentName": "A String", # Optional. 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>`.
+ "parameters": [ # Optional. The collection of parameters associated with the intent.
+ { # Represents intent parameters.
+ "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
+ "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
+ # whether the intent cannot be completed without collecting the parameter
+ # value.
+ "prompts": [ # Optional. The collection of prompts that the agent can present to the
+ # user in order to collect a value for the parameter.
+ "A String",
+ ],
+ "name": "A String", # The unique identifier of this parameter.
+ "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
+ # describes values of the parameter. If the parameter is
+ # required, this must be provided.
+ "displayName": "A String", # Required. The name of the parameter.
+ "value": "A String", # Optional. The definition of the parameter value. It can be:
+ #
+ # - a constant string,
+ # - a parameter value defined as `$parameter_name`,
+ # - an original parameter value defined as `$parameter_name.original`,
+ # - a parameter value from some context defined as
+ # `#context_name.parameter_name`.
+ "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
+ # result.
+ # Default values can be extracted from contexts by using the following
+ # syntax: `#context_name.parameter_name`.
+ },
+ ],
+ "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",
+ ],
+ "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the 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>`.
- "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
+ "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
+ # Note: If `ml_enabled` setting is set to false, then this intent is not
+ # taken into account during inference in `ML ONLY` match mode. Also,
+ # auto-markup in the UI is turned off.
+ # DEPRECATED! Please use `ml_disabled` field instead.
+ # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
+ # then the default value is determined as follows:
+ # - Before April 15th, 2018 the default is:
+ # ml_enabled = false / ml_disabled = true.
+ # - After April 15th, 2018 the default is:
+ # ml_enabled = true / ml_disabled = false.
+ "followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as
+ # a direct or indirect parent. We populate this field only in the output.
+ { # Represents a single followup intent in the chain.
+ "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "followupIntentName": "A String", # The unique identifier of the followup intent.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ },
+ ],
+ "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",
+ ],
"inputContextNames": [ # Optional. The list of context names required for this intent to be
# triggered.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
"A String",
],
- "followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as
- # a direct or indirect parent. We populate this field only in the output.
- { # Represents a single followup intent in the chain.
- "followupIntentName": "A String", # The unique identifier of the followup intent.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- },
- ],
+ "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
+ # priorities.
+ #
+ # - If the supplied value is unspecified or 0, the service
+ # translates the value to 500,000, which corresponds to the
+ # `Normal` priority in the console.
+ # - If the supplied value is negative, the intent is ignored
+ # in runtime detect intent requests.
}
- intentView: string, Optional. The resource view to apply to the returned intent.
languageCode: string, Optional. The language used to access language-specific data.
If not specified, the agent's default language is used.
For more information, see
[Multilingual intent and entity
data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
updateMask: string, Optional. The mask to control which fields get updated.
+ intentView: string, Optional. The resource view to apply to the returned intent.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -4998,134 +5110,58 @@
Returns:
An object of the form:
- { # Represents an intent.
- # Intents convert a number of user expressions or patterns into an action. An
- # action is an extraction of a user command or sentence semantics.
- "displayName": "A String", # Required. The name of this intent.
- "rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of
- # followup intents. It identifies the correct followup intents chain for
- # this intent.
- #
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
- # Note: If `ml_disabled` setting is set to true, then this intent is not
- # taken into account during inference in `ML ONLY` match mode. Also,
- # auto-markup in the UI is turned off.
- "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
- "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
- # Note: If `ml_enabled` setting is set to false, then this intent is not
- # taken into account during inference in `ML ONLY` match mode. Also,
- # auto-markup in the UI is turned off.
- # DEPRECATED! Please use `ml_disabled` field instead.
- # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
- # then the default value is determined as follows:
- # - Before April 15th, 2018 the default is:
- # ml_enabled = false / ml_disabled = true.
- # - After April 15th, 2018 the default is:
- # ml_enabled = true / ml_disabled = false.
- "trainingPhrases": [ # Optional. The collection of examples that the agent is
- # trained on.
- { # Represents an example that the agent is trained on.
- "parts": [ # Required. The ordered list of training phrase parts.
- # The parts are concatenated in order to form the training phrase.
- #
- # Note: The API does not automatically annotate training phrases like the
- # Dialogflow Console does.
- #
- # Note: Do not forget to include whitespace at part boundaries,
- # so the training phrase is well formatted when the parts are concatenated.
- #
- # If the training phrase does not need to be annotated with parameters,
- # you just need a single part with only the Part.text field set.
- #
- # If you want to annotate the training phrase, you must create multiple
- # parts, where the fields of each part are populated in one of two ways:
- #
- # - `Part.text` is set to a part of the phrase that has no parameters.
- # - `Part.text` is set to a part of the phrase that you want to annotate,
- # and the `entity_type`, `alias`, and `user_defined` fields are all
- # set.
- { # Represents a part of a training phrase.
- "alias": "A String", # Optional. The parameter name for the value extracted from the
- # annotated part of the example.
- # This field is required for annotated parts of the training phrase.
- "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
- # This field is set to true when the Dialogflow Console is used to
- # manually annotate the part. When creating an annotated part with the
- # API, you must set this to true.
- "text": "A String", # Required. The text for this part.
- "entityType": "A String", # Optional. The entity type name prefixed with `@`.
- # This field is required for annotated parts of the training phrase.
- },
- ],
- "name": "A String", # Output only. The unique identifier of this training phrase.
- "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
- # the intent. Each time a developer adds an existing sample by editing an
- # intent or training, this counter is increased.
- "type": "A String", # Required. The type of the training phrase.
- },
- ],
- "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
- # session when this intent is matched.
- "parameters": [ # Optional. The collection of parameters associated with the intent.
- { # Represents intent parameters.
- "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
- # describes values of the parameter. If the parameter is
- # required, this must be provided.
- "prompts": [ # Optional. The collection of prompts that the agent can present to the
- # user in order to collect a value for the parameter.
- "A String",
- ],
- "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
- # whether the intent cannot be completed without collecting the parameter
- # value.
- "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
- # result.
- # Default values can be extracted from contexts by using the following
- # syntax: `#context_name.parameter_name`.
- "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
- "name": "A String", # The unique identifier of this parameter.
- "value": "A String", # Optional. The definition of the parameter value. It can be:
- #
- # - a constant string,
- # - a parameter value defined as `$parameter_name`,
- # - an original parameter value defined as `$parameter_name.original`,
- # - a parameter value from some context defined as
- # `#context_name.parameter_name`.
- "displayName": "A String", # Required. The name of the parameter.
- },
- ],
- "events": [ # Optional. The collection of event names that trigger the intent.
- # If the collection of input contexts is not empty, all of the contexts must
- # be present in the active user session for an event to trigger this intent.
- # Event names are limited to 150 characters.
- "A String",
- ],
- "parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the
- # chain of followup intents. You can set this field when creating an intent,
- # for example with CreateIntent or
- # BatchUpdateIntents, in order to make this
- # intent a followup intent.
- #
- # It identifies the parent followup intent.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
- # priorities.
- #
- # - If the supplied value is unspecified or 0, the service
- # translates the value to 500,000, which corresponds to the
- # `Normal` priority in the console.
- # - If the supplied value is negative, the intent is ignored
- # in runtime detect intent requests.
+ { # An intent categorizes an end-user's intention for one conversation turn. For
+ # each agent, you define many intents, where your combined intents can handle a
+ # complete conversation. When an end-user writes or says something, referred to
+ # as an end-user expression or end-user input, Dialogflow matches the end-user
+ # input to the best intent in your agent. Matching an intent is also known as
+ # intent classification.
+ #
+ # For more information, see the [intent
+ # guide](https://cloud.google.com/dialogflow/docs/intents-overview).
"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
# (e.g., Actions on Google or Dialogflow phone gateway) use this information
# to close interaction with an end user. Default is false.
+ "action": "A String", # Optional. The name of the action associated with the intent.
+ # Note: The action name must not contain whitespaces.
+ "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
"outputContexts": [ # Optional. The collection of contexts that are activated when the intent
# is matched. Context messages in this collection should not set the
# parameters field. Setting the `lifespan_count` to 0 will reset the context
# when the intent is matched.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
- { # Represents a context.
+ { # Dialogflow contexts are similar to natural language context. If a person says
+ # to you "they are orange", you need context in order to understand what "they"
+ # is referring to. Similarly, for Dialogflow to handle an end-user expression
+ # like that, it needs to be provided with context in order to correctly match
+ # an intent.
+ #
+ # Using contexts, you can control the flow of a conversation. You can configure
+ # contexts for an intent by setting input and output contexts, which are
+ # identified by string names. When an intent is matched, any configured output
+ # contexts for that intent become active. While any contexts are active,
+ # Dialogflow is more likely to match intents that are configured with input
+ # contexts that correspond to the currently active contexts.
+ #
+ # For more information about context, see the
+ # [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).
+ "parameters": { # Optional. The collection of parameters associated with this context.
+ #
+ # Depending on your protocol or client library language, this is a
+ # 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. The default is `0`. If set to `0`, the context expires
# immediately. Contexts expire automatically after 20 minutes if there
@@ -5147,46 +5183,189 @@
# * `__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.
- },
},
],
- "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",
+ "displayName": "A String", # Required. The name of this intent.
+ "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
+ # session when this intent is matched.
+ "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
+ # Note: If `ml_disabled` setting is set to true, then this intent is not
+ # taken into account during inference in `ML ONLY` match mode. Also,
+ # auto-markup in the UI is turned off.
+ "rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of
+ # followup intents. It identifies the correct followup intents chain for
+ # this intent.
+ #
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "trainingPhrases": [ # Optional. The collection of examples that the agent is
+ # trained on.
+ { # Represents an example that the agent is trained on.
+ "type": "A String", # Required. The type of the training phrase.
+ "name": "A String", # Output only. The unique identifier of this training phrase.
+ "parts": [ # Required. The ordered list of training phrase parts.
+ # The parts are concatenated in order to form the training phrase.
+ #
+ # Note: The API does not automatically annotate training phrases like the
+ # Dialogflow Console does.
+ #
+ # Note: Do not forget to include whitespace at part boundaries,
+ # so the training phrase is well formatted when the parts are concatenated.
+ #
+ # If the training phrase does not need to be annotated with parameters,
+ # you just need a single part with only the Part.text field set.
+ #
+ # If you want to annotate the training phrase, you must create multiple
+ # parts, where the fields of each part are populated in one of two ways:
+ #
+ # - `Part.text` is set to a part of the phrase that has no parameters.
+ # - `Part.text` is set to a part of the phrase that you want to annotate,
+ # and the `entity_type`, `alias`, and `user_defined` fields are all
+ # set.
+ { # Represents a part of a training phrase.
+ "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
+ # This field is set to true when the Dialogflow Console is used to
+ # manually annotate the part. When creating an annotated part with the
+ # API, you must set this to true.
+ "alias": "A String", # Optional. The parameter name for the value extracted from the
+ # annotated part of the example.
+ # This field is required for annotated parts of the training phrase.
+ "entityType": "A String", # Optional. The entity type name prefixed with `@`.
+ # This field is required for annotated parts of the training phrase.
+ "text": "A String", # Required. The text for this part.
+ },
+ ],
+ "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
+ # the intent. Each time a developer adds an existing sample by editing an
+ # intent or training, this counter is increased.
+ },
],
"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.
- "text": { # The text response message. # Returns a text response.
- "text": [ # Optional. The collection of the agent's responses.
+ "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
+ "suggestions": [ # Required. The list of suggested replies.
+ { # The suggestion chip message that the user can tap to quickly post a reply
+ # to the conversation.
+ "title": "A String", # Required. The text shown the in the suggestion chip.
+ },
+ ],
+ },
+ "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
+ "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
+ "mediaObjects": [ # Required. List of media objects.
+ { # Response media object for media content card.
+ "description": "A String", # Optional. Description of media card.
+ "icon": { # The image response message. # Optional. Icon to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "contentUrl": "A String", # Required. Url where the media is stored.
+ "name": "A String", # Required. Name of media card.
+ "largeImage": { # The image response message. # Optional. Image to display above media content.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ },
+ ],
+ },
+ "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
+ "phoneNumber": "A String", # Required. The phone number to transfer the call to
+ # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+ #
+ # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
+ },
+ "platform": "A String", # Optional. The platform that this message is intended for.
+ "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
+ # Telephony Gateway.
+ #
+ # Telephony Gateway takes the synthesizer settings from
+ # `DetectIntentResponse.output_audio_config` which can either be set
+ # at request-level or can come from the agent-level synthesizer config.
+ "text": "A String", # The raw text to be synthesized.
+ "ssml": "A String", # The SSML to be synthesized. For more information, see
+ # [SSML](https://developers.google.com/actions/reference/ssml).
+ },
+ "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.
+ # or website associated with this agent.
+ "uri": "A String", # Required. The URI of the app or site to open when the user taps the
+ # suggestion chip.
+ "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
+ },
+ "quickReplies": { # The quick replies response message. # Displays quick replies.
+ "quickReplies": [ # Optional. The collection of quick replies.
"A String",
],
+ "title": "A String", # Optional. The title of the collection of quick replies.
+ },
+ "card": { # The card response message. # Displays a card.
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # Optional. Contains information about a button.
+ "text": "A String", # Optional. The text to show on the button.
+ "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
+ # open.
+ },
+ ],
+ "imageUri": "A String", # Optional. The public URI to an image file for the card.
+ "title": "A String", # Optional. The title of the card.
+ },
+ "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
+ "subtitle": "A String", # Optional. Subtitle of the list.
+ "title": "A String", # Optional. The overall title of the list.
+ "items": [ # Required. List items.
+ { # An item in the list.
+ "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
+ # dialog.
+ "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
+ # item in dialog.
+ "A String",
+ ],
+ "key": "A String", # Required. A unique key that will be sent back to the agent if this
+ # response is given.
+ },
+ "description": "A String", # Optional. The main text describing the item.
+ "title": "A String", # Required. The title of the list item.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ },
+ ],
+ },
+ "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
+ "buttons": [ # Optional. The collection of card buttons.
+ { # The button object that appears at the bottom of a card.
+ "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
+ "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
+ },
+ "title": "A String", # Required. The title of the button.
+ },
+ ],
+ "title": "A String", # Optional. The title of the card.
+ "image": { # The image response message. # Optional. The image for the card.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "subtitle": "A String", # Optional. The subtitle of the card.
+ "formattedText": "A String", # Required, unless image is present. The body text of the card.
+ },
+ "image": { # The image response message. # Displays an image.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
},
"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
- # For more details about RBM rich cards, please see:
- # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead.
+ "cardWidth": "A String", # Required. The width of the cards in the carousel.
"cardContents": [ # Required. The cards in the carousel. A carousel must have at least
# 2 cards and at most 10.
{ # Rich Business Messaging (RBM) Card content
@@ -5209,35 +5388,44 @@
# * video/mpeg
# * video/mpeg4
# * video/webm
- "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
- # provide a thumbnail URI, the RBM platform displays a blank
- # placeholder thumbnail until the user's device downloads the file.
- # Depending on the user's setting, the file may not download
- # automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
- # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
+ # within a rich card with a vertical layout.
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
+ "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
+ # provide a thumbnail URI, the RBM platform displays a blank
+ # placeholder thumbnail until the user's device downloads the file.
+ # Depending on the user's setting, the file may not download
+ # automatically and may require the user to tap a download button.
},
+ "title": "A String", # Optional. Title of the card (at most 200 bytes).
+ #
+ # At least one of the title, description or media must be set.
+ "description": "A String", # Optional. Description of the card (at most 2000 bytes).
+ #
+ # At least one of the title, description or media must be set.
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
- "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
- # instead of typing in their own response.
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested reply. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "text": "A String", # Suggested reply text.
- },
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
+ "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
+ # If the user has an app installed that is
+ # registered as the default handler for the URL, then this app will be
+ # opened instead, and its icon will be used in the suggested action UI.
+ "uri": "A String", # Required. The uri to open on the user device
+ },
+ "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
+ # to send back to the agent.
+ },
+ "text": "A String", # Text to display alongside the action.
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
- # but does not dial automatically (https://goo.gl/ergbB2).
+ # but does not dial automatically.
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
@@ -5246,180 +5434,34 @@
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
- "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
- # to send back to the agent (https://goo.gl/GXotJW).
- },
- "text": "A String", # Text to display alongside the action.
- "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
- # (https://goo.gl/6GLJD2). If the user has an app installed that is
- # registered as the default handler for the URL, then this app will be
- # opened instead, and its icon will be used in the suggested action UI.
- "uri": "A String", # Required. The uri to open on the user device
- },
+ },
+ "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
+ # instead of typing in their own response.
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested reply. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
+ "text": "A String", # Suggested reply text.
},
},
],
- "title": "A String", # Optional. Title of the card (at most 200 bytes).
- #
- # At least one of the title, description or media must be set.
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
- },
- ],
- "cardWidth": "A String", # Required. The width of the cards in the carousel.
- },
- "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
- "suggestions": [ # Required. The list of suggested replies.
- { # The suggestion chip message that the user can tap to quickly post a reply
- # to the conversation.
- "title": "A String", # Required. The text shown the in the suggestion chip.
},
],
},
- "platform": "A String", # Optional. The platform that this message is intended for.
- "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
- "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
- # play, e.g., "gs://bucket/object". The object must contain a single
- # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
- #
- # This object must be readable by the `service-<Project
- # Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
- # where <Project Number> is the number of the Telephony Gateway project
- # (usually the same as the Dialogflow agent project). If the Google Cloud
- # Storage bucket is in the Telephony Gateway project, this permission is
- # added by default when enabling the Dialogflow V2 API.
- #
- # For audio from other sources, consider using the
- # `TelephonySynthesizeSpeech` message with SSML.
- },
- "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
- "title": "A String", # Optional. The overall title of the list.
- "subtitle": "A String", # Optional. Subtitle of the list.
- "items": [ # Required. List items.
- { # An item in the list.
- "description": "A String", # Optional. The main text describing the item.
- "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
- # dialog.
- "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
- # item in dialog.
- "A String",
- ],
- "key": "A String", # Required. A unique key that will be sent back to the agent if this
- # response is given.
- },
- "title": "A String", # Required. The title of the list item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- },
- ],
- },
- "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
- #
- # RBM allows businesses to send enriched and branded versions of SMS. See
- # https://jibe.google.com/business-messaging.
- "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
- { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
- # easily select/click a predefined response or perform an action (like
- # opening a web uri).
- "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
- # instead of typing in their own response.
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested reply. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "text": "A String", # Suggested reply text.
- },
- "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
- # can choose from the card.
- "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
- # but does not dial automatically (https://goo.gl/ergbB2).
- "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
- # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
- # format. An example of a correctly formatted phone number:
- # +15556767888.
- },
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested action. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
- # to send back to the agent (https://goo.gl/GXotJW).
- },
- "text": "A String", # Text to display alongside the action.
- "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
- # (https://goo.gl/6GLJD2). If the user has an app installed that is
- # registered as the default handler for the URL, then this app will be
- # opened instead, and its icon will be used in the suggested action UI.
- "uri": "A String", # Required. The uri to open on the user device
- },
- },
- },
- ],
- "text": "A String", # Required. Text sent and displayed to the user.
- },
- "quickReplies": { # The quick replies response message. # Displays quick replies.
- "title": "A String", # Optional. The title of the collection of quick replies.
- "quickReplies": [ # Optional. The collection of quick replies.
- "A String",
- ],
- },
- "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
- # Telephony Gateway.
- #
- # Telephony Gateway takes the synthesizer settings from
- # `DetectIntentResponse.output_audio_config` which can either be set
- # at request-level or can come from the agent-level synthesizer config.
- "text": "A String", # The raw text to be synthesized.
- "ssml": "A String", # The SSML to be synthesized. For more information, see
- # [SSML](https://developers.google.com/actions/reference/ssml).
- },
- "card": { # The card response message. # Displays a card.
- "title": "A String", # Optional. The title of the card.
- "buttons": [ # Optional. The collection of card buttons.
- { # Optional. Contains information about a button.
- "text": "A String", # Optional. The text to show on the button.
- "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
- # open.
- },
- ],
- "subtitle": "A String", # Optional. The subtitle of the card.
- "imageUri": "A String", # Optional. The public URI to an image file for the card.
- },
- "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
- "title": "A String", # Optional. The title of the card.
- "image": { # The image response message. # Optional. The image for the card.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- "formattedText": "A String", # Required, unless image is present. The body text of the card.
- "buttons": [ # Optional. The collection of card buttons.
+ "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "buttons": [ # Optional. List of buttons for the card.
{ # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
+ "title": "A String", # Required. The title of the button.
},
],
- "subtitle": "A String", # Optional. The subtitle of the card.
- },
- "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
+ "subtitle": "A String", # Optional. Subtitle to the title.
"image": { # The image response message. # Optional. Image which should be displayed on the card.
"imageUri": "A String", # Optional. The public URI to an image file.
"accessibilityText": "A String", # A text description of the image to be used for accessibility,
# e.g., screen readers. Required if image_uri is set for CarouselSelect.
},
- "buttons": [ # Optional. List of buttons for the card.
- { # The button object that appears at the bottom of a card.
- "title": "A String", # Required. The title of the button.
- "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
- "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
- },
- },
- ],
- "title": "A String", # Required. Title of the card.
"rows": [ # Optional. Rows in this table of data.
{ # Row of TableCard.
"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
@@ -5430,7 +5472,7 @@
],
},
],
- "subtitle": "A String", # Optional. Subtitle to the title.
+ "title": "A String", # Required. Title of the card.
"columnProperties": [ # Optional. Display properties for the columns in this table.
{ # Column properties for TableCard.
"header": "A String", # Required. Column heading.
@@ -5438,117 +5480,63 @@
},
],
},
- "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
- "items": [ # Required. Carousel items.
- { # An item in the carousel.
- "description": "A String", # Optional. The body text of the card.
- "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
- # dialog.
- "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
- # item in dialog.
- "A String",
- ],
- "key": "A String", # Required. A unique key that will be sent back to the agent if this
- # response is given.
+ "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
+ #
+ # RBM allows businesses to send enriched and branded versions of SMS. See
+ # https://jibe.google.com/business-messaging.
+ "text": "A String", # Required. Text sent and displayed to the user.
+ "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
+ { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
+ # easily select/click a predefined response or perform an action (like
+ # opening a web uri).
+ "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
+ # can choose from the card.
+ "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
+ # If the user has an app installed that is
+ # registered as the default handler for the URL, then this app will be
+ # opened instead, and its icon will be used in the suggested action UI.
+ "uri": "A String", # Required. The uri to open on the user device
+ },
+ "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
+ # to send back to the agent.
+ },
+ "text": "A String", # Text to display alongside the action.
+ "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
+ # but does not dial automatically.
+ "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
+ # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
+ # format. An example of a correctly formatted phone number:
+ # +15556767888.
+ },
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested action. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
},
- "title": "A String", # Required. Title of the carousel item.
- "image": { # The image response message. # Optional. The image to display.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
+ # instead of typing in their own response.
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested reply. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
+ "text": "A String", # Suggested reply text.
},
},
],
},
- "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.
- # or website associated with this agent.
- "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
- "uri": "A String", # Required. The URI of the app or site to open when the user taps the
- # suggestion chip.
+ "payload": { # A custom platform-specific response.
+ "a_key": "", # Properties of the object.
},
- "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
- # https://developers.google.com/actions/assistant/responses#browsing_carousel
- "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
- # items.
- "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
- # items, maximum of ten.
- { # Browsing carousel tile
- "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.
- "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
- # the URL. Defaults to opening via web browser.
- "url": "A String", # Required. URL
- },
- "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
- # Card. Maximum of one line of text.
- "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
- "image": { # The image response message. # Optional. Hero image for the carousel item.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- },
+ "text": { # The text response message. # Returns a text response.
+ "text": [ # Optional. The collection of the agent's responses.
+ "A String",
],
},
- "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
- # This message in `QueryResult.fulfillment_messages` and
- # `WebhookResponse.fulfillment_messages` should contain only one
- # `SimpleResponse`.
- "simpleResponses": [ # Required. The list of simple responses.
- { # The simple response message containing speech or text.
- "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
- # response to the user in the SSML format. Mutually exclusive with
- # text_to_speech.
- "displayText": "A String", # Optional. The text to display.
- "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
- # speech output. Mutually exclusive with ssml.
- },
- ],
- },
- "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
- "phoneNumber": "A String", # Required. The phone number to transfer the call to
- # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
- #
- # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
- },
- "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.
- "name": "A String", # Required. Name of media card.
- "description": "A String", # Optional. Description of media card.
- "contentUrl": "A String", # Required. Url where the media is stored.
- "icon": { # The image response message. # Optional. Icon to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- "largeImage": { # The image response message. # Optional. Image to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
- },
- ],
- "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
- },
- "image": { # The image response message. # Displays an image.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
#
# Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions.
#
- # For more details about RBM rich cards, please see:
- # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
# You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout.
- "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
- # Image preview alignment for standalone cards with horizontal layout.
- "cardOrientation": "A String", # Required. Orientation of the card.
"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
@@ -5569,35 +5557,44 @@
# * video/mpeg
# * video/mpeg4
# * video/webm
- "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
- # provide a thumbnail URI, the RBM platform displays a blank
- # placeholder thumbnail until the user's device downloads the file.
- # Depending on the user's setting, the file may not download
- # automatically and may require the user to tap a download button.
"height": "A String", # Required for cards with vertical orientation. The height of the media
- # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
+ # within a rich card with a vertical layout.
# For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored.
"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
# determines the MIME type of the file from the content-type field in
# the HTTP headers when the platform fetches the file. The content-type
# field must be present and accurate in the HTTP response from the URL.
+ "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
+ # provide a thumbnail URI, the RBM platform displays a blank
+ # placeholder thumbnail until the user's device downloads the file.
+ # Depending on the user's setting, the file may not download
+ # automatically and may require the user to tap a download button.
},
+ "title": "A String", # Optional. Title of the card (at most 200 bytes).
+ #
+ # At least one of the title, description or media must be set.
+ "description": "A String", # Optional. Description of the card (at most 2000 bytes).
+ #
+ # At least one of the title, description or media must be set.
"suggestions": [ # Optional. List of suggestions to include in the card.
{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
# easily select/click a predefined response or perform an action (like
# opening a web uri).
- "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
- # instead of typing in their own response.
- "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
- # when the user taps the suggested reply. This data will be also
- # forwarded to webhook to allow performing custom business logic.
- "text": "A String", # Suggested reply text.
- },
"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
# can choose from the card.
+ "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
+ # If the user has an app installed that is
+ # registered as the default handler for the URL, then this app will be
+ # opened instead, and its icon will be used in the suggested action UI.
+ "uri": "A String", # Required. The uri to open on the user device
+ },
+ "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
+ # to send back to the agent.
+ },
+ "text": "A String", # Text to display alongside the action.
"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
- # but does not dial automatically (https://goo.gl/ergbB2).
+ # but does not dial automatically.
"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
# format. An example of a correctly formatted phone number:
@@ -5606,53 +5603,184 @@
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested action. This data will be also
# forwarded to webhook to allow performing custom business logic.
- "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
- # to send back to the agent (https://goo.gl/GXotJW).
- },
- "text": "A String", # Text to display alongside the action.
- "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
- # (https://goo.gl/6GLJD2). If the user has an app installed that is
- # registered as the default handler for the URL, then this app will be
- # opened instead, and its icon will be used in the suggested action UI.
- "uri": "A String", # Required. The uri to open on the user device
- },
+ },
+ "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
+ # instead of typing in their own response.
+ "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
+ # when the user taps the suggested reply. This data will be also
+ # forwarded to webhook to allow performing custom business logic.
+ "text": "A String", # Suggested reply text.
},
},
],
- "title": "A String", # Optional. Title of the card (at most 200 bytes).
- #
- # At least one of the title, description or media must be set.
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
},
+ "cardOrientation": "A String", # Required. Orientation of the card.
+ "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
+ # Image preview alignment for standalone cards with horizontal layout.
},
- "payload": { # A custom platform-specific response.
- "a_key": "", # Properties of the object.
+ "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
+ "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
+ # play, e.g., "gs://bucket/object". The object must contain a single
+ # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
+ #
+ # This object must be readable by the `service-<Project
+ # Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
+ # where <Project Number> is the number of the Telephony Gateway project
+ # (usually the same as the Dialogflow agent project). If the Google Cloud
+ # Storage bucket is in the Telephony Gateway project, this permission is
+ # added by default when enabling the Dialogflow V2 API.
+ #
+ # For audio from other sources, consider using the
+ # `TelephonySynthesizeSpeech` message with SSML.
+ },
+ "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
+ "items": [ # Required. Carousel items.
+ { # An item in the carousel.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
+ # dialog.
+ "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
+ # item in dialog.
+ "A String",
+ ],
+ "key": "A String", # Required. A unique key that will be sent back to the agent if this
+ # response is given.
+ },
+ "title": "A String", # Required. Title of the carousel item.
+ "description": "A String", # Optional. The body text of the card.
+ },
+ ],
+ },
+ "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
+ # This message in `QueryResult.fulfillment_messages` and
+ # `WebhookResponse.fulfillment_messages` should contain only one
+ # `SimpleResponse`.
+ "simpleResponses": [ # Required. The list of simple responses.
+ { # The simple response message containing speech or text.
+ "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
+ # response to the user in the SSML format. Mutually exclusive with
+ # text_to_speech.
+ "displayText": "A String", # Optional. The text to display.
+ "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
+ # speech output. Mutually exclusive with ssml.
+ },
+ ],
+ },
+ "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
+ # https://developers.google.com/actions/assistant/responses#browsing_carousel
+ "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
+ # items.
+ "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
+ # items, maximum of ten.
+ { # Browsing carousel tile
+ "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
+ # Card. Maximum of one line of text.
+ "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.
+ "image": { # The image response message. # Optional. Hero image for the carousel item.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
+ "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
+ "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
+ # the URL. Defaults to opening via web browser.
+ "url": "A String", # Required. URL
+ },
+ },
+ ],
},
},
],
- "action": "A String", # Optional. The name of the action associated with the intent.
- # Note: The action name must not contain whitespaces.
+ "parentFollowupIntentName": "A String", # Optional. 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>`.
+ "parameters": [ # Optional. The collection of parameters associated with the intent.
+ { # Represents intent parameters.
+ "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
+ "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
+ # whether the intent cannot be completed without collecting the parameter
+ # value.
+ "prompts": [ # Optional. The collection of prompts that the agent can present to the
+ # user in order to collect a value for the parameter.
+ "A String",
+ ],
+ "name": "A String", # The unique identifier of this parameter.
+ "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
+ # describes values of the parameter. If the parameter is
+ # required, this must be provided.
+ "displayName": "A String", # Required. The name of the parameter.
+ "value": "A String", # Optional. The definition of the parameter value. It can be:
+ #
+ # - a constant string,
+ # - a parameter value defined as `$parameter_name`,
+ # - an original parameter value defined as `$parameter_name.original`,
+ # - a parameter value from some context defined as
+ # `#context_name.parameter_name`.
+ "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
+ # result.
+ # Default values can be extracted from contexts by using the following
+ # syntax: `#context_name.parameter_name`.
+ },
+ ],
+ "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",
+ ],
+ "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the 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>`.
- "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
+ "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
+ # Note: If `ml_enabled` setting is set to false, then this intent is not
+ # taken into account during inference in `ML ONLY` match mode. Also,
+ # auto-markup in the UI is turned off.
+ # DEPRECATED! Please use `ml_disabled` field instead.
+ # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
+ # then the default value is determined as follows:
+ # - Before April 15th, 2018 the default is:
+ # ml_enabled = false / ml_disabled = true.
+ # - After April 15th, 2018 the default is:
+ # ml_enabled = true / ml_disabled = false.
+ "followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as
+ # a direct or indirect parent. We populate this field only in the output.
+ { # Represents a single followup intent in the chain.
+ "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ "followupIntentName": "A String", # The unique identifier of the followup intent.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
+ },
+ ],
+ "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",
+ ],
"inputContextNames": [ # Optional. The list of context names required for this intent to be
# triggered.
# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
"A String",
],
- "followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as
- # a direct or indirect parent. We populate this field only in the output.
- { # Represents a single followup intent in the chain.
- "followupIntentName": "A String", # The unique identifier of the followup intent.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
- # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
- },
- ],
+ "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
+ # priorities.
+ #
+ # - If the supplied value is unspecified or 0, the service
+ # translates the value to 500,000, which corresponds to the
+ # `Normal` priority in the console.
+ # - If the supplied value is negative, the intent is ignored
+ # in runtime detect intent requests.
}</pre>
</div>