rivescript java
0.11.0 - August 6, 2019
นี่คือไลบรารีล่าม RiveScript ที่เขียนขึ้นสำหรับภาษาการเขียนโปรแกรม Java RiveScript เป็นภาษาสคริปต์สำหรับแชทเตอร์บอต ทำให้ง่ายต่อการเขียนคู่ทริกเกอร์/การตอบสนองเพื่อสร้างความฉลาดของบอต
RiveScript เป็นภาษาสคริปต์สำหรับการเขียนแชทบอท มีไวยากรณ์ที่เรียบง่ายและได้รับการออกแบบให้อ่านง่ายและเขียนได้อย่างรวดเร็ว
ตัวอย่างง่ายๆ ของลักษณะของ RiverScript:
+ hello bot
- Hello human.
ซึ่งตรงกับข้อความ "hello bot" ของผู้ใช้ และจะตอบกลับว่า "Hello human" หรือตัวอย่างที่ซับซ้อนกว่านี้เล็กน้อย:
+ my name is *
* == => >Wow, we have the same name!
* != undefined => >Did you change your name?
- >Nice to meet you, !
เว็บไซต์อย่างเป็นทางการของ RiveScript คือ https://www.rivescript.com/
หากต้องการทดสอบไดรฟ์ RiveScript ในเว็บเบราว์เซอร์ของคุณ ให้ลองใช้ RiveScript Playground
นอกจากนี้ ให้ตรวจสอบ RiveScript Community Wiki สำหรับรูปแบบการออกแบบทั่วไป รวมถึงคำแนะนำและเคล็ดลับสำหรับ RiveScript
เพิ่มการพึ่งพา rivescript-core ให้กับโครงการของคุณ:
มาเวน :
< dependency >
< groupId >com.rivescriptgroupId >
< artifactId >rivescript-coreartifactId >
< version >0.10.0version >
dependency >เกรด :
dependencies {
compile " com.rivescript:rivescript-core:0.10.0 "
}หากคุณต้องการใช้ RiveScript ในแอปพลิเคชัน Spring Boot โปรดดูส่วน Spring Boot Starter
เมื่อใช้เป็นไลบรารีสำหรับเขียนแชทบอทของคุณเองมีเรื่องย่อดังนี้
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!" ); การแจกจ่าย rivescript-core ยังรวมถึงเชลล์แบบโต้ตอบสำหรับการทดสอบบอต RiveScript ของคุณ เรียกใช้ด้วยเส้นทางไปยังโฟลเดอร์บนดิสก์ที่มีเอกสาร RiverScript ของคุณ ตัวอย่าง:
java com.rivescript.cmd.Shell [options]
ตัวสร้าง com.rivescript.RiveScript ใช้อินสแตนซ์ Config ที่เป็นทางเลือก นี่คือตัวอย่างแบบเต็มพร้อมตัวเลือกที่รองรับทั้งหมด คุณจะต้องระบุค่าสำหรับตัวเลือกการกำหนดค่าที่แตกต่างจากค่าเริ่มต้นเท่านั้น
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 ());เพื่อความสะดวก คุณสามารถใช้ทางลัด:
// 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 ());การรองรับ UTF-8 ใน RiveScript ถือเป็นฟีเจอร์ทดลอง มันถูกปิดใช้งานโดยค่าเริ่มต้น
ตามค่าเริ่มต้น (โดยไม่เปิดโหมด UTF-8) ทริกเกอร์อาจมีเฉพาะอักขระ ASCII พื้นฐานเท่านั้น (ไม่มีอักขระต่างประเทศ) และข้อความของผู้ใช้จะถูกตัดออกจากอักขระทั้งหมด ยกเว้นตัวอักษร ตัวเลข และช่องว่าง ซึ่งหมายความว่า คุณไม่สามารถบันทึกที่อยู่อีเมลของผู้ใช้ในการตอบกลับ RiveScript ได้ เนื่องจาก @ และ . ตัวอักษร
เมื่อเปิดใช้งานโหมด UTF-8 ข้อจำกัดเหล่านี้จะถูกยกเลิก ทริกเกอร์ถูกจำกัดไม่ให้มีอักขระเมตาบางตัว เช่น แบ็กสแลช และข้อความของผู้ใช้จะถูกลบออกจากแบ็กสแลชและวงเล็บมุม HTML เท่านั้น (เพื่อป้องกันจาก XSS ที่ชัดเจนหากคุณใช้ RiveScript ในเว็บแอปพลิเคชัน) นอกจากนี้ อักขระเครื่องหมายวรรคตอนทั่วไปจะถูกตัดออก โดยค่าเริ่มต้นคือ [.,!?;:] ซึ่งสามารถแทนที่ได้โดยการระบุสตริง regexp ใหม่ให้กับเมธอด Config.Builder#unicodePunctuation() ตัวอย่าง:
// 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 ()); แท็ก
เพิ่มการพึ่งพา rivescript-spring-boot-starter ให้กับโปรเจ็กต์ของคุณ:
มาเวน :
< dependency >
< groupId >com.rivescriptgroupId >
< artifactId >rivescript-spring-boot-starterartifactId >
< version >0.10.0version >
dependency >เกรด :
dependencies {
compile " com.rivescript:rivescript-spring-boot-starter:0.10.0 "
} โปรแกรมเริ่มต้นจะเพิ่มการพึ่งพา rivescript-core ให้กับโปรเจ็กต์ของคุณโดยอัตโนมัติ และทริกเกอร์การกำหนดค่าอัตโนมัติเพื่อสร้างอินสแตนซ์บอท RiveScript
แม้ว่าการกำหนดค่าอัตโนมัติจะใช้ค่าเริ่มต้นที่สมเหตุสมผลเพื่อสร้างอินสแตนซ์บอท แต่สามารถระบุคุณสมบัติต่อไปนี้ภายในไฟล์ application.properties / application.yml ของคุณ (หรือเป็นสวิตช์บรรทัดคำสั่ง) เพื่อปรับแต่งลักษณะการทำงานของการกำหนดค่าอัตโนมัติ:
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`). หากต้องการลงทะเบียนรูทีนย่อย Java ที่กำหนดเองและ/หรือตัวจัดการวัตถุที่รองรับที่ไม่ใช่ค่าเริ่มต้นโดยอัตโนมัติในอินสแตนซ์บอท RiveScript ที่สร้างขึ้น ให้กำหนด bean ที่เหมาะสมในบริบทแอปพลิเคชันของคุณ เช่น:
@ 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 ; }
หากต้องการคอมไพล์ ทดสอบ สร้าง jar และเอกสารทั้งหมดให้รัน:
./gradlew build
หากต้องการติดตั้ง jars ทั้งหมดลงในแคช Maven ในเครื่องของคุณให้รัน:
./gradlew install
โฟลเดอร์ /samples มีตัวอย่างการใช้งานบอต Java RiveScript ที่หลากหลาย
rsbot - RSBot.java เป็นการนำไปใช้อย่างง่ายโดยใช้ com.rivescript.cmd.Shell
คำสั่งเหล่านี้อาจใช้ที่พรอมต์อินพุตของคุณใน 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.
หากต้องการรัน RSBot เพื่อเริ่มสนทนากับการสาธิตการทำงานแบบ Eliza:
./gradlew :rivescript-samples-rsbot:runBot --console plain
spring-boot-starter-rsbot - ตัวอย่างนี้ใช้ RiveScript Spring Boot Starter เพื่อกำหนดค่าอินสแตนซ์บอท RiveScript โดยอัตโนมัติ
หากต้องการเริ่มแชทกับบอทสาธิต ให้ทำดังนี้:
./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.
