主頁 > 知識庫 > Chatopera 智能問答引擎

Chatopera 智能問答引擎

智能問答引擎

架構圖
安裝
管理控制臺
API
首頁
多輪對話設計器
全渠道智能客服

智能問答引擎

智能問答引擎是問答服務的運行環境，包括可執行從多輪對話設計器導出的對話應用、基于常見問題集的知識庫、意圖識別和服務統計監控等模塊。

架構圖

從部署拓撲結構上看，智能問答引擎的架構如下圖所示：
智能問答引擎架構

superbrain：智能問答引擎核心服務節點，提供對外操作的Rest APIs，比如知識庫管理、多輪對話管理和監控統計等。
superbrain admin：智能問答引擎管理控制臺，提供Web管理頁面，方便企業IT人員或業務人員管理智能問答引擎。
siamese：底層服務，知識庫搜索時，文檔和查詢條件之間的相關度計算模塊。
Elasticsearch：底層服務，存儲知識庫數據的服務，在檢索時，召回數據。
intent：底層服務，提供意圖識別能力。
redis：底層服務，緩存數據和做定時任務。
MongoDB：底層服務，superbrain數據的持久化數據庫。

在企業使用過程中，只需要訪問superbrain的REST APIs和superbrain admin的Web頁面，底層服務的接口并不需要直接訪問。同時，上面的七個服務，都是以docker鏡像的形式分發，以docker容器的形式運行。

安裝

獲取服務鏡像

當前，Chatopera智能問答引擎只面向企業做私有部署，有合作意向的企業聯系下面郵箱，進行洽談：
聯系方式：info@chatopera.com
洽談內容包括：

概念驗證
試用申請
其他商業合作

當您獲得智能問答引擎的鏡像后，可以看到下面的文件：
chatopera.superadmin.docker.v1.tgz
chatopera.superbrain.docker.v1.tgz
chatopera.siamese.docker.v1.tgz
chatopera.mongodb.docker.v1.tgz
chatopera.redis.docker.v1.tgz
chatopera.elasticsearch.docker.v1.tgz

依賴環境

智能問答引擎是使用docker鏡像進行分發的，所以，只要是docker v12+ 版本支持的操作系統都可以運行智能問答引擎服務，對于更詳細的操作系統的兼容列表，請參考Docker Community Edition (CE)。
硬件方面，Chatopera推薦使用4Core CPU(Intel E5 or better)， 16GB Memory，128GB Disk運行服務。
智能問答引擎的docker鏡像可以安裝在docker服務中，或docker registry中。然后通過容器管理框架，比如kubernetes、Apache Mesos或docker compose。
在本文檔中，介紹使用docker compose的方式部署和管理服務，docker compose是輕量級的docker服務編排方案。

docker 版本

Docker version 18.03.1-ce, build 9ee9f40
安裝文檔，注意：docker為開源碼程序，本文檔使用社區版本（Docker CE）。

docker-compose

docker-compose version 1.21.1, build 5a3f1a3
安裝文檔。

安裝鏡像

假設docker已經被安裝好，并且其進程已經啟動，在命令行終端，執行下面命令：
docker load chatopera.superadmin.docker.v1.tgz
docker load chatopera.superbrain.docker.v1.tgz
docker load chatopera.siamese.docker.v1.tgz
docker load chatopera.mongodb.docker.v1.tgz
docker load chatopera.redis.docker.v1.tgz
docker load chatopera.elasticsearch.docker.v1.tgz

上述命令執行后，查看各個鏡像已經安裝成功，使用命令：
docker images

描述服務

在命令行終端，進入一個文件路徑，智能問答引擎的服務的數據文件將保存在這個路徑下，假設該路徑為 /app/chatbot。

創建服務描述文件 docker-compose.yml

docker-compose.yml：編排服務的描述文件
version: '2'
services:

superadmin:
    image: "registry.chatopera.com/ada/superadmin:develop"
    restart: always
    environment:
     - SUPERBRAIN_API_URL=http://superbrain:8003/api/v1

superbrain:
    image: "registry.chatopera.com/pintuan/superbrain:release"
    restart: always
    environment:
     - PORT_NUMBER=8003
     - SECRET_HASH=demo
     - MONGO_DB_URI=mongodb://mongodb/superbrain-dev
     - REDIS_HOST=redis
     - REDIS_PORT=6379
     - ELASTICSEARCH_HOST=http://elasticsearch:9200
     # - ELASTICSEARCH_AUTH=
     - ELASTICSEARCH_API_VERSION=5.2
    ports:
     - "8003:8003"
    volumes:
     - $PWD/superbrain/logs:/app/logs
    command: "node app.js"
    depends_on:
     - redis
     - mongodb
     - elasticsearch
     - siamese

siamese:
    image: "registry.chatopera.com/pintuan/siamese:release"
    restart: always
    ports:
     - "8012:8012"
    volumes:
     - $PWD/siamese/logs:/logs
    environment:
     - TXT_LOG_LVL=DEBUG
     - SIAMESE_PORT=8012
     - SIAMESE_THREADS=24
     - SIAMESE_W2V_MODEL_EN=/word2vec/google-news-slim/GoogleNews-vectors-negative300-SLIM.bin.gz

mongodb:
    image: "tutum/mongodb:3.2"
    restart: always
    volumes:
     - $PWD/mongodb/data:/data/db
    ports:
     - "27017:27017"
     - "27018:27018"
    environment:
     - AUTH=no

redis:
    image: redis:latest
    restart: always
    command: redis-server --appendonly yes
    volumes:
     - $PWD/redis/data:/data
    ports:
     - "6379:6379"

elasticsearch:
    image: "elasticsearch:5.2.0"
    restart: always
    environment:
     - bootstrap.memory_lock=true
     - "ES_JAVA_OPTS=-Xms512m -Xmx512m"
    volumes:
     - $PWD/elasticsearch/data:/usr/share/elasticsearch/data
     - $PWD/elasticsearch/plugins:/usr/share/elasticsearch/plugins
    ports:
     - "9200:9200"
     - "9300:9300"
    ulimits:
      memlock:
        soft: -1
        hard: -1
該描述文件采用的格式是YML，該描述文件聲明了多個容器服務和它的配置，比如鏡像、環境變量、映射的磁盤、日志管理等。拷貝右側的代碼為/app/chatbot/docker-compose.yml。
關于服務編排格式更多說明。

創建磁盤路徑

Docker容器是一種管理計算資源的方式，它讓開發運營軟件的構建、分發和運行做到了標準化。對于在容器運行過程中，不慎被刪除或崩潰，有可能造成數據丟失。一個解決方案是將Docker容器中應用產生的數據映射到宿主機器的磁盤上。
在命令行終端中，到/app/chatbot下，執行下面的命令：
mkdir -p mongodb/data # 存儲 mongodb 數據
mkdir -p elasticsearch/data # 存儲 elasticsearch 數據
mkdir -p elasticsearch/plugins # elasticsearch 插件程序
mkdir -p redis/data # 存儲 redis 數據
mkdir -p superbrain/logs # 存儲 superbrain 日志

啟動服務

完成磁盤路徑的創建后，就可以啟動服務了。
在命令行終端中，到/app/chatbot下，執行下面的命令：
docker-compose up -d
這時，命令會立即退出，因為該命令告訴docker-compose在后臺執行啟動工作，服務啟動需要1-2分鐘，這取決于運行服務的硬件資源。
在命令行終端中，到/app/chatbot下，執行下面的命令查看服務日志：
docker-compose logs -f
在服務啟動的過程中，也可以看到相應日志。
關于docker-compose up的更多使用介紹，請查看文檔。
在命令行終端中，到/app/chatbot下，執行下面的命令查看服務啟動狀態：
docker-compose ps
在輸出中，為多列描述的各服務的信息，其中State列為其中狀態，在沒有異常發生時，各服務的State均為Up，輸出結果類似下面：
chatoperaio_elasticsearch_1        /docker-entrypoint.sh elas ...   Up      0.0.0.0:9200->9200/tcp, 0.0.0.0:9300->9300/tcp
chatoperaio_intent_1               npm start                        Up      0.0.0.0:8027->8027/tcp
chatoperaio_mongodb_1              /run.sh                          Up      0.0.0.0:27017->27017/tcp, 0.0.0.0:27018->27018/tcp, 28017/tcp
chatoperaio_redis_1                docker-entrypoint.sh redis ...   Up      0.0.0.0:6379->6379/tcp
chatoperaio_siamese_1              /root/venv-py2/bin/python2 ...   Up      0.0.0.0:8012->8012/tcp
chatoperaio_superadmin_1           /bin/sh -c npm start             Up      3000/tcp
chatoperaio_superbrain_1           node app.js                      Up      0.0.0.0:8003->8003/tcp

以上代表服務正常啟動了，這時可以通過訪問智能問答引擎控制臺來管理聊天機器人。
http://服務器IP地址:8032

管理控制臺

智能問答引擎管理控制臺是為方便企業IT人員或業務人員管理智能問答引擎而設計的，在服務被正常啟動后，管理控制臺的URL地址是：
http://{{IP}}:8032
注意: {{IP}}是docker容器運行的宿主機器IP地址。
使用瀏覽器打開該地址，即可使用管理控制臺，主要功能包括：

聊天機器人增刪改差
聊天機器人監控
聊天機器人多輪對話管理
聊天機器人知識庫管理

聊天機器人管理

進入控制臺，可以看到所有聊天機器人并管理。
控制臺

點擊“新建”，創建一個聊天機器人。
新建機器人

新建完成后會直接進入機器人詳情頁面，默認顯示設置標簽，更新機器人名字，描述等信息。
管理詳情

聊天機器人監控

通過儀表盤可以查看機器人的使用情況。
儀表盤

多輪對話管理
使用多輪對話設計器 設計對話應用并導出的程序包，程序包后綴名是.c66。導入可以看到對話列表，也可以設置各個對話的狀態。
多輪對話

多輪對話的函數和環境變量可以在這里查看和設置。
環境變量4

同時，也可以查看多輪對話的腳本。
查看腳本

點擊“邏輯”，查看聊天機器人的思維邏輯導圖。
邏輯

知識庫管理
知識庫包括問答對和近義詞，問答對支持批量導入，導入文件格式必須是UTF-8編碼的CSV文件。
該CSV文件的每一行內容格式為：是否啟用，標準問,答案,擴展問1,擴展問2,擴展問3
CSV文件示例
true,錢款數據在哪查,微信商戶支付平臺里
false,怎么計算中獎呢,無法計算,中獎計算方法
true,沒有二維碼,刷新當前頁,看不到二維碼
常見問題

在問答對管理頁面，也支持導出問答對為CSV文件，檢索問答對等操作。
編輯一個問答對的標準問、擴展問、回復和狀態。
問題編輯

為提高準確性，支持自定義近義詞。
近義詞

API

智能問答引擎與其他服務集成的方式是暴露出來的Rest API接口，接口可以分為以下幾類：

資源	描述	路徑前綴
聊天機器人	對象的增刪改查	/api/v1/chatbot
多輪對話	查詢，導入和狀態管理	/api/v1/chatbot/:ChatbotID/conversation
多輪對話	問答的使用情況統計數據	/api/v1/chatbot/:chatbotID/conversation/query/counts
知識庫FAQ問答對	增刪改查和狀態管理	/api/v1/chatbot/:chatbotID/faq/database
知識庫近義詞	增刪改查	/api/v1/chatbot/:ChatbotID/faq/synonyms
知識庫	問答的使用情況統計數據	/api/v1/chatbot/:chatbotID/faq/query/counts
意圖識別	分析接口	/api/v1/chatbot/:ChatbotID/intent/parse
應用健康	狀態查詢接口	/ping

基本規范

在Rest API接口中，請求包括協議(http/https)，IP地址(Host)，HTTP頭字段(Headers)，HTTP報文主體(Body 可選)。

請求(Request)

在智能問答引擎服務啟動后，通過 http 協議處理請求，如無特殊說明，每個接口都有如下設置：
Host: {{IP}}
Headers: Content-Type application/json
注意： 1. {{變量}}代表變量； 2. {{IP}}代表服務運行的宿主機器的IP地址。

響應(Response)

如無特殊說明，返回值都是JSON數據格式，在正常返回下，格式符合如下形式：
{
"rc": 0,
"data": ...
}
其中，rc代表請求是否被滿足，0代表滿足；rc非0時，代表有異常，不同的異常類型使用不同的數字，在每個API中介紹。
異常返回的一般形式：
{
"rc": 非0的正整數,
"error": ...,
"msg": ...
}

POST /api/v1/chatbot/:ChatbotID

cURL：創建聊天機器人
curl --request POST \
--url 'http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}' \
--header 'Content-Type: application/json' \
--data '{
"name": "小叮當",
"primaryLanguage": "zh_CN"
}'
創建聊天機器人

BODY

{
"name": "小叮當",
"primaryLanguage": "zh_CN"
}

字段	必須	類型	描述
chatbotID	是	string	機器人的唯一ID，是以字母開始的由[a-zA-Z0-9_]組成的字符串。
name	是	string	機器人的名稱。
primaryLanguage	是	string	機器人的語言，現在支持兩個選項：["zh_CN", "en_US"]，分別代表中文和英文。
description	否	string	機器人的描述

成功返回

{
    "rc": 0,
    "data": {
        "chatbotID": "{{chatbotID}}",
        "name": "小叮當",
        "fallback": "我不明白您的意思。",
        "description": "智能問答和對話任務",
        "welcome": "你好！我是機器人客服。",
        "primaryLanguage": "zh_CN"
    }
}
返回字段說明：
fallback：聊天機器人的兜底回復。
description：聊天機器人的描述。
welcome：歡迎語。

異常返回

{
"rc":2,
"error":"already exists."
}
返回字段說明：
rc：非0正整數代表不同的異常類型，比如，當前rc是2，異常描述為“already exists.”，說明該{{chatbotID}}已經存在了。

PUT /api/v1/chatbot/:ChatbotID

cURL：更新聊天機器人
curl -X PUT \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}} \
-H 'Content-Type: application/json' \
-d '{
    "fallback": "我不能理解您的意思。",
    "description": "聊天機器人",
    "welcome": "我的特長是聊天。"
}'
更新聊天機器人

BODY

{
    "fallback": "我不能理解您的意思。",
    "description": "聊天機器人",
    "welcome": "我的特長是聊天。"
}

字段	必須	類型	描述
fallback	否	string	機器人兜底回復，在多輪對話查詢沒有匹配到回復時使用。
description	否	string	描述該機器人。
welcome	否	string	歡迎語，保留字段，暫時未使用。

對于機器人的chatbotID，name和primaryLanguage都是在創建時設定的，設定后不能變更。

成功返回

{
    "rc": 0,
    "data": {
        "chatbotID": "{{chatbotID}}",
        "fallback": ...,
        "description": ...,
        "welcome": ...
    }
}

異常返回

{
"rc": 1,
"error": ...
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

GET /api/v1/chatbot/:ChatbotID

cURL：獲取聊天機器人信息
curl -X GET \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}} \
-H 'Content-Type: application/json'
獲取聊天機器人信息

BODY

null

成功返回

異常返回

{
"rc": 3,
"error": "not exist."
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

GET /api/v1/chatbot

cURL：獲取聊天機器人列表
curl -X GET \
'http://{{IP}}:8003/api/v1/chatbot?sortby=-createdq={"chatbotID": "department_1"}' \
-H 'Content-Type: application/json'
獲取聊天機器人列表

QUERY

支持在URL中添加query信息來查詢機器人和翻頁等操作，比如 /api/v1/chatbot?page=1limit=10fields=chatbotID nameq={"name": "test"}，各參數介紹如下：

屬性	類型	描述	默認值	示例
limit	number	返回本頁數據的條數	100	10
page	number	返回哪一頁(可根據total進行判斷)	1	2
fields	string	返回哪些字段	除_id 和 __v之外的所有字段	chatbotID name
sortby	string	按照哪個字段進行排序	空	-created (按照 created 降序)
q	string	按照字段查詢	空	{"name": "test"}

BODY

null

成功返回

{
    "total": 1,
    "rc": 0,
    "current_page": 1,
    "total_page": 1,
    "data": [
        {
            "name": "小叮當",
            "chatbotID": "{{chatbotID}}",
            "primaryLanguage": "zh_CN",
            "fallback": "我不明白您的意思。",
            "welcome": "你好！我是機器人客服。",
            "description": "智能問答和對話任務"
        },
        ...
    ]
}
返回字段說明：
total代表聊天機器人數量。
current_page代表當前頁，total_page代表總頁數。
data是聊天機器人數據。

異常返回

{
"rc": 1,
"error": ...
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

DELETE /api/v1/chatbot/:ChatbotID

cURL：刪除一個聊天機器人
curl -X DELETE \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}} \
-H 'Content-Type: application/json' \
刪除一個聊天機器人

BODY

null

成功返回

{
    "rc": 0,
    "data": {
        "message": "done."
    }
}

異常返回

{
"rc": 1,
"error": ...
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

POST /api/v1/chatbot/:ChatbotID/faq/database

cURL：創建問答對
curl -X POST \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/faq/database \
-H 'Content-Type: application/json' \
-d '{
    "post": "怎么開通微信支付?",
    "reply": "登錄微信公眾號平臺，點擊左側微信支付菜單欄，按照開通步驟開通微信支付",
    "enabled": true
}'
創建問答對

BODY

{
    "post": "怎么開通微信支付?",
    "reply": "登錄微信公眾號平臺，點擊左側微信支付菜單欄，按照開通步驟開通微信支付",
    "enabled": true
}

字段	必須	類型	描述
post	是	string	問答對的問題，也稱“標準問”
reply	是	string	問題對應的回復
enabled	是	boolean	是否“啟用”，啟用代表該問答對在檢索時被使用；否則不被檢索

成功返回

{
    "rc": 0,
    "data": {
        "id": "{{docId}}}"
    }
}
返回字段說明：
docId代表該問答對的唯一標識。

異常返回

{
"rc": 3,
"error": ...
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

GET /api/v1/chatbot/:ChatbotID/faq/database/:docId

cURL：根據文檔Id查詢問答對詳情
curl -X GET \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/faq/database/{{docId}} \
-H 'Content-Type: application/json'
根據文檔Id查詢問答對詳情

BODY

null

成功返回

{
    "rc": 0,
    "data": {
        "id": "{{docId}}",
        "post": "怎么開通微信支付?",
        "reply": "登錄微信公眾號平臺，點擊左側微信支付菜單欄，按照開通步驟開通微信支付",
        "enabled": true
    }
}

異常返回

{
    "rc": 3,
    "error": {
        "msg": "Not Found"
    }
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

PUT /api/v1/chatbot/:ChatbotID/faq/database/:docId

cURL：根據文檔ID更新問答對
curl -X PUT \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/faq/database/{{docId}} \
-H 'Content-Type: application/json' \
-d '{
    "post": "怎么開通微信支付?",
    "reply": "登錄微信公眾號平臺，點擊左側微信支付菜單欄，按照開通步驟開通微信支付",
    "enabled": true
}'
根據文檔ID更新問答對

BODY

{
    "post": "怎么開通微信支付?",
   "reply": "登錄微信公眾號平臺，點擊左側微信支付菜單欄，按照開通步驟開通微信支付",
    "enabled": true
}

字段	必須	類型	描述
post	否	string	問答對的問題，也稱“標準問”
reply	否	string	問題對應的回復
enabled	否	boolean	是否“啟用”，啟用代表該問答對在檢索時被使用；否則不被檢索

成功返回

{
    "rc": 0,
    "data": {
        "id": "{{docId}}"
    }
}

異常返回

{
    "rc": 3,
    "error": {
        "msg": "Not Found"
    }
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

DELETE /api/v1/chatbot/:ChatbotID/faq/database/:docId

cURL：根據文檔ID刪除問答對
curl -X DELETE \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/faq/database/{{docId}} \
-H 'Content-Type: application/json'
根據文檔ID刪除問答對

BODY

null

成功返回

{
"rc": 0,
"message": "done"
}

異常返回

{
    "rc": 3,
    "error": {
        "msg": "Not Found"
    }
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

GET /api/v1/chatbot/:ChatbotID/faq/database

cURL：查詢問答對列表，可根據字段查詢，支持分頁
curl -X GET \
'http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/faq/database?limit=30' \
-H 'Content-Type: application/json'
查詢問答對列表，可根據字段查詢，支持分頁

QUERY

在url中，支持使用檢索條件，比如 /api/v1/chatbot/{{chatbotID}}/faq/database?page=1limit=10，各參數介紹如下：

屬性	類型	描述	默認值	示例
limit	number	返回本頁數據的條數	5	10
page	number	返回哪一頁(可根據total進行判斷)	1	2

BODY

null

成功返回

{
    "total": 354,
    "current_page": 1,
    "total_page": 12,
    "data": [
        {
            "post": "上架商品就不能修改了是嗎？",
            "is_original": true,
            "reply": "沒有訂單產生時可以修改",
            "enabled": true,
            "id": "{{docId}}"
        },
        ...
    ]
}

異常返回

{
    "rc": 3,
    "error": {
        "msg": "[index_not_found_exception] no such index
    }
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

POST /api/v1/chatbot/:chatbotID/faq/database/:docId/extend

cURL：創建擴展問
curl -X POST \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/faq/database/{{docId}}/extend \
-H 'Content-Type: application/json' \
-d '{
"post": "怎樣支持微信支付?"
}
'
創建擴展問，擴展問關聯一個問答對，擴展問是標準問的另一種問法。一個問答對可以關聯多個擴展問。
擴展問可以使系統更智能，提高檢索的準確率。

BODY

{
"post": "怎樣支持微信支付?"
}

字段	必須	類型	描述
post	是	string	與標準問意思一致的另一種問法，也稱“擴展問”。

成功返回

{
    "rc": 0,
    "data": {
        "id": "{{extendId}}"
    }
}
返回字段說明：
extendId是該擴展問的唯一標識。

異常返回

{
"rc": 1,
"error": ...
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

GET /api/v1/chatbot/:chatbotID/faq/database/:docId/extend

cURL：查詢擴展問
curl -X GET \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/faq/database/{{docId}}/extend \
-H 'Content-Type: application/json'
查詢擴展問

BODY

null

成功返回

{
    "total": 1,
    "current_page": 1,
    "total_page": 1,
    "data": [
        {
            "post": "怎樣支持微信支付?",
            "is_original": false,
            "postId": "{{docId}}",
            "enabled": true,
            "id": "{{extendId}}"
        },
        ...
    ],
    "rc": 0
}

異常返回

{
"rc": 3,
"error": ...
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

PUT /api/v1/chatbot/:chatbotID/faq/database/:docId/extend/:extendId

cURL：更新擴展問
curl -X PUT \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/faq/database/{{docId}}/extend/{{extendId}} \
-H 'Content-Type: application/json' \
-d '{
"post": "怎樣支持微信支付?"
}
'
更新擴展問

BODY

{
"post": "怎樣支持微信支付?"
}

字段	必須	類型	描述
post	是	string	與標準問意思一致的另一種問法，也稱“擴展問”。

成功返回

{
    "rc": 0,
    "data": {
        "id": "{{extendId}}"
    }
}
返回字段說明：
extendId是該擴展問的唯一標識。

異常返回

{
    "rc": 3,
    "error": {
        "msg": "Not Found"
    }
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

DELETE /api/v1/chatbot/:chatbotID/faq/database/:docId/extend/:extendId

cURL：刪除擴展問
curl -X DELETE \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/faq/database/{{docId}}/extend/{{extendId}} \
-H 'Content-Type: application/json'
刪除擴展問

BODY

null

成功返回

{
"rc": 0,
"message": "done"
}

異常返回

{
"rc": 3,
"error": ...
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

GET /api/v1/chatbot/:ChatbotID/faq/database/export

cURL：導出問答對數據
curl -X GET \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/faq/database/export \
-H 'Content-Type: application/json'
導出問答對數據

BODY

null

成功返回

{
    "rc": 0,
    "data": [
        [
            true,
            "怎么開通微信支付?",
            "登錄微信公眾號平臺，點擊左側微信支付菜單欄，按照開通步驟開通微信支付",
            "如何支持微信支付"
        ],
        ...
    ]
}
返回字段說明：
data是問答對的所有數據，每個元素代表一個問答對。每個元素又是一個數組，按照順序分別代表：[enabled，標準問，回復，0~多個擴展問]。

異常返回

{
"rc": 1,
"error": ...
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

POST /api/v1/chatbot/:ChatbotID/faq/synonyms

cURL：創建近義詞
curl -X POST \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/faq/synonyms \
-H 'Content-Type: application/json' \
-d '{
"text": "番茄",
"neighbors": ["西紅柿", "狼桃"]
}'
創建近義詞，近義詞可以進一步提高系統的智能水平。

BODY

{
"text": "番茄",
"neighbors": ["西紅柿", "狼桃"]
}

字段	必須	類型	描述
text	是	string	詞匯
neighbors	是	[string]	與text意思相近的詞匯

成功返回

{
    "rc": 0,
    "data": {
        "text": "番茄",
        "chatbot": "{{chatbotID}}",
        "neighbors": [
            "西紅柿",
            "狼桃"
        ],
        "id": "{{synonymsId}}"
    }
}
返回字段說明：
synonymsId是該近義詞組的唯一標識。

異常返回

{
"rc": 1,
"error": ...
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

GET /api/v1/chatbot/:ChatbotID/faq/synonyms/:synonymsId

cURL：使用synonymsId獲取近義詞詳情
curl -X GET \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/faq/synonyms/{{synonymsId}} \
-H 'Content-Type: application/json'
使用synonymsId獲取近義詞詳情

BODY

null

成功返回

{
    "rc": 0,
    "data": {
        "text": "番茄",
        "neighbors": [
            "西紅柿",
            "狼桃"
        ]
    }
}

異常返回

{
"rc": 1,
"error": ...
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

PUT /api/v1/chatbot/:ChatbotID/faq/synonyms/:synonymsId

cURL：更新近義詞
curl -X PUT \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/faq/synonyms/{{synonymsId}} \
-H 'Content-Type: application/json' \
-d '{
"text": "番茄",
"neighbors": ["西紅柿", "狼桃", "洋柿子"]
}'
更新近義詞

BODY

{
"text": "番茄",
"neighbors": ["西紅柿", "狼桃", "洋柿子"]
}

成功返回

{
    "rc": 0,
    "data": {
        "text": "番茄",
        "neighbors": [
            "西紅柿",
            "狼桃",
            "洋柿子"
        ]
    }
}

異常返回

{
"rc": 1,
"error": ...
}

DELETE /api/v1/chatbot/:ChatbotID/faq/synonyms/:synonymsId

cURL：刪除近義詞
curl -X DELETE \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/faq/synonyms/{{synonymsId}} \
-H 'Content-Type: application/json'
刪除近義詞

BODY

null

成功返回

{
"rc": 0,
"message": "done"
}

異常返回

{
"rc": 1,
"error": ...
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

GET /api/v1/chatbot/:ChatbotID/faq/synonyms

cURL：查詢近義詞列表，支持分頁和按字段查詢
curl -X GET \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/faq/synonyms \
-H 'Content-Type: application/json'
查詢近義詞列表，支持分頁和按字段查詢

BODY

null

成功返回

{
    "total": 1,
    "rc": 0,
    "current_page": 1,
    "total_page": 1,
    "data": [
        {
            "text": "番茄",
            "chatbot": "{{chatbotID}}",
            "neighbors": [
                "西紅柿",
                "狼桃",
                "洋柿子"
            ],
            "id": "{{synonymsId}}"
        },
        ...
    ]
}

異常返回

{
"rc": 1,
"error": ...
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

POST /api/v1/chatbot/:ChatbotID/faq/query

cURL：根據查詢句子查詢答案, 返回答案列表，并帶有分數
curl -X POST \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/faq/query \
-H 'Content-Type: application/json' \
-d '{
"query": "如何開通微信支付"
}'
根據查詢句子查詢答案, 返回答案列表，并帶有分數

BODY

{
"query": "如何開通微信支付"
}

字段	必須	類型	描述
query	是	string	從知識庫中檢索的目標

成功返回

{
    "rc": 0,
    "data": [
        {
            "id": "{{docId}}",
            "score": 0.647,
            "post": "怎么開通微信支付?",
            "reply": "登錄微信公眾號平臺，點擊左側微信支付菜單欄，按照開通步驟開通微信支付"
        }
    ]
}
返回字段說明：
data是一個數組，包含0～多個問答對，并且按照匹配程度降序，匹配程度就是該問答對的問題和query的相似度。
相似度是屬于[0-1]區間的值，越大代表語義越相似。

異常返回

{
"rc": 1,
"error": ...
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

POST /api/v1/chatbot/:ChatbotID/faq/click

cURL：記錄FAQ點擊事件
curl -X POST \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/faq/click \
-H 'Content-Type: application/json' \
-d '{
    "query": "如何開通微信支付",
    "groundtruth": "如何支持微信支付",
    "negatives": ["如何支持支付", "怎么取消微信支付"]
}'
記錄FAQ點擊事件：在客服人員點擊建議問時，將訪客的問題和客服點擊的問題記錄下來。
點擊事件具有很重要的價值：

梳理業務，提高商業智能;
方便統計系統使用情況;
評估系統準確率;
優化系統準確率，比如訓練更好的機器學習模型。

所以，該接口應保證盡可能調用。

BODY

{
    "query": "如何開通微信支付",
    "groundtruth": "如何支持微信支付",
    "negatives": ["如何支持支付", "怎么取消微信支付"]
}

字段	必須	類型	描述
query	是	string	原始查詢
groundtruth	是	string	準確答案
negatives	是	[string]	被展示為建議答案但是沒有被選中的候選回復

成功返回

{
"rc": 0,
"message": "done"
}
返回字段說明：

異常返回

{
"rc": 1,
"error": ...
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

POST /api/v1/chatbot/:chatbotID/intent/parse

cURL：意圖識別服務
curl -X POST \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/intent/parse \
-H 'Content-Type: application/json' \
-d '{
"query": "can I have my cashback",
"clientId": "gmis"
}'
使用機器學習模型，分析意圖和實體。

BODY

{
"query": "我想取錢",
"clientId": "{{clientId}}"
}

字段	必須	類型	描述
query	是	string	待被分析意圖的句子
clientId	是	string	客戶唯一標識，目前意圖識別模型依賴每個客戶的數據，和客戶的業務關系緊密，每個客戶單獨制作。

成功返回

{
    "rc": 0,
    "data": {
        "tag": "{{intentId}}",
        "score": 2.515
    }
}
返回字段說明：
如果rc為0，但是data中不包含tag和score時，代表程序未能識別出意圖。

異常返回

{
"rc": 1,
"error": ...
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

GET /api/v1/chatbot/:ChatbotId/conversation

cURL：獲得對話列表
curl -X GET \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/conversation \
-H 'Content-Type: application/json'
獲得對話列表

BODY

null

成功返回

{
    "rc": 0,
    "total": 1,
    "current_page": 1,
    "total_page": 1,
    "data": [
        {
            "chatbotID": "{{chatbotID}}",
            "name": "{{conversationName}}",
            "enabled": true,
            "id": "{{conversationId}}"
        },
        ...
    ]
}
返回字段說明：

異常返回

{
"rc": 1,
"error": ...
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

GET /api/v1/chatbot/:ChatbotId/conversation/:conversationId

cURL：獲得對話詳情
curl -X GET \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/conversation/{{conversationId}} \
-H 'Content-Type: application/json' \
獲得對話詳情

BODY

null

成功返回

{
    "rc": 0,
    "data": {
        "chatbotID": "{{chatbotID}}",
        "name": "course",
        "modified": "2018-07-11T09:39:58.349Z",
        "created": "2018-07-02T12:02:43.037Z",
        "scriptBody": "+ _resolve_course_\n- 您好，我是小云，您的課程顧問，請問您家小孩多大了？\n\n+ 一年級老師\n- ^get_teachers(1)",
        "enabled": true,
        "id": "{{conversationId}}"
    }
}
返回字段說明：

異常返回

{
"rc": 1,
"error": ...
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

PUT /api/v1/chatbot/:ChatbotId/conversation/:conversationId/enable

cURL：使對話處于"啟用"狀態
curl -X PUT \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/conversation/{{conversationId}}/enable
使對話處于"啟用"狀態

BODY

null

成功返回

{
    "rc": 0,
    "data": {
        "name": "course",
        "chatbotID": "{{chatbotID}}",
        "enabled": true,
        "id": "{{conversationId}}"
    }
}
返回字段說明：

異常返回

{
"rc": 1,
"error": ...
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

PUT /api/v1/chatbot/:ChatbotId/conversation/:conversationId/disable

cURL：使對話處于"禁用"狀態
curl -X PUT \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/conversation/{{conversationId}}/disable \
使對話處于"禁用"狀態

BODY

null

成功返回

{
    "rc": 0,
    "data": {
        "name": "course",
        "chatbotID": "{{chatbotID}}",
        "enabled": false,
        "id": "{{conversationId}}"
    }
}
返回字段說明：

異常返回

{
"rc": 1,
"error": ...
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

GET /api/v1/chatbot/:chatbotID/conversation/environment

cURL：獲取環境變量
curl -X GET \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/conversation/environment \
獲取環境變量
環境變量是多輪對話的在“設計階段”和“部署階段”不共享的變量。具體應用場景見多輪對話設計器：快速開始。

BODY

null

成功返回

{
    "rc": 0,
    "data": {
        "USERNAME": "張三"
    }
}
返回字段說明：

異常返回

{
"rc": 1,
"error": ...
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

PUT /api/v1/chatbot/:chatbotID/conversation/environment

cURL：更新環境變量
curl -X PUT \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/conversation/environment \
-H 'Content-Type: application/json' \
-d '{
        "USERNAME": "李四",
        "PASSWORD": "123456"
    }'
更新環境變量

BODY

{
"USERNAME": "李四",
"PASSWORD": "123456"
}

成功返回

{
"rc": 0,
"msg": "done"
}
返回字段說明：

異常返回

{
"rc": 1,
"error": ...
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

POST /api/v1/chatbot/:ChatbotId/conversation/query

cURL：對話問答查詢
curl -X POST \
http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/conversation/query \
-H 'Content-Type: application/json' \
-d '{
    "fromUserId": "{{uid}}",
    "textMessage": "北京今天天氣怎么樣",
    "isDebug": false
}'
對話問答查詢

BODY

{
    "fromUserId": "{{uid}}",
    "textMessage": "北京今天天氣怎么樣",
    "isDebug": false
}

成功返回

{
    "rc": 0,
    "data": {
        "state": "default",
        "createdAt": 1531910247845,
        "string": "白天天氣多云，并且空氣濕度偏大，在這種天氣條件下，您會感到有些悶熱，不很舒適。",
        "topicName": "weather",
        "subReplies": [],
        "logic_is_fallback": false,
        "botName": "小叮當"
    }
}
返回字段說明：
state是一些業務需求的約定字段，比如，對話要完成“用戶認證”，那么在完成認證后，state會返回auth_succ；認證失敗時，返回auth_fail，該字段可通過對話腳本設定。
logic_is_fallback代表該回復是否是兜底。
topicName代表當前機器人正在聊的話題。
botName代表聊天機器人的名字。

異常返回

{
"rc": 1,
"error": ...
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

POST /api/v1/chatbot/:ChatbotId/conversation/droplet/import

cURL：導入對話應用文件
ZIPFILE=小叮當-1.0.0-conversations.c66
set -x
curl -i -X POST -H "Content-Type: multipart/form-data" \
    -F "droplet=@$ZIPFILE" \
    -F "USERNAME=李四" \
    -F "PASSWORD=123456" \
    http://{{IP}}:8003/api/v1/chatbot/{{chatbotID}}/conversation/droplet/import
導入對話應用文件
對話應用文件示例詳見天氣查詢機器人:多輪對話示例程序。

BODY

multipart表單，環境變量使用-F設定鍵值對，對話應用文件設置droplet的文件路徑，參考cURL樣例程序。

成功返回

{
"rc": 0,
"data": {
"msg": "Import is done successfully."
}
}

異常返回

{
"rc": 1,
"error": ...
}
返回字段說明：
rc為正整數時，代表異常，異常描述為error。

GET /ping

cURL：獲取應用健康狀態
curl -X GET \
http://{{IP}}:8003/ping \
-H 'Content-Type: application/json'
獲取應用健康狀態

BODY

null

成功返回

{
    "timestamp": 1531918165514,
    "uptime": 8783.43,
    "application": {
        "name": "superbrain",
        "version": "1.0.0",
        "pid": 1,
        "title": "node",
        "argv": [
            "/usr/local/bin/node",
            "/app/app.js"
        ],
        "versions": {
            "http_parser": "2.8.0",
            "node": "8.11.3",
            "v8": "6.2.414.54",
            "uv": "1.19.1",
            "zlib": "1.2.11",
            "ares": "1.10.1-DEV",
            "modules": "57",
            "nghttp2": "1.32.0",
            "napi": "3",
            "openssl": "1.0.2o",
            "icu": "60.1",
            "unicode": "10.0",
            "cldr": "32.0",
            "tz": "2017c"
        }
    },
    "resources": {
        "memory": {
            "rss": 369848320,
            "heapTotal": 130859008,
            "heapUsed": 108874240,
            "external": 18007788
        },
        "loadavg": [
            0.35302734375,
            0.28759765625,
            0.2412109375
        ],
        "cpu": [
            {
                "model": "Intel(R) Xeon(R) CPU E5-2682 v4 @ 2.50GHz",
                "speed": 2500,
                "times": {
                    "user": 1586270600,
                    "nice": 0,
                    "sys": 1050236500,
                    "idle": 21709890800,
                    "irq": 0
                }
            },
            {
                "model": "Intel(R) Xeon(R) CPU E5-2682 v4 @ 2.50GHz",
                "speed": 2500,
                "times": {
                    "user": 1562807900,
                    "nice": 0,
                    "sys": 1015181800,
                    "idle": 21782348900,
                    "irq": 0
                }
            }
        ],
        "disk": [
            {
                "filesystem": "overlay",
                "size": 123721700,
                "used": 94808660,
                "available": 22605316,
                "capacity": 0.81,
                "mount": "/"
            },
            {
                "filesystem": "tmpfs",
                "size": 65536,
                "used": 0,
                "available": 65536,
                "capacity": 0,
                "mount": "/dev"
            },
            {
                "filesystem": "tmpfs",
                "size": 8216392,
                "used": 0,
                "available": 8216392,
                "capacity": 0,
                "mount": "/sys/fs/cgroup"
            },
            {
                "filesystem": "/dev/vda1",
                "size": 123721700,
                "used": 94808660,
                "available": 22605316,
                "capacity": 0.81,
                "mount": "/app/logs"
            },
            {
                "filesystem": "shm",
                "size": 65536,
                "used": 0,
                "available": 65536,
                "capacity": 0,
                "mount": "/dev/shm"
            },
            {
                "filesystem": "tmpfs",
                "size": 8216392,
                "used": 0,
                "available": 8216392,
                "capacity": 0,
                "mount": "/sys/firmware"
            }
        ],
        "nics": {
            "lo": [
                {
                    "address": "127.0.0.1",
                    "netmask": "255.0.0.0",
                    "family": "IPv4",
                    "mac": "00:00:00:00:00:00",
                    "internal": true,
                    "cidr": "127.0.0.1/8"
                }
            ],
            "eth0": [
                {
                    "address": "172.19.0.15",
                    "netmask": "255.255.0.0",
                    "family": "IPv4",
                    "mac": "02:42:ac:13:00:0f",
                    "internal": false,
                    "cidr": "172.19.0.15/16"
                }
            ]
        }
    },
    "system": {
        "arch": "x64",
        "platform": "linux",
        "type": "Linux",
        "release": "4.4.0-62-generic",
        "hostname": "29866b45ce71",
        "uptime": 2453892,
        "cores": 2,
        "memory": 16827174912
    }
}
返回字段說明：
描述應用和操作系統的各種數據。

標簽：涼山營口包頭平頂山河源襄陽澳門那曲

巨人網絡通訊聲明：本文標題《Chatopera 智能問答引擎》，本文關鍵詞 Chatopera,智能,問答,引擎,；如發現本文內容存在版權問題，煩請提供相關信息告之我們，我們將及時溝通與處理。本站內容系統采集于網絡，涉及言論、版權與本站無關。