Class Intent (0.8.2)

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

An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.

Attributes

NameDescription
name str
The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: projects/.
display_name str
Required. The human-readable name of the intent, unique within the agent.
training_phrases Sequence[google.cloud.dialogflowcx_v3beta1.types.Intent.TrainingPhrase]
The collection of training phrases the agent is trained on to identify the intent.
parameters Sequence[google.cloud.dialogflowcx_v3beta1.types.Intent.Parameter]
The collection of parameters associated with the intent.
priority int
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
Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
labels Sequence[google.cloud.dialogflowcx_v3beta1.types.Intent.LabelsEntry]
The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: - sys-head - sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
description str
Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.

Classes

LabelsEntry

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

The abstract base class for a message.

Parameters
NameDescription
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

Parameter

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

Represents an intent parameter. .. attribute:: id

Required. The unique identifier of the parameter. This field is used by [training phrases][google.cloud.dialogflow.cx.v3beta1.Intent.TrainingPhrase] to annotate their parts.

:type: str

TrainingPhrase

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

Represents an example that the agent is trained on to identify the intent.