文档召回，可根据文本从文档库中召回文档块。并可设置召回文档块数量、也可根据元信息条件进行过滤，同时可选择是否进行文档块的补全。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dianjin:RecallDocument | none | *全部资源 * |
| 无 |
请求语法
POST /{workspaceId}/api/library/recallDocument HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| workspaceId | string | 是 | 路径参数，业务空间 id。 | llm-xxxxx |
| body | object | 否 | 请求体参数。 | |
| filters | array<object> | 否 | 元信息过滤条件 | |
| filter | object | 否 | 过滤 | |
| and | array<object> | 否 | and 表达式，用于筛选文档/文档块 | |
| and | object | 否 | and 表达式 | |
| boost | float | 否 | 关键词权重 | 20 |
| key | string | 否 | 文档库中，元信息的 key | docType |
| operator | string | 否 | 文档库元信息 key 存储的 value 和您输入的 value 之间的关系
| contains |
| value | string | 否 | 输入的元信息的值 | 策略报告 |
| chunkType | string | 否 | 文档块类型，用于筛选文档块，包括：Text、Graph、Table、FAQ | Text |
| docIdList | array | 否 | 文档 id 列表，用于筛选文档/文档块 | |
| docIdList | string | 否 | 文档 id | 8372458573692819933 |
| libraryId | string | 是 | 文档库 id 用于筛选文档/文档块 | sdbjhvs |
| or | array<object> | 否 | or 表达式，用于筛选文档/文档块 | |
| or | object | 否 | or 表达式 | |
| boost | float | 否 | 关键词权重 | 30 |
| key | string | 否 | 文档库中，元信息的 key | researcher |
| operator | string | 否 | 文档库元信息 key 存储的 value 和您输入的 value 之间的关系
| eq |
| value | string | 否 | 输入的元信息的值 | zhangsan |
| status | array | 否 | 文档状态列表，用于筛选文档 | |
| statu | string | 否 | 文档状态 | WaitRefresh |
| query | string | 是 | 文本 | 欧洲杯历史上有哪些球队因为球员的适应新文化而受益 |
| rearrangement | boolean | 否 | 是否开启父子文档块召回。
| false |
| topK | integer | 否 | 为召回文档块的数量 | 10 |
返回参数
示例
正常返回示例
JSON格式
{
"cost": 0,
"data": {
"chunkList": [
{
"chunkId": "823746762354",
"chunkMeta": {
"a": "1"
},
"chunkOssUrl": "http://oss-xxx-hangzhou.com/xxx",
"chunkText": "测试文档块",
"chunkType": "text",
"docId": "839468263472",
"fileType": "pdf",
"libraryId": "dscsbdsk",
"libraryName": "测试文档库",
"nextChunkId": "982374872364",
"pos": [
{
"axisArray": [
20.8
],
"page": 1,
"textHighlightArea": [
1
]
}
],
"preChunkId": "827364827364832",
"score": 0.5,
"title": "test"
}
],
"chunkPartList": [
{
"chunkId": "98327482364",
"chunkMeta": {
"a": "1"
},
"chunkOssUrl": "http://oss-xxx-hangzhou.com/xxx\n",
"chunkText": "测试文档块\n",
"chunkType": "text",
"docId": "92837482364",
"fileType": "pdf",
"libraryId": "sjdhgjsd",
"libraryName": "测试文档库",
"nextChunkId": "2387648263542",
"pos": [
{
"axisArray": [
1
],
"page": 1,
"textHighlightArea": [
1
]
}
],
"preChunkId": "32874682764",
"score": 0.5,
"title": "测试文档标题"
}
],
"chunkTextList": [
"这是一段测试文档块"
],
"documents": [
{
"docId": "92837482364",
"documentMeta": {
"a": "1"
},
"fileType": "pdf",
"gmtCreate": "2024-01-01 00:00:00",
"libraryId": "sjdhgjsd\n",
"title": "test",
"url": "http://oss-xxx-hangzhou.com/test.pdf"
}
],
"embeddingElapsedMs": 100,
"textChunkList": [
{
"chunkId": "32874682364",
"chunkMeta": {
"a": "1"
},
"chunkOssUrl": "http://oss-xxx-hangzhou.com/xxx\n",
"chunkText": "这是一段测试文档块\n",
"chunkType": "text",
"docId": "8372467263542",
"fileType": "pdf",
"libraryId": "djsgfsjd",
"libraryName": "测试文档库",
"nextChunkId": "23874682432",
"pos": [
{
"axisArray": [
10
],
"page": 1,
"textHighlightArea": [
1
]
}
],
"preChunkId": "89473868346",
"score": 0.5,
"title": "测试文档标题"
}
],
"textSearchElapsedMs": 100,
"totalElapsedMs": 400,
"vectorChunkList": [
{
"chunkId": "8723642345276",
"chunkMeta": {
"a": "1"
},
"chunkOssUrl": "https://oss-xxxx-hangzhou.com/test.pdf",
"chunkText": "这是一段测试文本",
"chunkType": "text",
"docId": "78326476235675372",
"fileType": "pdf",
"libraryId": "djsgfsjd",
"libraryName": "测试文档库",
"nextChunkId": "293846872343",
"pos": [
{
"axisArray": [
48.8
],
"page": 1,
"textHighlightArea": [
10
]
}
],
"preChunkId": "873647326542",
"score": 0.5,
"title": "test"
}
],
"vectorSearchElapsedMs": 100
},
"dataType": "null",
"errCode": "0",
"message": "ok",
"requestId": "0bc13a9517168617617186457e401f",
"success": true,
"time": "2024-04-24 11:54:34"
}错误码
访问错误中心查看更多错误码。