获取文档列表(可按元信息过滤查询,也支持分页查询)。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
POST /{workspaceId}/api/library/filterDocument
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
workspaceId | string | 是 | 路径参数,业务空间 id | llm-xxxxx |
body | object | 否 | 请求 body。 | |
and | array<object> | 否 | and 表达式,用于筛选文档/文档块 | |
object | 否 | 一系列约束条件,为三元组,用“与”连接 | ||
boost | float | 否 | value 在文本召回引擎中的权重。默认是 1。 | 1 |
key | string | 否 | 文档库中,元信息的 key | company |
operator | string | 否 | eq | |
value | string | 否 | 输入的元信息的值 | alibaba |
docIdList | array | 否 | 文档 id 列表,用于筛选文档/文档块 | |
string | 否 | 文档 id | 3553835752369972270 | |
libraryId | string | 是 | 文档库 id 用于筛选文档/文档块 | cjshcxxxx |
or | array<object> | 否 | or 表达式,用于筛选文档/文档块。 | |
object | 否 | 一系列约束条件,为三元组,用“或”连接 | ||
boost | float | 否 | value 在文本召回引擎中的权重。默认是 1。 | 1 |
key | string | 否 | 文档库中,元信息的 key | company |
operator | string | 否 | contains | |
value | string | 否 | 输入的元信息的值 | alibaba |
page | integer | 否 | 页码,用于分页 | 1 |
pageSize | integer | 否 | 每页大小,用于分页 | 10 |
status | array | 否 | ||
string | 否 | 文档状态,用于筛选文档。 | Completed |
返回参数
示例
正常返回示例
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"
}
错误码
访问错误中心查看更多错误码。