知识库详情
更新时间：2024-12-11
接口描述
获取指定知识库详情
在线调试
百度智能云千帆提供了 API在线调试平台-示例代码 ，用于帮助开发者调试接口，平台集成快速检索、查看开发文档、查看在线调用的请求内容和返回结果、复制和下载示例代码等功能，支持Python、Java、PHP、C#、Go、Node.js、C++ 7种主流语言示例代码自动生成。
权限说明
Authorization需要填写密钥
接口定义
| Path | /v2/knowledgeBase?Action=DescribeKnowledgeBase |
|---|---|
| Method | POST |
| Content-Type | application/json |
| Authorization | 请求签名(此签名为应用工作台密钥) |
请求结构
POST /v2/knowledgeBase?Action=DescribeKnowledgeBase HTTP/1.1
HOST: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
"id": "knowledgeBaseID"
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 字段 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| id | string | 是 | 知识库 id |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 字段 | 类型 | 必然存在 | 说明 |
|---|---|---|---|
| requestId | string | 是 | requestId |
| id | string | 是 | 知识库id |
| name | string | 是 | 知识库名称 |
| description | string | 是 | 知识库描述 |
| config \ index | dict | 是 | 知识库配置 |
| config \ index \ type | string | 是 | 知识库索引存储配置 (public | bes | vdb) |
| config \ index \ esUrl | dict | 是 | bes 访问地址 |
请求curl 示例
curl --location 'https://qianfan.baidubce.com/v2/knowledgeBase?Action=DescribeKnowledgeBase' \
--header 'Authorization: Bearer authorization string' \
--header 'Content-Type: application/json' \
--data '{
"id":"5e12955f-6b45-4f54-b2b6-84369f068a3d"
}'正确响应示例
HTTP/1.1 200 OK
{
"requestId": "75a340ee-bfb5-40c2-b0a9-de80400368c8",
"id": "5e12955f-6b45-4f54-b2b6-84369f068a3d",
"name": "knowledge_base",
"description": "knowledge_base description",
"config": {
"index": {
"type": "public",
"esUrl": ""
}
}
}错误响应示例
HTTP/1.1 400
{
"code": "InvalidRequestArgumentError",
"message": "Dataset Not Found",
"requestId": "aceb2ccb-2762-4a11-b8de-1c01c9ad5b35"
}