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

Create a Intent Resource

new Intent(name: string, args: IntentArgs, opts?: CustomResourceOptions);

def Intent(resource_name, opts=None, action=None, default_response_platforms=None, display_name=None, events=None, input_context_names=None, is_fallback=None, ml_disabled=None, parent_followup_intent_name=None, priority=None, project=None, reset_contexts=None, webhook_state=None, __props__=None);

func NewIntent(ctx *Context, name string, args IntentArgs, opts ...ResourceOption) (*Intent, error)

public Intent(string name, IntentArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args IntentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args IntentArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args IntentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Intent Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Intent resource accepts the following input properties:

DisplayName string: The name of this intent to be displayed on the console.
Action string: The name of the action associated with the intent. Note: The action name must not contain whitespaces.
DefaultResponsePlatforms List<string>: The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
Events List<string>: 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.
InputContextNames List<string>: The list of context names required for this intent to be triggered. Format: projects//agent/sessions/-/contexts/.
IsFallback bool: Indicates whether this is a fallback intent.
MlDisabled bool: 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.
ParentFollowupIntentName string: The unique identifier of the parent intent in the chain of followup intents. Format: projects//agent/intents/.
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.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
ResetContexts bool: Indicates whether to delete all contexts in the current session when this intent is matched.
WebhookState string: 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.

DisplayName string: The name of this intent to be displayed on the console.
Action string: The name of the action associated with the intent. Note: The action name must not contain whitespaces.
DefaultResponsePlatforms []string: The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
Events []string: 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.
InputContextNames []string: The list of context names required for this intent to be triggered. Format: projects//agent/sessions/-/contexts/.
IsFallback bool: Indicates whether this is a fallback intent.
MlDisabled bool: 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.
ParentFollowupIntentName string: The unique identifier of the parent intent in the chain of followup intents. Format: projects//agent/intents/.
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.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
ResetContexts bool: Indicates whether to delete all contexts in the current session when this intent is matched.
WebhookState string: 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.

displayName string: The name of this intent to be displayed on the console.
action string: The name of the action associated with the intent. Note: The action name must not contain whitespaces.
defaultResponsePlatforms string[]: The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
events string[]: 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.
inputContextNames string[]: The list of context names required for this intent to be triggered. Format: projects//agent/sessions/-/contexts/.
isFallback boolean: Indicates whether this is a fallback intent.
mlDisabled boolean: 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.
parentFollowupIntentName string: The unique identifier of the parent intent in the chain of followup intents. Format: projects//agent/intents/.
priority number: 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.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
resetContexts boolean: Indicates whether to delete all contexts in the current session when this intent is matched.
webhookState string: 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.

display_name str: The name of this intent to be displayed on the console.
action str: The name of the action associated with the intent. Note: The action name must not contain whitespaces.
default_response_platforms List[str]: The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
events List[str]: 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.
input_context_names List[str]: The list of context names required for this intent to be triggered. Format: projects//agent/sessions/-/contexts/.
is_fallback bool: Indicates whether this is a fallback intent.
ml_disabled bool: 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.
parent_followup_intent_name str: The unique identifier of the parent intent in the chain of followup intents. Format: projects//agent/intents/.
priority float: 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.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
reset_contexts bool: Indicates whether to delete all contexts in the current session when this intent is matched.
webhook_state str: 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.

Outputs

All input properties are implicitly available as output properties. Additionally, the Intent resource produces the following output properties:

FollowupIntentInfos List<IntentFollowupIntentInfo>: Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.
Id string: The provider-assigned unique ID for this managed resource.
Name string: The unique identifier of this intent. Format: projects//agent/intents/.
RootFollowupIntentName string: 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//agent/intents/.

FollowupIntentInfos []IntentFollowupIntentInfo: Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.
Id string: The provider-assigned unique ID for this managed resource.
Name string: The unique identifier of this intent. Format: projects//agent/intents/.
RootFollowupIntentName string: 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//agent/intents/.

followupIntentInfos IntentFollowupIntentInfo[]: Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.
id string: The provider-assigned unique ID for this managed resource.
name string: The unique identifier of this intent. Format: projects//agent/intents/.
rootFollowupIntentName string: 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//agent/intents/.

followup_intent_infos List[IntentFollowupIntentInfo]: Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.
id str: The provider-assigned unique ID for this managed resource.
name str: The unique identifier of this intent. Format: projects//agent/intents/.
root_followup_intent_name str: 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//agent/intents/.

Look up an Existing Intent Resource

Get an existing Intent resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: IntentState, opts?: CustomResourceOptions): Intent

static get(resource_name, id, opts=None, action=None, default_response_platforms=None, display_name=None, events=None, followup_intent_infos=None, input_context_names=None, is_fallback=None, ml_disabled=None, name=None, parent_followup_intent_name=None, priority=None, project=None, reset_contexts=None, root_followup_intent_name=None, webhook_state=None, __props__=None);

func GetIntent(ctx *Context, name string, id IDInput, state *IntentState, opts ...ResourceOption) (*Intent, error)

public static Intent Get(string name, Input<string> id, IntentState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Action string: The name of the action associated with the intent. Note: The action name must not contain whitespaces.
DefaultResponsePlatforms List<string>: The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
DisplayName string: The name of this intent to be displayed on the console.
Events List<string>: 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.
FollowupIntentInfos List<IntentFollowupIntentInfoArgs>: Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.
InputContextNames List<string>: The list of context names required for this intent to be triggered. Format: projects//agent/sessions/-/contexts/.
IsFallback bool: Indicates whether this is a fallback intent.
MlDisabled bool: 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.
Name string: The unique identifier of this intent. Format: projects//agent/intents/.
ParentFollowupIntentName string: The unique identifier of the parent intent in the chain of followup intents. Format: projects//agent/intents/.
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.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
ResetContexts bool: Indicates whether to delete all contexts in the current session when this intent is matched.
RootFollowupIntentName string: 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//agent/intents/.
WebhookState string: 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.

Action string: The name of the action associated with the intent. Note: The action name must not contain whitespaces.
DefaultResponsePlatforms []string: The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
DisplayName string: The name of this intent to be displayed on the console.
Events []string: 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.
FollowupIntentInfos []IntentFollowupIntentInfo: Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.
InputContextNames []string: The list of context names required for this intent to be triggered. Format: projects//agent/sessions/-/contexts/.
IsFallback bool: Indicates whether this is a fallback intent.
MlDisabled bool: 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.
Name string: The unique identifier of this intent. Format: projects//agent/intents/.
ParentFollowupIntentName string: The unique identifier of the parent intent in the chain of followup intents. Format: projects//agent/intents/.
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.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
ResetContexts bool: Indicates whether to delete all contexts in the current session when this intent is matched.
RootFollowupIntentName string: 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//agent/intents/.
WebhookState string: 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.

action string: The name of the action associated with the intent. Note: The action name must not contain whitespaces.
defaultResponsePlatforms string[]: The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
displayName string: The name of this intent to be displayed on the console.
events string[]: 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.
followupIntentInfos IntentFollowupIntentInfo[]: Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.
inputContextNames string[]: The list of context names required for this intent to be triggered. Format: projects//agent/sessions/-/contexts/.
isFallback boolean: Indicates whether this is a fallback intent.
mlDisabled boolean: 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.
name string: The unique identifier of this intent. Format: projects//agent/intents/.
parentFollowupIntentName string: The unique identifier of the parent intent in the chain of followup intents. Format: projects//agent/intents/.
priority number: 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.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
resetContexts boolean: Indicates whether to delete all contexts in the current session when this intent is matched.
rootFollowupIntentName string: 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//agent/intents/.
webhookState string: 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.

action str: The name of the action associated with the intent. Note: The action name must not contain whitespaces.
default_response_platforms List[str]: The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
display_name str: The name of this intent to be displayed on the console.
events List[str]: 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.
followup_intent_infos List[IntentFollowupIntentInfo]: Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.
input_context_names List[str]: The list of context names required for this intent to be triggered. Format: projects//agent/sessions/-/contexts/.
is_fallback bool: Indicates whether this is a fallback intent.
ml_disabled bool: 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.
name str: The unique identifier of this intent. Format: projects//agent/intents/.
parent_followup_intent_name str: The unique identifier of the parent intent in the chain of followup intents. Format: projects//agent/intents/.
priority float: 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.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
reset_contexts bool: Indicates whether to delete all contexts in the current session when this intent is matched.
root_followup_intent_name str: 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//agent/intents/.
webhook_state str: 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.

Supporting Types

IntentFollowupIntentInfo

See the output API doc for this type.

FollowupIntentName string
ParentFollowupIntentName string: The unique identifier of the parent intent in the chain of followup intents. Format: projects//agent/intents/.

FollowupIntentName string
ParentFollowupIntentName string: The unique identifier of the parent intent in the chain of followup intents. Format: projects//agent/intents/.

followupIntentName string
parentFollowupIntentName string: The unique identifier of the parent intent in the chain of followup intents. Format: projects//agent/intents/.

followupIntentName str
parent_followup_intent_name str: The unique identifier of the parent intent in the chain of followup intents. Format: projects//agent/intents/.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud