Class Intent
Represents a Dialogflow intent. Intents convert a number of user expressions or patterns into an action. An action is an extraction of a user command or sentence semantics.
To get more information about Intent, see:
- API documentation
- How-to Guides
- Official Documentation
Example Usage - Dialogflow Intent Basic
using Pulumi;
using Gcp = Pulumi.Gcp;
class MyStack : Stack
{
public MyStack()
{
var basicAgent = new Gcp.Diagflow.Agent("basicAgent", new Gcp.Diagflow.AgentArgs
{
DisplayName = "example_agent",
DefaultLanguageCode = "en",
TimeZone = "America/New_York",
});
var basicIntent = new Gcp.Diagflow.Intent("basicIntent", new Gcp.Diagflow.IntentArgs
{
DisplayName = "basic-intent",
});
}
}
Inherited Members
Namespace: Pulumi.Gcp.Diagflow
Assembly: Pulumi.Gcp.dll
Syntax
public class Intent : CustomResource
Constructors
View SourceIntent(String, IntentArgs, CustomResourceOptions)
Create a Intent resource with the given unique name, arguments, and options.
Declaration
public Intent(string name, IntentArgs args, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resource |
| IntentArgs | args | The arguments used to populate this resource's properties |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Properties
View SourceAction
The name of the action associated with the intent. Note: The action name must not contain whitespaces.
Declaration
public Output<string> Action { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
DefaultResponsePlatforms
The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
Declaration
public Output<ImmutableArray<string>> DefaultResponsePlatforms { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Collections.Immutable.ImmutableArray<System.String>> |
DisplayName
The name of this intent to be displayed on the console.
Declaration
public Output<string> DisplayName { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Events
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. See the events reference for more details.
Declaration
public Output<ImmutableArray<string>> Events { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Collections.Immutable.ImmutableArray<System.String>> |
FollowupIntentInfos
Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.
Declaration
public Output<ImmutableArray<IntentFollowupIntentInfo>> FollowupIntentInfos { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Collections.Immutable.ImmutableArray<IntentFollowupIntentInfo>> |
InputContextNames
The list of context names required for this intent to be triggered. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.
Declaration
public Output<ImmutableArray<string>> InputContextNames { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Collections.Immutable.ImmutableArray<System.String>> |
IsFallback
Indicates whether this is a fallback intent.
Declaration
public Output<bool> IsFallback { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Boolean> |
MlDisabled
Indicates whether Machine Learning is disabled for the intent. Note: If mlDisabled 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.
Declaration
public Output<bool> MlDisabled { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Boolean> |
Name
The unique identifier of this intent. Format: projects/<Project ID>/agent/intents/<Intent ID>.
Declaration
public Output<string> Name { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
ParentFollowupIntentName
The unique identifier of the parent intent in the chain of followup intents. Format: projects/<Project ID>/agent/intents/<Intent ID>.
Declaration
public Output<string> ParentFollowupIntentName { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Priority
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.
Declaration
public Output<int> Priority { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Int32> |
Project
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Declaration
public Output<string> Project { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
ResetContexts
Indicates whether to delete all contexts in the current session when this intent is matched.
Declaration
public Output<bool> ResetContexts { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Boolean> |
RootFollowupIntentName
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/<Project ID>/agent/intents/<Intent ID>.
Declaration
public Output<string> RootFollowupIntentName { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
WebhookState
Indicates whether webhooks are enabled for the intent.
- WEBHOOK_STATE_ENABLED: Webhook is enabled in the agent and in the intent.
- WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING: Webhook is enabled in the agent and in the intent. Also, each slot filling prompt is forwarded to the webhook.
Declaration
public Output<string> WebhookState { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Methods
View SourceGet(String, Input<String>, IntentState, CustomResourceOptions)
Get an existing Intent resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
Declaration
public static Intent Get(string name, Input<string> id, IntentState state = null, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resulting resource. |
| Input<System.String> | id | The unique provider ID of the resource to lookup. |
| IntentState | state | Any extra arguments used during the lookup. |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Returns
| Type | Description |
|---|---|
| Intent |