RecallDocument - 文档召回

接口说明

前提条件

已开通阿里云百炼服务和通义点金服务。
获取到 workspaceId：获取 workspace 标识。

调试

您可以在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 之间的关系 eq: 文档库元信息 key 存储的 value = 您输入的 value lte：文档库元信息 key 存储的 value <= 您输入的 value gte：文档库元信息 key 存储的 value >= 您输入的 value lt：文档库元信息 key 存储的 value < 您输入的 value gt：文档库元信息 key 存储的 value > 您输入的 value contains: 文档库元信息 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: 文档库元信息 key 存储的 value = 您输入的 value lte：文档库元信息 key 存储的 value <= 您输入的 value gte：文档库元信息 key 存储的 value >= 您输入的 value lt：文档库元信息 key 存储的 value < 您输入的 value gt：文档库元信息 key 存储的 value > 您输入的 value contains: 文档库元信息 key 存储的 value 列表 "包含" 您输入的 value	eq
value	string	否	输入的元信息的值	zhangsan
status	array	否	文档状态列表，用于筛选文档
statu	string	否	文档状态	WaitRefresh
query	string	是	文本	欧洲杯历史上有哪些球队因为球员的适应新文化而受益
rearrangement	boolean	否	是否开启父子文档块召回。父子文档块：文档解析过程中，一个完整的语义块，比如一个自然段，一个小节，可能会被切分成多个文档块，这取决于您配置的切分策略。开启父子文档召回之后，系统会尝试补全召回文档块所属的语义块，这样在构造 prompt 时，可以使得语料的语义更加完整，进而提升答案的完整性和准确性。	false
topK	integer	否	为召回文档块的数量	10

返回参数

名称	类型	描述	示例值
	object	返回数据
cost	long	耗时	0
data	object	响应数据
chunkList	array<object>	chunk 列表
chunkList	object	chunk
chunkId	string	文档块 id	823746762354
chunkMeta	object	文档块元数据	{"a":"1"}
chunkOssUrl	string	文档块 oss 地址	http://oss-xxx-hangzhou.com/xxx
chunkText	string	文档块文本	测试文档块
chunkType	string	文档块类型	text
docId	string	文档 id	839468263472
fileType	string	文档类型	pdf
libraryId	string	文档库 id	dscsbdsk
libraryName	string	文档库名称	测试文档库
nextChunkId	string	后一个文档块 id	982374872364
pos	array<object>	文档块位置
po	object	文档块位置坐标
axisArray	array	坐标
axisArray	double	坐标值	20.8
page	integer	页码	1
textHighlightArea	array	文本高亮区域，用于文本类型的文件高亮
textHighlightArea	integer	文本高亮区域数据	1
preChunkId	string	前一个文档块 id	827364827364832
score	float	文档块分数	0.5
title	string	文档标题	test
chunkPartList	array<object>	chunk part（版面识别结果）列表
chunkPartList	object	chunk part（版面识别结果）
chunkId	string	文档块 id	98327482364
chunkMeta	object	文档块元数据	{"a":"1"}
chunkOssUrl	string	文档块 oss 地址	http://oss-xxx-hangzhou.com/xxx
chunkText	string	文档块文本	测试文档块
chunkType	string	文档块类型	text
docId	string	文档 id	92837482364
fileType	string	文档类型	pdf
libraryId	string	文档库 id	sjdhgjsd
libraryName	string	文档库名称	测试文档库
nextChunkId	string	后一个文档块 id	2387648263542
pos	array<object>	文档块位置
po	object	文档块位置数据
axisArray	array	坐标
axisArray	double	坐标数值	1
page	integer	页码	1
textHighlightArea	array	文本高亮区域，用于文本类型的文件高亮
textHighlightArea	integer	文本高亮区域位置数据	1
preChunkId	string	前一个文档块 id	32874682764
score	float	文档块分数	0.5
title	string	文档标题	测试文档标题
chunkTextList	array	chunk text 列表
chunkTextList	string	文档块	这是一段测试文档块
documents	array<object>	文档列表
document	object	文档信息
docId	string	文档 id	92837482364
documentMeta	object	文档元数据	{"a":"1"}
fileType	string	文档类型	pdf
gmtCreate	string	创建时间	2024-01-01 00:00:00
libraryId	string	文档库 id	sjdhgjsd
title	string	文档标题	test
url	string	文档链接	http://oss-xxx-hangzhou.com/test.pdf
embeddingElapsedMs	long	向量计算耗时	100
textChunkList	array<object>	从文本索引召回的 chunk 列表
textChunkList	object	从文本索引召回的 chunk
chunkId	string	文档块 id	32874682364
chunkMeta	object	文档块元数据	{"a":"1"}
chunkOssUrl	string	文档块 oss 地址	http://oss-xxx-hangzhou.com/xxx
chunkText	string	文档块文本	这是一段测试文档块
chunkType	string	文档块类型	text
docId	string	文档 id	8372467263542
fileType	string	文档类型	pdf
libraryId	string	文档库 id	djsgfsjd
libraryName	string	文档库名称	测试文档库
nextChunkId	string	后一个文档块 id	23874682432
pos	array<object>	文档块位置
po	object	文档块位置
axisArray	array	坐标
axisArray	double	坐标值	10
page	integer	页码	1
textHighlightArea	array	文本高亮区域，用于文本类型的文件高亮
textHighlightArea	integer	文本高亮区域数据	1
preChunkId	string	前一个文档块 id	89473868346
score	float	文档块分数	0.5
title	string	文档标题	测试文档标题
textSearchElapsedMs	long	文本搜索耗时	100
totalElapsedMs	long	总耗时包括向量计算耗时、向量搜索耗时、文本搜索耗时等（取决于召回参数）	400
vectorChunkList	array<object>	从向量索引召回的 chunk 列表
vectorChunkList	object	从向量索引召回的 chunk
chunkId	string	文档块 id	8723642345276
chunkMeta	object	文档块元数据	{"a":"1"}
chunkOssUrl	string	文档块 oss 地址	https://oss-xxxx-hangzhou.com/test.pdf
chunkText	string	文档块文本	这是一段测试文本
chunkType	string	文档块类型	text
docId	string	文档 id	78326476235675372
fileType	string	文档类型	pdf
libraryId	string	文档库 id	djsgfsjd
libraryName	string	文档库名称	测试文档库
nextChunkId	string	后一个文档块 id	293846872343
pos	array<object>	文档块位置
po	object	文档块位置坐标
axisArray	array	坐标
axisArray	double	坐标值	48.8
page	integer	页码	1
textHighlightArea	array	文本高亮区域，用于文本类型的文件高亮
textHighlightArea	integer	文本高亮区域	10
preChunkId	string	前一个文档块 id	873647326542
score	float	文档块分数	0.5
title	string	文档标题	test
vectorSearchElapsedMs	long	向量搜索耗时	100
dataType	string	数据类型	null
errCode	string	错误码	0
message	string	错误信息	ok
requestId	string	请求 id	0bc13a9517168617617186457e401f
success	boolean	是否成功	true
time	string	时间戳	2024-04-24 11:54:34

示例

正常返回示例 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": 78326476235675380,
        "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"
}

错误码

访问错误中心查看更多错误码。

​接口说明

​调试

​授权信息

​请求语法

​请求参数

​返回参数

​示例

​错误码

接口说明

调试

授权信息

请求语法

请求参数

返回参数

示例

错误码