docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.intents.html b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.intents.html
index 8927f4b..3793f5e 100644
--- a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.intents.html
+++ b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.intents.html
@@ -117,6 +117,28 @@
{ # 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.
@@ -163,7 +185,6 @@
# session when this intent is matched.
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
- "displayName": "A String", # Required. The name of the parameter.
"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
# describes values of the parameter. If the parameter is
# required, this must be provided.
@@ -171,13 +192,13 @@
# 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`.
- "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
- # whether the intent cannot be completed without collecting the parameter
- # value.
"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
"name": "A String", # The unique identifier of this parameter.
"value": "A String", # Optional. The definition of the parameter value. It can be:
@@ -187,6 +208,7 @@
# - 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.
@@ -281,13 +303,9 @@
# 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
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
@@ -327,13 +345,20 @@
# 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.
- "text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
+ "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.
@@ -347,21 +372,18 @@
# 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
},
- "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.
- },
},
},
],
"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.
@@ -392,6 +414,7 @@
"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
@@ -407,7 +430,6 @@
"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.
},
- "description": "A String", # Optional. The main text describing the item.
},
],
},
@@ -421,13 +443,20 @@
# 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.
- "text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
+ "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.
@@ -441,13 +470,6 @@
# 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
},
- "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.
- },
},
},
],
@@ -470,7 +492,6 @@
# [SSML](https://developers.google.com/actions/reference/ssml).
},
"card": { # The card response message. # Displays a card.
- "imageUri": "A String", # Optional. The public URI to an image file for the card.
"title": "A String", # Optional. The title of the card.
"buttons": [ # Optional. The collection of card buttons.
{ # Optional. Contains information about a button.
@@ -480,6 +501,7 @@
},
],
"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.
@@ -491,22 +513,15 @@
"formattedText": "A String", # Required, unless image is present. The body text of the card.
"buttons": [ # Optional. The collection of card buttons.
{ # The button object that appears at the bottom of a card.
+ "title": "A String", # Required. The title of the button.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
- "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.
- "columnProperties": [ # Optional. Display properties for the columns in this table.
- { # Column properties for TableCard.
- "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
- "header": "A String", # Required. Column heading.
- },
- ],
"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,
@@ -514,10 +529,10 @@
},
"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.
},
],
"title": "A String", # Required. Title of the card.
@@ -531,16 +546,17 @@
],
},
],
+ "subtitle": "A String", # Optional. Subtitle to the title.
+ "columnProperties": [ # Optional. Display properties for the columns in this table.
+ { # Column properties for TableCard.
+ "header": "A String", # Required. Column heading.
+ "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
+ },
+ ],
},
"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.
- "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.
- },
"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.
@@ -551,6 +567,12 @@
"key": "A String", # Required. A unique key that will be sent back to the agent if this
# response is given.
},
+ "title": "A String", # Required. Title of the carousel item.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
},
],
},
@@ -567,12 +589,6 @@
"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
# items, maximum of ten.
{ # Browsing carousel tile
- "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.
- },
"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.
@@ -582,6 +598,12 @@
},
"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.
+ },
},
],
},
@@ -591,12 +613,12 @@
# `SimpleResponse`.
"simpleResponses": [ # Required. The list of simple responses.
{ # The simple response message containing speech or text.
- "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
- # speech output. Mutually exclusive with ssml.
"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
# response to the user in the SSML format. Mutually exclusive with
# text_to_speech.
"displayText": "A String", # Optional. The text to display.
+ "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
+ # speech output. Mutually exclusive with ssml.
},
],
},
@@ -609,11 +631,6 @@
"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
"mediaObjects": [ # Required. List of media objects.
{ # Response media object for media content card.
- "largeImage": { # The image response message. # Optional. Image to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
"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.
@@ -622,6 +639,11 @@
"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").
@@ -631,9 +653,6 @@
"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.
},
- "payload": { # A custom platform-specific response.
- "a_key": "", # Properties of the object.
- },
"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.
@@ -647,9 +666,6 @@
# 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.
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
@@ -689,13 +705,20 @@
# 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.
- "text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
+ "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.
@@ -709,21 +732,20 @@
# 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
},
- "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.
- },
},
},
],
"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.
},
},
+ "payload": { # A custom platform-specific response.
+ "a_key": "", # Properties of the object.
+ },
},
],
"action": "A String", # Optional. The name of the action associated with the intent.
@@ -747,28 +769,6 @@
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
},
],
- "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.
},
],
}
@@ -783,6 +783,27 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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
@@ -802,27 +823,6 @@
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
- "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).
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
}</pre>
</div>
@@ -844,6 +844,28 @@
{ # 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.
@@ -890,7 +912,6 @@
# session when this intent is matched.
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
- "displayName": "A String", # Required. The name of the parameter.
"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
# describes values of the parameter. If the parameter is
# required, this must be provided.
@@ -898,13 +919,13 @@
# 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`.
- "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
- # whether the intent cannot be completed without collecting the parameter
- # value.
"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
"name": "A String", # The unique identifier of this parameter.
"value": "A String", # Optional. The definition of the parameter value. It can be:
@@ -914,6 +935,7 @@
# - 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.
@@ -1008,13 +1030,9 @@
# 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
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
@@ -1054,13 +1072,20 @@
# 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.
- "text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
+ "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.
@@ -1074,21 +1099,18 @@
# 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
},
- "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.
- },
},
},
],
"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.
@@ -1119,6 +1141,7 @@
"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
@@ -1134,7 +1157,6 @@
"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.
},
- "description": "A String", # Optional. The main text describing the item.
},
],
},
@@ -1148,13 +1170,20 @@
# 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.
- "text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
+ "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.
@@ -1168,13 +1197,6 @@
# 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
},
- "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.
- },
},
},
],
@@ -1197,7 +1219,6 @@
# [SSML](https://developers.google.com/actions/reference/ssml).
},
"card": { # The card response message. # Displays a card.
- "imageUri": "A String", # Optional. The public URI to an image file for the card.
"title": "A String", # Optional. The title of the card.
"buttons": [ # Optional. The collection of card buttons.
{ # Optional. Contains information about a button.
@@ -1207,6 +1228,7 @@
},
],
"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.
@@ -1218,22 +1240,15 @@
"formattedText": "A String", # Required, unless image is present. The body text of the card.
"buttons": [ # Optional. The collection of card buttons.
{ # The button object that appears at the bottom of a card.
+ "title": "A String", # Required. The title of the button.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
- "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.
- "columnProperties": [ # Optional. Display properties for the columns in this table.
- { # Column properties for TableCard.
- "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
- "header": "A String", # Required. Column heading.
- },
- ],
"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,
@@ -1241,10 +1256,10 @@
},
"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.
},
],
"title": "A String", # Required. Title of the card.
@@ -1258,16 +1273,17 @@
],
},
],
+ "subtitle": "A String", # Optional. Subtitle to the title.
+ "columnProperties": [ # Optional. Display properties for the columns in this table.
+ { # Column properties for TableCard.
+ "header": "A String", # Required. Column heading.
+ "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
+ },
+ ],
},
"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.
- "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.
- },
"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.
@@ -1278,6 +1294,12 @@
"key": "A String", # Required. A unique key that will be sent back to the agent if this
# response is given.
},
+ "title": "A String", # Required. Title of the carousel item.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
},
],
},
@@ -1294,12 +1316,6 @@
"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
# items, maximum of ten.
{ # Browsing carousel tile
- "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.
- },
"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.
@@ -1309,6 +1325,12 @@
},
"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.
+ },
},
],
},
@@ -1318,12 +1340,12 @@
# `SimpleResponse`.
"simpleResponses": [ # Required. The list of simple responses.
{ # The simple response message containing speech or text.
- "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
- # speech output. Mutually exclusive with ssml.
"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
# response to the user in the SSML format. Mutually exclusive with
# text_to_speech.
"displayText": "A String", # Optional. The text to display.
+ "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
+ # speech output. Mutually exclusive with ssml.
},
],
},
@@ -1336,11 +1358,6 @@
"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
"mediaObjects": [ # Required. List of media objects.
{ # Response media object for media content card.
- "largeImage": { # The image response message. # Optional. Image to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
"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.
@@ -1349,6 +1366,11 @@
"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").
@@ -1358,9 +1380,6 @@
"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.
},
- "payload": { # A custom platform-specific response.
- "a_key": "", # Properties of the object.
- },
"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.
@@ -1374,9 +1393,6 @@
# 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.
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
@@ -1416,13 +1432,20 @@
# 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.
- "text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
+ "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.
@@ -1436,21 +1459,20 @@
# 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
},
- "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.
- },
},
},
],
"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.
},
},
+ "payload": { # A custom platform-specific response.
+ "a_key": "", # Properties of the object.
+ },
},
],
"action": "A String", # Optional. The name of the action associated with the intent.
@@ -1474,28 +1496,6 @@
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
},
],
- "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.
},
],
},
@@ -1521,6 +1521,27 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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
@@ -1540,27 +1561,6 @@
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
- "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).
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
}</pre>
</div>
@@ -1577,6 +1577,28 @@
{ # 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.
@@ -1623,7 +1645,6 @@
# session when this intent is matched.
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
- "displayName": "A String", # Required. The name of the parameter.
"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
# describes values of the parameter. If the parameter is
# required, this must be provided.
@@ -1631,13 +1652,13 @@
# 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`.
- "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
- # whether the intent cannot be completed without collecting the parameter
- # value.
"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
"name": "A String", # The unique identifier of this parameter.
"value": "A String", # Optional. The definition of the parameter value. It can be:
@@ -1647,6 +1668,7 @@
# - 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.
@@ -1741,13 +1763,9 @@
# 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
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
@@ -1787,13 +1805,20 @@
# 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.
- "text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
+ "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.
@@ -1807,21 +1832,18 @@
# 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
},
- "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.
- },
},
},
],
"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.
@@ -1852,6 +1874,7 @@
"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
@@ -1867,7 +1890,6 @@
"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.
},
- "description": "A String", # Optional. The main text describing the item.
},
],
},
@@ -1881,13 +1903,20 @@
# 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.
- "text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
+ "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.
@@ -1901,13 +1930,6 @@
# 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
},
- "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.
- },
},
},
],
@@ -1930,7 +1952,6 @@
# [SSML](https://developers.google.com/actions/reference/ssml).
},
"card": { # The card response message. # Displays a card.
- "imageUri": "A String", # Optional. The public URI to an image file for the card.
"title": "A String", # Optional. The title of the card.
"buttons": [ # Optional. The collection of card buttons.
{ # Optional. Contains information about a button.
@@ -1940,6 +1961,7 @@
},
],
"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.
@@ -1951,22 +1973,15 @@
"formattedText": "A String", # Required, unless image is present. The body text of the card.
"buttons": [ # Optional. The collection of card buttons.
{ # The button object that appears at the bottom of a card.
+ "title": "A String", # Required. The title of the button.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
- "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.
- "columnProperties": [ # Optional. Display properties for the columns in this table.
- { # Column properties for TableCard.
- "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
- "header": "A String", # Required. Column heading.
- },
- ],
"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,
@@ -1974,10 +1989,10 @@
},
"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.
},
],
"title": "A String", # Required. Title of the card.
@@ -1991,16 +2006,17 @@
],
},
],
+ "subtitle": "A String", # Optional. Subtitle to the title.
+ "columnProperties": [ # Optional. Display properties for the columns in this table.
+ { # Column properties for TableCard.
+ "header": "A String", # Required. Column heading.
+ "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
+ },
+ ],
},
"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.
- "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.
- },
"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.
@@ -2011,6 +2027,12 @@
"key": "A String", # Required. A unique key that will be sent back to the agent if this
# response is given.
},
+ "title": "A String", # Required. Title of the carousel item.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
},
],
},
@@ -2027,12 +2049,6 @@
"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
# items, maximum of ten.
{ # Browsing carousel tile
- "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.
- },
"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.
@@ -2042,6 +2058,12 @@
},
"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.
+ },
},
],
},
@@ -2051,12 +2073,12 @@
# `SimpleResponse`.
"simpleResponses": [ # Required. The list of simple responses.
{ # The simple response message containing speech or text.
- "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
- # speech output. Mutually exclusive with ssml.
"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
# response to the user in the SSML format. Mutually exclusive with
# text_to_speech.
"displayText": "A String", # Optional. The text to display.
+ "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
+ # speech output. Mutually exclusive with ssml.
},
],
},
@@ -2069,11 +2091,6 @@
"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
"mediaObjects": [ # Required. List of media objects.
{ # Response media object for media content card.
- "largeImage": { # The image response message. # Optional. Image to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
"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.
@@ -2082,6 +2099,11 @@
"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").
@@ -2091,9 +2113,6 @@
"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.
},
- "payload": { # A custom platform-specific response.
- "a_key": "", # Properties of the object.
- },
"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.
@@ -2107,9 +2126,6 @@
# 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.
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
@@ -2149,13 +2165,20 @@
# 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.
- "text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
+ "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.
@@ -2169,21 +2192,20 @@
# 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
},
- "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.
- },
},
},
],
"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.
},
},
+ "payload": { # A custom platform-specific response.
+ "a_key": "", # Properties of the object.
+ },
},
],
"action": "A String", # Optional. The name of the action associated with the intent.
@@ -2207,28 +2229,6 @@
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
},
],
- "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.
}
intentView: string, Optional. The resource view to apply to the returned intent.
@@ -2248,6 +2248,28 @@
{ # 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.
@@ -2294,7 +2316,6 @@
# session when this intent is matched.
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
- "displayName": "A String", # Required. The name of the parameter.
"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
# describes values of the parameter. If the parameter is
# required, this must be provided.
@@ -2302,13 +2323,13 @@
# 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`.
- "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
- # whether the intent cannot be completed without collecting the parameter
- # value.
"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
"name": "A String", # The unique identifier of this parameter.
"value": "A String", # Optional. The definition of the parameter value. It can be:
@@ -2318,6 +2339,7 @@
# - 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.
@@ -2412,13 +2434,9 @@
# 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
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
@@ -2458,13 +2476,20 @@
# 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.
- "text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
+ "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.
@@ -2478,21 +2503,18 @@
# 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
},
- "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.
- },
},
},
],
"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.
@@ -2523,6 +2545,7 @@
"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
@@ -2538,7 +2561,6 @@
"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.
},
- "description": "A String", # Optional. The main text describing the item.
},
],
},
@@ -2552,13 +2574,20 @@
# 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.
- "text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
+ "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.
@@ -2572,13 +2601,6 @@
# 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
},
- "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.
- },
},
},
],
@@ -2601,7 +2623,6 @@
# [SSML](https://developers.google.com/actions/reference/ssml).
},
"card": { # The card response message. # Displays a card.
- "imageUri": "A String", # Optional. The public URI to an image file for the card.
"title": "A String", # Optional. The title of the card.
"buttons": [ # Optional. The collection of card buttons.
{ # Optional. Contains information about a button.
@@ -2611,6 +2632,7 @@
},
],
"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.
@@ -2622,22 +2644,15 @@
"formattedText": "A String", # Required, unless image is present. The body text of the card.
"buttons": [ # Optional. The collection of card buttons.
{ # The button object that appears at the bottom of a card.
+ "title": "A String", # Required. The title of the button.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
- "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.
- "columnProperties": [ # Optional. Display properties for the columns in this table.
- { # Column properties for TableCard.
- "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
- "header": "A String", # Required. Column heading.
- },
- ],
"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,
@@ -2645,10 +2660,10 @@
},
"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.
},
],
"title": "A String", # Required. Title of the card.
@@ -2662,16 +2677,17 @@
],
},
],
+ "subtitle": "A String", # Optional. Subtitle to the title.
+ "columnProperties": [ # Optional. Display properties for the columns in this table.
+ { # Column properties for TableCard.
+ "header": "A String", # Required. Column heading.
+ "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
+ },
+ ],
},
"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.
- "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.
- },
"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.
@@ -2682,6 +2698,12 @@
"key": "A String", # Required. A unique key that will be sent back to the agent if this
# response is given.
},
+ "title": "A String", # Required. Title of the carousel item.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
},
],
},
@@ -2698,12 +2720,6 @@
"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
# items, maximum of ten.
{ # Browsing carousel tile
- "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.
- },
"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.
@@ -2713,6 +2729,12 @@
},
"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.
+ },
},
],
},
@@ -2722,12 +2744,12 @@
# `SimpleResponse`.
"simpleResponses": [ # Required. The list of simple responses.
{ # The simple response message containing speech or text.
- "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
- # speech output. Mutually exclusive with ssml.
"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
# response to the user in the SSML format. Mutually exclusive with
# text_to_speech.
"displayText": "A String", # Optional. The text to display.
+ "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
+ # speech output. Mutually exclusive with ssml.
},
],
},
@@ -2740,11 +2762,6 @@
"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
"mediaObjects": [ # Required. List of media objects.
{ # Response media object for media content card.
- "largeImage": { # The image response message. # Optional. Image to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
"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.
@@ -2753,6 +2770,11 @@
"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").
@@ -2762,9 +2784,6 @@
"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.
},
- "payload": { # A custom platform-specific response.
- "a_key": "", # Properties of the object.
- },
"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.
@@ -2778,9 +2797,6 @@
# 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.
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
@@ -2820,13 +2836,20 @@
# 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.
- "text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
+ "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.
@@ -2840,21 +2863,20 @@
# 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
},
- "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.
- },
},
},
],
"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.
},
},
+ "payload": { # A custom platform-specific response.
+ "a_key": "", # Properties of the object.
+ },
},
],
"action": "A String", # Optional. The name of the action associated with the intent.
@@ -2878,28 +2900,6 @@
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
},
],
- "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.
}</pre>
</div>
@@ -2956,6 +2956,28 @@
{ # 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.
@@ -3002,7 +3024,6 @@
# session when this intent is matched.
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
- "displayName": "A String", # Required. The name of the parameter.
"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
# describes values of the parameter. If the parameter is
# required, this must be provided.
@@ -3010,13 +3031,13 @@
# 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`.
- "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
- # whether the intent cannot be completed without collecting the parameter
- # value.
"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
"name": "A String", # The unique identifier of this parameter.
"value": "A String", # Optional. The definition of the parameter value. It can be:
@@ -3026,6 +3047,7 @@
# - 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.
@@ -3120,13 +3142,9 @@
# 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
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
@@ -3166,13 +3184,20 @@
# 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.
- "text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
+ "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.
@@ -3186,21 +3211,18 @@
# 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
},
- "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.
- },
},
},
],
"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.
@@ -3231,6 +3253,7 @@
"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
@@ -3246,7 +3269,6 @@
"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.
},
- "description": "A String", # Optional. The main text describing the item.
},
],
},
@@ -3260,13 +3282,20 @@
# 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.
- "text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
+ "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.
@@ -3280,13 +3309,6 @@
# 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
},
- "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.
- },
},
},
],
@@ -3309,7 +3331,6 @@
# [SSML](https://developers.google.com/actions/reference/ssml).
},
"card": { # The card response message. # Displays a card.
- "imageUri": "A String", # Optional. The public URI to an image file for the card.
"title": "A String", # Optional. The title of the card.
"buttons": [ # Optional. The collection of card buttons.
{ # Optional. Contains information about a button.
@@ -3319,6 +3340,7 @@
},
],
"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.
@@ -3330,22 +3352,15 @@
"formattedText": "A String", # Required, unless image is present. The body text of the card.
"buttons": [ # Optional. The collection of card buttons.
{ # The button object that appears at the bottom of a card.
+ "title": "A String", # Required. The title of the button.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
- "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.
- "columnProperties": [ # Optional. Display properties for the columns in this table.
- { # Column properties for TableCard.
- "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
- "header": "A String", # Required. Column heading.
- },
- ],
"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,
@@ -3353,10 +3368,10 @@
},
"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.
},
],
"title": "A String", # Required. Title of the card.
@@ -3370,16 +3385,17 @@
],
},
],
+ "subtitle": "A String", # Optional. Subtitle to the title.
+ "columnProperties": [ # Optional. Display properties for the columns in this table.
+ { # Column properties for TableCard.
+ "header": "A String", # Required. Column heading.
+ "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
+ },
+ ],
},
"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.
- "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.
- },
"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.
@@ -3390,6 +3406,12 @@
"key": "A String", # Required. A unique key that will be sent back to the agent if this
# response is given.
},
+ "title": "A String", # Required. Title of the carousel item.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
},
],
},
@@ -3406,12 +3428,6 @@
"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
# items, maximum of ten.
{ # Browsing carousel tile
- "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.
- },
"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.
@@ -3421,6 +3437,12 @@
},
"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.
+ },
},
],
},
@@ -3430,12 +3452,12 @@
# `SimpleResponse`.
"simpleResponses": [ # Required. The list of simple responses.
{ # The simple response message containing speech or text.
- "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
- # speech output. Mutually exclusive with ssml.
"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
# response to the user in the SSML format. Mutually exclusive with
# text_to_speech.
"displayText": "A String", # Optional. The text to display.
+ "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
+ # speech output. Mutually exclusive with ssml.
},
],
},
@@ -3448,11 +3470,6 @@
"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
"mediaObjects": [ # Required. List of media objects.
{ # Response media object for media content card.
- "largeImage": { # The image response message. # Optional. Image to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
"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.
@@ -3461,6 +3478,11 @@
"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").
@@ -3470,9 +3492,6 @@
"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.
},
- "payload": { # A custom platform-specific response.
- "a_key": "", # Properties of the object.
- },
"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.
@@ -3486,9 +3505,6 @@
# 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.
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
@@ -3528,13 +3544,20 @@
# 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.
- "text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
+ "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.
@@ -3548,21 +3571,20 @@
# 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
},
- "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.
- },
},
},
],
"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.
},
},
+ "payload": { # A custom platform-specific response.
+ "a_key": "", # Properties of the object.
+ },
},
],
"action": "A String", # Optional. The name of the action associated with the intent.
@@ -3586,28 +3608,6 @@
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
},
],
- "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.
}</pre>
</div>
@@ -3641,6 +3641,28 @@
{ # 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.
@@ -3687,7 +3709,6 @@
# session when this intent is matched.
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
- "displayName": "A String", # Required. The name of the parameter.
"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
# describes values of the parameter. If the parameter is
# required, this must be provided.
@@ -3695,13 +3716,13 @@
# 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`.
- "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
- # whether the intent cannot be completed without collecting the parameter
- # value.
"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
"name": "A String", # The unique identifier of this parameter.
"value": "A String", # Optional. The definition of the parameter value. It can be:
@@ -3711,6 +3732,7 @@
# - 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.
@@ -3805,13 +3827,9 @@
# 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
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
@@ -3851,13 +3869,20 @@
# 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.
- "text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
+ "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.
@@ -3871,21 +3896,18 @@
# 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
},
- "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.
- },
},
},
],
"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.
@@ -3916,6 +3938,7 @@
"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
@@ -3931,7 +3954,6 @@
"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.
},
- "description": "A String", # Optional. The main text describing the item.
},
],
},
@@ -3945,13 +3967,20 @@
# 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.
- "text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
+ "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.
@@ -3965,13 +3994,6 @@
# 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
},
- "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.
- },
},
},
],
@@ -3994,7 +4016,6 @@
# [SSML](https://developers.google.com/actions/reference/ssml).
},
"card": { # The card response message. # Displays a card.
- "imageUri": "A String", # Optional. The public URI to an image file for the card.
"title": "A String", # Optional. The title of the card.
"buttons": [ # Optional. The collection of card buttons.
{ # Optional. Contains information about a button.
@@ -4004,6 +4025,7 @@
},
],
"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.
@@ -4015,22 +4037,15 @@
"formattedText": "A String", # Required, unless image is present. The body text of the card.
"buttons": [ # Optional. The collection of card buttons.
{ # The button object that appears at the bottom of a card.
+ "title": "A String", # Required. The title of the button.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
- "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.
- "columnProperties": [ # Optional. Display properties for the columns in this table.
- { # Column properties for TableCard.
- "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
- "header": "A String", # Required. Column heading.
- },
- ],
"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,
@@ -4038,10 +4053,10 @@
},
"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.
},
],
"title": "A String", # Required. Title of the card.
@@ -4055,16 +4070,17 @@
],
},
],
+ "subtitle": "A String", # Optional. Subtitle to the title.
+ "columnProperties": [ # Optional. Display properties for the columns in this table.
+ { # Column properties for TableCard.
+ "header": "A String", # Required. Column heading.
+ "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
+ },
+ ],
},
"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.
- "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.
- },
"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.
@@ -4075,6 +4091,12 @@
"key": "A String", # Required. A unique key that will be sent back to the agent if this
# response is given.
},
+ "title": "A String", # Required. Title of the carousel item.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
},
],
},
@@ -4091,12 +4113,6 @@
"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
# items, maximum of ten.
{ # Browsing carousel tile
- "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.
- },
"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.
@@ -4106,6 +4122,12 @@
},
"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.
+ },
},
],
},
@@ -4115,12 +4137,12 @@
# `SimpleResponse`.
"simpleResponses": [ # Required. The list of simple responses.
{ # The simple response message containing speech or text.
- "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
- # speech output. Mutually exclusive with ssml.
"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
# response to the user in the SSML format. Mutually exclusive with
# text_to_speech.
"displayText": "A String", # Optional. The text to display.
+ "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
+ # speech output. Mutually exclusive with ssml.
},
],
},
@@ -4133,11 +4155,6 @@
"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
"mediaObjects": [ # Required. List of media objects.
{ # Response media object for media content card.
- "largeImage": { # The image response message. # Optional. Image to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
"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.
@@ -4146,6 +4163,11 @@
"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").
@@ -4155,9 +4177,6 @@
"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.
},
- "payload": { # A custom platform-specific response.
- "a_key": "", # Properties of the object.
- },
"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.
@@ -4171,9 +4190,6 @@
# 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.
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
@@ -4213,13 +4229,20 @@
# 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.
- "text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
+ "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.
@@ -4233,21 +4256,20 @@
# 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
},
- "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.
- },
},
},
],
"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.
},
},
+ "payload": { # A custom platform-specific response.
+ "a_key": "", # Properties of the object.
+ },
},
],
"action": "A String", # Optional. The name of the action associated with the intent.
@@ -4271,28 +4293,6 @@
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
},
],
- "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.
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
@@ -4329,6 +4329,28 @@
{ # 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.
@@ -4375,7 +4397,6 @@
# session when this intent is matched.
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
- "displayName": "A String", # Required. The name of the parameter.
"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
# describes values of the parameter. If the parameter is
# required, this must be provided.
@@ -4383,13 +4404,13 @@
# 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`.
- "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
- # whether the intent cannot be completed without collecting the parameter
- # value.
"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
"name": "A String", # The unique identifier of this parameter.
"value": "A String", # Optional. The definition of the parameter value. It can be:
@@ -4399,6 +4420,7 @@
# - 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.
@@ -4493,13 +4515,9 @@
# 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
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
@@ -4539,13 +4557,20 @@
# 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.
- "text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
+ "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.
@@ -4559,21 +4584,18 @@
# 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
},
- "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.
- },
},
},
],
"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.
@@ -4604,6 +4626,7 @@
"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
@@ -4619,7 +4642,6 @@
"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.
},
- "description": "A String", # Optional. The main text describing the item.
},
],
},
@@ -4633,13 +4655,20 @@
# 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.
- "text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
+ "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.
@@ -4653,13 +4682,6 @@
# 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
},
- "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.
- },
},
},
],
@@ -4682,7 +4704,6 @@
# [SSML](https://developers.google.com/actions/reference/ssml).
},
"card": { # The card response message. # Displays a card.
- "imageUri": "A String", # Optional. The public URI to an image file for the card.
"title": "A String", # Optional. The title of the card.
"buttons": [ # Optional. The collection of card buttons.
{ # Optional. Contains information about a button.
@@ -4692,6 +4713,7 @@
},
],
"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.
@@ -4703,22 +4725,15 @@
"formattedText": "A String", # Required, unless image is present. The body text of the card.
"buttons": [ # Optional. The collection of card buttons.
{ # The button object that appears at the bottom of a card.
+ "title": "A String", # Required. The title of the button.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
- "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.
- "columnProperties": [ # Optional. Display properties for the columns in this table.
- { # Column properties for TableCard.
- "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
- "header": "A String", # Required. Column heading.
- },
- ],
"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,
@@ -4726,10 +4741,10 @@
},
"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.
},
],
"title": "A String", # Required. Title of the card.
@@ -4743,16 +4758,17 @@
],
},
],
+ "subtitle": "A String", # Optional. Subtitle to the title.
+ "columnProperties": [ # Optional. Display properties for the columns in this table.
+ { # Column properties for TableCard.
+ "header": "A String", # Required. Column heading.
+ "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
+ },
+ ],
},
"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.
- "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.
- },
"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.
@@ -4763,6 +4779,12 @@
"key": "A String", # Required. A unique key that will be sent back to the agent if this
# response is given.
},
+ "title": "A String", # Required. Title of the carousel item.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
},
],
},
@@ -4779,12 +4801,6 @@
"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
# items, maximum of ten.
{ # Browsing carousel tile
- "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.
- },
"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.
@@ -4794,6 +4810,12 @@
},
"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.
+ },
},
],
},
@@ -4803,12 +4825,12 @@
# `SimpleResponse`.
"simpleResponses": [ # Required. The list of simple responses.
{ # The simple response message containing speech or text.
- "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
- # speech output. Mutually exclusive with ssml.
"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
# response to the user in the SSML format. Mutually exclusive with
# text_to_speech.
"displayText": "A String", # Optional. The text to display.
+ "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
+ # speech output. Mutually exclusive with ssml.
},
],
},
@@ -4821,11 +4843,6 @@
"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
"mediaObjects": [ # Required. List of media objects.
{ # Response media object for media content card.
- "largeImage": { # The image response message. # Optional. Image to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
"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.
@@ -4834,6 +4851,11 @@
"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").
@@ -4843,9 +4865,6 @@
"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.
},
- "payload": { # A custom platform-specific response.
- "a_key": "", # Properties of the object.
- },
"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.
@@ -4859,9 +4878,6 @@
# 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.
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
@@ -4901,13 +4917,20 @@
# 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.
- "text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
+ "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.
@@ -4921,21 +4944,20 @@
# 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
},
- "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.
- },
},
},
],
"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.
},
},
+ "payload": { # A custom platform-specific response.
+ "a_key": "", # Properties of the object.
+ },
},
],
"action": "A String", # Optional. The name of the action associated with the intent.
@@ -4959,28 +4981,6 @@
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
},
],
- "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.
}
intentView: string, Optional. The resource view to apply to the returned intent.
@@ -5001,6 +5001,28 @@
{ # 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.
@@ -5047,7 +5069,6 @@
# session when this intent is matched.
"parameters": [ # Optional. The collection of parameters associated with the intent.
{ # Represents intent parameters.
- "displayName": "A String", # Required. The name of the parameter.
"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
# describes values of the parameter. If the parameter is
# required, this must be provided.
@@ -5055,13 +5076,13 @@
# 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`.
- "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
- # whether the intent cannot be completed without collecting the parameter
- # value.
"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
"name": "A String", # The unique identifier of this parameter.
"value": "A String", # Optional. The definition of the parameter value. It can be:
@@ -5071,6 +5092,7 @@
# - 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.
@@ -5165,13 +5187,9 @@
# 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
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
@@ -5211,13 +5229,20 @@
# 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.
- "text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
+ "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.
@@ -5231,21 +5256,18 @@
# 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
},
- "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.
- },
},
},
],
"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.
@@ -5276,6 +5298,7 @@
"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
@@ -5291,7 +5314,6 @@
"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.
},
- "description": "A String", # Optional. The main text describing the item.
},
],
},
@@ -5305,13 +5327,20 @@
# 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.
- "text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
+ "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.
@@ -5325,13 +5354,6 @@
# 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
},
- "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.
- },
},
},
],
@@ -5354,7 +5376,6 @@
# [SSML](https://developers.google.com/actions/reference/ssml).
},
"card": { # The card response message. # Displays a card.
- "imageUri": "A String", # Optional. The public URI to an image file for the card.
"title": "A String", # Optional. The title of the card.
"buttons": [ # Optional. The collection of card buttons.
{ # Optional. Contains information about a button.
@@ -5364,6 +5385,7 @@
},
],
"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.
@@ -5375,22 +5397,15 @@
"formattedText": "A String", # Required, unless image is present. The body text of the card.
"buttons": [ # Optional. The collection of card buttons.
{ # The button object that appears at the bottom of a card.
+ "title": "A String", # Required. The title of the button.
"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
"uri": "A String", # Required. The HTTP or HTTPS scheme URI.
},
- "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.
- "columnProperties": [ # Optional. Display properties for the columns in this table.
- { # Column properties for TableCard.
- "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
- "header": "A String", # Required. Column heading.
- },
- ],
"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,
@@ -5398,10 +5413,10 @@
},
"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.
},
],
"title": "A String", # Required. Title of the card.
@@ -5415,16 +5430,17 @@
],
},
],
+ "subtitle": "A String", # Optional. Subtitle to the title.
+ "columnProperties": [ # Optional. Display properties for the columns in this table.
+ { # Column properties for TableCard.
+ "header": "A String", # Required. Column heading.
+ "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
+ },
+ ],
},
"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.
- "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.
- },
"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.
@@ -5435,6 +5451,12 @@
"key": "A String", # Required. A unique key that will be sent back to the agent if this
# response is given.
},
+ "title": "A String", # Required. Title of the carousel item.
+ "image": { # The image response message. # Optional. The image to display.
+ "imageUri": "A String", # Optional. The public URI to an image file.
+ "accessibilityText": "A String", # A text description of the image to be used for accessibility,
+ # e.g., screen readers. Required if image_uri is set for CarouselSelect.
+ },
},
],
},
@@ -5451,12 +5473,6 @@
"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
# items, maximum of ten.
{ # Browsing carousel tile
- "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.
- },
"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.
@@ -5466,6 +5482,12 @@
},
"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.
+ },
},
],
},
@@ -5475,12 +5497,12 @@
# `SimpleResponse`.
"simpleResponses": [ # Required. The list of simple responses.
{ # The simple response message containing speech or text.
- "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
- # speech output. Mutually exclusive with ssml.
"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
# response to the user in the SSML format. Mutually exclusive with
# text_to_speech.
"displayText": "A String", # Optional. The text to display.
+ "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
+ # speech output. Mutually exclusive with ssml.
},
],
},
@@ -5493,11 +5515,6 @@
"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
"mediaObjects": [ # Required. List of media objects.
{ # Response media object for media content card.
- "largeImage": { # The image response message. # Optional. Image to display above media content.
- "imageUri": "A String", # Optional. The public URI to an image file.
- "accessibilityText": "A String", # A text description of the image to be used for accessibility,
- # e.g., screen readers. Required if image_uri is set for CarouselSelect.
- },
"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.
@@ -5506,6 +5523,11 @@
"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").
@@ -5515,9 +5537,6 @@
"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.
},
- "payload": { # A custom platform-specific response.
- "a_key": "", # Properties of the object.
- },
"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.
@@ -5531,9 +5550,6 @@
# 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.
- "description": "A String", # Optional. Description of the card (at most 2000 bytes).
- #
- # At least one of the title, description or media must be set.
"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
# be set. Media (image, GIF or a video) to include in the card.
# The following media-types are currently supported:
@@ -5573,13 +5589,20 @@
# 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.
- "text": "A String", # Suggested reply text.
"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
# when the user taps the suggested reply. This data will be also
# forwarded to webhook to allow performing custom business logic.
+ "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.
@@ -5593,21 +5616,20 @@
# 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
},
- "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.
- },
},
},
],
"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.
},
},
+ "payload": { # A custom platform-specific response.
+ "a_key": "", # Properties of the object.
+ },
},
],
"action": "A String", # Optional. The name of the action associated with the intent.
@@ -5631,28 +5653,6 @@
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
},
],
- "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.
}</pre>
</div>