Represents an intent. Intents convert a number of user expressions or patterns into an action. An action is an extraction of a user command or sentence semantics.
Required. The name of this intent.
Optional. The priority of this intent. Higher numbers represent higher priorities. If this is zero or unspecified, we use the default priority 500000. Negative numbers mean that the intent is disabled.
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.
Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.
Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent.
Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.
Optional. Indicates whether to delete all contexts in the current session when this intent is matched.
Optional. The collection of rich messages corresponding to the
Response field in the Dialogflow console.
Read-only. The unique identifier of the root intent in the
chain of followup intents. It identifies the correct followup
intents chain for this intent. We populate this field only in
the output. Format: projects/<Project
ID>/agent/intents/<Intent ID>.
Read-only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.
Classes
FollowupIntentInfo
Represents a single followup intent in the chain.
The unique identifier of the followup intent's parent. Format:
projects/<Project ID>/agent/intents/<Intent ID>.
Message
Corresponds to the Response field in the Dialogflow console.
Returns a text response.
Displays quick replies.
Returns a response containing a custom, platform-specific payload. See the Intent.Message.Platform type for a description of the structure that may be required for your platform.
Displays a basic card for Actions on Google.
Displays a link out suggestion chip for Actions on Google.
Displays a carousel card for Actions on Google.
Synthesizes speech in Telephony Gateway.
Rich Business Messaging (RBM) text response. RBM allows businesses to send enriched and branded versions of SMS. See https://jibe.google.com/business-messaging.
Rich Business Messaging (RBM) carousel rich card response.
Table card for Actions on Google.
Optional. The platform that this message is intended for.
Parameter
Represents intent parameters.
Required. The name of the parameter.
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.
Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.
Optional. Indicates whether the parameter represents a list of values.
TrainingPhrase
Represents an example that the agent is trained on.
Required. The type of the training phrase.
Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased.