├── .gitignore
├── .mvn
└── wrapper
│ ├── maven-wrapper.jar
│ └── maven-wrapper.properties
├── Dockerfile
├── LICENSE
├── README.md
├── doc
└── rasa_java_action_server.png
├── mvnw
├── mvnw.cmd
├── pom.xml
└── src
└── main
├── java
└── io
│ └── github
│ └── rbajek
│ └── rasa
│ └── action
│ └── server
│ ├── RasaActionServer.java
│ ├── action
│ ├── custom
│ │ ├── form
│ │ │ └── restaurant
│ │ │ │ ├── RestaurantFormAction.java
│ │ │ │ ├── data
│ │ │ │ └── Constants.java
│ │ │ │ └── validator
│ │ │ │ ├── ValidateCuisineSlot.java
│ │ │ │ ├── ValidateNumPeopleSlot.java
│ │ │ │ └── ValidateOutdoorSeatingSlot.java
│ │ └── joke
│ │ │ └── ActionJoke.java
│ └── support
│ │ └── AutoRegisterAction.java
│ ├── config
│ └── AppConfig.java
│ └── controller
│ ├── EndpointController.java
│ ├── GlobalExceptionController.java
│ └── dto
│ ├── RegisteredAction.java
│ └── Status.java
└── resources
├── application.properties
└── log4j2.xml
/.gitignore:
--------------------------------------------------------------------------------
1 | /target/
2 | target/
3 | !.mvn/wrapper/maven-wrapper.jar
4 |
5 | ### STS ###
6 | .apt_generated
7 | .classpath
8 | .factorypath
9 | .project
10 | .settings
11 | .springBeans
12 | .sts4-cache
13 |
14 | ### IntelliJ IDEA ###
15 | .idea
16 | *.iws
17 | *.iml
18 | *.ipr
19 |
20 | ### NetBeans ###
21 | /nbproject/private/
22 | /build/
23 | /nbbuild/
24 | /dist/
25 | /nbdist/
26 | /.nb-gradle/
--------------------------------------------------------------------------------
/.mvn/wrapper/maven-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/rbajek/rasa-java-action-server/8dc75134ed27b0f25fbb949154b86389de1df553/.mvn/wrapper/maven-wrapper.jar
--------------------------------------------------------------------------------
/.mvn/wrapper/maven-wrapper.properties:
--------------------------------------------------------------------------------
1 | distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.5.3/apache-maven-3.5.3-bin.zip
2 |
--------------------------------------------------------------------------------
/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM openjdk:8-jdk-alpine as build
2 | WORKDIR /workspace/app
3 |
4 | COPY mvnw .
5 | COPY .mvn .mvn
6 | COPY pom.xml .
7 | COPY src src
8 |
9 | RUN ./mvnw install \
10 | && mkdir -p target/dependency && (cd target/dependency; jar -xf ../*.jar)
11 |
12 | FROM openjdk:8-jre-alpine
13 | RUN addgroup -S rasa && adduser -S rasa -G rasa
14 | # VOLUME /t
15 | USER rasa
16 | ARG DEPENDENCY=/workspace/app/target/dependency
17 | COPY --from=build ${DEPENDENCY}/BOOT-INF/lib /app/lib
18 | COPY --from=build ${DEPENDENCY}/META-INF /app/META-INF
19 | COPY --from=build ${DEPENDENCY}/BOOT-INF/classes /app
20 | ENTRYPOINT ["java","-noverify","-XX:TieredStopAtLevel=1","-cp","app:app/lib/*","io.github.rbajek.rasa.action.server.RasaActionServer"]
21 |
--------------------------------------------------------------------------------
/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 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Rasa Java Action Server
2 | Action server for the Rasa custom actions
3 |
4 | You can use this implementation of the action server as a starting point for your own chatbot based on [Rasa](https://rasa.com/).
5 |
6 | Using the action server, you can focus on the business logic (defined within custom actions). Everything else is already done for you.
7 |
8 | Rasa Core sends a request to the action server to execute a certain custom action. As a response to the action call from Core, you can modify the tracker, e.g. by setting slots and send responses back to the user.
9 |
10 | 
11 |
12 | Action server exposes an API that is used by Rasa to execute custom actions. The following endpoints are supported:
13 |
14 | | Endpoint | Description |
15 | |----------------|-----------------------------------|
16 | | GET /health | Ping endpoint to check if the server is running and well. |
17 | | GET /actions | List all registered actions. |
18 | | POST /webhook | It allows you to run the custom action. This endpoint should be set in the ``endpoints.yml`` file in Rasa. |
19 |
20 | ## Usage
21 |
22 | Before starting the action server ensure that contains your custom action.
23 |
24 | #### 1. Adding custom actions
25 |
26 | You can create two types of custom actions:
27 | - **general** - which corresponds to [Rasa Custom Action](https://rasa.com/docs/rasa/core/actions/#custom-actions). To use this kind of actions, you can create a Java class which implement the ``io.github.rbajek.rasa.sdk.action.Action`` interface.
28 | - **forms** - which corresponds to [Rasa Forms](https://rasa.com/docs/rasa/core/forms/). Ths kind of actions should extends the ``io.github.rbajek.rasa.sdk.action.form.AbstractFormAction``
29 |
30 | To add your custom action, you can create a Java class which implement/extend an appropriate interface/class. Recommended package for your custom actions is ``io.github.rbajek.rasa.action.server.action.custom``. Afterwards, you have to register your custom action in ``io.github.rbajek.rasa.sdk.ActionExecutor``.
31 |
32 | **Tip:** If you want your custom action to be automatically registered, your action has to be as Spring component.
33 |
34 |
35 | **Attention:** action server contains two examples of custom actions:
36 | - [ActionJoke.java](https://github.com/rbajek/rasa-java-action-server/blob/master/src/main/java/io/github/rbajek/rasa/action/server/action/custom/joke/ActionJoke.java) - as the general action (based on [original example](https://rasa.com/docs/rasa/user-guide/running-rasa-with-docker/#creating-a-custom-action))
37 | - [RestaurantFormAction.java](https://github.com/rbajek/rasa-java-action-server/blob/master/src/main/java/io/github/rbajek/rasa/action/server/action/custom/form/restaurant/RestaurantFormAction.java) - as the form action, which implement functionality of [Restaurant Form](https://blog.rasa.com/building-contextual-assistants-with-rasa-formaction/)
38 |
39 | #### 2. Starting the actio server
40 |
41 | In order to start the action server using implemented custom actions, fisrt of all, you have to build the application:
42 |
43 | ```
44 | mvnw clean package
45 | ```
46 |
47 | next, you ca run server as follows:
48 |
49 | ```
50 | java -jar target\rasa-java-action-server.jar
51 | ```
52 |
53 | ##### Docker
54 |
55 | If you are using docker you can build the docker image:
56 |
57 | ```
58 | docker build -t rasa-action-server:1.0.0
59 | ```
60 |
61 | and tun it:
62 |
63 | ```
64 | docker run -p 5055:8080 --name rasa-action-server rasa-action-server:1.0.0
65 | ```
66 |
67 | #### 3. Set the URL in Rasa Core
68 |
69 | Rasa core has to know what is the URL of your custom server. To set this, you have to set the ``/webhook`` endpoint in the ``endpoints.yml`` within the Rasa server (see [custom action](https://rasa.com/docs/rasa/core/actions/#custom-actions)):
70 |
71 | For example:
72 |
73 | ```yml
74 | action_endpoint:
75 | url: "http://localhost:5055/webhook"
76 | ```
77 |
--------------------------------------------------------------------------------
/doc/rasa_java_action_server.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/rbajek/rasa-java-action-server/8dc75134ed27b0f25fbb949154b86389de1df553/doc/rasa_java_action_server.png
--------------------------------------------------------------------------------
/mvnw:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | # ----------------------------------------------------------------------------
3 | # Licensed to the Apache Software Foundation (ASF) under one
4 | # or more contributor license agreements. See the NOTICE file
5 | # distributed with this work for additional information
6 | # regarding copyright ownership. The ASF licenses this file
7 | # to you under the Apache License, Version 2.0 (the
8 | # "License"); you may not use this file except in compliance
9 | # with the License. You may obtain a copy of the License at
10 | #
11 | # http://www.apache.org/licenses/LICENSE-2.0
12 | #
13 | # Unless required by applicable law or agreed to in writing,
14 | # software distributed under the License is distributed on an
15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 | # KIND, either express or implied. See the License for the
17 | # specific language governing permissions and limitations
18 | # under the License.
19 | # ----------------------------------------------------------------------------
20 |
21 | # ----------------------------------------------------------------------------
22 | # Maven2 Start Up Batch script
23 | #
24 | # Required ENV vars:
25 | # ------------------
26 | # JAVA_HOME - location of a JDK home dir
27 | #
28 | # Optional ENV vars
29 | # -----------------
30 | # M2_HOME - location of maven2's installed home dir
31 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven
32 | # e.g. to debug Maven itself, use
33 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
34 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files
35 | # ----------------------------------------------------------------------------
36 |
37 | if [ -z "$MAVEN_SKIP_RC" ] ; then
38 |
39 | if [ -f /etc/mavenrc ] ; then
40 | . /etc/mavenrc
41 | fi
42 |
43 | if [ -f "$HOME/.mavenrc" ] ; then
44 | . "$HOME/.mavenrc"
45 | fi
46 |
47 | fi
48 |
49 | # OS specific support. $var _must_ be set to either true or false.
50 | cygwin=false;
51 | darwin=false;
52 | mingw=false
53 | case "`uname`" in
54 | CYGWIN*) cygwin=true ;;
55 | MINGW*) mingw=true;;
56 | Darwin*) darwin=true
57 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home
58 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html
59 | if [ -z "$JAVA_HOME" ]; then
60 | if [ -x "/usr/libexec/java_home" ]; then
61 | export JAVA_HOME="`/usr/libexec/java_home`"
62 | else
63 | export JAVA_HOME="/Library/Java/Home"
64 | fi
65 | fi
66 | ;;
67 | esac
68 |
69 | if [ -z "$JAVA_HOME" ] ; then
70 | if [ -r /etc/gentoo-release ] ; then
71 | JAVA_HOME=`java-config --jre-home`
72 | fi
73 | fi
74 |
75 | if [ -z "$M2_HOME" ] ; then
76 | ## resolve links - $0 may be a link to maven's home
77 | PRG="$0"
78 |
79 | # need this for relative symlinks
80 | while [ -h "$PRG" ] ; do
81 | ls=`ls -ld "$PRG"`
82 | link=`expr "$ls" : '.*-> \(.*\)$'`
83 | if expr "$link" : '/.*' > /dev/null; then
84 | PRG="$link"
85 | else
86 | PRG="`dirname "$PRG"`/$link"
87 | fi
88 | done
89 |
90 | saveddir=`pwd`
91 |
92 | M2_HOME=`dirname "$PRG"`/..
93 |
94 | # make it fully qualified
95 | M2_HOME=`cd "$M2_HOME" && pwd`
96 |
97 | cd "$saveddir"
98 | # echo Using m2 at $M2_HOME
99 | fi
100 |
101 | # For Cygwin, ensure paths are in UNIX format before anything is touched
102 | if $cygwin ; then
103 | [ -n "$M2_HOME" ] &&
104 | M2_HOME=`cygpath --unix "$M2_HOME"`
105 | [ -n "$JAVA_HOME" ] &&
106 | JAVA_HOME=`cygpath --unix "$JAVA_HOME"`
107 | [ -n "$CLASSPATH" ] &&
108 | CLASSPATH=`cygpath --path --unix "$CLASSPATH"`
109 | fi
110 |
111 | # For Mingw, ensure paths are in UNIX format before anything is touched
112 | if $mingw ; then
113 | [ -n "$M2_HOME" ] &&
114 | M2_HOME="`(cd "$M2_HOME"; pwd)`"
115 | [ -n "$JAVA_HOME" ] &&
116 | JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`"
117 | # TODO classpath?
118 | fi
119 |
120 | if [ -z "$JAVA_HOME" ]; then
121 | javaExecutable="`which javac`"
122 | if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then
123 | # readlink(1) is not available as standard on Solaris 10.
124 | readLink=`which readlink`
125 | if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then
126 | if $darwin ; then
127 | javaHome="`dirname \"$javaExecutable\"`"
128 | javaExecutable="`cd \"$javaHome\" && pwd -P`/javac"
129 | else
130 | javaExecutable="`readlink -f \"$javaExecutable\"`"
131 | fi
132 | javaHome="`dirname \"$javaExecutable\"`"
133 | javaHome=`expr "$javaHome" : '\(.*\)/bin'`
134 | JAVA_HOME="$javaHome"
135 | export JAVA_HOME
136 | fi
137 | fi
138 | fi
139 |
140 | if [ -z "$JAVACMD" ] ; then
141 | if [ -n "$JAVA_HOME" ] ; then
142 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
143 | # IBM's JDK on AIX uses strange locations for the executables
144 | JAVACMD="$JAVA_HOME/jre/sh/java"
145 | else
146 | JAVACMD="$JAVA_HOME/bin/java"
147 | fi
148 | else
149 | JAVACMD="`which java`"
150 | fi
151 | fi
152 |
153 | if [ ! -x "$JAVACMD" ] ; then
154 | echo "Error: JAVA_HOME is not defined correctly." >&2
155 | echo " We cannot execute $JAVACMD" >&2
156 | exit 1
157 | fi
158 |
159 | if [ -z "$JAVA_HOME" ] ; then
160 | echo "Warning: JAVA_HOME environment variable is not set."
161 | fi
162 |
163 | CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher
164 |
165 | # traverses directory structure from process work directory to filesystem root
166 | # first directory with .mvn subdirectory is considered project base directory
167 | find_maven_basedir() {
168 |
169 | if [ -z "$1" ]
170 | then
171 | echo "Path not specified to find_maven_basedir"
172 | return 1
173 | fi
174 |
175 | basedir="$1"
176 | wdir="$1"
177 | while [ "$wdir" != '/' ] ; do
178 | if [ -d "$wdir"/.mvn ] ; then
179 | basedir=$wdir
180 | break
181 | fi
182 | # workaround for JBEAP-8937 (on Solaris 10/Sparc)
183 | if [ -d "${wdir}" ]; then
184 | wdir=`cd "$wdir/.."; pwd`
185 | fi
186 | # end of workaround
187 | done
188 | echo "${basedir}"
189 | }
190 |
191 | # concatenates all lines of a file
192 | concat_lines() {
193 | if [ -f "$1" ]; then
194 | echo "$(tr -s '\n' ' ' < "$1")"
195 | fi
196 | }
197 |
198 | BASE_DIR=`find_maven_basedir "$(pwd)"`
199 | if [ -z "$BASE_DIR" ]; then
200 | exit 1;
201 | fi
202 |
203 | ##########################################################################################
204 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
205 | # This allows using the maven wrapper in projects that prohibit checking in binary data.
206 | ##########################################################################################
207 | if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then
208 | if [ "$MVNW_VERBOSE" = true ]; then
209 | echo "Found .mvn/wrapper/maven-wrapper.jar"
210 | fi
211 | else
212 | if [ "$MVNW_VERBOSE" = true ]; then
213 | echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..."
214 | fi
215 | jarUrl="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar"
216 | while IFS="=" read key value; do
217 | case "$key" in (wrapperUrl) jarUrl="$value"; break ;;
218 | esac
219 | done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties"
220 | if [ "$MVNW_VERBOSE" = true ]; then
221 | echo "Downloading from: $jarUrl"
222 | fi
223 | wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar"
224 |
225 | if command -v wget > /dev/null; then
226 | if [ "$MVNW_VERBOSE" = true ]; then
227 | echo "Found wget ... using wget"
228 | fi
229 | wget "$jarUrl" -O "$wrapperJarPath"
230 | elif command -v curl > /dev/null; then
231 | if [ "$MVNW_VERBOSE" = true ]; then
232 | echo "Found curl ... using curl"
233 | fi
234 | curl -o "$wrapperJarPath" "$jarUrl"
235 | else
236 | if [ "$MVNW_VERBOSE" = true ]; then
237 | echo "Falling back to using Java to download"
238 | fi
239 | javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java"
240 | if [ -e "$javaClass" ]; then
241 | if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then
242 | if [ "$MVNW_VERBOSE" = true ]; then
243 | echo " - Compiling MavenWrapperDownloader.java ..."
244 | fi
245 | # Compiling the Java class
246 | ("$JAVA_HOME/bin/javac" "$javaClass")
247 | fi
248 | if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then
249 | # Running the downloader
250 | if [ "$MVNW_VERBOSE" = true ]; then
251 | echo " - Running MavenWrapperDownloader.java ..."
252 | fi
253 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR")
254 | fi
255 | fi
256 | fi
257 | fi
258 | ##########################################################################################
259 | # End of extension
260 | ##########################################################################################
261 |
262 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}
263 | if [ "$MVNW_VERBOSE" = true ]; then
264 | echo $MAVEN_PROJECTBASEDIR
265 | fi
266 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS"
267 |
268 | # For Cygwin, switch paths to Windows format before running java
269 | if $cygwin; then
270 | [ -n "$M2_HOME" ] &&
271 | M2_HOME=`cygpath --path --windows "$M2_HOME"`
272 | [ -n "$JAVA_HOME" ] &&
273 | JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"`
274 | [ -n "$CLASSPATH" ] &&
275 | CLASSPATH=`cygpath --path --windows "$CLASSPATH"`
276 | [ -n "$MAVEN_PROJECTBASEDIR" ] &&
277 | MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"`
278 | fi
279 |
280 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
281 |
282 | exec "$JAVACMD" \
283 | $MAVEN_OPTS \
284 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \
285 | "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \
286 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@"
287 |
--------------------------------------------------------------------------------
/mvnw.cmd:
--------------------------------------------------------------------------------
1 | @REM ----------------------------------------------------------------------------
2 | @REM Licensed to the Apache Software Foundation (ASF) under one
3 | @REM or more contributor license agreements. See the NOTICE file
4 | @REM distributed with this work for additional information
5 | @REM regarding copyright ownership. The ASF licenses this file
6 | @REM to you under the Apache License, Version 2.0 (the
7 | @REM "License"); you may not use this file except in compliance
8 | @REM with the License. You may obtain a copy of the License at
9 | @REM
10 | @REM http://www.apache.org/licenses/LICENSE-2.0
11 | @REM
12 | @REM Unless required by applicable law or agreed to in writing,
13 | @REM software distributed under the License is distributed on an
14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | @REM KIND, either express or implied. See the License for the
16 | @REM specific language governing permissions and limitations
17 | @REM under the License.
18 | @REM ----------------------------------------------------------------------------
19 |
20 | @REM ----------------------------------------------------------------------------
21 | @REM Maven2 Start Up Batch script
22 | @REM
23 | @REM Required ENV vars:
24 | @REM JAVA_HOME - location of a JDK home dir
25 | @REM
26 | @REM Optional ENV vars
27 | @REM M2_HOME - location of maven2's installed home dir
28 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands
29 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a key stroke before ending
30 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven
31 | @REM e.g. to debug Maven itself, use
32 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
33 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files
34 | @REM ----------------------------------------------------------------------------
35 |
36 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on'
37 | @echo off
38 | @REM set title of command window
39 | title %0
40 | @REM enable echoing my setting MAVEN_BATCH_ECHO to 'on'
41 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO%
42 |
43 | @REM set %HOME% to equivalent of $HOME
44 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%")
45 |
46 | @REM Execute a user defined script before this one
47 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre
48 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending
49 | if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat"
50 | if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd"
51 | :skipRcPre
52 |
53 | @setlocal
54 |
55 | set ERROR_CODE=0
56 |
57 | @REM To isolate internal variables from possible post scripts, we use another setlocal
58 | @setlocal
59 |
60 | @REM ==== START VALIDATION ====
61 | if not "%JAVA_HOME%" == "" goto OkJHome
62 |
63 | echo.
64 | echo Error: JAVA_HOME not found in your environment. >&2
65 | echo Please set the JAVA_HOME variable in your environment to match the >&2
66 | echo location of your Java installation. >&2
67 | echo.
68 | goto error
69 |
70 | :OkJHome
71 | if exist "%JAVA_HOME%\bin\java.exe" goto init
72 |
73 | echo.
74 | echo Error: JAVA_HOME is set to an invalid directory. >&2
75 | echo JAVA_HOME = "%JAVA_HOME%" >&2
76 | echo Please set the JAVA_HOME variable in your environment to match the >&2
77 | echo location of your Java installation. >&2
78 | echo.
79 | goto error
80 |
81 | @REM ==== END VALIDATION ====
82 |
83 | :init
84 |
85 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn".
86 | @REM Fallback to current working directory if not found.
87 |
88 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR%
89 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir
90 |
91 | set EXEC_DIR=%CD%
92 | set WDIR=%EXEC_DIR%
93 | :findBaseDir
94 | IF EXIST "%WDIR%"\.mvn goto baseDirFound
95 | cd ..
96 | IF "%WDIR%"=="%CD%" goto baseDirNotFound
97 | set WDIR=%CD%
98 | goto findBaseDir
99 |
100 | :baseDirFound
101 | set MAVEN_PROJECTBASEDIR=%WDIR%
102 | cd "%EXEC_DIR%"
103 | goto endDetectBaseDir
104 |
105 | :baseDirNotFound
106 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR%
107 | cd "%EXEC_DIR%"
108 |
109 | :endDetectBaseDir
110 |
111 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig
112 |
113 | @setlocal EnableExtensions EnableDelayedExpansion
114 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a
115 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS%
116 |
117 | :endReadAdditionalConfig
118 |
119 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe"
120 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar"
121 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
122 |
123 | set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar"
124 | FOR /F "tokens=1,2 delims==" %%A IN (%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties) DO (
125 | IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B
126 | )
127 |
128 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
129 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data.
130 | if exist %WRAPPER_JAR% (
131 | echo Found %WRAPPER_JAR%
132 | ) else (
133 | echo Couldn't find %WRAPPER_JAR%, downloading it ...
134 | echo Downloading from: %DOWNLOAD_URL%
135 | powershell -Command "(New-Object Net.WebClient).DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"
136 | echo Finished downloading %WRAPPER_JAR%
137 | )
138 | @REM End of extension
139 |
140 | %MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %*
141 | if ERRORLEVEL 1 goto error
142 | goto end
143 |
144 | :error
145 | set ERROR_CODE=1
146 |
147 | :end
148 | @endlocal & set ERROR_CODE=%ERROR_CODE%
149 |
150 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost
151 | @REM check for post script, once with legacy .bat ending and once with .cmd ending
152 | if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat"
153 | if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd"
154 | :skipRcPost
155 |
156 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on'
157 | if "%MAVEN_BATCH_PAUSE%" == "on" pause
158 |
159 | if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE%
160 |
161 | exit /B %ERROR_CODE%
162 |
--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
4 | 4.0.0
5 |
6 | io.github.rbajek
7 | rasa-java-action-server
8 | 1.0.0
9 |
10 | rasa-java-action-server
11 | Action Server for the Rasa
12 |
13 |
14 | org.springframework.boot
15 | spring-boot-starter-parent
16 | 2.2.0.RELEASE
17 |
18 |
19 |
20 |
21 |
22 | Apache License, Version 2.0
23 | http://www.apache.org/licenses/LICENSE-2.0.txt
24 | repo
25 |
26 |
27 |
28 |
29 |
30 | Rafał Bajek
31 | raf.bajek@gmail.com
32 |
33 |
34 |
35 |
36 | UTF-8
37 | UTF-8
38 | 1.8
39 |
40 | 1.0.1
41 | 1.7.26
42 | 2.12.0
43 | 1.18.4
44 |
45 | false
46 | ${skipTests}
47 | ${skipTests}
48 |
49 |
50 |
51 |
52 |
53 |
54 | io.github.rbajek
55 | rasa-java-sdk
56 | ${rasa-java-sdk.version}
57 |
58 |
59 |
60 |
61 | org.projectlombok
62 | lombok
63 | ${lombok.version}
64 | provided
65 |
66 |
67 |
68 |
69 | org.springframework.boot
70 | spring-boot-starter-web
71 |
72 |
73 | org.springframework.boot
74 | spring-boot-starter-tomcat
75 |
76 |
77 | org.springframework.boot
78 | spring-boot-starter-logging
79 |
80 |
81 |
82 |
83 | org.springframework.boot
84 | spring-boot-starter-jetty
85 |
86 |
87 | org.springframework.boot
88 | spring-boot-starter-log4j2
89 |
90 |
91 | org.springframework.boot
92 | spring-boot-starter-test
93 | test
94 |
95 |
96 |
97 | junit
98 | junit
99 |
100 |
101 |
102 |
103 |
104 |
105 | org.slf4j
106 | slf4j-api
107 | ${slf4j.version}
108 |
109 |
110 |
111 |
112 | org.apache.logging.log4j
113 | log4j-api
114 | ${log4j.version}
115 |
116 |
117 | org.apache.logging.log4j
118 | log4j-core
119 | ${log4j.version}
120 |
121 |
122 | org.apache.logging.log4j
123 | log4j-slf4j-impl
124 | ${log4j.version}
125 |
126 |
127 |
128 |
129 | org.junit.jupiter
130 | junit-jupiter-api
131 | test
132 |
133 |
134 |
135 | org.junit.jupiter
136 | junit-jupiter-engine
137 | test
138 |
139 |
140 |
141 |
142 |
143 | ${project.name}
144 |
145 |
146 | org.springframework.boot
147 | spring-boot-maven-plugin
148 |
149 |
150 | org.apache.maven.plugins
151 | maven-surefire-plugin
152 |
153 | ${skipUTs}
154 |
155 |
156 |
157 | org.apache.maven.plugins
158 | maven-failsafe-plugin
159 |
160 | ${skipITs}
161 |
162 |
163 |
164 | org.codehaus.mojo
165 | build-helper-maven-plugin
166 |
167 |
168 | add-integration-test-source
169 | generate-test-sources
170 |
171 | add-test-source
172 |
173 |
174 |
175 | src/integration-test/java
176 |
177 |
178 |
179 |
180 |
181 |
182 |
183 |
184 |
185 |
--------------------------------------------------------------------------------
/src/main/java/io/github/rbajek/rasa/action/server/RasaActionServer.java:
--------------------------------------------------------------------------------
1 | package io.github.rbajek.rasa.action.server;
2 |
3 | import io.github.rbajek.rasa.action.server.config.AppConfig;
4 | import org.springframework.boot.Banner;
5 | import org.springframework.boot.SpringApplication;
6 | import org.springframework.boot.autoconfigure.SpringBootApplication;
7 | import org.springframework.context.annotation.Import;
8 |
9 | /**
10 | * @author Rafał Bajek
11 | */
12 | @SpringBootApplication
13 | @Import({AppConfig.class})
14 | public class RasaActionServer {
15 |
16 | public static void main(String[] args) throws Exception {
17 | SpringApplication app = new SpringApplication(RasaActionServer.class);
18 | app.setBannerMode(Banner.Mode.OFF);
19 | app.run(args);
20 | }
21 | }
22 |
--------------------------------------------------------------------------------
/src/main/java/io/github/rbajek/rasa/action/server/action/custom/form/restaurant/RestaurantFormAction.java:
--------------------------------------------------------------------------------
1 | package io.github.rbajek.rasa.action.server.action.custom.form.restaurant;
2 |
3 | import io.github.rbajek.rasa.action.server.action.custom.form.restaurant.data.Constants;
4 | import io.github.rbajek.rasa.action.server.action.custom.form.restaurant.validator.ValidateCuisineSlot;
5 | import io.github.rbajek.rasa.action.server.action.custom.form.restaurant.validator.ValidateNumPeopleSlot;
6 | import io.github.rbajek.rasa.action.server.action.custom.form.restaurant.validator.ValidateOutdoorSeatingSlot;
7 | import io.github.rbajek.rasa.sdk.CollectingDispatcher;
8 | import io.github.rbajek.rasa.sdk.action.form.AbstractFormAction;
9 | import io.github.rbajek.rasa.sdk.action.form.slot.mapper.AbstractSlotMapping;
10 | import io.github.rbajek.rasa.sdk.action.form.slot.mapper.EntitySlotMapping;
11 | import io.github.rbajek.rasa.sdk.action.form.slot.mapper.IntentSlotMapping;
12 | import io.github.rbajek.rasa.sdk.action.form.slot.mapper.TextSlotMapping;
13 | import io.github.rbajek.rasa.sdk.dto.Tracker;
14 | import io.github.rbajek.rasa.sdk.dto.event.AbstractEvent;
15 | import org.springframework.stereotype.Component;
16 |
17 | import java.util.*;
18 |
19 | /**
20 | * Example of a custom form action
21 | *
22 | * @author Rafał Bajek
23 | */
24 | @Component
25 | public class RestaurantFormAction extends AbstractFormAction {
26 |
27 | public RestaurantFormAction() {
28 | super("restaurant_form");
29 | }
30 |
31 | @Override
32 | protected List requiredSlots(Tracker tracker) {
33 | return Arrays.asList(Constants.Slots.CUISINE,
34 | Constants.Slots.NUM_PEOPLE,
35 | Constants.Slots.OUTDOOR_SEATING,
36 | Constants.Slots.PREFERENCES,
37 | Constants.Slots.FEEDBACK);
38 | }
39 |
40 | @Override
41 | protected Map> slotMappings() {
42 | Map> slotMappingMap = new HashMap<>();
43 |
44 | slotMappingMap.put(Constants.Slots.CUISINE, Arrays.asList(EntitySlotMapping.builder(Constants.Entities.CUISINE)
45 | .notIntent(Constants.Intents.CHITCHAT).build()));
46 |
47 | slotMappingMap.put(Constants.Slots.NUM_PEOPLE, Arrays.asList(
48 | EntitySlotMapping.builder(Constants.Entities.NUM_PEOPLE).intent(Constants.Intents.INFORM).intent(Constants.Intents.REQUEST_RESTAURANT).build(),
49 | EntitySlotMapping.builder(Constants.Entities.NUMBER).build()
50 | )
51 | );
52 |
53 | slotMappingMap.put(Constants.Slots.OUTDOOR_SEATING, Arrays.asList(
54 | EntitySlotMapping.builder(Constants.Entities.SEATING).build(),
55 | IntentSlotMapping.builder().intent(Constants.Intents.AFFIRM).value(true).build(),
56 | IntentSlotMapping.builder().intent(Constants.Intents.DENY).value(false).build()
57 | )
58 | );
59 |
60 | slotMappingMap.put(Constants.Slots.PREFERENCES, Arrays.asList(
61 | IntentSlotMapping.builder().intent(Constants.Intents.DENY).value("no additional preferences").build(),
62 | TextSlotMapping.builder().notIntent(Constants.Intents.AFFIRM).build()
63 | )
64 | );
65 |
66 | slotMappingMap.put(Constants.Slots.FEEDBACK, Arrays.asList(
67 | EntitySlotMapping.builder(Constants.Entities.FEEDBACK).build(),
68 | TextSlotMapping.builder().build()
69 | )
70 | );
71 |
72 | return slotMappingMap;
73 | }
74 |
75 | /**
76 | * Define what the form has to do after all required slots are filled
77 | *
78 | * @return
79 | */
80 | @Override
81 | protected List submit(CollectingDispatcher dispatcher) {
82 | // utter submit template
83 | dispatcher.utterTemplate(Constants.Templates.UTTER_SUBMIT);
84 | return Collections.emptyList();
85 | }
86 |
87 | @Override
88 | protected void registerSlotsValidators(Map slotValidatorMap) {
89 | slotValidatorMap.put(Constants.Slots.CUISINE, new ValidateCuisineSlot());
90 | slotValidatorMap.put(Constants.Slots.NUM_PEOPLE, new ValidateNumPeopleSlot());
91 | slotValidatorMap.put(Constants.Slots.OUTDOOR_SEATING, new ValidateOutdoorSeatingSlot());
92 | }
93 | }
94 |
--------------------------------------------------------------------------------
/src/main/java/io/github/rbajek/rasa/action/server/action/custom/form/restaurant/data/Constants.java:
--------------------------------------------------------------------------------
1 | package io.github.rbajek.rasa.action.server.action.custom.form.restaurant.data;
2 |
3 | /**
4 | * Constants used by Restaurant Form Action
5 | *
6 | * @author Rafał Bajek
7 | */
8 | public class Constants {
9 |
10 | /**
11 | * Supported slots
12 | */
13 | public static class Slots {
14 | public static final String CUISINE= "cuisine";
15 | public static final String NUM_PEOPLE= "num_people";
16 | public static final String OUTDOOR_SEATING= "outdoor_seating";
17 | public static final String PREFERENCES= "preferences";
18 | public static final String FEEDBACK= "feedback";
19 | }
20 |
21 | /**
22 | * Supported entities
23 | */
24 | public static class Entities {
25 | public static final String CUISINE= "cuisine";
26 | public static final String NUM_PEOPLE= "num_people";
27 | public static final String NUMBER= "number";
28 | public static final String SEATING= "seating";
29 | public static final String FEEDBACK= "feedback";
30 | }
31 |
32 | /**
33 | * Supported intents
34 | */
35 | public static class Intents {
36 | public static final String CHITCHAT= "chitchat";
37 | public static final String INFORM= "inform";
38 | public static final String REQUEST_RESTAURANT= "request_restaurant";
39 | public static final String AFFIRM= "affirm";
40 | public static final String DENY= "deny";
41 | }
42 |
43 | /**
44 | * Supported templates
45 | */
46 | public static class Templates {
47 | public static final String UTTER_SUBMIT= "utter_submit";
48 | public static final String UTTER_WRONG_CUISINE = "utter_wrong_cuisine";
49 | public static final String UTTER_WRONG_NUM_PEOPLE = "utter_wrong_num_people";
50 | public static final String UTTER_WRONG_OUTDOOR_SEATING = "utter_wrong_outdoor_seating";
51 | }
52 | }
53 |
--------------------------------------------------------------------------------
/src/main/java/io/github/rbajek/rasa/action/server/action/custom/form/restaurant/validator/ValidateCuisineSlot.java:
--------------------------------------------------------------------------------
1 | package io.github.rbajek.rasa.action.server.action.custom.form.restaurant.validator;
2 |
3 | import io.github.rbajek.rasa.action.server.action.custom.form.restaurant.data.Constants;
4 | import io.github.rbajek.rasa.sdk.CollectingDispatcher;
5 | import io.github.rbajek.rasa.sdk.action.form.AbstractFormAction;
6 | import io.github.rbajek.rasa.sdk.dto.Domain;
7 | import io.github.rbajek.rasa.sdk.dto.Tracker;
8 |
9 | import java.util.*;
10 |
11 | /**
12 | * Validate cuisine value.
13 | *
14 | * @author Rafał Bajek
15 | */
16 | public class ValidateCuisineSlot implements AbstractFormAction.ValidateSlot {
17 |
18 | /**
19 | * Database of supported cuisines
20 | *
21 | * @return list of supported cuisines
22 | */
23 | private List cuisineDB() {
24 | return Arrays.asList("caribbean", "chinese", "french", "greek", "indian", "italian", "mexican");
25 | }
26 |
27 | @Override
28 | public Map validateAndConvert(Object value, CollectingDispatcher dispatcher, Tracker tracker, Domain domain) {
29 | Objects.requireNonNull(value, "Value cannot be null");
30 |
31 | Map validationMapResult = new HashMap<>();
32 |
33 | if(cuisineDB().contains(String.class.cast(value).toLowerCase())) {
34 | // validation succeeded, return the value of the "cuisine" slot to value
35 | validationMapResult.put(Constants.Slots.CUISINE, value);
36 | return validationMapResult;
37 | }
38 |
39 | // validation failed, return "null", meaning the user will be asked for the slot again
40 | dispatcher.utterTemplate(Constants.Templates.UTTER_WRONG_CUISINE);
41 | validationMapResult.put(Constants.Slots.CUISINE, null);
42 | return validationMapResult;
43 | }
44 | }
45 |
--------------------------------------------------------------------------------
/src/main/java/io/github/rbajek/rasa/action/server/action/custom/form/restaurant/validator/ValidateNumPeopleSlot.java:
--------------------------------------------------------------------------------
1 | package io.github.rbajek.rasa.action.server.action.custom.form.restaurant.validator;
2 |
3 | import io.github.rbajek.rasa.action.server.action.custom.form.restaurant.data.Constants;
4 | import io.github.rbajek.rasa.sdk.CollectingDispatcher;
5 | import io.github.rbajek.rasa.sdk.action.form.AbstractFormAction;
6 | import io.github.rbajek.rasa.sdk.dto.Domain;
7 | import io.github.rbajek.rasa.sdk.dto.Tracker;
8 |
9 | import java.util.HashMap;
10 | import java.util.Map;
11 |
12 | /**
13 | * Validate num_people value.
14 | *
15 | * @author Rafał Bajek
16 | */
17 | public class ValidateNumPeopleSlot implements AbstractFormAction.ValidateSlot {
18 |
19 | @Override
20 | public Map validateAndConvert(Object value, CollectingDispatcher dispatcher, Tracker tracker, Domain domain) {
21 | Map validationMapResult = new HashMap<>();
22 |
23 | if(String.class.isInstance(value) && Integer.parseInt((String)value) > 0) {
24 | validationMapResult.put(Constants.Slots.NUM_PEOPLE, value);
25 | } else if(Integer.class.isInstance(value) && Integer.class.cast(value) > 0) {
26 | validationMapResult.put(Constants.Slots.NUM_PEOPLE, value);
27 | } else {
28 | dispatcher.utterTemplate(Constants.Templates.UTTER_WRONG_NUM_PEOPLE);
29 | // validation failed, set slot to null
30 | validationMapResult.put(Constants.Slots.NUM_PEOPLE, null);
31 | }
32 | return validationMapResult;
33 | }
34 | }
35 |
--------------------------------------------------------------------------------
/src/main/java/io/github/rbajek/rasa/action/server/action/custom/form/restaurant/validator/ValidateOutdoorSeatingSlot.java:
--------------------------------------------------------------------------------
1 | package io.github.rbajek.rasa.action.server.action.custom.form.restaurant.validator;
2 |
3 | import io.github.rbajek.rasa.action.server.action.custom.form.restaurant.data.Constants;
4 | import io.github.rbajek.rasa.sdk.CollectingDispatcher;
5 | import io.github.rbajek.rasa.sdk.action.form.AbstractFormAction;
6 | import io.github.rbajek.rasa.sdk.dto.Domain;
7 | import io.github.rbajek.rasa.sdk.dto.Tracker;
8 |
9 | import java.util.HashMap;
10 | import java.util.Map;
11 |
12 | /**
13 | * Validate outdoor_seating value.
14 | *
15 | * @author Rafał Bajek
16 | */
17 | public class ValidateOutdoorSeatingSlot implements AbstractFormAction.ValidateSlot {
18 |
19 | @Override
20 | public Map validateAndConvert(Object value, CollectingDispatcher dispatcher, Tracker tracker, Domain domain) {
21 | Map validationMapResult = new HashMap<>();
22 | if(String.class.isInstance(value)) {
23 | if ("out".equals(value)) {
24 | // convert "out..." to true
25 | validationMapResult.put(Constants.Slots.OUTDOOR_SEATING, true);
26 | } else if ("in".equals(value)) {
27 | // convert "in..." to false
28 | validationMapResult.put(Constants.Slots.OUTDOOR_SEATING, false);
29 | } else {
30 | dispatcher.utterTemplate(Constants.Templates.UTTER_WRONG_OUTDOOR_SEATING);
31 | // validation failed, set slot to None
32 | validationMapResult.put(Constants.Slots.OUTDOOR_SEATING, null);
33 | }
34 | } else {
35 | // affirm/deny was picked up as T/F
36 | validationMapResult.put(Constants.Slots.OUTDOOR_SEATING, value);
37 | }
38 | return validationMapResult;
39 | }
40 | }
41 |
--------------------------------------------------------------------------------
/src/main/java/io/github/rbajek/rasa/action/server/action/custom/joke/ActionJoke.java:
--------------------------------------------------------------------------------
1 | package io.github.rbajek.rasa.action.server.action.custom.joke;
2 |
3 | import io.github.rbajek.rasa.sdk.CollectingDispatcher;
4 | import io.github.rbajek.rasa.sdk.action.Action;
5 | import io.github.rbajek.rasa.sdk.dto.Domain;
6 | import io.github.rbajek.rasa.sdk.dto.Tracker;
7 | import io.github.rbajek.rasa.sdk.dto.event.AbstractEvent;
8 | import lombok.Getter;
9 | import lombok.Setter;
10 | import lombok.ToString;
11 | import org.springframework.beans.factory.annotation.Autowired;
12 | import org.springframework.stereotype.Component;
13 | import org.springframework.web.client.RestTemplate;
14 |
15 | import java.util.Collections;
16 | import java.util.List;
17 |
18 | /**
19 | * Custom action for handling jokes
20 | *
21 | * @author Rafał Bajek
22 | */
23 | @Component
24 | public class ActionJoke implements Action {
25 |
26 | private static final String REST_URI = "http://api.icndb.com/jokes/random";
27 |
28 | @Autowired
29 | private RestTemplate restTemplate;
30 |
31 | @Override
32 | public String name() {
33 | return "action_joke";
34 | }
35 |
36 | @Override
37 | public List run(CollectingDispatcher dispatcher, Tracker tracker, Domain domain) {
38 | // make an API call
39 | Joke jokeResponse = restTemplate.getForObject(REST_URI, Joke.class);
40 |
41 | // extract a joke from returned json response
42 | String joke = jokeResponse.getValue().getJoke();
43 |
44 | // send the message back to the user
45 | dispatcher.utterMessage(joke);
46 |
47 | return Collections.emptyList();
48 | }
49 |
50 | @ToString
51 | @Getter
52 | @Setter
53 | private static class Joke {
54 | String type;
55 | JokeValue value;
56 | }
57 |
58 | @ToString @Getter @Setter
59 | private static class JokeValue {
60 | Long id;
61 | String joke;
62 | Object[] categories;
63 | }
64 | }
65 |
--------------------------------------------------------------------------------
/src/main/java/io/github/rbajek/rasa/action/server/action/support/AutoRegisterAction.java:
--------------------------------------------------------------------------------
1 | package io.github.rbajek.rasa.action.server.action.support;
2 |
3 | import io.github.rbajek.rasa.sdk.ActionExecutor;
4 | import io.github.rbajek.rasa.sdk.action.Action;
5 | import org.springframework.beans.factory.annotation.Autowired;
6 | import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
7 | import org.springframework.context.ApplicationListener;
8 | import org.springframework.context.event.ContextRefreshedEvent;
9 | import org.springframework.stereotype.Component;
10 |
11 | /**
12 | * Discover and register custom rasa actions
13 | *
14 | * @author Rafał Bajek
15 | */
16 | @Component
17 | public class AutoRegisterAction implements ApplicationListener {
18 |
19 | @Autowired
20 | private ConfigurableListableBeanFactory beanFactory;
21 |
22 | @Autowired
23 | private ActionExecutor rasaActionExecutor;
24 |
25 | @Override
26 | public void onApplicationEvent(ContextRefreshedEvent contextRefreshedEvent) {
27 | beanFactory.getBeansOfType(Action.class).values().forEach(rasaAction -> {
28 | rasaActionExecutor.registerAction(rasaAction);
29 | });
30 | }
31 | }
32 |
--------------------------------------------------------------------------------
/src/main/java/io/github/rbajek/rasa/action/server/config/AppConfig.java:
--------------------------------------------------------------------------------
1 | package io.github.rbajek.rasa.action.server.config;
2 |
3 | import io.github.rbajek.rasa.sdk.ActionExecutor;
4 | import org.springframework.context.annotation.Bean;
5 | import org.springframework.context.annotation.ComponentScan;
6 | import org.springframework.context.annotation.Configuration;
7 | import org.springframework.web.client.RestTemplate;
8 |
9 | /**
10 | * @author Rafał Bajek
11 | */
12 | @Configuration(proxyBeanMethods = false)
13 | @ComponentScan(basePackages = "io.github.rbajek.rasa.action.server")
14 | public class AppConfig {
15 |
16 | @Bean
17 | public ActionExecutor rasaActionExecutor() {
18 | return new ActionExecutor();
19 | }
20 |
21 | @Bean
22 | public RestTemplate restTemplate() {
23 | return new RestTemplate();
24 | }
25 | }
26 |
--------------------------------------------------------------------------------
/src/main/java/io/github/rbajek/rasa/action/server/controller/EndpointController.java:
--------------------------------------------------------------------------------
1 | package io.github.rbajek.rasa.action.server.controller;
2 |
3 | import io.github.rbajek.rasa.action.server.controller.dto.RegisteredAction;
4 | import io.github.rbajek.rasa.action.server.controller.dto.Status;
5 | import io.github.rbajek.rasa.sdk.ActionExecutor;
6 | import io.github.rbajek.rasa.sdk.dto.ActionRequest;
7 | import io.github.rbajek.rasa.sdk.dto.ActionResponse;
8 | import lombok.extern.slf4j.Slf4j;
9 | import org.springframework.beans.factory.annotation.Autowired;
10 | import org.springframework.web.bind.annotation.*;
11 |
12 | import java.util.List;
13 | import java.util.stream.Collectors;
14 |
15 | /**
16 | * @author Rafał Bajek
17 | */
18 | @RestController
19 | @RequestMapping("/")
20 | @Slf4j
21 | public class EndpointController {
22 |
23 | @Autowired
24 | private ActionExecutor rasaActionExecutor;
25 |
26 | /**
27 | * The main entry point
28 | *
29 | * @return info about the action server
30 | */
31 | @GetMapping("/")
32 | public String home() {
33 | return "Rasa action server is up and running";
34 | }
35 |
36 | /**
37 | * Ping endpoint to check if the server is running and well.
38 | *
39 | * @return status of action server
40 | */
41 | @GetMapping("/health")
42 | public Status health() {
43 | return new Status("ok");
44 | }
45 |
46 | /**
47 | * List all registered actions.
48 | *
49 | * @return
50 | */
51 | @GetMapping("/actions")
52 | public List actions() {
53 | return rasaActionExecutor.getRegisteredActionNames().stream().map(actionName -> new RegisteredAction((actionName))).collect(Collectors.toList());
54 | }
55 |
56 | @PostMapping("/webhook")
57 | public ActionResponse webhook(@RequestBody ActionRequest actionRequest) {
58 | return rasaActionExecutor.run(actionRequest);
59 | }
60 | }
61 |
--------------------------------------------------------------------------------
/src/main/java/io/github/rbajek/rasa/action/server/controller/GlobalExceptionController.java:
--------------------------------------------------------------------------------
1 | package io.github.rbajek.rasa.action.server.controller;
2 |
3 | import lombok.extern.slf4j.Slf4j;
4 | import org.springframework.http.HttpHeaders;
5 | import org.springframework.http.HttpStatus;
6 | import org.springframework.http.ResponseEntity;
7 | import org.springframework.web.bind.annotation.ControllerAdvice;
8 | import org.springframework.web.bind.annotation.ExceptionHandler;
9 | import org.springframework.web.context.request.WebRequest;
10 | import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;
11 |
12 | /**
13 | * @author Rafał Bajek
14 | */
15 | @ControllerAdvice
16 | @Slf4j
17 | public class GlobalExceptionController extends ResponseEntityExceptionHandler {
18 |
19 | @ExceptionHandler(value = { Throwable.class})
20 | protected ResponseEntity