rivescript java
0.11.0 - August 6, 2019
Ini adalah perpustakaan juru bahasa RiveScript yang ditulis untuk bahasa pemrograman Java. RiveScript adalah bahasa skrip untuk chatterbots, sehingga memudahkan penulisan pasangan pemicu/respons untuk membangun kecerdasan bot.
RiveScript adalah bahasa skrip untuk membuat chatbots. Ini memiliki sintaks yang sangat sederhana dan dirancang agar mudah dibaca dan cepat untuk ditulis.
Contoh sederhana tampilan RiveScript:
+ hello bot
- Hello human.
Ini cocok dengan pesan pengguna "halo bot" dan akan membalas "Halo manusia." Atau untuk contoh yang sedikit lebih rumit:
+ my name is *
* == => >Wow, we have the same name!
* != undefined => >Did you change your name?
- >Nice to meet you, !
Situs web resmi untuk RiveScript adalah https://www.rivescript.com/
Untuk menguji coba RiveScript di browser web Anda, cobalah RiveScript Playground.
Lihat juga Wiki Komunitas RiveScript untuk pola desain umum dan tip & trik untuk RiveScript.
Tambahkan ketergantungan rivescript-core ke proyek Anda:
Pakar :
< dependency >
< groupId >com.rivescriptgroupId >
< artifactId >rivescript-coreartifactId >
< version >0.10.0version >
dependency >kelas :
dependencies {
compile " com.rivescript:rivescript-core:0.10.0 "
}Jika Anda ingin menggunakan RiveScript dalam aplikasi Spring Boot, lihat bagian Spring Boot Starter.
Jika digunakan sebagai perpustakaan untuk menulis chatbot Anda sendiri, sinopsisnya adalah sebagai berikut:
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!" ); Distribusi rivescript-core juga menyertakan shell interaktif untuk menguji bot RiveScript Anda. Jalankan dengan path ke folder pada disk yang berisi dokumen RiveScript Anda. Contoh:
java com.rivescript.cmd.Shell [options]
Konstruktor com.rivescript.RiveScript mengambil instance Config opsional. Berikut adalah contoh lengkap dengan semua opsi yang didukung. Anda hanya perlu memberikan nilai untuk opsi konfigurasi yang berbeda dengan defaultnya.
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 ());Untuk kenyamanan, Anda dapat menggunakan pintasan:
// 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 ());Dukungan UTF-8 di RiveScript dianggap sebagai fitur eksperimental. Ini dinonaktifkan secara default.
Secara default (tanpa mengaktifkan mode UTF-8), pemicu hanya boleh berisi karakter ASCII dasar (tidak ada karakter asing), dan semua karakter dalam pesan pengguna akan dihilangkan kecuali huruf, angka, dan spasi. Artinya, misalnya, Anda tidak dapat menangkap alamat email pengguna dalam balasan RiveScript, karena tanda @ dan . karakter.
Jika mode UTF-8 diaktifkan, pembatasan ini akan dicabut. Pemicu hanya dibatasi untuk tidak mengandung metakarakter tertentu seperti garis miring terbalik, dan pesan pengguna hanya dihilangkan dari garis miring terbalik dan tanda kurung siku HTML (untuk melindungi dari XSS yang jelas jika Anda menggunakan RiveScript dalam aplikasi web). Selain itu, karakter tanda baca umum dihilangkan, dengan set defaultnya adalah [.,!?;:] . Hal ini dapat diatasi dengan memberikan string regexp baru ke metode Config.Builder#unicodePunctuation() . Contoh:
// 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 ()); Tag
Tambahkan ketergantungan rivescript-spring-boot-starter ke proyek Anda:
Pakar :
< dependency >
< groupId >com.rivescriptgroupId >
< artifactId >rivescript-spring-boot-starterartifactId >
< version >0.10.0version >
dependency >kelas :
dependencies {
compile " com.rivescript:rivescript-spring-boot-starter:0.10.0 "
} Pemula akan secara otomatis menambahkan ketergantungan rivescript-core ke proyek Anda dan memicu konfigurasi otomatis untuk membuat instance bot RiveScript .
Meskipun konfigurasi otomatis akan menggunakan default yang masuk akal untuk membuat instance bot, properti berikut dapat ditentukan di dalam file application.properties / application.yml Anda (atau sebagai saklar baris perintah) untuk menyesuaikan perilaku konfigurasi otomatis:
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`). Untuk secara otomatis mendaftarkan subrutin Java khusus dan/atau penangan objek yang didukung non-default dalam instance bot RiveScript yang dibuat, tentukan kacang yang sesuai dalam konteks aplikasi Anda seperti:
@ 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 ; }
Untuk mengkompilasi, menguji, membuat semua toples dan dokumen dijalankan:
./gradlew build
Untuk menginstal semua toples ke dalam cache Maven lokal Anda, jalankan:
./gradlew install
Folder /samples berisi berbagai contoh implementasi bot Java RiveScript.
rsbot - RSBot.java adalah implementasi sederhana menggunakan com.rivescript.cmd.Shell .
Perintah berikut dapat digunakan pada prompt input Anda di 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.
Untuk menjalankan RSBot untuk mulai mengobrol dengan demo yang dijalankan berbasis Eliza:
./gradlew :rivescript-samples-rsbot:runBot --console plain
spring-boot-starter-rsbot - Contoh ini menggunakan RiveScript Spring Boot Starter untuk mengonfigurasi otomatis instance bot RiveScript .
Untuk mulai mengobrol dengan menjalankan bot demo:
./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.
