Skip to content

词库接口

WordMomo 的两种常用库

在 WordMomo 中,词库按存放内容的形态分为两种常用类型:

类型bookType适合存放的内容
单词词库wordlib单词、词组等短内容,例如 applecheck in,适合背单词场景
句子库sentencelib完整的外语句子,例如情景对话、课文句子,适合句子学习场景

AI 在为聊天内容选择库时,应根据内容形态选择:整理出的是单词/词组就放入单词词库,整理出的是句子就放入句子库。

获取词库列表

POST /ai/invoke
method: book.list

获取用户已有的词库列表,支持按库类型筛选。

请求体

json
{
  "method": "book.list",
  "data": {
    "bookType": "all"
  }
}

data 参数:

字段必填说明
bookType库类型筛选:all=全部(默认值)、wordlib=单词词库、sentencelib=句子库

请求示例

bash
curl -X POST http://127.0.0.1:27531/ai/invoke \
  -H "Content-Type: application/json; charset=utf-8" \
  -d "{\"method\":\"book.list\",\"data\":{\"bookType\":\"wordlib\"}}"

响应示例

json
{
  "success": true,
  "data": [
    {
      "bookId": "b8f1c2a0d3e4",
      "bookName": "旅游英语单词",
      "bookType": "wordlib"
    },
    {
      "bookId": "f5a6b7c8d9e0",
      "bookName": "酒店情景对话",
      "bookType": "sentencelib"
    }
  ]
}

响应字段

返回词库数组,每项字段:

字段说明
bookId词库 ID,后续操作该词库时使用
bookName词库名称
bookType词库类型:wordlib=单词词库、sentencelib=句子库

备注

  • 没有匹配的词库时返回空数组 []

创建词库

POST /ai/invoke
method: book.create

创建一个新的词库。创建前建议先调用「获取词库列表」检查是否已有同主题、同类型的词库,避免重复创建。

请求体

json
{
  "method": "book.create",
  "data": {
    "bookName": "酒店情景对话",
    "bookType": "sentencelib"
  }
}

data 参数:

字段必填说明
bookName词库名称,建议根据对话主题起一个清晰的名字,如「旅游英语单词」「酒店情景对话」
bookType词库类型:wordlib=单词词库、sentencelib=句子库,根据要存放的内容形态选择

请求示例

bash
curl -X POST http://127.0.0.1:27531/ai/invoke \
  -H "Content-Type: application/json; charset=utf-8" \
  -d "{\"method\":\"book.create\",\"data\":{\"bookName\":\"酒店情景对话\",\"bookType\":\"sentencelib\"}}"

响应示例

json
{
  "success": true,
  "data": {
    "bookId": "c3d9e4b1a2f3",
    "bookName": "酒店情景对话",
    "bookType": "sentencelib"
  }
}

响应字段

字段说明
bookId新词库的 ID,后续操作该词库时使用
bookName词库名称
bookType词库类型