创建知识库接口

开发环境

http://dev-cn.your-api-server.com

POST

/v1/kbs

该接口支持创建、管理知识文档。相关操作流程如下：
1.新建知识库后得到知识库 ID；
2.上传文件，获取文件 ID；
3.通过文件 ID 与知识库 ID 进行知识库文件关联，知识库中可以关联多个文档。
4.调用对话接口时通过 knowledge_base 字段传入知识库 ID 列表，大模型使用检索到的知识信息回答问题。

请求参数

Header 参数

Body 参数application/json

示例

返回响应

🟢200成功

application/json

Body

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/v1/kbs' \
--header 'Authorization: Bearer $API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
        "name": "string",
        "description": "string",
        "split_type": 2,
        "split_config": {
          "chunk_overlap_len": 500,
          "chunk_max_len": 100,
          "separators": [".","。","\n"]
        }
      }'

响应示例

                {
  "id": "kb-abc123",
  "object": "knowledge-base",
  "name": "string",
  "description": "string",
  "file_ids": [],
  "created_at": 1677610602,
  "updated_at": 1677610602,
  "status": "online",
  "split_type": ,
  "split_config": {
    "chunk_overlap_len": 512,
    "chunk_max_len": 100,
    "separators": [".","。","\n"]
  }
}

修改于 2023-12-21 08:56:15

流式接口

知识库检索接口