知识库列表
更新时间：2024-12-11
接口描述
获取知识库列表
在线调试
百度智能云千帆提供了 API在线调试平台-示例代码 ，用于帮助开发者调试接口，平台集成快速检索、查看开发文档、查看在线调用的请求内容和返回结果、复制和下载示例代码等功能，支持Python、Java、PHP、C#、Go、Node.js、C++ 7种主流语言示例代码自动生成。
权限说明
Authorization需要填写密钥
接口定义
| Path | /v2/knowledgeBase?Action=DescribeKnowledgeBases |
|---|---|
| Method | POST |
| Content-Type | application/json |
| Authorization | 请求签名(此签名为应用工作台密钥) |
请求结构
POST /v2/knowledgeBase?Action=DescribeKnowledgeBases HTTP/1.1
HOST: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
"marker": "知识库起始位置id",
"maxKeys": 10,
"keyword": "搜索关键字"
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 字段 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| keyword | string | 否 | 搜索关键字 |
| marker | string | 否 | 起始位置 |
| maxKeys | integer | 否 | 数据大小，默认10，最大值100 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 字段 | 类型 | 必然存在 | 说明 |
|---|---|---|---|
| requestId | string | 是 | 请求 id |
| data | []dict | 是 | 知识库列表 |
| data \ id | string | 是 | 知识库id |
| data \ name | string | 是 | 知识库名称 |
| data \ description | string | 是 | 知识库描述 |
| data \ config \ index | dict | 是 | 知识库配置 |
| data \ config \ index \ type | string | 是 | 知识库索引存储配置 (public | bes | vdb) |
| data \ config \ index \ esUrl | dict | 是 | bes 访问地址 |
| marker | string | 是 | 起始位置 |
| isTruncated | bool | 是 | true表示后面还有数据，false表示已经是最后一页 |
| nextMarker | string | 是 | nextMarker下次查询的起始位置 |
| maxKeys | int | 是 | 本次查询包含的最大结果集数量 |
请求curl 示例
curl --location 'https://qianfan.baidubce.com/v2/knowledgeBase?Action=DescribeKnowledgeBases' \
--header 'Authorization: Bearer authorization string' \
--header 'Content-Type: application/json' \
--data '{
"marker": "",
"maxKeys": 10,
"keyword":""
}'正确响应示例
HTTP/1.1 200 OK
{
"requestId": "095b353d-44da-4844-bf5f-965aa5103459",
"data": [
{
"id": "5e12955f-6b45-4f54-b2b6-84369f068a3d",
"name": "knowledge_base",
"description": "knowledge_base description",
"config": {
"index": {
"type": "public",
"esUrl": ""
}
}
}
],
"marker": "",
"isTruncated": true,
"nextMarker": "f1e93884-bfa6-4ebe-8581-fc3c1461adaf",
"maxKeys": 10
}错误响应示例
HTTP/1.1 400
{
"code": "InvalidRequestArgumentError",
"message": "marker is not valid",
"requestId": "a69c5c0c-1170-43ed-a425-d62990286dc1"
}