rivescript java
0.11.0 - August 6, 2019
これは、Java プログラミング言語用に作成された RiveScript インタープリタ ライブラリです。 RiveScript はチャタボット用のスクリプト言語であり、ボットのインテリジェンスを構築するためのトリガーと応答のペアを簡単に作成できます。
RiveScript は、チャットボットを作成するためのスクリプト言語です。構文は非常にシンプルで、読みやすく、速く書けるように設計されています。
RiveScript がどのようなものかを示す簡単な例:
+ hello bot
- Hello human.
これは、ユーザーの「こんにちはボット」というメッセージと一致し、「こんにちは、人間です」と応答します。または、もう少し複雑な例としては次のようになります。
+ my name is *
* == => >Wow, we have the same name!
* != undefined => >Did you change your name?
- >Nice to meet you, !
RiveScript の公式 Web サイトは https://www.rivescript.com/ です。
Web ブラウザで RiveScript をテストするには、RiveScript Playground を試してください。
RiveScript の一般的なデザイン パターンやヒントとテクニックについては、 RiveScript コミュニティ Wikiもチェックしてください。
rivescript-core依存関係をプロジェクトに追加します。
メイブン:
< dependency >
< groupId >com.rivescriptgroupId >
< artifactId >rivescript-coreartifactId >
< version >0.10.0version >
dependency >グラドル：
dependencies {
compile " com.rivescript:rivescript-core:0.10.0 "
}Spring Boot アプリケーションで RiveScript を使用する場合は、「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 ());RiveScript での UTF-8 サポートは実験的な機能とみなされます。デフォルトでは無効になっています。
デフォルト (UTF-8 モードをオンにしていない場合) では、トリガーには基本的な ASCII 文字のみを含めることができ (外国文字は不可)、ユーザーのメッセージからは文字、数字、スペースを除くすべての文字が削除されます。これは、たとえば、@ と . が原因で、RiveScript 応答でユーザーの電子メール アドレスを取得できないことを意味します。文字。
UTF-8 モードを有効にすると、これらの制限が解除されます。トリガーにはバックスラッシュなどの特定のメタキャラクターが含まれないように制限されており、ユーザーのメッセージからはバックスラッシュと HTML 山かっこのみが削除されます (Web アプリケーションで RiveScript を使用する場合に明らかな XSS から保護するため)。さらに、一般的な句読点文字は削除され、デフォルトのセットは[.,!?;:]になります。これは、新しい正規表現文字列を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 の
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`).作成されたRiveScriptボット インスタンスにカスタム Java サブルーチンやサポートされているデフォルト以外のオブジェクト ハンドラーを自動的に登録するには、次のようにアプリケーション コンテキストで適切な 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
すべての jar をローカルの 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.
