创建知识库
更新时间：2025-09-04
POST
https://qianfan.baidubce.com/v2/knowledgeBase?Action=CreateKnowledgeBase
为当前用户创建知识库
权限说明
调用本API，需使用API Key鉴权方式。Authorization的值为Bearer <API Key>。获取API Key流程，请查看授权。
请求参数
Headers 参数
除公共头域外，无其它特殊头域
Body 参数
name
string
知识库名称
必选
config
object {3}
知识库配置
必选
显示子属性
隐藏子属性
index
object {5}
知识库托管配置
必选
显示子属性
隐藏子属性
type
string
知识库托管资源选择
可选值：
public：AppBuilder共享资源
bes：百度 Elasticsearch
vdb：百度向量数据库VectorDB
必选
location
string
托管资源的区域
可选值：
bj：北京
bd：保定
sz：苏州
gz：广州
备注：type=bes 和 vdb 时填写需填写
可选
password
string
密码/API密钥
请在bes、vdb控制台中查看。
备注：type=bes 和 vdb 时填写需填写
可选
username
string
用户名/账号
请在bes、vdb控制台中查看。
备注：type=bes 和 vdb 时填写需填写
可选
clusterId
string
集群/实例 ID
请在bes、vdb控制台中查看。
备注：type=bes 和 vdb 时填写需填写
可选
catalogue
object {1}
知识库目录配置
可选
显示子属性
隐藏子属性
pathPrefix
string
知识库创建到指定目录下，最大层级为5， 默认为根目录下
可选
embeddingModel
string
向量模型选择，默认选择multilingual-embedding-AppBuilder 可选值：
- multilingual-embedding-AppBuilder：AppBuilder平台提供的文本表示模型，支持多语言场景（default）
- bge-large-zh：由智源研究院开源，针对中文任务优化的文本表示模型（需使用专享资源）
- bge-large-en：由智源研究院开源，面向英文任务的高性能文本表示模型（需使用专享资源）
如需指定除默认模型外的其他向量模型，请注意以下限制条件：
- 知识库托管资源（config \ index \ type）必须选择bes或vdb。
- 模型资源必须使用专享资源：请确保您在 ModelBuilder 平台中已开通相应预置服务，且资源充足。您可前往控制台查看资源情况。
可选
description
string
知识库描述
可选
请求结构
POST /v2/knowledgeBase?Action=CreateKnowledgeBase HTTP/1.1
HOST: qianfan.baidubce.com
Authorization: Bearer <API Key>
Content-Type: application/json
{
"name": "knowledge_base_name",
"description": "knowledge_base description",
"config": {
"index": {
"type": "bes",
"username": "####",
"password": "####",
"location":"bj",
"clusterId":"985231####0126080"
},
"catalogue":{
"pathPrefix": "/全部群组/##/##"
}
}
}示例代码
curl
curl --location 'https://qianfan.baidubce.com/v2/knowledgeBase?Action=CreateKnowledgeBase' \
--header 'Authorization: Bearer <API Key>' \
--header 'Content-Type: application/json' \
--data '{
"name": "openapi_knowledgeBase",
"config": {
"index": {
"type": "bes",
"username": "####",
"password": "####",
"location":"bj",
"clusterId":"985231####0126080"
},
"catalogue":{
"pathPrefix": "/全部群组/##/##"
}
}
}'返回响应
Headers 参数
除公共头域外，无其它特殊头域
返回参数
id
string
知识库id
必选
name
string
知识库名称
必选
config
object {1}
知识库配置
必选
显示子属性
隐藏子属性
index
object {1}
知识库托管配置
必选
显示子属性
隐藏子属性
type
string
知识库托管资源
可选值：
public：AppBuilder共享资源
bes：百度 Elasticsearch
vdb：百度向量数据库VectorDB
必选
requestId
string
requestId
必选
description
string
知识库描述
必选
JSON
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"
}
}
}JSON
HTTP/1.1 400
{
"code": "InvalidRequestArgumentError",
"message": "index type invalid",
"requestId": "20123341-d278-4a43-b04c-db5bc68c4769"
}