创建知识库
更新时间：2024-12-11
接口描述
为当前用户创建知识库
在线调试
百度智能云千帆提供了 API在线调试平台-示例代码 ，用于帮助开发者调试接口，平台集成快速检索、查看开发文档、查看在线调用的请求内容和返回结果、复制和下载示例代码等功能，支持Python、Java、PHP、C#、Go、Node.js、C++ 7种主流语言示例代码自动生成。
权限说明
Authorization需要填写密钥
接口定义
| Path | /v2/knowledgeBase?Action=CreateKnowledgeBase |
|---|---|
| Method | POST |
| Content-Type | application/json |
| Authorization | 请求签名(此签名为应用工作台密钥) |
请求结构
POST /v2/knowledgeBase?Action=CreateKnowledgeBase HTTP/1.1
HOST: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
"name": "knowledge_base_name",
"description": "knowledge_base description",
"config": {
"index": {
"type": "bes" # public | bes
"esUrl": "host:port",
"username": "",
"password": ""
}
}
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 字段 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| name | string | 是 | 知识库名称 |
| description | string | 否 | 知识库描述 |
| config | dict | 是 | 知识库配置 |
| config \ index | dict | 是 | 知识库托管配置 |
| config \ index \ type | string | 是 | 知识库托管资源选择 可选值： public：AppBuilder共享资源 bes：百度 Elasticsearch vdb：百度向量数据库VectorDB |
| config \ index \ clusterId | string | type=bes 和 vdb 时填写 | bes | vdb 集群 Id |
| config \ index \ username | string | type=bes 和 vdb 时填写 | bes | vdb 用户名 |
| config \ index \ password | string | type=bes 和 vdb 时填写 | bes | vdb 密码 |
| config \ index \ location | string | type=bes 和 vdb 时填写 | 托管资源的区域 可选值： bj：北京 bd：保定 sz：苏州 gz：广州 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 字段 | 类型 | 必然存在 | 说明 |
|---|---|---|---|
| requestId | string | 是 | requestId |
| id | string | 是 | 知识库id |
| name | string | 是 | 知识库名称 |
| description | string | 是 | 知识库描述 |
| config \ index | dict | 是 | 知识库托管配置 |
| config \ index \ type | string | 是 | 知识库托管资源 可选值： public：AppBuilder共享资源 bes：百度 Elasticsearch vdb：百度向量数据库VectorDB |
请求curl 示例
curl --location 'https://qianfan.baidubce.com/v2/knowledgeBase?Action=CreateKnowledgeBase' \
--header 'Authorization: Bearer authorization string' \
--header 'Content-Type: application/json' \
--data '{
"name": "openapi_knowledgeBase",
"config": {
"index": {
"type": "bes",
"username": "####",
"password": "####",
"location":"bj",
"clusterId":"985231####0126080"
}
}
}'正确响应示例
HTTP/1.1 200 OK
{
"requestId": "b970f03e-0761-489d-beb7-59fd771de589",
"id": "81f864e4-ce78-4def-acfd-5cef72e1ba23",
"name": "openapi_knowledgeBase",
"description": "",
"config": {
"index": {
"type": "bes"
}
}
}错误响应示例
HTTP/1.1 400
{
"code": "InvalidRequestArgumentError",
"message": "index type invalid",
"requestId": "20123341-d278-4a43-b04c-db5bc68c4769"
}