检索知识库
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
polardb:RetrievalKnowledgeBase |
get |
*全部资源
|
无 | 无 |
请求语法
POST HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
地域 ID |
cn-beijing |
| KnowledgeBaseId |
string |
是 |
知识库唯一标识，支持使用逗号分隔指定多个知识库，最多 50 个 |
pkb-1xxxxx,pkb-2xxxxx |
| QueryText |
string |
是 |
查询文本 |
财报 |
| TopK |
integer |
否 |
返回结果数量 |
5 |
| ScoreThreshold |
number |
否 |
相似度分数阈值 |
0.7 |
| RerankEnabled |
boolean |
否 |
是否开启 Rerank 重排序，默认开启 |
true |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| QueryText |
string |
查询文本 |
财报 |
| RequestId |
string |
Id of the request |
CD35F3-F3-44CA-AFFF-BAF869****** |
| ResultCount |
integer |
结果数量 |
5 |
| Results |
array<object> |
搜索结果 |
|
|
array<object> |
搜索结果 |
||
| Captions |
array |
分片关联的图或表标题列表 |
|
|
string |
图或表标题 |
系统架构图 |
|
| DocItems |
array |
分片关联的 Docling 源文档结构化元素引用列表，可用于精确定位原文元素 |
|
|
string |
Docling 源文档结构化元素引用 |
#/texts/2 |
|
| FileId |
string |
文件唯一标识 |
91b97b71-xxxx-xxxx-xxxx-33c6a6341cdc |
| FileName |
string |
文件名称 |
2024财报.pdf |
| Headings |
array |
分片所属的章节标题链 |
|
|
string |
标题 |
财报 |
|
| ImageResources |
array<object> |
分片引用的图片资源列表 |
|
|
object |
图片资源 |
||
| DocumentIndex |
integer |
图片所属源文档的序号，从 0 开始 |
0 |
| Id |
string |
图片资源唯一标识 |
document-0/pictures/1 |
| ItemRef |
string |
图片在 Docling 源文档结构中的元素引用 |
#/pictures/1 |
| MimeType |
string |
图片资源的媒体类型 |
image/png |
| Uri |
string |
图片资源的 OSS URI |
oss://my-bucket/results/my-space/doc-001/artifacts/image-1.png |
| Metadata |
string |
元数据 |
{} |
| PageNumbers |
array |
分片所属的页码列表 |
|
|
integer |
分片所属的页码 |
1 |
|
| ShardContent |
string |
分片文本内容 |
财报 |
| ShardIndex |
integer |
分片序号 |
1 |
| SimilarityScore |
number |
相似度分数 |
0.8 |
示例
正常返回示例
JSON格式
{
"QueryText": "财报",
"RequestId": "CD35F3-F3-44CA-AFFF-BAF869******",
"ResultCount": 5,
"Results": [
{
"Captions": [
"系统架构图"
],
"DocItems": [
"#/texts/2"
],
"FileId": "91b97b71-xxxx-xxxx-xxxx-33c6a6341cdc",
"FileName": "2024财报.pdf",
"Headings": [
"财报"
],
"ImageResources": [
{
"DocumentIndex": 0,
"Id": "document-0/pictures/1",
"ItemRef": "#/pictures/1",
"MimeType": "image/png",
"Uri": "oss://my-bucket/results/my-space/doc-001/artifacts/image-1.png"
}
],
"Metadata": "{}",
"PageNumbers": [
1
],
"ShardContent": "财报",
"ShardIndex": 1,
"SimilarityScore": 0.8
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。