知识库API

INFO

知识库是小智Pro 平台的核心能力之一，允许您为小智外挂知识库，提升问答的准确性和专业性。本文档描述了知识库相关的API接口。

WARNING

旧版向量知识库接口已停止服务，知识库相关接口现已全面切换为推理知识库（Tree-RAG）。推理知识库基于文档树结构进行推理检索，返回按文档分组的节点内容，而非旧的向量分片。请按本文档最新结构对接。

1. 查询知识库列表

基本信息

• 接口路径: /xiaozhi/kb/list
• 请求方法: GET
• 认证方式: API Key

请求参数

无

响应示例

{
  "code": 200,
  "data": [
    {
      "kb_id": "知识库ID",
      "name": "知识库名称",
      "description": "知识库描述",
      "doc_count": 12,
      "create_at": "2026-07-01T10:00:00Z",
      "update_at": "2026-07-31T15:30:00Z"
    }
  ],
  "msg": "success"
}

字段说明

字段	类型	说明
kb_id	string	知识库ID
name	string	知识库名称
description	string	知识库描述
doc_count	int	知识库中文档数量
create_at	string	创建时间（ISO 8601）
update_at	string	最近更新时间（ISO 8601）

2. 知识检索

基本信息

• 接口路径: /xiaozhi/kb/search
• 请求方法: GET
• 认证方式: API Key

请求参数

参数名	类型	必填	默认值	说明
kb_id	string	是	-	知识库ID，通过知识库列表获取。
query	string	是	-	检索问题，支持自然语言提问

响应示例

{
  "code": 200,
  "msg": "查询成功",
  "data": {
    "results": [
      {
        "doc_id": "文档ID",
        "doc_name": "文档名称",
        "nodes": [
          {
            "node_id": "节点ID",
            "title": "节点标题",
            "content": "节点内容片段"
          }
        ]
      }
    ]
  }
}

字段说明

data 为一个对象，其 results 为按文档分组的检索结果数组：

字段	类型	说明
results	array	检索结果列表
results[].doc_id	string	命中文档ID
results[].doc_name	string	命中文档名称
results[].nodes	array	该文档下命中的节点列表
nodes[].node_id	string	节点ID
nodes[].title	string	节点标题
nodes[].content	string	节点内容片段

3. 查询知识库文档列表

基本信息

• 接口路径: /xiaozhi/kb/doc/list
• 请求方法: GET
• 认证方式: API Key

请求参数

参数名	类型	必填	默认值	说明
kb_id	string	是	-	知识库ID，通过知识库列表获取。

响应示例

{
  "code": 200,
  "data": [
    {
      "doc_id": "文档ID",
      "doc_name": "文档名称",
      "doc_description": "文档描述",
      "file_type": "pdf",
      "file_size": 1048576,
      "tokens": 5200,
      "status": "ready",
      "error_message": ""
    }
  ],
  "msg": "success"
}

字段说明

字段	类型	说明
doc_id	string	文档ID
doc_name	string	文档名称
doc_description	string	文档描述
file_type	string	文件类型，如 pdf/docx/pptx/xlsx/html/md/txt/图片等
file_size	int	文件大小（Byte）
tokens	int	文档分词 token 数
status	string	文档状态：indexing（索引中）/ready（就绪）/failed（失败）
error_message	string	失败时的错误信息，成功时为空