rivescript java
0.11.0 - August 6, 2019
هذه مكتبة مترجم RiveScript مكتوبة للغة برمجة Java. RiveScript هي لغة برمجة نصية لروبوتات الدردشة، مما يجعل من السهل كتابة أزواج التشغيل/الاستجابة لبناء ذكاء الروبوت.
RiveScript هي لغة برمجة نصية لتأليف برامج الدردشة الآلية. يحتوي على بناء جملة بسيط جدًا ومصمم ليكون سهل القراءة وسريع الكتابة.
مثال بسيط لما يبدو عليه RiveScript:
+ 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 الخاص بك. قم بتشغيله باستخدام المسار إلى مجلد على القرص يحتوي على مستندات RiveScript الخاصة بك. مثال:
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 bot.
على الرغم من أن التكوين التلقائي سيستخدم إعدادات افتراضية معقولة لإنشاء مثيل الروبوت، إلا أنه يمكن تحديد الخصائص التالية داخل ملف 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 bot الذي تم إنشاؤه، حدد الفاصوليا المناسبة في سياق التطبيق الخاص بك مثل:
@ 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 ; }
لتجميع واختبار وبناء جميع الجرار والمستندات، قم بتشغيل:
./gradlew build
لتثبيت جميع الجرار في ذاكرة التخزين المؤقت المحلية لـ Maven، قم بتشغيل:
./gradlew install
يحتوي المجلد /samples على نماذج مختلفة لتطبيقات Java RiveScript bot.
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.
