支持多文件夹ID或文件ID检索的RAG结果获取接口，供客户端自行加工结果并嵌入业务逻辑。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST /api/v2/aidoc/knowledgebase/retrieve HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
请求 Body |
|
| query |
string |
是 |
用户输入查询语句 |
"What's the meaning of the file?" |
| useReranker |
boolean |
否 |
是否需要使用 reranker（默认 true） |
|
| rerankerThreshold |
number |
否 |
重排序分数阈值，低于该阈值的结果会被过滤（默认 0.0） |
0.0 |
| topK |
integer |
否 |
返回召回结果的 Top-K 条目（默认 10） |
10 |
| preRetrieveTopK |
integer |
否 |
返回预召回的召回数（默认 0） |
0 |
| documentIds |
array |
否 |
docIds 与 folderIds 必须选择且仅选择其一传入 |
|
|
integer |
否 |
文件 id，可通过 SaaS 页面或 sdk 中接口获取 |
3456 |
|
| folderIds |
array |
否 |
folderIds 与 docIds 必须选择且仅选择其一传入 |
|
|
string |
否 |
文件夹 id，可通过 SaaS 页面或 sdk 中接口获取 |
adafb91d4e014e2eb4d0a5375b547115 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| requestId |
string |
Id of the request |
83A5A7DD-8974-5769-952E-590A97BEA34E |
| data |
object |
返回数据 |
|
| jobId |
string |
任务 id |
76cd1691-daf6-4113-8444-4998a25a5323 |
| results |
array |
检索结果列表 |
|
| ChunkItem |
检索结果 |
示例
正常返回示例
JSON格式
{
"requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
"data": {
"jobId": "76cd1691-daf6-4113-8444-4998a25a5323",
"results": [
{
"score": 0.4295678,
"docName": "临时场地协议-APM.pdf",
"rerankScore": 0.5053711,
"docId": "b4620821aea92c062d8d19ad793243669cf9ae2b900e6967dee6ee9f3bf5feed",
"docUrl": "jobs/a4123b3f-9287-4c61-b59d-32e40fcb0a31/document/8b24a2e06669427fb3dc9812374d9d1a.pdf",
"weightedScore": 0.47252458,
"chunkId": "b0x7,b1x10",
"chunkContent": "\\\\n## 第三条 场地占用费(含物业管理费和市场推广费)\\\\n\\\\n3.2 乙方应于本协议签订后 20 个工作日内或该场地交付乙方的同时(以日期在先者为准),\\\\n向甲方一次性支付该场地四个月的场地占用费。\\\\n\\\\n3.3 乙方应向甲方支付的协议价款(场地占用费、物业管理费、市场推广费及本协议约定的其 他费用)以及实际发生的各种性质的价外费用(根据适用税法的相关规定,价外费用包括 但不限于违约金、赔偿金、代收款项、代垫款项)均为含增值税价格。",
"docElsIds": [
"b0x7"
]
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。