rivescript java
0.11.0 - August 6, 2019
Esta es una biblioteca de intérpretes RiveScript escrita para el lenguaje de programación Java. RiveScript es un lenguaje de programación para chatterbots, que facilita la escritura de pares de activación/respuesta para desarrollar la inteligencia de un bot.
RiveScript es un lenguaje de programación para crear chatbots. Tiene una sintaxis muy simple y está diseñado para ser fácil de leer y rápido de escribir.
Un ejemplo sencillo de cómo se ve RiveScript:
+ hello bot
- Hello human.
Esto coincide con el mensaje de un usuario de "hola robot" y respondería "Hola humano". O para un ejemplo un poco más complicado:
+ my name is *
* == => >Wow, we have the same name!
* != undefined => >Did you change your name?
- >Nice to meet you, !
El sitio web oficial de RiveScript es https://www.rivescript.com/
Para probar RiveScript en su navegador web, pruebe RiveScript Playground.
Consulte también el Wiki de la comunidad RiveScript para conocer patrones de diseño comunes, consejos y trucos para RiveScript.
Agregue la dependencia rivescript-core a su proyecto:
experto :
< dependency >
< groupId >com.rivescriptgroupId >
< artifactId >rivescript-coreartifactId >
< version >0.10.0version >
dependency >Gradle :
dependencies {
compile " com.rivescript:rivescript-core:0.10.0 "
}Si desea utilizar RiveScript en una aplicación Spring Boot, consulte la sección Spring Boot Starter.
Cuando se utiliza como biblioteca para escribir su propio chatbot, la sinopsis es la siguiente:
import com . rivescript . Config ;
import com . rivescript . RiveScript ;
// Create a new bot with the default settings.
RiveScript bot = new RiveScript ();
// To enable UTF-8 mode, you'd have initialized the bot like:
RiveScript bot = new RiveScript ( Config . utf8 ());
// Load a directory full of RiveScript documents (.rive files)
bot . loadDirectory ( "./replies" );
// Load an individual file.
bot . LoadFile ( "./testsuite.rive" );
// Sort the replies after loading them!
bot . sortReplies ();
// Get a reply.
String reply = bot . reply ( "user" , "Hello bot!" ); La distribución rivescript-core también incluye un shell interactivo para probar su bot RiveScript. Ejecútelo con la ruta a una carpeta en el disco que contenga sus documentos RiveScript. Ejemplo:
java com.rivescript.cmd.Shell [options]
El constructor com.rivescript.RiveScript toma una instancia Config opcional. Aquí hay un ejemplo completo con todas las opciones admitidas. Solo necesita proporcionar valores para las opciones de configuración que sean diferentes a los predeterminados.
RiveScript bot = new RiveScript ( Config . newBuilder ()
. throwExceptions ( false ) // Whether exception throwing is enabled
. strict ( true ) // Whether strict syntax checking is enabled
. utf8 ( false ) // Whether UTF-8 mode is enabled
. unicodePunctuation ( "[.,!?;:]" ) // The unicode punctuation pattern
. forceCase ( false ) // Whether forcing triggers to lowercase is enabled
. concat ( ConcatMode . NONE ) // The concat mode
. depth ( 50 ) // The recursion depth limit
. sessionManager ( sessionManager ) // The session manager for user variables
. errorMessages ( errors ) // Map of custom error messages
. build ());Para mayor comodidad, puede utilizar atajos:
// The default constructor uses a basic configuration.
RiveScript bot = new RiveScript ();
// This is similar as:
RiveScript bot = new RiveScript ( Config . basic ());
// To use the basic configuration with UTF-8 mode enabled use:
RiveScript bot = new RiveScript ( Config . utf8 ());La compatibilidad con UTF-8 en RiveScript se considera una característica experimental. Está deshabilitado de forma predeterminada.
De forma predeterminada (sin el modo UTF-8 activado), los activadores solo pueden contener caracteres ASCII básicos (sin caracteres extranjeros) y el mensaje del usuario carece de todos los caracteres excepto letras, números y espacios. Esto significa que, por ejemplo, no puede capturar la dirección de correo electrónico de un usuario en una respuesta de RiveScript debido a @ y . personajes.
Cuando el modo UTF-8 está habilitado, estas restricciones se eliminan. Los activadores solo se limitan a no contener ciertos metacaracteres como la barra invertida, y el mensaje del usuario solo está libre de barras invertidas y corchetes en ángulo HTML (para protegerlo de XSS obvio si usa RiveScript en una aplicación web). Además, se eliminan los caracteres de puntuación comunes y el conjunto predeterminado es [.,!?;:] . Esto se puede anular proporcionando una nueva cadena de expresión regular al método Config.Builder#unicodePunctuation() . Ejemplo:
// Make a new bot with UTF-8 mode enabled and override the punctuation
characters that get stripped from the user 's message.
RiveScript bot = new RiveScript ( Config . Builder
. utf8 ()
. unicodePunctuation ( "[.,!?;:]" )
. build ()); Las etiquetas
Agregue la dependencia rivescript-spring-boot-starter a su proyecto:
experto :
< dependency >
< groupId >com.rivescriptgroupId >
< artifactId >rivescript-spring-boot-starterartifactId >
< version >0.10.0version >
dependency >Gradle :
dependencies {
compile " com.rivescript:rivescript-spring-boot-starter:0.10.0 "
} El iniciador agregará automáticamente la dependencia rivescript-core a su proyecto y activará la configuración automática para crear la instancia del bot RiveScript .
Aunque la configuración automática utilizará valores predeterminados razonables para crear la instancia del bot, se pueden especificar las siguientes propiedades dentro de su archivo application.properties / application.yml (o como modificadores de línea de comando) para personalizar el comportamiento de la configuración automática:
rivescript:
enabled: true # Enable RiveScript for the application.
source-path: classpath:/rivescript/ # The comma-separated list of RiveScript source files and/or directories.
file-extensions: .rive, .rs # The comma-separated list of RiveScript file extensions to load.
throw-exceptions: false # Enable throw exceptions.
strict: true # Enable strict syntax checking.
utf8: false # Enable UTF-8 mode.
unicode-punctuation: [.,!?;:] # The unicode punctuation pattern (only used when UTF-8 mode is enabled).
force-case: false # Enable forcing triggers to lowercase.
concat: none # The concat mode (none|newline|space).
depth: 50 # The recursion depth limit.
error-messages: # The custom error message overrides. For instance `rivescript.error-messages.deepRecursion=Custom Deep Recursion Detected Message`
object-handlers: # The comma-separated list of object handler names to register (currently supported: `groovy`, `javascript`, `ruby`). Para registrar automáticamente subrutinas Java personalizadas y/o controladores de objetos compatibles no predeterminados en la instancia del bot RiveScript creada, defina los beans apropiados en el contexto de su aplicación, como:
@ Bean public Map < String , Subroutine > subroutines () { // The key is the name of the Java object macro to register. Map < String , Subroutine > subroutines = new HashMap <>(); subroutines . put ( "subroutine1" , new Subroutine1 ()); subroutines . put ( "subroutine2" , new Subroutine2 ()); return subroutines ; } @ Bean public Map < String , ObjectHandler > objectHandlers () { // The key is the name of the programming language to register. Map < String , ObjectHandler > objectHandlers = new HashMap <>(); objectHandlers . put ( "handler1" , new ObjectHandler1 ()); objectHandlers . put ( "handler2" , new ObjectHandler2 ()); return objectHandlers ; }
Para compilar, probar y compilar todos los archivos jar y documentos, ejecute:
./gradlew build
Para instalar todos los archivos jar en su caché local de Maven, ejecute:
./gradlew install
La carpeta /samples contiene varios ejemplos de implementaciones de bots Java RiveScript.
rsbot : RSBot.java es una implementación simple que utiliza com.rivescript.cmd.Shell .
Estos comandos se pueden usar en el indicador de entrada en RSBot:
/quit - Quit the program
/dump topics - Dump the internal topic/trigger/reply struct (debugging)
/dump sorted - Dump the internal trigger sort buffers (debugging)
/last - Print the last trigger you matched.
Para ejecutar RSBot y comenzar a chatear con la demostración basada en Eliza:
./gradlew :rivescript-samples-rsbot:runBot --console plain
spring-boot-starter-rsbot : este ejemplo utiliza RiveScript Spring Boot Starter para configurar automáticamente la instancia del bot RiveScript .
Para comenzar a chatear con el bot de demostración, ejecute:
./gradlew :rivescript-samples-spring-boot-starter-rsbot:bootRun --console plain
The MIT License (MIT)
Copyright (c) 2016 the original author or authors.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
