Struct aws_sdk_lexmodelsv2::input::CreateIntentInput

#[non_exhaustive]
pub struct CreateIntentInput {

    pub intent_name: Option<String>,
    pub description: Option<String>,
    pub parent_intent_signature: Option<String>,
    pub sample_utterances: Option<Vec<SampleUtterance>>,
    pub dialog_code_hook: Option<DialogCodeHookSettings>,
    pub fulfillment_code_hook: Option<FulfillmentCodeHookSettings>,
    pub intent_confirmation_setting: Option<IntentConfirmationSetting>,
    pub intent_closing_setting: Option<IntentClosingSetting>,
    pub input_contexts: Option<Vec<InputContext>>,
    pub output_contexts: Option<Vec<OutputContext>>,
    pub kendra_configuration: Option<KendraConfiguration>,
    pub bot_id: Option<String>,
    pub bot_version: Option<String>,
    pub locale_id: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

intent_name: Option<String>

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.

description: Option<String>

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

parent_intent_signature: Option<String>

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

sample_utterances: Option<Vec<SampleUtterance>>

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..

dialog_code_hook: Option<DialogCodeHookSettings>

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.

fulfillment_code_hook: Option<FulfillmentCodeHookSettings>

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.

intent_confirmation_setting: Option<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.

intent_closing_setting: Option<IntentClosingSetting>

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

input_contexts: Option<Vec<InputContext>>

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.

output_contexts: Option<Vec<OutputContext>>

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.

kendra_configuration: Option<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.

bot_id: Option<String>

The identifier of the bot associated with this intent.

bot_version: Option<String>

The identifier of the version of the bot associated with this intent.

locale_id: Option<String>

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.

Implementations

impl CreateIntentInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<CreateIntent, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<CreateIntent>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateIntentInput

impl CreateIntentInput

pub fn intent_name(&self) -> Option<&str>

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.

pub fn description(&self) -> Option<&str>

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

pub fn parent_intent_signature(&self) -> Option<&str>

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

pub fn sample_utterances(&self) -> Option<&[SampleUtterance]>

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..

pub fn dialog_code_hook(&self) -> Option<&DialogCodeHookSettings>

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.

pub fn fulfillment_code_hook(&self) -> Option<&FulfillmentCodeHookSettings>

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.

pub fn intent_confirmation_setting(&self) -> Option<&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.

pub fn intent_closing_setting(&self) -> Option<&IntentClosingSetting>

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

pub fn input_contexts(&self) -> Option<&[InputContext]>

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.

pub fn output_contexts(&self) -> Option<&[OutputContext]>

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.

pub fn kendra_configuration(&self) -> Option<&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.

pub fn bot_id(&self) -> Option<&str>

The identifier of the bot associated with this intent.

pub fn bot_version(&self) -> Option<&str>

The identifier of the version of the bot associated with this intent.

pub fn locale_id(&self) -> Option<&str>

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.

Trait Implementations

impl Clone for CreateIntentInput

fn clone(&self) -> CreateIntentInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateIntentInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<CreateIntentInput> for CreateIntentInput

fn eq(&self, other: &CreateIntentInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CreateIntentInput) -> bool

This method tests for !=.

impl StructuralPartialEq for CreateIntentInput