Struct aws_sdk_lexmodelsv2::input::create_intent_input::Builder

pub struct Builder { /* private fields */ }

A builder for CreateIntentInput.

Implementations

impl Builder

pub fn intent_name(self, input: impl Into<String>) -> Self

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.

Examples found in repository

src/client.rs (line 2301)

        pub fn intent_name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.intent_name(input.into());
            self
        }

pub fn set_intent_name(self, input: Option<String>) -> Self

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.

Examples found in repository

src/client.rs (line 2306)

        pub fn set_intent_name(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_intent_name(input);
            self
        }

pub fn description(self, input: impl Into<String>) -> Self

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

Examples found in repository

src/client.rs (line 2311)

        pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.description(input.into());
            self
        }

pub fn set_description(self, input: Option<String>) -> Self

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

Examples found in repository

src/client.rs (line 2316)

        pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_description(input);
            self
        }

pub fn parent_intent_signature(self, input: impl Into<String>) -> Self

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

Examples found in repository

src/client.rs (line 2321)

        pub fn parent_intent_signature(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.parent_intent_signature(input.into());
            self
        }

pub fn set_parent_intent_signature(self, input: Option<String>) -> Self

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

Examples found in repository

src/client.rs (line 2329)

        pub fn set_parent_intent_signature(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_parent_intent_signature(input);
            self
        }

pub fn sample_utterances(self, input: SampleUtterance) -> Self

Appends an item to sample_utterances.

To override the contents of this collection use set_sample_utterances.

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

Examples found in repository

src/client.rs (line 2339)

        pub fn sample_utterances(mut self, input: crate::model::SampleUtterance) -> Self {
            self.inner = self.inner.sample_utterances(input);
            self
        }

pub fn set_sample_utterances(self, input: Option<Vec<SampleUtterance>>) -> Self

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

Examples found in repository

src/client.rs (line 2348)

        pub fn set_sample_utterances(
            mut self,
            input: std::option::Option<std::vec::Vec<crate::model::SampleUtterance>>,
        ) -> Self {
            self.inner = self.inner.set_sample_utterances(input);
            self
        }

pub fn dialog_code_hook(self, input: DialogCodeHookSettings) -> Self

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.

Examples found in repository

src/client.rs (line 2354)

        pub fn dialog_code_hook(mut self, input: crate::model::DialogCodeHookSettings) -> Self {
            self.inner = self.inner.dialog_code_hook(input);
            self
        }

pub fn set_dialog_code_hook(self, input: Option<DialogCodeHookSettings>) -> Self

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.

Examples found in repository

src/client.rs (line 2363)

        pub fn set_dialog_code_hook(
            mut self,
            input: std::option::Option<crate::model::DialogCodeHookSettings>,
        ) -> Self {
            self.inner = self.inner.set_dialog_code_hook(input);
            self
        }

pub fn fulfillment_code_hook(self, input: FulfillmentCodeHookSettings) -> Self

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.

Examples found in repository

src/client.rs (line 2372)

        pub fn fulfillment_code_hook(
            mut self,
            input: crate::model::FulfillmentCodeHookSettings,
        ) -> Self {
            self.inner = self.inner.fulfillment_code_hook(input);
            self
        }

pub fn set_fulfillment_code_hook(
    self,
    input: Option<FulfillmentCodeHookSettings>
) -> Self

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.

Examples found in repository

src/client.rs (line 2381)

        pub fn set_fulfillment_code_hook(
            mut self,
            input: std::option::Option<crate::model::FulfillmentCodeHookSettings>,
        ) -> Self {
            self.inner = self.inner.set_fulfillment_code_hook(input);
            self
        }

pub fn intent_confirmation_setting(
    self,
    input: IntentConfirmationSetting
) -> Self

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.

Examples found in repository

src/client.rs (line 2389)

        pub fn intent_confirmation_setting(
            mut self,
            input: crate::model::IntentConfirmationSetting,
        ) -> Self {
            self.inner = self.inner.intent_confirmation_setting(input);
            self
        }

pub fn set_intent_confirmation_setting(
    self,
    input: Option<IntentConfirmationSetting>
) -> Self

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.

Examples found in repository

src/client.rs (line 2397)

        pub fn set_intent_confirmation_setting(
            mut self,
            input: std::option::Option<crate::model::IntentConfirmationSetting>,
        ) -> Self {
            self.inner = self.inner.set_intent_confirmation_setting(input);
            self
        }

pub fn intent_closing_setting(self, input: IntentClosingSetting) -> Self

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

Examples found in repository

src/client.rs (line 2402)

        pub fn intent_closing_setting(mut self, input: crate::model::IntentClosingSetting) -> Self {
            self.inner = self.inner.intent_closing_setting(input);
            self
        }

pub fn set_intent_closing_setting(
    self,
    input: Option<IntentClosingSetting>
) -> Self

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

Examples found in repository

src/client.rs (line 2410)

        pub fn set_intent_closing_setting(
            mut self,
            input: std::option::Option<crate::model::IntentClosingSetting>,
        ) -> Self {
            self.inner = self.inner.set_intent_closing_setting(input);
            self
        }

pub fn input_contexts(self, input: InputContext) -> Self

Appends an item to input_contexts.

To override the contents of this collection use set_input_contexts.

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.

Examples found in repository

src/client.rs (line 2423)

        pub fn input_contexts(mut self, input: crate::model::InputContext) -> Self {
            self.inner = self.inner.input_contexts(input);
            self
        }

pub fn set_input_contexts(self, input: Option<Vec<InputContext>>) -> Self

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.

Examples found in repository

src/client.rs (line 2435)

        pub fn set_input_contexts(
            mut self,
            input: std::option::Option<std::vec::Vec<crate::model::InputContext>>,
        ) -> Self {
            self.inner = self.inner.set_input_contexts(input);
            self
        }

pub fn output_contexts(self, input: OutputContext) -> Self

Appends an item to output_contexts.

To override the contents of this collection use set_output_contexts.

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.

Examples found in repository

src/client.rs (line 2446)

        pub fn output_contexts(mut self, input: crate::model::OutputContext) -> Self {
            self.inner = self.inner.output_contexts(input);
            self
        }

pub fn set_output_contexts(self, input: Option<Vec<OutputContext>>) -> Self

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.

Examples found in repository

src/client.rs (line 2456)

        pub fn set_output_contexts(
            mut self,
            input: std::option::Option<std::vec::Vec<crate::model::OutputContext>>,
        ) -> Self {
            self.inner = self.inner.set_output_contexts(input);
            self
        }

pub fn kendra_configuration(self, input: KendraConfiguration) -> Self

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.

Examples found in repository

src/client.rs (line 2461)

        pub fn kendra_configuration(mut self, input: crate::model::KendraConfiguration) -> Self {
            self.inner = self.inner.kendra_configuration(input);
            self
        }

pub fn set_kendra_configuration(self, input: Option<KendraConfiguration>) -> Self

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.

Examples found in repository

src/client.rs (line 2469)

        pub fn set_kendra_configuration(
            mut self,
            input: std::option::Option<crate::model::KendraConfiguration>,
        ) -> Self {
            self.inner = self.inner.set_kendra_configuration(input);
            self
        }

pub fn bot_id(self, input: impl Into<String>) -> Self

The identifier of the bot associated with this intent.

Examples found in repository

src/client.rs (line 2474)

        pub fn bot_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.bot_id(input.into());
            self
        }

pub fn set_bot_id(self, input: Option<String>) -> Self

The identifier of the bot associated with this intent.

Examples found in repository

src/client.rs (line 2479)

        pub fn set_bot_id(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_bot_id(input);
            self
        }

pub fn bot_version(self, input: impl Into<String>) -> Self

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

Examples found in repository

src/client.rs (line 2484)

        pub fn bot_version(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.bot_version(input.into());
            self
        }

pub fn set_bot_version(self, input: Option<String>) -> Self

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

Examples found in repository

src/client.rs (line 2489)

        pub fn set_bot_version(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_bot_version(input);
            self
        }

pub fn locale_id(self, input: impl Into<String>) -> Self

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.

Examples found in repository

src/client.rs (line 2494)

        pub fn locale_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.locale_id(input.into());
            self
        }

pub fn set_locale_id(self, input: Option<String>) -> Self

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.

Examples found in repository

src/client.rs (line 2499)

        pub fn set_locale_id(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_locale_id(input);
            self
        }

pub fn initial_response_setting(self, input: InitialResponseSetting) -> Self

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

Examples found in repository

src/client.rs (line 2507)

        pub fn initial_response_setting(
            mut self,
            input: crate::model::InitialResponseSetting,
        ) -> Self {
            self.inner = self.inner.initial_response_setting(input);
            self
        }

pub fn set_initial_response_setting(
    self,
    input: Option<InitialResponseSetting>
) -> Self

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

Examples found in repository

src/client.rs (line 2515)

        pub fn set_initial_response_setting(
            mut self,
            input: std::option::Option<crate::model::InitialResponseSetting>,
        ) -> Self {
            self.inner = self.inner.set_initial_response_setting(input);
            self
        }

pub fn build(self) -> Result<CreateIntentInput, BuildError>

Consumes the builder and constructs a CreateIntentInput.

Examples found in repository

src/client.rs (line 2268)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::CreateIntent,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::CreateIntentError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// Sends the request and returns the response.
        ///
        /// If an error occurs, an `SdkError` will be returned with additional details that
        /// can be matched against.
        ///
        /// By default, any retryable failures will be retried twice. Retry behavior
        /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::CreateIntentOutput,
            aws_smithy_http::result::SdkError<crate::error::CreateIntentError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Builder