创建知识库
通过调用本接口,开发者可以在秘钥(token)所属空间内创建一个知识库。
请求地址
POST``https://api.tbox.cn/api/datasets/createDatasets
请求头
| 参数名 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|
| Authorization | 是 | String | 用于验证客户端身份的访问令牌,你可以在百宝箱中获取,获取方式可参见:授权管理。 | pat_2j4e******THUIVRH1 |
| Content-Type | application/json | 解释请求正文的方式。 | - |
请求参数
| 参数名 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|
| name | 是 | String | 自定义知识库名称,最多支持输入 50 个字符。**说明:**知识库名称需在租户内保持唯一。 | demo知识库 |
| description | 是 | String | 自定义知识库描述,最多支持输入 100 个字符 | 这是一个demo知识库 |
请求示例
curl --location 'https://api.tbox.cn/api/datasets/createDatasets' \
--header 'Authorization: {your_token}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"name":"demo知识库",
"description":"这是一个demo知识库"
}'
返回参数
| 参数名 | 类型 | 说明 | 示例 |
|---|---|---|---|
| errorCode | String | 错误码,为 0 表示成功。 | 0 |
| errorMsg | String | 错误信息。 | success |
| data | String | 创建的知识库 ID。 | 202508059********063 |
| traceId | String | 本次请求的唯一标识,通常用于发生错误时的排查定位。 | 0b****4d9 |
其中,errorCode 与 errorMsg 的对照关系以及对应的解决方案,请参见下方错误码。
返回示例
成功示例
{
"data": "202508059********063",
"errorCode": "0",
"errorMsg": "success",
"traceId": "0b****4d9"
}
失败返回
{
"errorCode": "P_1_06_384",
"errorMsg": "知识库名称已存在",
"solution": "请更换知识库名称",
"traceId": "0b446a1717543623264013347e386f"
}
错误码
公共错误码
| errorCode | errorMsg | 说明 |
|---|---|---|
| S40000 | 系统异常 | - 原因:系统出现错误。 解决方案:请稍后重试,若持续报错,请点击此处与我们取得联系,并将错误码与 traceId 一同反馈,帮助我们快速定位问题。 |
| P_1_10_183 | 授权令牌无效 | - 原因:token 不正确。 解决方案:请校验是否输入了有效令牌或配置新令牌。 |
| P_1_10_184 | 授权令牌已失效 | - 原因:当前 token 已过期。 解决方案:请前往百宝箱开放平台申请新令牌并更新到调用配置中。 |
| P_1_10_185 | 未检测到授权令牌 | - 原因:未填写 token 信息。 解决方案:请参考授权管理完成授权令牌的申请和配置。 |
| P_1_13_682 | 非法访问,请联系平台 | - 原因:系统检测到异常活动。 解决方案:请稍后重试,若持续报错,请点击此处与我们取得联系,并将错误码与 traceId 一同反馈,帮助我们快速定位问题。 |
参数校验与业务错误码
| errorCode | errorMsg | 说明 |
|---|---|---|
| P_1_00_005 | name长度不能超过50 | - 原因:请求参数超出限制。 解决方案:请修改后,重试。 |
| P_1_00_005 | description长度不能超过100 | - 原因:请求参数超出限制。 解决方案:请修改后,重试。 |
| P_1_06_384 | 知识库名称已存在 | - 原因:自定义的知识库名称需在租户内保证唯一。 解决方案:请更换知识库名称后,重试。 |