aws-sdk-lexruntime

Crates.ioaws-sdk-lexruntime
lib.rsaws-sdk-lexruntime
version1.50.0
sourcesrc
created_at2021-10-21 23:04:46.506325
updated_at2024-12-04 06:35:18.754885
descriptionAWS SDK for Amazon Lex Runtime Service
homepage
repositoryhttps://github.com/awslabs/aws-sdk-rust
max_upload_size
id469085
size1,049,814
AWS SDK Rust Bot (aws-sdk-rust-ci)

documentation

README

aws-sdk-lexruntime

Amazon Lex provides both build and runtime endpoints. Each endpoint provides a set of operations (API). Your conversational bot uses the runtime API to understand user utterances (user input text or voice). For example, suppose a user says "I want pizza", your bot sends this input to Amazon Lex using the runtime API. Amazon Lex recognizes that the user request is for the OrderPizza intent (one of the intents defined in the bot). Then Amazon Lex engages in user conversation on behalf of the bot to elicit required information (slot values, such as pizza size and crust type), and then performs fulfillment activity (that you configured when you created the bot). You use the build-time API to create and manage your Amazon Lex bot. For a list of build-time operations, see the build-time API, .

Getting Started

Examples are available for many services and operations, check out the examples folder in GitHub.

The SDK provides one crate per AWS service. You must add Tokio as a dependency within your Rust project to execute asynchronous code. To add aws-sdk-lexruntime to your project, add the following to your Cargo.toml file:

[dependencies]
aws-config = { version = "1.1.7", features = ["behavior-version-latest"] }
aws-sdk-lexruntime = "1.50.0"
tokio = { version = "1", features = ["full"] }

Then in code, a client can be created with the following:

use aws_sdk_lexruntime as lexruntime;

#[::tokio::main]
async fn main() -> Result<(), lexruntime::Error> {
    let config = aws_config::load_from_env().await;
    let client = aws_sdk_lexruntime::Client::new(&config);

    // ... make some calls with the client

    Ok(())
}

See the client documentation for information on what calls can be made, and the inputs and outputs for each of those calls.

Using the SDK

Until the SDK is released, we will be adding information about using the SDK to the Developer Guide. Feel free to suggest additional sections for the guide by opening an issue and describing what you are trying to do.

Getting Help

License

This project is licensed under the Apache-2.0 License.

Commit count: 1103

cargo fmt