AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateIntent operation. Creates an intent.

To define the interaction between the user and your bot, you define one or more intents. For example, for a pizza ordering bot you would create an OrderPizza intent.

When you create an intent, you must provide a name. You can optionally provide the following:

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.LexModelsV2.AmazonLexModelsV2Request
      Amazon.LexModelsV2.Model.CreateIntentRequest

Namespace: Amazon.LexModelsV2.Model
Assembly: AWSSDK.LexModelsV2.dll
Version: 3.x.y.z

Syntax

C#
public class CreateIntentRequest : AmazonLexModelsV2Request
         IAmazonWebServiceRequest

The CreateIntentRequest type exposes the following members

Constructors

NameDescription
Public Method CreateIntentRequest()

Properties

NameTypeDescription
Public Property BotId System.String

Gets and sets the property BotId.

The identifier of the bot associated with this intent.

Public Property BotVersion System.String

Gets and sets the property BotVersion.

The version of the bot associated with this intent.

Public Property Description System.String

Gets and sets the property Description.

A description of the intent. Use the description to help identify the intent in lists.

Public Property DialogCodeHook Amazon.LexModelsV2.Model.DialogCodeHookSettings

Gets and sets the property DialogCodeHook.

Specifies that Amazon Lex invokes the alias Lambda function for each user input. You can invoke this Lambda function to personalize user interaction.

For example, suppose that your bot determines that the user's name is John. You Lambda function might retrieve John's information from a backend database and prepopulate some of the values. For example, if you find that John is gluten intolerant, you might set the corresponding intent slot, glutenIntolerant to true. You might find John's phone number and set the corresponding session attribute.

Public Property FulfillmentCodeHook Amazon.LexModelsV2.Model.FulfillmentCodeHookSettings

Gets and sets the property FulfillmentCodeHook.

Specifies that Amazon Lex invokes the alias Lambda function when the intent is ready for fulfillment. You can invoke this function to complete the bot's transaction with the user.

For example, in a pizza ordering bot, the Lambda function can look up the closest pizza restaurant to the customer's location and then place an order on the customer's behalf.

Public Property InitialResponseSetting Amazon.LexModelsV2.Model.InitialResponseSetting

Gets and sets the property InitialResponseSetting.

Configuration settings for the response that is sent to the user at the beginning of a conversation, before eliciting slot values.

Public Property InputContexts System.Collections.Generic.List<Amazon.LexModelsV2.Model.InputContext>

Gets and sets the property InputContexts.

A list of contexts that must be active for this intent to be considered by Amazon Lex.

When an intent has an input context list, Amazon Lex only considers using the intent in an interaction with the user when the specified contexts are included in the active context list for the session. If the contexts are not active, then Amazon Lex will not use the intent.

A context can be automatically activated using the outputContexts property or it can be set at runtime.

For example, if there are two intents with different input contexts that respond to the same utterances, only the intent with the active context will respond.

An intent may have up to 5 input contexts. If an intent has multiple input contexts, all of the contexts must be active to consider the intent.

Public Property IntentClosingSetting Amazon.LexModelsV2.Model.IntentClosingSetting

Gets and sets the property IntentClosingSetting.

Sets the response that Amazon Lex sends to the user when the intent is closed.

Public Property IntentConfirmationSetting Amazon.LexModelsV2.Model.IntentConfirmationSetting

Gets and sets the property IntentConfirmationSetting.

Provides prompts that Amazon Lex sends to the user to confirm the completion of an intent. If the user answers "no," the settings contain a statement that is sent to the user to end the intent.

Public Property IntentName System.String

Gets and sets the property IntentName.

The name of the intent. Intent names must be unique in the locale that contains the intent and cannot match the name of any built-in intent.

Public Property KendraConfiguration Amazon.LexModelsV2.Model.KendraConfiguration

Gets and sets the property KendraConfiguration.

Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. The AMAZON.KendraSearchIntent intent is called when Amazon Lex can't determine another intent to invoke.

Public Property LocaleId System.String

Gets and sets the property LocaleId.

The identifier of the language and locale where this intent is used. All of the bots, slot types, and slots used by the intent must have the same locale. For more information, see Supported languages.

Public Property OutputContexts System.Collections.Generic.List<Amazon.LexModelsV2.Model.OutputContext>

Gets and sets the property OutputContexts.

A lists of contexts that the intent activates when it is fulfilled.

You can use an output context to indicate the intents that Amazon Lex should consider for the next turn of the conversation with a customer.

When you use the outputContextsList property, all of the contexts specified in the list are activated when the intent is fulfilled. You can set up to 10 output contexts. You can also set the number of conversation turns that the context should be active, or the length of time that the context should be active.

Public Property ParentIntentSignature System.String

Gets and sets the property ParentIntentSignature.

A unique identifier for the built-in intent to base this intent on.

Public Property QInConnectIntentConfiguration Amazon.LexModelsV2.Model.QInConnectIntentConfiguration

Gets and sets the property QInConnectIntentConfiguration.

Qinconnect intent configuration details for the create intent request.

Public Property QnAIntentConfiguration Amazon.LexModelsV2.Model.QnAIntentConfiguration

Gets and sets the property QnAIntentConfiguration.

Specifies the configuration of the built-in Amazon.QnAIntent. The AMAZON.QnAIntent intent is called when Amazon Lex can't determine another intent to invoke. If you specify this field, you can't specify the kendraConfiguration field.

Public Property SampleUtterances System.Collections.Generic.List<Amazon.LexModelsV2.Model.SampleUtterance>

Gets and sets the property SampleUtterances.

An array of strings that a user might say to signal the intent. For example, "I want a pizza", or "I want a {PizzaSize} pizza".

In an utterance, slot names are enclosed in curly braces ("{", "}") to indicate where they should be displayed in the utterance shown to the user..

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5