Class Intent (1.1.2)

An intent categorizes an end-user’s intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the intent guide <https://cloud.google.com/dialogflow/docs/intents-overview>__.

Required. The name of this intent.

Optional. The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.

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.

Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.

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.

Inheritance

builtins.object > google.protobuf.pyext._message.CMessage > builtins.object > google.protobuf.message.Message > Intent

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

A rich response message. Corresponds to the intent Response field in the Dialogflow console. For more information, see Rich response messages <https://cloud.google.com/dialogflow/docs/intents-rich- messages>__.

The text response.

The quick replies response.

A custom platform-specific response.

The basic card response for Actions on Google.

The link out suggestion chip for Actions on Google.

The carousel card response for Actions on Google.

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.