Class Intent (2.24.0)

Version 2.24.0

• 2.36.0 (latest)
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.2
• 2.29.0
• 2.28.3
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.1
• 2.23.3
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.1
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.2
• 2.14.1
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.1
• 2.8.1
• 2.7.1
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.2
• 2.0.0
• 1.1.3
• 1.0.0
• 0.8.0
• 0.7.2

Intent(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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>__.

Attributes
Name	Description
name	str Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats: - projects/ - projects/
display_name	str Required. The name of this intent.
webhook_state	google.cloud.dialogflow_v2beta1.types.Intent.WebhookState Optional. Indicates whether webhooks are enabled for the intent.
priority	int 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.
is_fallback	bool Optional. Indicates whether this is a fallback intent.
ml_enabled	bool 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.
ml_disabled	bool 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.
live_agent_handoff	bool Optional. Indicates that a live agent should be brought in to handle the interaction with the user. In most cases, when you set this flag to true, you would also want to set end_interaction to true as well. Default is false.
end_interaction	bool 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.
input_context_names	MutableSequence[str] Optional. The list of context names required for this intent to be triggered. Formats: - projects/ - projects/
events	MutableSequence[str] 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.
training_phrases	MutableSequence[google.cloud.dialogflow_v2beta1.types.Intent.TrainingPhrase] Optional. The collection of examples that the agent is trained on.
action	str Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.
output_contexts	MutableSequence[google.cloud.dialogflow_v2beta1.types.Context] Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the lifespan_count to 0 will reset the context when the intent is matched. Format: projects/.
reset_contexts	bool Optional. Indicates whether to delete all contexts in the current session when this intent is matched.
parameters	MutableSequence[google.cloud.dialogflow_v2beta1.types.Intent.Parameter] Optional. The collection of parameters associated with the intent.
messages	MutableSequence[google.cloud.dialogflow_v2beta1.types.Intent.Message] Optional. The collection of rich messages corresponding to the Response field in the Dialogflow console.
default_response_platforms	MutableSequence[google.cloud.dialogflow_v2beta1.types.Intent.Message.Platform] Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
root_followup_intent_name	str 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/.
parent_followup_intent_name	str Optional. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent. Format: projects/.
followup_intent_info	MutableSequence[google.cloud.dialogflow_v2beta1.types.Intent.FollowupIntentInfo] Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

Classes

FollowupIntentInfo

FollowupIntentInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents a single followup intent in the chain.

Message

Message(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Corresponds to the Response field in the Dialogflow console.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Parameter

Parameter(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents intent parameters.

TrainingPhrase

TrainingPhrase(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents an example that the agent is trained on.

WebhookState

WebhookState(value)

Represents the different states that webhooks can be in.

Values: WEBHOOK_STATE_UNSPECIFIED (0): Webhook is disabled in the agent and in the intent. WEBHOOK_STATE_ENABLED (1): Webhook is enabled in the agent and in the intent. WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING (2): Webhook is enabled in the agent and in the intent. Also, each slot filling prompt is forwarded to the webhook.