新建知识库

POST/v1/embedding/create_knowledge_base

请求参数

Query 参数

GroupId

string

用户所属的组

必需

示例值:

${group_id}

Header 参数

content-type

string

必需

示例值:

application/json

Authorization

string

必需

示例值:

Bearer ${api_key}

operator_id

integer

操作流水ID，同一操作流水ID幂等

必需

用同一个流水ID调用会使用第一次的调用参数

name

string

知识库名称

必需

不能重复

embedding_model

string

知识库模型

必需

仅支持以下值 kbq-001

doc_params

object

增加文档参数

可选

chunk_size

integer

切片的最大token数

可选

默认500 chunk_size >= 2*chunk_overlap + 1 如果同时配置了分隔符，会先以分隔符进行切分，然后再用size大小进行拼接

chunk_overlap

integer

切片与顺序相邻切片重叠的最大token数

可选

默认50 chunk_overlap >= 0 注：如果正则情况下，该功能是不生效的

separators

array[string]

分隔符

可选

默认["\n", ""]

is_regex

boolean

分割符是否为正则表达式

必需

默认false

{
  "operator_id": 10,
  "name": "dongtian10",
  "embedding_model": "kbq-001",
  "doc_params": {
    "chunk_size": 500,
    "chunk_overlap": 50,
    "separators": [
      "/n"
    ],
    "is_regex": false
  }
}

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

knowledge_base_id

object

文件的唯一标识符

必需

file_id

object

必需

knowledge_base

object

知识库信息

必需

knowledge_base_id

object

知识库ID

必需

name

string

知识库名称

必需

description

string

知识库描述

必需

embedding_model

string

知识库模型

必需

create_time

integer

必需

知识库创建时间，毫秒

insert_time

integer

必需

最近一次插入文档时间，毫秒

delete_time

integer

必需

最近一次删除文档时间，毫秒

docs

array [object {1}]

必需

最近一次删除文档时间，毫秒

status

string

必需

loading-操作进行中 available-无操作进行中

usage

null

必需

知识库计费为异步，需通过账单查看用量

base_resp

object

错误状态码和详情

必需

status_code

integer

状态码

必需

1000，未知错误 1001，超时 1002，触发RPM限流 1004，鉴权失败 1008，余额不足 1013，服务内部错误 1026，输入内容错误 1027，输出内容错误 1039，触发TPM限流 2013，输入格式信息不正常

status_msg

string

错误详情

必需

{
    "knowledge_base_id": ${knowledge_base_id},
    "file_id": ${file_id},
    "knowledge_base": {
        "knowledge_base_id": ${knowledge_base_id},
        "name": "test1",
        "description": "",
        "embedding_model": "kbq-001",
        "create_time": 1700812395930,
        "insert_time": 1700812483055,
        "delete_time": 0,
        "docs": [
            {
                "file_id": ${file_id}
            }
        ],
        "status": "loading"
    },
    "usage": null,
    "base_resp": {
        "status_code": 0,
        "status_msg": "success"
    }
}

最后修改时间： 1 年前