创建知识库
更新时间 2026-02-02 16:55:55
最近更新时间: 2026-02-02 16:55:55
本文主要介绍创建知识库的内容。
接口描述
在租户下创建知识库
请求方法
POST
接口要求
无
URI
/openapi/v1/infobases/create
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
| Content-Type | 是 | String | json格式 | application/json | |
| tenantId | 是 | String | 租户ID | 562b89493b1a40e1b97ea05e50dd8170 | |
| ctyun-eop-request-id | 是 | String | 用户请求 id，由用户构造，用户可以通过 uuid 等方法自行生成唯一字符串，用于日志请求追踪 | 33dfa732-b27b-464f-b15a-21ed6845afd5 | |
| eop-date | 是 | String | 请求时间，由用户构造，形如 yyyymmddTHHMMSSZ。 | 20211221T163014Z | |
| host | 是 | String | 终端节点域名，固定字段 | kqa-global.ctapi.ctyun.cn | |
| Eop-Authorization | 是 | String | 由天翼云官网 accessKey 和 securityKey 经签名后生成，参与签名生成的字段包括天翼云官网 accessKey 、securityKey、平台应用的appkey（非必须），用户请求id（非必须），请求时间，终端节点域名（非必须）以及请求体内容。 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
| name | 是 | String | 知识库名称 | 学习资料 | |
| type | 是 | Array | 知识库类型 1：通用 2：自定义 | 1 | |
| chunkConfigs | 否 | Array[Object] | 切分策略列表 | 详情见chunkConfig对象 |
chunkConfig对象
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
chunkMode | 是 | String | 切分策略。可选范围： LENGTH：按长度切分； H1：按一级标题（H1）切分； H2：按二级标题（H2）切分； REGEX：按正则表达式切分； RULE：默认，按规则（例如，特定的标记或段落格式）切分 | RULE |
|
chunkOverlap | 否 | Int | 分段重叠长度，需小于chunkSize | 0 |
|
chunkSize | 否 | Int | 分段长度 | 200 |
|
| separator | 否 | String | 分隔符 | ||
| enablecontextExpansion | 否 | Boolean | 是否启用上下文扩展模式 | ||
| contextChunkMode | 否 | String | 上下文片段切分策略，定义同chunkMode - 仅当启用上下文扩展模式时生效 | ||
| contextChunkOverlap | 否 | Int | 上下文片段之间的重叠长度，表示当前文本切片与前一个文本切片的重叠字符数 - 仅当启用上下文扩展模式时生效 | ||
| contextChunkSize | 否 | Int | 控制用于大模型推理的上下文片段的最大字符长度上限 - 仅当启用上下文扩展模式时生效 | ||
| contextSeparator | 否 | String | 指定上下文片段切分所依据的字面量分隔字符串 - 仅当启用上下文扩展模式时生效 | ||
| supportFileTypes | 否 | Array[Object] | 该配置支持的文件类型。支持的文档类型范围：ALL、PDF、DOC、DOCX、TXT、WPS、PPTX、JPG、JPEG、PNG。其中ALL代表所有类型 |
请求代码示例
Curl -X POST "https://kqa-global.ctapi.ctyun.cn/openapi/v1/infobases/create"
-H "Content-Type: application/json"
-H "ctyun-eop-request-id:33dfa732-b27b-464f-b15a-21ed6845afd5"
-H "tenantId:XXX"
-H "Eop-Authorization:XXX"
-H "eop-date:20211109T104641Z"
-H "host:kqa-global.ctapi.ctyun.cn"
--data '{
"name": "学习资料",
"type": 1,
"chunkConfigs": [
{
"chunkMode": "LENGTH",
"chunkOverlap": 0,
"chunkSize": 100,
"contextChunkMode": "LENGTH",
"contextChunkOverlap": 0,
"contextChunkSize": 406,
"contextSeparator": "\\n",
"enablecontextExpansion": true,
"separator": "\\n\\n",
"supportFileTypes": [
"pdf"
]
}
]
}'返回值说明
1.请求成功返回响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
| statusCode | String | 返回状态，返回200表示成功 | 200 | |
| message | String | 返回Success | Success | |
| returnObj | Object | 接口返回结果 | returnObj表 |
returnObj表
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
| id | Int | 知识库ID | 100 | |
| name | String | 知识库名称 | 学习资料 | |
| type | String | 知识库类型 | 1 | |
| categoryId | Int | 类目ID | 20 | |
| createTime | String | 创建时间 | 2023-05-08T15:14:00Z | |
| updateTime | String | 更新时间 | 2023-05-08T15:14:00Z |
2.请求失败返回响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
| statusCode | String | 错误码，放置API对应的错误码 | 40001 | |
| message | String | 失败信息 | 缺少鉴权信息 | |
| error | String | 返回对应的错误码 | KQA_40001 |
返回值示例
1.请求成功返回值示例
{
"statusCode": "200",
"error": null,
"message": "Success",
"returnObj": {
"type": 2,
"id": 281,
"name": "test2-4",
"categoryId": 124,
"createTime": "2025-09-18T16:23:57+08:00",
"updateTime": "2025-09-18T16:23:57+08:00"
}
}2.请求失败返回值示例
{
"statusCode": "40004",
"error": "KQA_40004",
"message": "接口执行异常"
}状态码
| http状态码 | 描述 |
| 200 | 表示请求成功 |
错误码说明
| 错误码 | 错误信息 | 错误描述 |
| 40006 | 知识库名称重复 | 用户下已有重名知识库 |
| 40007 | 类目不存在 | 用户不存在可用类目 |
| 40014 | 类目不唯一 | 用户类目不唯一，属于异常情况，联系技术支持 |
