logo
开发者文档
搜索
创建知识库

创建知识库

可以通过该接口,为 API Key 绑定的 Agent 创建一个新的知识库。

请求方式

POST

调用地址

https://api-${endpoint}.gptbots.ai/v1/bot/knowledge/base/create

调用验证

详情参见 API 概述的鉴权方式说明。

请求

请求示例

curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/bot/knowledge/base/create' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "name": "产品知识库", "desc": "用于存放产品说明、FAQ 和业务资料的知识库", "graph_enable": false, "access_control_enabled": false }'
                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/bot/knowledge/base/create' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
    "name": "产品知识库",
    "desc": "用于存放产品说明、FAQ 和业务资料的知识库",
    "graph_enable": false,
    "access_control_enabled": false
}'

                    
此代码块在浮窗中显示

请求头

字段 类型 描述
Authorization Bearer ${API Key} 使用 Authorization: Bearer ${API Key}进行调用验证,请在 API 密钥页面获取密钥作为 API Key。

请求参数

字段 类型 必填 说明
name String 知识库名称。
desc String 知识库描述。
graph_enable Boolean 是否启用知识图谱。
kg_ner_extraction_user_prompt String 三元组抽取提示词。为空时使用系统默认配置。
access_control_enabled Boolean 是否启用访问控制,即角色或文档级权限过滤。

响应

响应示例

{ "knowledge_base_id": "6a475ee61d276b3d062a1bcb" }
                      
                      {
    "knowledge_base_id": "6a475ee61d276b3d062a1bcb"
}

                    
此代码块在浮窗中显示

成功响应

字段 类型 描述
knowledge_base_id String 新建知识库 ID。

失败响应

字段 类型 描述
code Integer 错误码。
message String 错误详情。