rivescript java

RiveScript-Java

導入

これは、Java プログラミング言語用に作成された RiveScript インタープリタ ライブラリです。 RiveScript はチャタボット用のスクリプト言語であり、ボットのインテリジェンスを構築するためのトリガーと応答のペアを簡単に作成できます。

RiveScript について

RiveScript は、チャットボットを作成するためのスクリプト言語です。構文は非常にシンプルで、読みやすく、速く書けるように設計されています。

RiveScript がどのようなものかを示す簡単な例:

+ hello bot
- Hello human.

これは、ユーザーの「こんにちはボット」というメッセージと一致し、「こんにちは、人間です」と応答します。または、もう少し複雑な例としては次のようになります。

+ my name is *
* <formal> == <bot name> => <set name=<formal>>Wow, we have the same name!
* <get name> != undefined => <set name=<formal>>Did you change your name?
- <set name=<formal>>Nice to meet you, <get name>!

RiveScript の公式 Web サイトは https://www.rivescript.com/ です。

Web ブラウザで RiveScript をテストするには、RiveScript Playground を試してください。

ドキュメント

• API ドキュメント: http://www.javadoc.io/doc/com.rivescript/rivescript-core/

• 作業草案: http://www.rivescript.com/wd/RiveScript

RiveScript の一般的なデザイン パターンやヒントとテクニックについては、 RiveScript コミュニティ Wikiもチェックしてください。

インストール

rivescript-core依存関係をプロジェクトに追加します。

メイブン:

 <依存関係>
  <groupId>com.rivescript</groupId>
  <artifactId>rivescript-core</artifactId>
  <バージョン>0.10.0</バージョン>
</依存関係>

グラドル：

依存関係 {
    コンパイル "com.rivescript:rivescript-core:0.10.0"}

Spring Boot アプリケーションで RiveScript を使用する場合は、「Spring Boot Starter」セクションを参照してください。

使用法

独自のチャットボットを作成するためのライブラリとして使用する場合、概要は次のとおりです。

 import com.rivescript.Config;import com.rivescript.RiveScript;// デフォルト設定で新しいボットを作成します。RiveScript bot = new RiveScript();// UTF-8 モードを有効にするには、次のようにボットを初期化します。 :RiveScript bot = new RiveScript(Config.utf8());// RiveScript ドキュメント (.rive) が詰まったディレクトリをロードしますfiles)bot.loadDirectory("./replies");// 個別のファイルをロードします。bot.LoadFile("./testsuite.rive");// 返信をロードした後に並べ替えます!bot.sortReplies();//返信を取得します。String Reply = bot.reply("user", "Hello bot!");

rivescript-coreディストリビューションには、RiveScript ボットをテストするための対話型シェルも含まれています。 RiveScript ドキュメントを含むディスク上のフォルダーへのパスを指定して実行します。例：

java com.rivescript.cmd.Shell [options] </path/to/documents>

構成

com.rivescript.RiveScriptコンストラクターは、オプションのConfigインスタンスを受け取ります。以下は、サポートされているすべてのオプションを含む完全な例です。デフォルトとは異なる構成オプションの値のみを指定する必要があります。

 RiveScript ボット = new RiveScript(Config.newBuilder()
        .throwExceptions(false) // 例外スローが有効かどうか。strict(true) // 厳密な構文チェックが有効かどうか。utf8(false) // UTF-8 モードが有効かどうか。unicodePunctuation("[.,!​​?;: ]") // Unicode 句読点パターン.forceCase(false) // トリガーを強制的に小文字にするかどうか。concat(ConcatMode.NONE) // concat mode. Depth(50) // 再帰の深さ制限 .sessionManager(sessionManager) // ユーザー変数のセッションマネージャ variables.errorMessages(errors) // カスタムエラーメッセージのマップ.build());

便宜上、ショートカットを使用できます。

 // デフォルトのコンストラクターは基本構成を使用します。RiveScript bot = new RiveScript();// これは次のようになります:RiveScript bot = new RiveScript(Config.basic());// UTF-8 モードで基本構成を使用するには有効な使用: RiveScript bot = new RiveScript(Config.utf8());

UTF-8のサポート

RiveScript での UTF-8 サポートは実験的な機能とみなされます。デフォルトでは無効になっています。

デフォルト (UTF-8 モードをオンにしていない場合) では、トリガーには基本的な ASCII 文字のみを含めることができ (外国文字は不可)、ユーザーのメッセージからは文字、数字、スペースを除くすべての文字が削除されます。これは、たとえば、@ と . が原因で、RiveScript 応答でユーザーの電子メール アドレスを取得できないことを意味します。文字。

UTF-8 モードを有効にすると、これらの制限が解除されます。トリガーにはバックスラッシュなどの特定のメタキャラクターが含まれないように制限されており、ユーザーのメッセージからはバックスラッシュと HTML 山かっこのみが削除されます (Web アプリケーションで RiveScript を使用する場合に明らかな XSS から保護するため)。さらに、一般的な句読点文字は削除され、デフォルトのセットは[.,!?;:]になります。これは、新しい正規表現文字列をConfig.Builder#unicodePunctuation()メソッドに提供することでオーバーライドできます。例：

 // UTF-8 モードを有効にして新しいボットを作成し、ユーザーのメッセージから削除される句読点文字をオーバーライドします。RiveScript bot = new RiveScript(Config.Builder.utf8()
        .unicodePunctuation("[.,!​​?;:]")
        。建てる（））;

RiveScript の<star>タグはユーザーの「生の」入力をキャプチャするため、返信を書いてユーザーの電子メール アドレスを取得したり、ユーザーの名前に外国文字を保存したりできます。

スプリングブートスターター

rivescript-spring-boot-starter依存関係をプロジェクトに追加します。

メイブン:

 <依存関係>
  <groupId>com.rivescript</groupId>
  <artifactId>rivescript-spring-boot-starter</artifactId>
  <バージョン>0.10.0</バージョン>
</依存関係>

グラドル：

依存関係 {
    "com.rivescript:rivescript-spring-boot-starter:0.10.0" をコンパイルします。}

スターターは、 rivescript-core依存関係をプロジェクトに自動的に追加し、自動構成をトリガーしてRiveScriptボット インスタンスを作成します。

自動構成では適切なデフォルトを使用してボット インスタンスを作成しますが、次のプロパティをapplication.properties / application.ymlファイル内で (またはコマンド ライン スイッチとして) 指定して、自動構成の動作をカスタマイズできます。

ライブスクリプト:
  Enabled: true # アプリケーションの RiveScript を有効にします。
  source-path: classpath:/rivescript/ # RiveScript ソース ファイルおよび/またはディレクトリのカンマ区切りのリスト。
  file-extensions: .rive, .rs # ロードする RiveScript ファイル拡張子のカンマ区切りのリスト。
  throw-Exceptions: false # 例外のスローを有効にします。
  strict: true # 厳密な構文チェックを有効にします。
  utf8: false # UTF-8 モードを有効にします。
  unicode-punctuation: [.,!?;:] # Unicode 句読点パターン (UTF-8 モードが有効な場合にのみ使用されます)。
  force-case: false # トリガーを強制的に小文字にすることを有効にします。
  concat: none # concat モード (none|newline|space)。
  Depth: 50 # 再帰の深さの制限。
  error-messages: # カスタム エラー メッセージがオーバーライドされます。たとえば、「rivescript.error-messages.deepRecursion=カスタムの深い再帰が検出されたメッセージ」です。
  object-handlers: # 登録するオブジェクト ハンドラー名のカンマ区切りリスト (現在サポートされているのは `groovy`、`javascript`、`ruby`)。

作成されたRiveScriptボット インスタンスにカスタム Java サブルーチンやサポートされているデフォルト以外のオブジェクト ハンドラーを自動的に登録するには、次のようにアプリケーション コンテキストで適切な Bean を定義します。

 @Beanpublic Map<String, Subroutine> subroutines() {// キーは、登録する Java オブジェクト マクロの名前です。Map<String, Subroutine> subroutines = new HashMap<>();subroutines.put("subroutine1", new Subroutine1());subroutines.put("subroutine2", new Subroutine2());サブルーチンを返します。
}@Beanpublic Map<String, ObjectHandler> objectHandlers() {// キーは登録するプログラミング言語の名前です。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

著者

• ノア・ピーターブリッジ、https://www.kirsle.net/

• マルセル・オーヴァーダイク、https://twitter.com/marceloverdijk

ライセンス

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.