rivescript java

RiveScript-Java

介紹

這是為 Java 程式語言編寫的 RiveScript 解譯器函式庫。 RiveScript 是聊天機器人的腳本語言，可以輕鬆編寫觸發器/響應對來建立機器人的智慧。

關於 RiveScript

RiveScript 是一種用於編寫聊天機器人的腳本語言。它的語法非常簡單，旨在易於閱讀和快速編寫。

RiveScript 的簡單範例如下：

+ hello bot
- Hello human.

這與用戶的“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 的官方網站是 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 社群 Wiki ，以了解 RiveScript 的常見設計模式以及提示和技巧。

安裝

將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;// 使用預設設定建立新的機器人。 bot = new RiveScript(Config.utf8());// 載入一個充滿RiveScript 文件的目錄（.rive 檔案）bot.loadDirectory("./replies");// 載入單一檔案.bot.LoadFile( "./ testsuite.rive");// 載入回復後對其進行排序！bot.sortReplies();// 取得回應。Stringreply = bot.reply("user", "Hello bot!");

rivescript-core發行版還包括一個用於測試 RiveScript 機器人的互動式 shell。使用磁碟上包含 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 標點pattern.forceCase(false) // 是否啟用強制觸發器小寫。concat(ConcatMode.NONE) // concat 模式.depth(50) // 遞歸深度限制.sessionManager(sessionManager ) // 使用者變數的會話管理器。

為了方便起見，您可以使用快捷方式：

 // 預設建構子使用基本配置。 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 模式的新機器人，並覆寫從使用者訊息中刪除的標點符號。
        .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 # 連接模式（無|換行|空格）。
  depth: 50 # 遞歸深度限制。
  error-messages: # 自訂錯誤訊息覆蓋。例如 `rivescript.error-messages.deepRecursion=自訂深度遞歸偵測到的訊息`
  object-handlers: # 要註冊的物件處理程序名稱的逗號分隔清單（目前支援：`groovy`、`javascript`、`ruby`）。

若要在建立的RiveScript機器人實例中自動註冊自訂 Java 子程式和/或非預設支援的物件處理程序，請在應用程式上下文中定義適當的 bean，例如：

 @Beanpublic Map<String, Subroutine> subroutines() {// key是要註冊的Java物件巨集的名稱。 ());subroutines.put("subroutine2", new Subroutine2());回傳子程式;
}@Beanpublic Map<String, ObjectHandler> objectHandlers() {// key是要註冊的程式語言的名稱。 ());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.