rivescript java
0.11.0 - August 6, 2019
Il s'agit d'une bibliothèque d'interpréteur RiveScript écrite pour le langage de programmation Java. RiveScript est un langage de script pour les chaterbots, facilitant l'écriture de paires déclencheur/réponse pour développer l'intelligence d'un bot.
RiveScript est un langage de script pour la création de chatbots. Il a une syntaxe très simple et est conçu pour être facile à lire et rapide à écrire.
Un exemple simple de ce à quoi ressemble RiveScript :
+ hello bot
- Hello human.
Cela correspond au message "Bonjour bot" d'un utilisateur et répondrait "Bonjour humain". Ou pour un exemple un peu plus compliqué :
+ my name is *
* == => >Wow, we have the same name!
* != undefined => >Did you change your name?
- >Nice to meet you, !
Le site officiel de RiveScript est https://www.rivescript.com/
Pour tester RiveScript dans votre navigateur Web, essayez RiveScript Playground.
Consultez également le wiki de la communauté RiveScript pour connaître les modèles de conception courants ainsi que les trucs et astuces pour RiveScript.
Ajoutez la dépendance rivescript-core à votre projet :
Maven :
< dependency >
< groupId >com.rivescriptgroupId >
< artifactId >rivescript-coreartifactId >
< version >0.10.0version >
dependency >Graduation :
dependencies {
compile " com.rivescript:rivescript-core:0.10.0 "
}Si vous souhaitez utiliser RiveScript dans une application Spring Boot, consultez la section Spring Boot Starter.
Lorsqu'il est utilisé comme bibliothèque pour écrire votre propre chatbot, le synopsis est le suivant :
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 distribution rivescript-core comprend également un shell interactif pour tester votre bot RiveScript. Exécutez-le avec le chemin d'accès à un dossier sur le disque contenant vos documents RiveScript. Exemple:
java com.rivescript.cmd.Shell [options]
Le constructeur com.rivescript.RiveScript prend une instance Config facultative. Voici un exemple complet avec toutes les options prises en charge. Vous devez uniquement fournir des valeurs pour les options de configuration qui sont différentes des valeurs par défaut.
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 ());Pour plus de commodité, vous pouvez utiliser des raccourcis :
// 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 prise en charge d'UTF-8 dans RiveScript est considérée comme une fonctionnalité expérimentale. Il est désactivé par défaut.
Par défaut (sans le mode UTF-8 activé), les déclencheurs ne peuvent contenir que des caractères ASCII de base (pas de caractères étrangers) et le message de l'utilisateur est dépourvu de tous les caractères à l'exception des lettres, des chiffres et des espaces. Cela signifie que, par exemple, vous ne pouvez pas capturer l'adresse e-mail d'un utilisateur dans une réponse RiveScript, à cause des @ et . personnages.
Lorsque le mode UTF-8 est activé, ces restrictions sont levées. Les déclencheurs sont uniquement limités à ne pas contenir certains métacaractères comme la barre oblique inverse, et le message de l'utilisateur est uniquement dépourvu de barres obliques inverses et de crochets HTML (pour se protéger des XSS évidents si vous utilisez RiveScript dans une application Web). De plus, les caractères de ponctuation courants sont supprimés, le jeu par défaut étant [.,!?;:] . Cela peut être remplacé en fournissant une nouvelle chaîne d'expression rationnelle à la méthode Config.Builder#unicodePunctuation() . Exemple:
// 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 ()); Les balises
Ajoutez la dépendance rivescript-spring-boot-starter à votre projet :
Maven :
< dependency >
< groupId >com.rivescriptgroupId >
< artifactId >rivescript-spring-boot-starterartifactId >
< version >0.10.0version >
dependency >Graduation :
dependencies {
compile " com.rivescript:rivescript-spring-boot-starter:0.10.0 "
} Le démarreur ajoutera automatiquement la dépendance rivescript-core à votre projet et déclenchera la configuration automatique pour créer l'instance de bot RiveScript .
Bien que la configuration automatique utilise des valeurs par défaut raisonnables pour créer l'instance de bot, les propriétés suivantes peuvent être spécifiées dans votre fichier application.properties / application.yml (ou en tant que commutateurs de ligne de commande) pour personnaliser le comportement de la configuration automatique :
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`). Pour enregistrer automatiquement des sous-programmes Java personnalisés et/ou des gestionnaires d'objets non pris en charge par défaut dans l'instance de bot RiveScript créée, définissez les beans appropriés dans le contexte de votre application, comme :
@ 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 ; }
Pour compiler, tester, construire tous les fichiers jar et docs, exécutez :
./gradlew build
Pour installer tous les fichiers JAR dans votre cache Maven local, exécutez :
./gradlew install
Le dossier /samples contient divers exemples d'implémentations de robots Java RiveScript.
rsbot - Le RSBot.java est une implémentation simple utilisant le com.rivescript.cmd.Shell .
Ces commandes peuvent être utilisées à votre invite de saisie dans 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.
Pour exécuter RSBot et commencer à discuter avec la démo basée sur Eliza :
./gradlew :rivescript-samples-rsbot:runBot --console plain
spring-boot-starter-rsbot - Cet exemple utilise RiveScript Spring Boot Starter pour configurer automatiquement l'instance de bot RiveScript .
Pour commencer à discuter avec le robot de démonstration, exécutez :
./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.
