public sealed class Intent : IMessage<Intent>, IEquatable<Intent>, IDeepCloneable<Intent>, IBufferMessage, IMessageReference documentation and code samples for the Google Cloud Dialogflow v2 API class Intent.
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.
Namespace
Google.Cloud.Dialogflow.V2Assembly
Google.Cloud.Dialogflow.V2.dll
Constructors
Intent()
public Intent()Intent(Intent)
public Intent(Intent other)| Parameter | |
|---|---|
| Name | Description |
other |
Intent |
Properties
Action
public string Action { get; set; }Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.
| Property Value | |
|---|---|
| Type | Description |
string |
|
DefaultResponsePlatforms
public RepeatedField<Intent.Types.Message.Types.Platform> DefaultResponsePlatforms { get; }Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldIntentTypesMessageTypesPlatform |
|
DisplayName
public string DisplayName { get; set; }Required. The name of this intent.
| Property Value | |
|---|---|
| Type | Description |
string |
|
EndInteraction
public bool EndInteraction { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Events
public RepeatedField<string> Events { get; }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.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|
FollowupIntentInfo
public RepeatedField<Intent.Types.FollowupIntentInfo> FollowupIntentInfo { get; }Output only. 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.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldIntentTypesFollowupIntentInfo |
|
InputContextNames
public RepeatedField<string> InputContextNames { get; }Optional. The list of context names required for this intent to be
triggered.
Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|
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; }Optional. Indicates whether this is a fallback intent.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
LiveAgentHandoff
public bool LiveAgentHandoff { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Messages
public RepeatedField<Intent.Types.Message> Messages { get; }Optional. The collection of rich messages corresponding to the
Response field in the Dialogflow console.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldIntentTypesMessage |
|
MlDisabled
public bool MlDisabled { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Name
public string Name { get; set; }Optional. The unique identifier of this intent.
Required for
[Intents.UpdateIntent][google.cloud.dialogflow.v2.Intents.UpdateIntent] and
[Intents.BatchUpdateIntents][google.cloud.dialogflow.v2.Intents.BatchUpdateIntents]
methods.
Format: projects/<Project ID>/agent/intents/<Intent ID>.
| Property Value | |
|---|---|
| Type | Description |
string |
|
OutputContexts
public RepeatedField<Context> OutputContexts { get; }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/<Project ID>/agent/sessions/-/contexts/<Context ID>.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldContext |
|
Parameters
public RepeatedField<Intent.Types.Parameter> Parameters { get; }Optional. The collection of parameters associated with the intent.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldIntentTypesParameter |
|
ParentFollowupIntentName
public string ParentFollowupIntentName { get; set; }Read-only after creation. 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][google.cloud.dialogflow.v2.Intents.CreateIntent] or [BatchUpdateIntents][google.cloud.dialogflow.v2.Intents.BatchUpdateIntents], in order to make this intent a followup intent.
It identifies the parent followup intent.
Format: projects/<Project ID>/agent/intents/<Intent ID>.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Priority
public int Priority { get; set; }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
Normalpriority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.
| Property Value | |
|---|---|
| Type | Description |
int |
|
ResetContexts
public bool ResetContexts { get; set; }Optional. Indicates whether to delete all contexts in the current session when this intent is matched.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
RootFollowupIntentName
public string RootFollowupIntentName { get; set; }Output only. 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>.
| Property Value | |
|---|---|
| Type | Description |
string |
|
TrainingPhrases
public RepeatedField<Intent.Types.TrainingPhrase> TrainingPhrases { get; }Optional. The collection of examples that the agent is trained on.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldIntentTypesTrainingPhrase |
|
WebhookState
public Intent.Types.WebhookState WebhookState { get; set; }Optional. Indicates whether webhooks are enabled for the intent.
| Property Value | |
|---|---|
| Type | Description |
IntentTypesWebhookState |
|