Amazon Lex - Developer Guide - AWS Documentation

1 Amazon LexDeveloper GuideAmazon Lex Developer GuideAmazon Lex: Developer GuideCopyright 2019 Amazon Web Services, Inc. and/or its affiliates. All rights 's trademarks and trade dress may not be used in connection with any product or service that is not Amazon 's, in any mannerthat is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon . All other trademarks notowned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored Lex Developer GuideTable of ContentsWhat Is Amazon Lex? .. 1 Are You a First-time User of Amazon Lex? .. 2 How It Works .. 3 Programming Model .. 4 Model Building API Operations.. 5 Runtime API Operations.. 5 Lambda Functions As Code Hooks .. 6 Service Permissions .. 8 Creating Resource-Based Policies for AWS Lambda.

2 8 Deleting Service-Linked Roles .. 8 Managing Messages.. 9 Types of Messages .. 9 Contexts for Configuring Messages .. 10 Supported Message Formats .. 14 Message Groups .. 14 Response Cards .. 15 Managing Conversation Context .. 19 Setting Session Attributes .. 19 Setting Request Attributes .. 20 Setting the Session Timeout .. 22 Sharing Information Between Intents .. 22 Setting Complex Attributes .. 23 Deployment Options .. 24 Built-in Intents and Slot Types .. 24 Built-in Intents .. 24 Built-in Slot Types .. 25 Custom Slot Types .. 29 Getting Started .. 31 Step 1: Set Up an Account .. 31 Sign Up for AWS .. 31 Create an IAM User .. 32 Next Step .. 32 Step 2: Set Up the AWS CLI .. 32.. 33 Step 3: Getting Started (Console) .. 33 Exercise 1: Create a Bot Using a Blueprint.

3 33 Exercise 2: Create a Custom Bot .. 60 Exercise 3: Publish a Version and Create an Alias .. 71 Step 4: Getting Started (AWS CLI) .. 72 Exercise 1: Create a Bot .. 72 Exercise 2: Add a New Utterance .. 84 Exercise 3: Add a Lambda Function .. 88 Exercise 4: Publish a Version .. 91 Exercise 5: Create an Alias .. 95 Exercise 6: Clean Up .. 96 Versioning and Aliases .. 97 Versioning .. 97 The $LATEST Version .. 97 Publishing an Amazon Lex Resource Version .. 97 Updating an Amazon Lex Resource .. 98 Deleting an Amazon Lex Resource or Version .. 98 Aliases.. 99 Using Lambda Functions .. 101 Lambda Function Input Event and Response Format .. 101iiiAmazon Lex Developer GuideInput Event Format .. 101 Response Format .. 104 Amazon Lex and AWS Lambda Blueprints .. 108 Deploying Bots.

4 109 Deploying an Amazon Lex Bot on a Messaging Platform.. 109 Integrating with Facebook .. 111 Integrating with Kik.. 113 Integrating with Slack.. 116 Integrating with Twilio SMS .. 120 Deploying an Amazon Lex Bot in Mobile Applications .. 123 Importing and Exporting .. 124 Exporting and Importing in Amazon Lex Format .. 124 Exporting in Amazon Lex Format .. 124 Importing in Amazon Lex Format .. 125 JSON Format for Importing and Exporting .. 126 Exporting to an Alexa Skill .. 128 Bot Examples.. 130 Example Bot: ScheduleAppointment.. 130 Overview of the Bot Blueprint (ScheduleAppointment) .. 132 Overview of the Lambda Function Blueprint (lex-make-appointment-python) .. 133 Step 1: Create an Amazon Lex Bot .. 133 Step 2: Create a Lambda Function .. 135 Step 3: Update the Intent: Configure a Code Hook.

5 135 Step 4: Deploy the Bot on the Facebook Messenger Platform.. 136 Details of Information Flow.. 137 Example Bot: BookTrip .. 148 Step 1: Blueprint Review.. 149 Step 2: Create an Amazon Lex Bot .. 151 Step 3: Create a Lambda function .. 154 Step 4: Add the Lambda Function as a Code Hook .. 154 Details of the Information Flow.. 156 Example: Using a Response Card .. 170 Example: Updating Utterances .. 173 Example: Integrating with a Web site .. 174 Monitoring.. 175 Monitoring Amazon Lex with CloudWatch .. 175 CloudWatch Metrics for Amazon Lex .. 175 Viewing Amazon Lex Metrics .. 175 Creating an Alarm.. 176 Runtime Metrics for Amazon Lex .. 176 Channel Association Metrics for Amazon Lex .. 179 Logging Amazon Lex API Calls with AWS CloudTrail .. 180 Amazon Lex Information in CloudTrail.

6 180 Example: Amazon Lex Log File Entries .. 181 Guidelines and Limits.. 184 General Guidelines.. 184 Limits.. 186 General Limits.. 186 Runtime Service Limits .. 186 Model Building Limits.. 187 Authentication and Access Control .. 191 Authentication.. 191 Access Control .. 192 Overview of Managing Access .. 192 Amazon Lex Resources and Operations .. 193 Understanding Resource Ownership .. 193 Managing Access to Resources .. 193ivAmazon Lex Developer GuideSpecifying Policy Elements: Actions, Effects, and Principals .. 194 Specifying Conditions in a Policy .. 195 Using Identity-Based Policies (IAM Policies) for Amazon Lex .. 196 Permissions Required to Use the Amazon Lex Console .. 197 AWS Managed (Predefined) Policies for Amazon Lex .. 199 Examples of Customer Managed Policies .. 199 Amazon Lex API Permissions Reference.

7 201 API Reference .. 202 Actions .. 202 Amazon Lex Model Building Service .. 203 Amazon Lex Runtime Service .. 326 Data Types .. 340 Amazon Lex Model Building Service .. 341 Amazon Lex Runtime Service .. 367 Document History .. 372 AWS Glossary .. 374vAmazon Lex Developer GuideWhat Is Amazon Lex? Amazon Lex is an AWS service for building conversational interfaces for applications using voice andtext. With Amazon Lex, the same conversational engine that powers Amazon Alexa is now availableto any Developer , enabling you to build sophisticated, natural language chatbots into your new andexisting applications. Amazon Lex provides the deep functionality and flexibility of natural languageunderstanding (NLU) and automatic speech recognition (ASR) so you can build highly engaging userexperiences with lifelike, conversational interactions, and create new categories of Lex enables any Developer to build conversational chatbots quickly.

8 With Amazon Lex, no deeplearning expertise is necessary to create a bot, you just specify the basic conversation flow in theAmazon Lex console. Amazon Lex manages the dialogue and dynamically adjusts the responses in theconversation. Using the console, you can build, test, and publish your text or voice chatbot. You can thenadd the conversational interfaces to bots on mobile devices, web applications, and chat platforms (forexample, Facebook Messenger). Amazon Lex provides pre-built integration with AWS Lambda, and you can easily integrate with manyother services on the AWS platform, including Amazon Cognito, AWS Mobile Hub, Amazon CloudWatch,and Amazon DynamoDB. Integration with Lambda provides bots access to pre-built serverless enterpriseconnectors to link to data in SaaS applications, such as Salesforce, HubSpot, or of the benefits of using Amazon Lex include: Simplicity Amazon Lex guides you through using the console to create your own chatbot in supply just a few example phrases, and Amazon Lex builds a complete natural language modelthrough which the bot can interact using voice and text to ask questions, get answers, and completesophisticated tasks.

9 Democratized deep learning technologies Powered by the same technology as Alexa, AmazonLex provides ASR and NLU technologies to create a Speech Language Understanding (SLU) SLU, Amazon Lex takes natural language speech and text input, understands the intentbehind the input, and fulfills the user intent by invoking the appropriate business function. Speech recognition and natural language understanding are some of the most challenging problemsto solve in computer science, requiring sophisticated deep learning algorithms to be trained onmassive amounts of data and infrastructure. Amazon Lex puts deep learning technologies within reachof all developers, powered by the same technology as Alexa. Amazon Lex chatbots convert incomingspeech to text and understand the user intent to generate an intelligent response, so you can focus onbuilding your bots with differentiated value-add for your customers, to define entirely new categoriesof products made possible through conversational interfaces.

10 Seamless deployment and scaling With Amazon Lex, you can build, test, and deploy your chatbotsdirectly from the Amazon Lex console. Amazon Lex enables you to easily publish your voice or textchatbots for use on mobile devices, web apps, and chat services (for example, Facebook Messenger). Amazon Lex scales automatically so you don t need to worry about provisioning hardware andmanaging infrastructure to power your bot experience. Built-in integration with the AWS platform Amazon Lex has native interoperability with other AWSservices, such as Amazon Cognito, AWS Lambda, Amazon CloudWatch, and AWS Mobile Hub. You1 Amazon Lex Developer GuideAre You a First-time User of Amazon Lex?can take advantage of the power of the AWS platform for security, monitoring, user authentication,business logic, storage, and mobile app development. Cost-effectiveness With Amazon Lex, there are no upfront costs or minimum fees.