public sealed class Intent : IMessage<Intent>, IEquatable<Intent>, IDeepCloneable<Intent>, IBufferMessage, IMessageReference documentation and code samples for the Dialogflow v3 API class Intent.
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.
Namespace
GoogleCloudGoogle.Cloud.DialogflowGoogle.Cloud.Dialogflow.CxV3Assembly
Google.Cloud.Dialogflow.Cx.V3.dll
Constructors
Intent()
public Intent()Intent(Intent)
public Intent(Intent other)| Parameter | |
|---|---|
| Name | Description |
other | Intent |
Properties
Description
public string Description { get; set; }Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
| Property Value | |
|---|---|
| Type | Description |
string | |
DisplayName
public string DisplayName { get; set; }Required. The human-readable name of the intent, unique within the agent.
| Property Value | |
|---|---|
| Type | Description |
string | |
IntentName
public IntentName IntentName { get; set; }IntentName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
IntentName | |
IsFallback
public bool IsFallback { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool | |
Labels
public MapField<string, string> Labels { get; }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.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring | |
Name
public string Name { get; set; }The unique identifier of the intent.
Required for the
[Intents.UpdateIntent][google.cloud.dialogflow.cx.v3.Intents.UpdateIntent]
method.
[Intents.CreateIntent][google.cloud.dialogflow.cx.v3.Intents.CreateIntent]
populates the name automatically.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/intents/<Intent ID>.
| Property Value | |
|---|---|
| Type | Description |
string | |
Parameters
public RepeatedField<Intent.Types.Parameter> Parameters { get; }The collection of parameters associated with the intent.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldIntentTypesParameter | |
Priority
public int Priority { get; set; }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
Normalpriority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.
| Property Value | |
|---|---|
| Type | Description |
int | |
TrainingPhrases
public RepeatedField<Intent.Types.TrainingPhrase> TrainingPhrases { get; }The collection of training phrases the agent is trained on to identify the intent.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldIntentTypesTrainingPhrase | |