docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/dialogflow_v2beta1.projects.agent.sessions.html b/docs/dyn/dialogflow_v2beta1.projects.agent.sessions.html
index 663d166..860c196 100644
--- a/docs/dyn/dialogflow_v2beta1.projects.agent.sessions.html
+++ b/docs/dyn/dialogflow_v2beta1.projects.agent.sessions.html
@@ -163,6 +163,34 @@
# 2. A conversational query in the form of text.
#
# 3. An event that specifies which intent to trigger.
+ "event": { # Events allow for matching intents by event name instead of the natural # The event to be processed.
+ # language input. For instance, input `<event: { name: "welcome_event",
+ # parameters: { name: "Sam" } }>` can trigger a personalized welcome response.
+ # The parameter `name` may be used by the agent in the response:
+ # `"Hello #welcome_event.name! What can I do for you today?"`.
+ "languageCode": "A String", # Required. The language of this query. See [Language
+ # Support](https://cloud.google.com/dialogflow/docs/reference/language)
+ # for a list of the currently supported language codes. Note that queries in
+ # the same session do not necessarily need to specify the same language.
+ "name": "A String", # Required. The unique identifier of the event.
+ "parameters": { # The collection of parameters associated with the event.
+ #
+ # Depending on your protocol or client library language, this is a
+ # map, associative array, symbol table, dictionary, or JSON object
+ # composed of a collection of (MapKey, MapValue) pairs:
+ #
+ # - MapKey type: string
+ # - MapKey value: parameter name
+ # - MapValue type:
+ # - If parameter's entity type is a composite entity: map
+ # - Else: string or number, depending on parameter value type
+ # - MapValue value:
+ # - If parameter's entity type is a composite entity:
+ # map from composite entity property names to property values
+ # - Else: parameter value
+ "a_key": "", # Properties of the object.
+ },
+ },
"text": { # Represents the natural language text to be processed. # The natural language text to be processed.
"text": "A String", # Required. The UTF-8 encoded natural language text to be processed.
# Text length must not exceed 256 characters.
@@ -172,6 +200,17 @@
# the same session do not necessarily need to specify the same language.
},
"audioConfig": { # Instructs the speech recognizer on how to process the audio content. # Instructs the speech recognizer how to process the speech audio.
+ "audioEncoding": "A String", # Required. Audio encoding of the audio content to process.
+ "singleUtterance": True or False, # If `false` (default), recognition does not cease until the
+ # client closes the stream.
+ # If `true`, the recognizer will detect a single spoken utterance in input
+ # audio. Recognition ceases when it detects the audio's voice has
+ # stopped or paused. In this case, once a detected intent is received, the
+ # client should close the stream and start a new request with a new stream as
+ # needed.
+ # Note: This setting is relevant only for streaming methods.
+ # Note: When specified, InputAudioConfig.single_utterance takes precedence
+ # over StreamingDetectIntentRequest.single_utterance.
"languageCode": "A String", # Required. The language of the supplied audio. Dialogflow does not do
# translations. See [Language
# Support](https://cloud.google.com/dialogflow/docs/reference/language)
@@ -242,50 +281,9 @@
# documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model)
# for more details.
"modelVariant": "A String", # Which variant of the Speech model to use.
- "audioEncoding": "A String", # Required. Audio encoding of the audio content to process.
- "singleUtterance": True or False, # If `false` (default), recognition does not cease until the
- # client closes the stream.
- # If `true`, the recognizer will detect a single spoken utterance in input
- # audio. Recognition ceases when it detects the audio's voice has
- # stopped or paused. In this case, once a detected intent is received, the
- # client should close the stream and start a new request with a new stream as
- # needed.
- # Note: This setting is relevant only for streaming methods.
- # Note: When specified, InputAudioConfig.single_utterance takes precedence
- # over StreamingDetectIntentRequest.single_utterance.
- },
- "event": { # Events allow for matching intents by event name instead of the natural # The event to be processed.
- # language input. For instance, input `<event: { name: "welcome_event",
- # parameters: { name: "Sam" } }>` can trigger a personalized welcome response.
- # The parameter `name` may be used by the agent in the response:
- # `"Hello #welcome_event.name! What can I do for you today?"`.
- "name": "A String", # Required. The unique identifier of the event.
- "parameters": { # The collection of parameters associated with the event.
- #
- # Depending on your protocol or client library language, this is a
- # map, associative array, symbol table, dictionary, or JSON object
- # composed of a collection of (MapKey, MapValue) pairs:
- #
- # - MapKey type: string
- # - MapKey value: parameter name
- # - MapValue type:
- # - If parameter's entity type is a composite entity: map
- # - Else: string or number, depending on parameter value type
- # - MapValue value:
- # - If parameter's entity type is a composite entity:
- # map from composite entity property names to property values
- # - Else: parameter value
- "a_key": "", # Properties of the object.
- },
- "languageCode": "A String", # Required. The language of this query. See [Language
- # Support](https://cloud.google.com/dialogflow/docs/reference/language)
- # for a list of the currently supported language codes. Note that queries in
- # the same session do not necessarily need to specify the same language.
},
},
"queryParams": { # Represents the parameters of the conversational query. # The parameters of this query.
- "resetContexts": True or False, # Specifies whether to delete all contexts in the current session
- # before the new ones are activated.
"payload": { # This field can be used to pass custom data to your webhook.
# Arbitrary JSON objects are supported.
# If supplied, the value is used to populate the
@@ -298,9 +296,16 @@
# specified otherwise, this must conform to the
# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
# standard</a>. Values must be within normalized ranges.
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
+ "resetContexts": True or False, # Specifies whether to delete all contexts in the current session
+ # before the new ones are activated.
+ "knowledgeBaseNames": [ # KnowledgeBases to get alternative results from. If not set, the
+ # KnowledgeBases enabled in the agent (through UI) will be used.
+ # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
+ "A String",
+ ],
"contexts": [ # The collection of contexts to be activated before this query is
# executed.
{ # Represents a context.
@@ -344,11 +349,6 @@
},
},
],
- "knowledgeBaseNames": [ # KnowledgeBases to get alternative results from. If not set, the
- # KnowledgeBases enabled in the agent (through UI) will be used.
- # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
- "A String",
- ],
"sentimentAnalysisRequestConfig": { # Configures the types of sentiment analysis to perform. # Configures the type of sentiment analysis to perform. If not
# provided, sentiment analysis is not performed.
# Note: Sentiment Analysis is only currently available for Enterprise Edition
@@ -426,11 +426,11 @@
# be returned. If empty, Dialogflow will decide which sub agents to query.
# If specified for a non-mega-agent query, will be silently ignored.
{ # Contains basic configuration for a sub-agent.
- "project": "A String", # Required. The project of this agent.
- # Format: `projects/<Project ID>`.
"environment": "A String", # Optional. The unique identifier (`environment name` in dialogflow console)
# of this sub-agent environment. Assumes draft environment if `environment`
# is not set.
+ "project": "A String", # Required. The project of this agent.
+ # Format: `projects/<Project ID>`.
},
],
},
@@ -492,23 +492,71 @@
An object of the form:
{ # The message returned from the DetectIntent method.
+ "outputAudio": "A String", # The audio data bytes encoded as specified in the request.
+ # Note: The output audio is generated based on the values of default platform
+ # text responses found in the `query_result.fulfillment_messages` field. If
+ # multiple default text responses exist, they will be concatenated when
+ # generating audio. If no default platform text responses exist, the
+ # generated audio content will be empty.
+ #
+ # In some scenarios, multiple output audio fields may be present in the
+ # response structure. In these cases, only the top-most-level audio output
+ # has content.
"queryResult": { # Represents the result of conversational query or event processing. # The selected results of the conversational query or event processing.
# See `alternative_query_results` for additional potential results.
+ "knowledgeAnswers": { # Represents the result of querying a Knowledge base. # The result from Knowledge Connector (if any), ordered by decreasing
+ # `KnowledgeAnswers.match_confidence`.
+ "answers": [ # A list of answers from Knowledge Connector.
+ { # An answer from Knowledge Connector.
+ "source": "A String", # Indicates which Knowledge Document this answer was extracted from.
+ # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
+ # ID>/documents/<Document ID>`.
+ "answer": "A String", # The piece of text from the `source` knowledge base document that answers
+ # this conversational query.
+ "faqQuestion": "A String", # The corresponding FAQ question if the answer was extracted from a FAQ
+ # Document, empty otherwise.
+ "matchConfidenceLevel": "A String", # The system's confidence level that this knowledge answer is a good match
+ # for this conversational query.
+ # NOTE: The confidence level for a given `<query, answer>` pair may change
+ # without notice, as it depends on models that are constantly being
+ # improved. However, it will change less frequently than the confidence
+ # score below, and should be preferred for referencing the quality of an
+ # answer.
+ "matchConfidence": 3.14, # The system's confidence score that this Knowledge answer is a good match
+ # for this conversational query.
+ # The range is from 0.0 (completely uncertain) to 1.0 (completely certain).
+ # Note: The confidence score is likely to vary somewhat (possibly even for
+ # identical requests), as the underlying model is under constant
+ # improvement. It may be deprecated in the future. We recommend using
+ # `match_confidence_level` which should be generally more stable.
+ },
+ ],
+ },
+ "sentimentAnalysisResult": { # The result of sentiment analysis as configured by # The sentiment analysis result, which depends on the
+ # `sentiment_analysis_request_config` specified in the request.
+ # `sentiment_analysis_request_config`.
+ "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit # The sentiment analysis result for `query_text`.
+ # of analysis, such as the query text.
+ "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive
+ # sentiment).
+ "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents the absolute
+ # magnitude of sentiment, regardless of score (positive or negative).
+ },
+ },
+ "intentDetectionConfidence": 3.14, # The intent detection confidence. Values range from 0.0
+ # (completely uncertain) to 1.0 (completely certain).
+ # This value is for informational purpose only and is only used to
+ # help match the best intent within the classification threshold.
+ # This value may change for the same end-user expression at any time due to a
+ # model retraining or change in implementation.
+ # If there are `multiple knowledge_answers` messages, this value is set to
+ # the greatest `knowledgeAnswers.match_confidence` value in the list.
"allRequiredParamsPresent": True or False, # This field is set to:
#
# - `false` if the matched intent has required parameters and not all of
# the required parameter values have been collected.
# - `true` if all required parameter values have been collected, or if the
# matched intent doesn't contain any required parameters.
- "queryText": "A String", # The original conversational query text:
- #
- # - If natural language text was provided as input, `query_text` contains
- # a copy of the input.
- # - If natural language speech audio was provided as input, `query_text`
- # contains the speech recognition result. If speech recognizer produced
- # multiple alternatives, a particular one is picked.
- # - If automatic spell correction is enabled, `query_text` will contain the
- # corrected user input.
"speechRecognitionConfidence": 3.14, # The Speech recognition confidence between 0.0 and 1.0. A higher number
# indicates an estimated greater likelihood that the recognized words are
# correct. The default of 0.0 is a sentinel value indicating that confidence
@@ -518,6 +566,15 @@
# field isn't set for StreamingDetectIntent since the streaming endpoint has
# separate confidence estimates per portion of the audio in
# StreamingRecognitionResult.
+ "queryText": "A String", # The original conversational query text:
+ #
+ # - If natural language text was provided as input, `query_text` contains
+ # a copy of the input.
+ # - If natural language speech audio was provided as input, `query_text`
+ # contains the speech recognition result. If speech recognizer produced
+ # multiple alternatives, a particular one is picked.
+ # - If automatic spell correction is enabled, `query_text` will contain the
+ # corrected user input.
"diagnosticInfo": { # Free-form diagnostic information for the associated detect intent request.
# The fields of this data can change without notice, so you should not write
# code that depends on its structure.
@@ -527,60 +584,33 @@
# - webhook errors
"a_key": "", # Properties of the object.
},
- "outputContexts": [ # The collection of output contexts. If applicable,
- # `output_contexts.parameters` contains entries with name
- # `<parameter name>.original` containing the original parameter values
- # before the query.
- { # Represents a context.
- "lifespanCount": 42, # Optional. The number of conversational query requests after which the
- # context expires. The default is `0`. If set to `0`, the context expires
- # immediately. Contexts expire automatically after 20 minutes if there
- # are no matching queries.
- "name": "A String", # Required. The unique identifier of the context. Format:
- # `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,
- # or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
- # ID>/sessions/<Session ID>/contexts/<Context ID>`.
- #
- # The `Context ID` is always converted to lowercase, may only contain
- # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
- #
- # If `Environment ID` is not specified, we assume default 'draft'
- # environment. If `User ID` is not specified, we assume default '-' user.
- #
- # The following context names are reserved for internal use by Dialogflow.
- # You should not use these contexts or create contexts with these names:
- #
- # * `__system_counters__`
- # * `*_id_dialog_context`
- # * `*_dialog_params_size`
- "parameters": { # Optional. The collection of parameters associated with this context.
- #
- # Depending on your protocol or client library language, this is a
- # map, associative array, symbol table, dictionary, or JSON object
- # composed of a collection of (MapKey, MapValue) pairs:
- #
- # - MapKey type: string
- # - MapKey value: parameter name
- # - MapValue type:
- # - If parameter's entity type is a composite entity: map
- # - Else: string or number, depending on parameter value type
- # - MapValue value:
- # - If parameter's entity type is a composite entity:
- # map from composite entity property names to property values
- # - Else: parameter value
- "a_key": "", # Properties of the object.
- },
- },
- ],
- "languageCode": "A String", # The language that was triggered during intent detection.
- # See [Language
- # Support](https://cloud.google.com/dialogflow/docs/reference/language)
- # for a list of the currently supported language codes.
"intent": { # Represents an intent. # The intent that matched the conversational query. Some, not
# all fields are filled in this message, including but not limited to:
# `name`, `display_name`, `end_interaction` and `is_fallback`.
# 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.
@@ -627,7 +657,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.
@@ -635,13 +664,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:
@@ -651,6 +680,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.
@@ -745,13 +775,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:
@@ -791,13 +817,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.
@@ -811,21 +844,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.
@@ -856,6 +886,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
@@ -871,7 +902,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.
},
],
},
@@ -885,13 +915,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.
@@ -905,13 +942,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.
- },
},
},
],
@@ -934,7 +964,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.
@@ -944,6 +973,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.
@@ -955,22 +985,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,
@@ -978,10 +1001,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.
@@ -995,16 +1018,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.
@@ -1015,6 +1039,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.
+ },
},
],
},
@@ -1031,12 +1061,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.
@@ -1046,6 +1070,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.
+ },
},
],
},
@@ -1055,12 +1085,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.
},
],
},
@@ -1073,11 +1103,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.
@@ -1086,6 +1111,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").
@@ -1095,9 +1125,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.
@@ -1111,9 +1138,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:
@@ -1153,13 +1177,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.
@@ -1173,21 +1204,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.
@@ -1211,28 +1241,59 @@
# 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.
+ },
+ "languageCode": "A String", # The language that was triggered during intent detection.
+ # See [Language
+ # Support](https://cloud.google.com/dialogflow/docs/reference/language)
+ # for a list of the currently supported language codes.
+ "outputContexts": [ # The collection of output contexts. If applicable,
+ # `output_contexts.parameters` contains entries with name
+ # `<parameter name>.original` containing the original parameter values
+ # before the query.
+ { # Represents a context.
+ "lifespanCount": 42, # Optional. The number of conversational query requests after which the
+ # context expires. The default is `0`. If set to `0`, the context expires
+ # immediately. Contexts expire automatically after 20 minutes if there
+ # are no matching queries.
+ "name": "A String", # Required. The unique identifier of the context. Format:
+ # `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,
+ # or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
+ # ID>/sessions/<Session ID>/contexts/<Context ID>`.
+ #
+ # The `Context ID` is always converted to lowercase, may only contain
+ # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
+ #
+ # If `Environment ID` is not specified, we assume default 'draft'
+ # environment. If `User ID` is not specified, we assume default '-' user.
+ #
+ # The following context names are reserved for internal use by Dialogflow.
+ # You should not use these contexts or create contexts with these names:
+ #
+ # * `__system_counters__`
+ # * `*_id_dialog_context`
+ # * `*_dialog_params_size`
+ "parameters": { # Optional. The collection of parameters associated with this context.
+ #
+ # Depending on your protocol or client library language, this is a
+ # map, associative array, symbol table, dictionary, or JSON object
+ # composed of a collection of (MapKey, MapValue) pairs:
+ #
+ # - MapKey type: string
+ # - MapKey value: parameter name
+ # - MapValue type:
+ # - If parameter's entity type is a composite entity: map
+ # - Else: string or number, depending on parameter value type
+ # - MapValue value:
+ # - If parameter's entity type is a composite entity:
+ # map from composite entity property names to property values
+ # - Else: parameter value
+ "a_key": "", # Properties of the object.
+ },
+ },
+ ],
+ "webhookPayload": { # If the query was fulfilled by a webhook call, this field is set to the
+ # value of the `payload` field returned in the webhook response.
+ "a_key": "", # Properties of the object.
},
"fulfillmentMessages": [ # The collection of rich messages to present to the user.
{ # Corresponds to the `Response` field in the Dialogflow console.
@@ -1250,13 +1311,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:
@@ -1296,13 +1353,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.
@@ -1316,21 +1380,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.
@@ -1361,6 +1422,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
@@ -1376,7 +1438,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.
},
],
},
@@ -1390,13 +1451,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.
@@ -1410,13 +1478,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.
- },
},
},
],
@@ -1439,7 +1500,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.
@@ -1449,6 +1509,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.
@@ -1460,22 +1521,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,
@@ -1483,10 +1537,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.
@@ -1500,16 +1554,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.
@@ -1520,6 +1575,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.
+ },
},
],
},
@@ -1536,12 +1597,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.
@@ -1551,6 +1606,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.
+ },
},
],
},
@@ -1560,12 +1621,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.
},
],
},
@@ -1578,11 +1639,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.
@@ -1591,6 +1647,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").
@@ -1600,9 +1661,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.
@@ -1616,9 +1674,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:
@@ -1658,13 +1713,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.
@@ -1678,27 +1740,22 @@
# 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.
+ },
},
],
- "webhookPayload": { # If the query was fulfilled by a webhook call, this field is set to the
- # value of the `payload` field returned in the webhook response.
- "a_key": "", # Properties of the object.
- },
"action": "A String", # The action name from the matched intent.
"webhookSource": "A String", # If the query was fulfilled by a webhook call, this field is set to the
# value of the `source` field returned in the webhook response.
@@ -1721,53 +1778,6 @@
# - Else: parameter value
"a_key": "", # Properties of the object.
},
- "knowledgeAnswers": { # Represents the result of querying a Knowledge base. # The result from Knowledge Connector (if any), ordered by decreasing
- # `KnowledgeAnswers.match_confidence`.
- "answers": [ # A list of answers from Knowledge Connector.
- { # An answer from Knowledge Connector.
- "source": "A String", # Indicates which Knowledge Document this answer was extracted from.
- # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
- # ID>/documents/<Document ID>`.
- "answer": "A String", # The piece of text from the `source` knowledge base document that answers
- # this conversational query.
- "faqQuestion": "A String", # The corresponding FAQ question if the answer was extracted from a FAQ
- # Document, empty otherwise.
- "matchConfidenceLevel": "A String", # The system's confidence level that this knowledge answer is a good match
- # for this conversational query.
- # NOTE: The confidence level for a given `<query, answer>` pair may change
- # without notice, as it depends on models that are constantly being
- # improved. However, it will change less frequently than the confidence
- # score below, and should be preferred for referencing the quality of an
- # answer.
- "matchConfidence": 3.14, # The system's confidence score that this Knowledge answer is a good match
- # for this conversational query.
- # The range is from 0.0 (completely uncertain) to 1.0 (completely certain).
- # Note: The confidence score is likely to vary somewhat (possibly even for
- # identical requests), as the underlying model is under constant
- # improvement. It may be deprecated in the future. We recommend using
- # `match_confidence_level` which should be generally more stable.
- },
- ],
- },
- "sentimentAnalysisResult": { # The result of sentiment analysis as configured by # The sentiment analysis result, which depends on the
- # `sentiment_analysis_request_config` specified in the request.
- # `sentiment_analysis_request_config`.
- "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit # The sentiment analysis result for `query_text`.
- # of analysis, such as the query text.
- "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive
- # sentiment).
- "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents the absolute
- # magnitude of sentiment, regardless of score (positive or negative).
- },
- },
- "intentDetectionConfidence": 3.14, # The intent detection confidence. Values range from 0.0
- # (completely uncertain) to 1.0 (completely certain).
- # This value is for informational purpose only and is only used to
- # help match the best intent within the classification threshold.
- # This value may change for the same end-user expression at any time due to a
- # model retraining or change in implementation.
- # If there are `multiple knowledge_answers` messages, this value is set to
- # the greatest `knowledgeAnswers.match_confidence` value in the list.
},
"webhookStatus": { # The `Status` type defines a logical error model that is suitable for # Specifies the status of the webhook request.
# different programming environments, including REST APIs and RPC APIs. It is
@@ -1776,6 +1786,9 @@
#
# 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.
{
@@ -1783,9 +1796,6 @@
},
],
"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.
},
"alternativeQueryResults": [ # If Knowledge Connectors are enabled, there could be more than one result
# returned for a given query or event, and this field will contain all
@@ -1796,21 +1806,59 @@
# intents are supported, at which point those additional results will be
# surfaced here.
{ # Represents the result of conversational query or event processing.
+ "knowledgeAnswers": { # Represents the result of querying a Knowledge base. # The result from Knowledge Connector (if any), ordered by decreasing
+ # `KnowledgeAnswers.match_confidence`.
+ "answers": [ # A list of answers from Knowledge Connector.
+ { # An answer from Knowledge Connector.
+ "source": "A String", # Indicates which Knowledge Document this answer was extracted from.
+ # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
+ # ID>/documents/<Document ID>`.
+ "answer": "A String", # The piece of text from the `source` knowledge base document that answers
+ # this conversational query.
+ "faqQuestion": "A String", # The corresponding FAQ question if the answer was extracted from a FAQ
+ # Document, empty otherwise.
+ "matchConfidenceLevel": "A String", # The system's confidence level that this knowledge answer is a good match
+ # for this conversational query.
+ # NOTE: The confidence level for a given `<query, answer>` pair may change
+ # without notice, as it depends on models that are constantly being
+ # improved. However, it will change less frequently than the confidence
+ # score below, and should be preferred for referencing the quality of an
+ # answer.
+ "matchConfidence": 3.14, # The system's confidence score that this Knowledge answer is a good match
+ # for this conversational query.
+ # The range is from 0.0 (completely uncertain) to 1.0 (completely certain).
+ # Note: The confidence score is likely to vary somewhat (possibly even for
+ # identical requests), as the underlying model is under constant
+ # improvement. It may be deprecated in the future. We recommend using
+ # `match_confidence_level` which should be generally more stable.
+ },
+ ],
+ },
+ "sentimentAnalysisResult": { # The result of sentiment analysis as configured by # The sentiment analysis result, which depends on the
+ # `sentiment_analysis_request_config` specified in the request.
+ # `sentiment_analysis_request_config`.
+ "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit # The sentiment analysis result for `query_text`.
+ # of analysis, such as the query text.
+ "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive
+ # sentiment).
+ "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents the absolute
+ # magnitude of sentiment, regardless of score (positive or negative).
+ },
+ },
+ "intentDetectionConfidence": 3.14, # The intent detection confidence. Values range from 0.0
+ # (completely uncertain) to 1.0 (completely certain).
+ # This value is for informational purpose only and is only used to
+ # help match the best intent within the classification threshold.
+ # This value may change for the same end-user expression at any time due to a
+ # model retraining or change in implementation.
+ # If there are `multiple knowledge_answers` messages, this value is set to
+ # the greatest `knowledgeAnswers.match_confidence` value in the list.
"allRequiredParamsPresent": True or False, # This field is set to:
#
# - `false` if the matched intent has required parameters and not all of
# the required parameter values have been collected.
# - `true` if all required parameter values have been collected, or if the
# matched intent doesn't contain any required parameters.
- "queryText": "A String", # The original conversational query text:
- #
- # - If natural language text was provided as input, `query_text` contains
- # a copy of the input.
- # - If natural language speech audio was provided as input, `query_text`
- # contains the speech recognition result. If speech recognizer produced
- # multiple alternatives, a particular one is picked.
- # - If automatic spell correction is enabled, `query_text` will contain the
- # corrected user input.
"speechRecognitionConfidence": 3.14, # The Speech recognition confidence between 0.0 and 1.0. A higher number
# indicates an estimated greater likelihood that the recognized words are
# correct. The default of 0.0 is a sentinel value indicating that confidence
@@ -1820,6 +1868,15 @@
# field isn't set for StreamingDetectIntent since the streaming endpoint has
# separate confidence estimates per portion of the audio in
# StreamingRecognitionResult.
+ "queryText": "A String", # The original conversational query text:
+ #
+ # - If natural language text was provided as input, `query_text` contains
+ # a copy of the input.
+ # - If natural language speech audio was provided as input, `query_text`
+ # contains the speech recognition result. If speech recognizer produced
+ # multiple alternatives, a particular one is picked.
+ # - If automatic spell correction is enabled, `query_text` will contain the
+ # corrected user input.
"diagnosticInfo": { # Free-form diagnostic information for the associated detect intent request.
# The fields of this data can change without notice, so you should not write
# code that depends on its structure.
@@ -1829,60 +1886,33 @@
# - webhook errors
"a_key": "", # Properties of the object.
},
- "outputContexts": [ # The collection of output contexts. If applicable,
- # `output_contexts.parameters` contains entries with name
- # `<parameter name>.original` containing the original parameter values
- # before the query.
- { # Represents a context.
- "lifespanCount": 42, # Optional. The number of conversational query requests after which the
- # context expires. The default is `0`. If set to `0`, the context expires
- # immediately. Contexts expire automatically after 20 minutes if there
- # are no matching queries.
- "name": "A String", # Required. The unique identifier of the context. Format:
- # `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,
- # or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
- # ID>/sessions/<Session ID>/contexts/<Context ID>`.
- #
- # The `Context ID` is always converted to lowercase, may only contain
- # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
- #
- # If `Environment ID` is not specified, we assume default 'draft'
- # environment. If `User ID` is not specified, we assume default '-' user.
- #
- # The following context names are reserved for internal use by Dialogflow.
- # You should not use these contexts or create contexts with these names:
- #
- # * `__system_counters__`
- # * `*_id_dialog_context`
- # * `*_dialog_params_size`
- "parameters": { # Optional. The collection of parameters associated with this context.
- #
- # Depending on your protocol or client library language, this is a
- # map, associative array, symbol table, dictionary, or JSON object
- # composed of a collection of (MapKey, MapValue) pairs:
- #
- # - MapKey type: string
- # - MapKey value: parameter name
- # - MapValue type:
- # - If parameter's entity type is a composite entity: map
- # - Else: string or number, depending on parameter value type
- # - MapValue value:
- # - If parameter's entity type is a composite entity:
- # map from composite entity property names to property values
- # - Else: parameter value
- "a_key": "", # Properties of the object.
- },
- },
- ],
- "languageCode": "A String", # The language that was triggered during intent detection.
- # See [Language
- # Support](https://cloud.google.com/dialogflow/docs/reference/language)
- # for a list of the currently supported language codes.
"intent": { # Represents an intent. # The intent that matched the conversational query. Some, not
# all fields are filled in this message, including but not limited to:
# `name`, `display_name`, `end_interaction` and `is_fallback`.
# 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.
@@ -1929,7 +1959,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.
@@ -1937,13 +1966,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:
@@ -1953,6 +1982,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.
@@ -2047,13 +2077,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:
@@ -2093,13 +2119,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.
@@ -2113,21 +2146,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.
@@ -2158,6 +2188,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
@@ -2173,7 +2204,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.
},
],
},
@@ -2187,13 +2217,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.
@@ -2207,13 +2244,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.
- },
},
},
],
@@ -2236,7 +2266,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.
@@ -2246,6 +2275,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.
@@ -2257,22 +2287,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,
@@ -2280,10 +2303,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.
@@ -2297,16 +2320,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.
@@ -2317,6 +2341,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.
+ },
},
],
},
@@ -2333,12 +2363,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.
@@ -2348,6 +2372,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.
+ },
},
],
},
@@ -2357,12 +2387,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.
},
],
},
@@ -2375,11 +2405,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.
@@ -2388,6 +2413,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").
@@ -2397,9 +2427,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.
@@ -2413,9 +2440,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:
@@ -2455,13 +2479,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.
@@ -2475,21 +2506,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.
@@ -2513,28 +2543,59 @@
# 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.
+ },
+ "languageCode": "A String", # The language that was triggered during intent detection.
+ # See [Language
+ # Support](https://cloud.google.com/dialogflow/docs/reference/language)
+ # for a list of the currently supported language codes.
+ "outputContexts": [ # The collection of output contexts. If applicable,
+ # `output_contexts.parameters` contains entries with name
+ # `<parameter name>.original` containing the original parameter values
+ # before the query.
+ { # Represents a context.
+ "lifespanCount": 42, # Optional. The number of conversational query requests after which the
+ # context expires. The default is `0`. If set to `0`, the context expires
+ # immediately. Contexts expire automatically after 20 minutes if there
+ # are no matching queries.
+ "name": "A String", # Required. The unique identifier of the context. Format:
+ # `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,
+ # or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
+ # ID>/sessions/<Session ID>/contexts/<Context ID>`.
+ #
+ # The `Context ID` is always converted to lowercase, may only contain
+ # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
+ #
+ # If `Environment ID` is not specified, we assume default 'draft'
+ # environment. If `User ID` is not specified, we assume default '-' user.
+ #
+ # The following context names are reserved for internal use by Dialogflow.
+ # You should not use these contexts or create contexts with these names:
+ #
+ # * `__system_counters__`
+ # * `*_id_dialog_context`
+ # * `*_dialog_params_size`
+ "parameters": { # Optional. The collection of parameters associated with this context.
+ #
+ # Depending on your protocol or client library language, this is a
+ # map, associative array, symbol table, dictionary, or JSON object
+ # composed of a collection of (MapKey, MapValue) pairs:
+ #
+ # - MapKey type: string
+ # - MapKey value: parameter name
+ # - MapValue type:
+ # - If parameter's entity type is a composite entity: map
+ # - Else: string or number, depending on parameter value type
+ # - MapValue value:
+ # - If parameter's entity type is a composite entity:
+ # map from composite entity property names to property values
+ # - Else: parameter value
+ "a_key": "", # Properties of the object.
+ },
+ },
+ ],
+ "webhookPayload": { # If the query was fulfilled by a webhook call, this field is set to the
+ # value of the `payload` field returned in the webhook response.
+ "a_key": "", # Properties of the object.
},
"fulfillmentMessages": [ # The collection of rich messages to present to the user.
{ # Corresponds to the `Response` field in the Dialogflow console.
@@ -2552,13 +2613,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:
@@ -2598,13 +2655,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.
@@ -2618,21 +2682,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.
@@ -2663,6 +2724,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
@@ -2678,7 +2740,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.
},
],
},
@@ -2692,13 +2753,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.
@@ -2712,13 +2780,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.
- },
},
},
],
@@ -2741,7 +2802,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.
@@ -2751,6 +2811,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.
@@ -2762,22 +2823,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,
@@ -2785,10 +2839,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.
@@ -2802,16 +2856,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.
@@ -2822,6 +2877,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.
+ },
},
],
},
@@ -2838,12 +2899,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.
@@ -2853,6 +2908,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.
+ },
},
],
},
@@ -2862,12 +2923,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.
},
],
},
@@ -2880,11 +2941,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.
@@ -2893,6 +2949,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").
@@ -2902,9 +2963,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.
@@ -2918,9 +2976,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:
@@ -2960,13 +3015,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.
@@ -2980,27 +3042,22 @@
# 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.
+ },
},
],
- "webhookPayload": { # If the query was fulfilled by a webhook call, this field is set to the
- # value of the `payload` field returned in the webhook response.
- "a_key": "", # Properties of the object.
- },
"action": "A String", # The action name from the matched intent.
"webhookSource": "A String", # If the query was fulfilled by a webhook call, this field is set to the
# value of the `source` field returned in the webhook response.
@@ -3023,53 +3080,6 @@
# - Else: parameter value
"a_key": "", # Properties of the object.
},
- "knowledgeAnswers": { # Represents the result of querying a Knowledge base. # The result from Knowledge Connector (if any), ordered by decreasing
- # `KnowledgeAnswers.match_confidence`.
- "answers": [ # A list of answers from Knowledge Connector.
- { # An answer from Knowledge Connector.
- "source": "A String", # Indicates which Knowledge Document this answer was extracted from.
- # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
- # ID>/documents/<Document ID>`.
- "answer": "A String", # The piece of text from the `source` knowledge base document that answers
- # this conversational query.
- "faqQuestion": "A String", # The corresponding FAQ question if the answer was extracted from a FAQ
- # Document, empty otherwise.
- "matchConfidenceLevel": "A String", # The system's confidence level that this knowledge answer is a good match
- # for this conversational query.
- # NOTE: The confidence level for a given `<query, answer>` pair may change
- # without notice, as it depends on models that are constantly being
- # improved. However, it will change less frequently than the confidence
- # score below, and should be preferred for referencing the quality of an
- # answer.
- "matchConfidence": 3.14, # The system's confidence score that this Knowledge answer is a good match
- # for this conversational query.
- # The range is from 0.0 (completely uncertain) to 1.0 (completely certain).
- # Note: The confidence score is likely to vary somewhat (possibly even for
- # identical requests), as the underlying model is under constant
- # improvement. It may be deprecated in the future. We recommend using
- # `match_confidence_level` which should be generally more stable.
- },
- ],
- },
- "sentimentAnalysisResult": { # The result of sentiment analysis as configured by # The sentiment analysis result, which depends on the
- # `sentiment_analysis_request_config` specified in the request.
- # `sentiment_analysis_request_config`.
- "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit # The sentiment analysis result for `query_text`.
- # of analysis, such as the query text.
- "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive
- # sentiment).
- "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents the absolute
- # magnitude of sentiment, regardless of score (positive or negative).
- },
- },
- "intentDetectionConfidence": 3.14, # The intent detection confidence. Values range from 0.0
- # (completely uncertain) to 1.0 (completely certain).
- # This value is for informational purpose only and is only used to
- # help match the best intent within the classification threshold.
- # This value may change for the same end-user expression at any time due to a
- # model retraining or change in implementation.
- # If there are `multiple knowledge_answers` messages, this value is set to
- # the greatest `knowledgeAnswers.match_confidence` value in the list.
},
],
"responseId": "A String", # The unique identifier of the response. It can be used to
@@ -3116,12 +3126,6 @@
# rate, then the synthesizer will honor this request by converting to the
# desired sample rate (which might result in worse audio quality).
},
- "outputAudio": "A String", # The audio data bytes encoded as specified in the request.
- # Note: The output audio is generated based on the values of default platform
- # text responses found in the `query_result.fulfillment_messages` field. If
- # multiple default text responses exist, they will be concatenated when
- # generating audio. If no default platform text responses exist, the
- # generated audio content will be empty.
}</pre>
</div>