GetFilterDocumentList - 按元信息过滤查询文档列表

接口说明

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

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dianjin:GetFilterDocumentList	none	全部资源 ``	无	无

请求语法

POST /{workspaceId}/api/library/filterDocument HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
workspaceId	string	是	路径参数，业务空间 id	llm-xxxxx
body	object	否	请求 body。
and	array<object>	否	and 表达式，用于筛选文档/文档块
and	object	否	一系列约束条件，为三元组，用“与”连接
boost	float	否	value 在文本召回引擎中的权重。默认是 1。	1
key	string	否	文档库中，元信息的 key	company
operator	string	否	文档库元信息 key 存储的 value 和输入的 value 之间的关系 eq：文档库元信息 key 存储的 value = 输入的 value contains：文档库元信息 key 存储的 value 列表 "包含" 您输入的 value	eq
value	string	否	输入的元信息的值	alibaba
docIdList	array	否	文档 id 列表，用于筛选文档/文档块
docIdList	string	否	文档 id	3553835752369972270
libraryId	string	是	文档库 id 用于筛选文档/文档块	cjshcxxxx
or	array<object>	否	or 表达式，用于筛选文档/文档块。
or	object	否	一系列约束条件，为三元组，用“或”连接
boost	float	否	value 在文本召回引擎中的权重。默认是 1。	1
key	string	否	文档库中，元信息的 key	company
operator	string	否	文档库元信息 key 存储的 value 和输入的 value 之间的关系 eq：文档库元信息 key 存储的 value = 输入的 value contains：文档库元信息 key 存储的 value 列表 "包含" 您输入的 value	contains
value	string	否	输入的元信息的值	alibaba
page	integer	否	页码，用于分页	1
pageSize	integer	否	每页大小，用于分页	10
status	array	否	文档状态列表，用于筛选文档。文档解析状态列表， StatusCode：WaitRefresh、InQueue、FetchingData、Embedding、Completed、FormatError、Error Completed：可用，文档解析完毕。 Error：不可用，文档解析错误。 FormatError：文件格式错误。例如文件加密或不完整时需要重新上传正确格式的文件。 InQueue：待处理，文档待解析。 Parsed：已解析完成。其他状态：为系统内部状态，WaitRefresh 任务被调度，FetchingData 正在解析中，Embedding 正在构建索引。
statu	string	否	文档状态，用于筛选文档。	Completed

返回参数

名称	类型	描述	示例值
	object	返回数据
cost	long	耗时	null
data	object	响应数据
currentPage	long	当前页	1
pageSize	long	每页记录数	10
records	array<object>	记录
record	object	数据
docId	string	文档 id	29368126816
documentMeta	object	文档元数据	{"a": "1"}
fileType	string	文档类型	pdf
gmtCreate	string	创建时间	2024-01-01 00:00:00
gmtModified	string	修改时间	2024-01-01 00:00:00
libraryId	string	文档所属库 id	sdfgsjdfg
statusCode	string	文档状态（WaitRefresh：等待刷新，InQueue：待处理，FetchingData：数据获取中，Embedding：文档处理中，Error：错误，Completed：可用，Null：未知）	WaitRefresh
title	string	文档标题	公司文档
url	string	文档链接	null
totalPages	long	总页数	10
totalRecords	long	总记录数	100
dataType	string	数据类型	null
errCode	string	错误码	0
message	string	错误信息	ok
requestId	string	请求 id	7ADF010C-FD89-569D-A079-2D4D5247E943
success	boolean	是否成功	true
time	string	时间戳	2024-01-01 00:00:00

示例

正常返回示例 JSON格式

{
  "cost": 0,
  "data": {
    "currentPage": 1,
    "pageSize": 10,
    "records": [
      {
        "docId": 29368126816,
        "documentMeta": {
          "a": 1
        },
        "fileType": "pdf",
        "gmtCreate": "2024-01-01 00:00:00",
        "gmtModified": "2024-01-01 00:00:00",
        "libraryId": "sdfgsjdfg",
        "statusCode": "WaitRefresh",
        "title": "公司文档",
        "url": null
      }
    ],
    "totalPages": 10,
    "totalRecords": 100
  },
  "dataType": null,
  "errCode": 0,
  "message": "ok",
  "requestId": "7ADF010C-FD89-569D-A079-2D4D5247E943",
  "success": true,
  "time": "2024-01-01 00:00:00"
}

错误码

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

​接口说明

​调试

​授权信息

​请求语法

​请求参数

​返回参数

​示例

​错误码

接口说明

调试

授权信息

请求语法

请求参数

返回参数

示例

错误码