├── .gitignore ├── LICENSE ├── hello-alexa-world ├── pom.xml └── src │ └── main │ └── java │ └── org │ └── sample │ └── aws │ └── alexa │ └── hello │ ├── DBUtil.java │ ├── HelloWorldSpeechlet.java │ ├── HelloWorldSpeechletRequestStreamHandler.java │ ├── Person.java │ └── speechAssets │ ├── IntentSchema.json │ └── SampleUtterances.txt ├── images ├── intent1.png ├── intent2.png └── intent3.png └── readme.adoc /.gitignore: -------------------------------------------------------------------------------- 1 | **/target 2 | 3 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /hello-alexa-world/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | org.sample.aws.alexa 6 | hello-alexa-world 7 | 1.0-SNAPSHOT 8 | jar 9 | 10 | UTF-8 11 | 1.8 12 | 1.8 13 | 14 | 15 | 16 | 17 | 18 | com.amazon.alexa 19 | alexa-skills-kit 20 | 1.4.0 21 | compile 22 | 23 | 24 | 25 | com.amazonaws 26 | aws-java-sdk-dynamodb 27 | 1.11.127 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | org.apache.maven.plugins 36 | maven-shade-plugin 37 | 2.3 38 | 39 | false 40 | 41 | 42 | 43 | package 44 | 45 | shade 46 | 47 | 48 | 49 | 50 | 51 | org.codehaus.mojo 52 | properties-maven-plugin 53 | 1.0.0 54 | 55 | 56 | initialize 57 | 58 | read-project-properties 59 | 60 | 61 | 62 | ${user.home}/.aws/credentials 63 | 64 | 65 | 66 | 67 | 68 | 69 | com.github.seanroy 70 | lambda-maven-plugin 71 | 2.2.2 72 | 73 | ${project.basedir}/target/${project.artifactId}-${project.version}.jar 74 | ${project.version} 75 | alexa-java-skill 76 | us-east-1 77 | arn:aws:iam::091144949931:role/lambda_services 78 | true 79 | 80 | 81 | java8 82 | 1024 83 | 30 84 | 85 | [ 86 | { 87 | "functionName": "HelloAlexaWorld", 88 | "description": "Hello Alexa World", 89 | "handler": "org.sample.aws.alexa.hello.HelloWorldSpeechletRequestStreamHandler", 90 | "triggers": [ 91 | { 92 | "integration": "Alexa Skills Kit" 93 | } 94 | ] 95 | } 96 | ] 97 | 98 | 99 | 100 | 101 | install 102 | 103 | deploy-lambda 104 | 105 | 106 | 107 | 108 | 109 | 110 | hello-alexa-world 111 | 112 | -------------------------------------------------------------------------------- /hello-alexa-world/src/main/java/org/sample/aws/alexa/hello/DBUtil.java: -------------------------------------------------------------------------------- 1 | package org.sample.aws.alexa.hello; 2 | 3 | import com.amazonaws.regions.Regions; 4 | import com.amazonaws.services.dynamodbv2.AmazonDynamoDB; 5 | import com.amazonaws.services.dynamodbv2.AmazonDynamoDBClientBuilder; 6 | import com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMapper; 7 | 8 | /** 9 | * @author Arun Gupta 10 | */ 11 | public class DBUtil { 12 | 13 | private static AmazonDynamoDB dynamodbClient; 14 | 15 | private static AmazonDynamoDB getClient() { 16 | if (null != dynamodbClient) { 17 | return dynamodbClient; 18 | } 19 | 20 | String region = System.getProperty("DYNAMODB_REGION"); 21 | if (null == region) { 22 | System.err.println("Region not set, default \"" + Regions.US_EAST_1.name() + "\" is used"); 23 | region = Regions.US_EAST_1.name(); 24 | } 25 | System.out.println("DynamoDB region: " + region); 26 | 27 | dynamodbClient = AmazonDynamoDBClientBuilder.standard() 28 | .withRegion(region) 29 | .build(); 30 | 31 | return dynamodbClient; 32 | } 33 | 34 | public static Person getPerson(String id) { 35 | DynamoDBMapper mapper = new DynamoDBMapper(getClient()); 36 | return mapper.load(Person.class, id); 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /hello-alexa-world/src/main/java/org/sample/aws/alexa/hello/HelloWorldSpeechlet.java: -------------------------------------------------------------------------------- 1 | package org.sample.aws.alexa.hello; 2 | 3 | import org.slf4j.Logger; 4 | import org.slf4j.LoggerFactory; 5 | 6 | import com.amazon.speech.slu.Intent; 7 | import com.amazon.speech.slu.Slot; 8 | import com.amazon.speech.speechlet.IntentRequest; 9 | import com.amazon.speech.speechlet.LaunchRequest; 10 | import com.amazon.speech.speechlet.Session; 11 | import com.amazon.speech.speechlet.SessionEndedRequest; 12 | import com.amazon.speech.speechlet.SessionStartedRequest; 13 | import com.amazon.speech.speechlet.Speechlet; 14 | import com.amazon.speech.speechlet.SpeechletException; 15 | import com.amazon.speech.speechlet.SpeechletResponse; 16 | import com.amazon.speech.ui.PlainTextOutputSpeech; 17 | import com.amazon.speech.ui.Reprompt; 18 | import com.amazon.speech.ui.SimpleCard; 19 | 20 | /** 21 | * @author Arun Gupta 22 | */ 23 | public class HelloWorldSpeechlet implements Speechlet { 24 | private static final Logger log = LoggerFactory.getLogger(HelloWorldSpeechlet.class); 25 | 26 | @Override 27 | public void onSessionStarted(final SessionStartedRequest request, final Session session) 28 | throws SpeechletException { 29 | log.info("onSessionStarted requestId={}, sessionId={}", request.getRequestId(), 30 | session.getSessionId()); 31 | // any initialization logic goes here 32 | } 33 | 34 | @Override 35 | public SpeechletResponse onLaunch(final LaunchRequest request, final Session session) 36 | throws SpeechletException { 37 | log.info("onLaunch requestId={}, sessionId={}", request.getRequestId(), 38 | session.getSessionId()); 39 | return getWelcomeResponse(); 40 | } 41 | 42 | @Override 43 | public SpeechletResponse onIntent(final IntentRequest request, final Session session) 44 | throws SpeechletException { 45 | log.info("onIntent requestId={}, sessionId={}", request.getRequestId(), 46 | session.getSessionId()); 47 | 48 | Intent intent = request.getIntent(); 49 | String intentName = (intent != null) ? intent.getName() : null; 50 | 51 | if ("HelloWorldIntent".equals(intentName)) { 52 | Slot slot = intent.getSlot("howMany"); 53 | Integer times = (slot != null && slot.getValue() != null) ? Integer.parseInt(slot.getValue()) : 1; 54 | return getHelloResponse(times); 55 | } else if ("HelloWorldDbIntent".equals(intentName)) { 56 | Slot slot = intent.getSlot("id"); 57 | String id = (slot != null) ? slot.getValue() : "1"; 58 | Person person = DBUtil.getPerson(id); 59 | return getHelloDbResponse(person, id); 60 | } else if ("AMAZON.HelpIntent".equals(intentName)) { 61 | return getHelpResponse(); 62 | } else { 63 | throw new SpeechletException("Invalid Intent"); 64 | } 65 | } 66 | 67 | @Override 68 | public void onSessionEnded(final SessionEndedRequest request, final Session session) 69 | throws SpeechletException { 70 | log.info("onSessionEnded requestId={}, sessionId={}", request.getRequestId(), 71 | session.getSessionId()); 72 | // any cleanup logic goes here 73 | } 74 | 75 | /** 76 | * Creates and returns a {@code SpeechletResponse} with a welcome message. 77 | * 78 | * @return SpeechletResponse spoken and visual response for the given intent 79 | */ 80 | private SpeechletResponse getWelcomeResponse() { 81 | String speechText = "Welcome to the Alexa Skills Kit, you can say hello"; 82 | 83 | // Create the Simple card content. 84 | SimpleCard card = new SimpleCard(); 85 | card.setTitle("HelloWorld"); 86 | card.setContent(speechText); 87 | 88 | // Create the plain text output. 89 | PlainTextOutputSpeech speech = new PlainTextOutputSpeech(); 90 | speech.setText(speechText); 91 | 92 | // Create reprompt 93 | Reprompt reprompt = new Reprompt(); 94 | reprompt.setOutputSpeech(speech); 95 | 96 | return SpeechletResponse.newAskResponse(speech, reprompt, card); 97 | } 98 | 99 | /** 100 | * Creates a {@code SpeechletResponse} for the hello intent. 101 | * 102 | * @return SpeechletResponse spoken and visual response for the given intent 103 | */ 104 | private SpeechletResponse getHelloResponse(int times) { 105 | String speechText = ""; 106 | for (int i=0; i supportedApplicationIds = new HashSet(); 15 | static { 16 | supportedApplicationIds.add("amzn1.ask.skill.4005c936-3df6-4bd5-8aa0-0f05c75b1c82"); 17 | } 18 | 19 | public HelloWorldSpeechletRequestStreamHandler() { 20 | super(new HelloWorldSpeechlet(), supportedApplicationIds); 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /hello-alexa-world/src/main/java/org/sample/aws/alexa/hello/Person.java: -------------------------------------------------------------------------------- 1 | package org.sample.aws.alexa.hello; 2 | 3 | import com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBAttribute; 4 | import com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBHashKey; 5 | import com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBTable; 6 | 7 | /** 8 | * @author Arun Gupta 9 | */ 10 | @DynamoDBTable(tableName = "Person") 11 | public class Person { 12 | 13 | private String id; 14 | private String name; 15 | 16 | public Person() { 17 | } 18 | 19 | public Person(String id, String name) { 20 | this.id = id; 21 | this.name = name; 22 | } 23 | 24 | @DynamoDBHashKey 25 | public String getId() { 26 | return id; 27 | } 28 | 29 | public void setId(String id) { 30 | this.id = id; 31 | } 32 | 33 | @DynamoDBAttribute 34 | public String getName() { 35 | return name; 36 | } 37 | 38 | public void setName(String name) { 39 | this.name = name; 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /hello-alexa-world/src/main/java/org/sample/aws/alexa/hello/speechAssets/IntentSchema.json: -------------------------------------------------------------------------------- 1 | { 2 | "intents": [ 3 | { 4 | "intent": "HelloWorldIntent", 5 | "slots": [ 6 | { 7 | "name": "howMany", 8 | "type": "AMAZON.NUMBER" 9 | } 10 | ] 11 | }, 12 | { 13 | "intent": "HelloWorldDbIntent", 14 | "slots": [ 15 | { 16 | "name": "id", 17 | "type": "AMAZON.NUMBER" 18 | } 19 | ] 20 | }, 21 | { 22 | "intent": "AMAZON.HelpIntent" 23 | } 24 | ] 25 | } -------------------------------------------------------------------------------- /hello-alexa-world/src/main/java/org/sample/aws/alexa/hello/speechAssets/SampleUtterances.txt: -------------------------------------------------------------------------------- 1 | HelloWorldIntent say hello 2 | HelloWorldIntent say hello {howMany} times 3 | 4 | HelloWorldDbIntent what is the name of {id} 5 | -------------------------------------------------------------------------------- /images/intent1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arun-gupta/alexa-skill-java/ed6a452db8a6fb037b951dc5dc3a61467e5bb141/images/intent1.png -------------------------------------------------------------------------------- /images/intent2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arun-gupta/alexa-skill-java/ed6a452db8a6fb037b951dc5dc3a61467e5bb141/images/intent2.png -------------------------------------------------------------------------------- /images/intent3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arun-gupta/alexa-skill-java/ed6a452db8a6fb037b951dc5dc3a61467e5bb141/images/intent3.png -------------------------------------------------------------------------------- /readme.adoc: -------------------------------------------------------------------------------- 1 | = Hello World using an Alexa Skill and Java 2 | 3 | == Pre-setup Alexa Skill 4 | 5 | . Create an account at http://developer.amazon.com and login 6 | . Select `Alexa`, `Alexa Skills Kit`, `Get Started >`, `Add a New Skill` 7 | . Use `Name` and `Invocation Name` as `Hello World` 8 | . Click on `Save` 9 | . Copy the `Application Id` (from top left) and paste it in the `HelloWorldSpeechletRequestStreamHandler` class 10 | 11 | == Create Lambda function 12 | 13 | . Create bucket: `aws s3 mb s3://alexa-java-skill --region us-east-1`. 14 | . Create and upload a deployment package: `mvn -f hello-alexa-world/pom.xml package install` 15 | 16 | == Setup Alexa Skill 17 | 18 | . On http://developer.amazon.com, click on `Next` 19 | .. Copy content of `IntentSchema.json` in `Intent Schema` 20 | .. Copy content of `SampleUtterances.txt` in `Sample Utterances` 21 | .. Click on `Next` 22 | .. Select `AWS Lambda ARN` 23 | .. Get Function ARN: `aws lambda get-function --function-name HelloAlexaWorld --region us-east-1 | jq .Configuration.FunctionArn` and paste it in the textbox labeled `Default` 24 | . Click on `Next` 25 | 26 | == Test Alexa Skill 27 | 28 | The different intents can be tested in `Service Simulator` or https://echosim.io. 29 | 30 | === Hello 31 | 32 | Type `say hello` in `Enter Utterance` and click on `Ask Hello World`. The output should look as shown. 33 | 34 | image::images/intent1.png[] 35 | 36 | === Hello World N times 37 | 38 | Type `say hello 3 times`: 39 | 40 | image::images/intent2.png[] 41 | 42 | === Name of a person 43 | 44 | Type `what is the name of 1`: 45 | 46 | image::images/intent3.png[] 47 | 48 | Skill can also be tested at https://echosim.io/ or using Alexa Echo. 49 | 50 | . `Ask Hello World say hello` 51 | . `Ask Hello World say hello 3 times` 52 | . `Ask Hello World what is the name of 1`, `2` or `3` 53 | 54 | == References 55 | 56 | . https://developer.amazon.com/alexa-skills-kit/alexa-skill-quick-start-tutorial[Detailed Tutorial] 57 | 58 | --------------------------------------------------------------------------------