文档

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

更新时间:

获取文档列表(可按元信息过滤查询,也支持分页查询)。

接口说明

前提条件

已开通 百炼服务和通义点金服务。

获取到 workspaceId:获取 workspace 标识

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

POST /{workspaceId}/api/library/filterDocument

请求参数

名称类型必填描述示例值
workspaceIdstring

路径参数,业务空间 id

llm-xxxxx
bodyobject

请求 body。

andarray<object>

and 表达式,用于筛选文档/文档块

object

一系列约束条件,为三元组,用“与”连接

boostfloat

value 在文本召回引擎中的权重。默认是 1。

1
keystring

文档库中,元信息的 key

company
operatorstring

文档库元信息 key 存储的 value 和输入的 value 之间的关系

  • eq: 文档库元信息 key 存储的 value = 输入的 value
  • contains: 文档库元信息 key 存储的 value 列表 "包含" 您输入的 value
eq
valuestring

输入的元信息的值

alibaba
docIdListarray

文档 id 列表,用于筛选文档/文档块

string

文档 id

3553835752369972270
libraryIdstring

文档库 id 用于筛选文档/文档块

cjshcxxxx
orarray<object>

or 表达式,用于筛选文档/文档块。

object

一系列约束条件,为三元组,用“或”连接

boostfloat

value 在文本召回引擎中的权重。默认是 1。

1
keystring

文档库中,元信息的 key

company
operatorstring

文档库元信息 key 存储的 value 和输入的 value 之间的关系

  • eq: 文档库元信息 key 存储的 value = 输入的 value
  • contains: 文档库元信息 key 存储的 value 列表 "包含" 您输入的 value
contains
valuestring

输入的元信息的值

alibaba
pageinteger

页码,用于分页

1
pageSizeinteger

每页大小,用于分页

10
statusarray

文档状态列表,用于筛选文档。

文档解析状态列表,

StatusCode: WaitRefresh、InQueue、FetchingData、Embedding、Completed

  • Completed:可用,文档解析完毕。
  • Error:不可用,文档解析错误。
  • InQueue:待处理,文档待解析。
  • 其他状态:为系统内部状态,WaitRefresh 任务被调度,FetchingData 正在解析中,Embedding 正在构建索引。
string

文档状态,用于筛选文档。

Completed

返回参数

名称类型描述示例值
object

返回数据

costlong

耗时

null
dataobject

响应数据

currentPagelong

当前页

1
pageSizelong

每页记录数

10
recordsarray<object>

记录

object

数据

docIdstring

文档 id

29368126816
documentMetaobject

文档元数据

{"a": "1"}
fileTypestring

文档类型

pdf
gmtCreatestring

创建时间

2024-01-01 00:00:00
gmtModifiedstring

修改时间

2024-01-01 00:00:00
libraryIdstring

文档所属库 id

sdfgsjdfg
statusCodestring

文档状态 (WaitRefresh: 等待刷新, InQueue: 待处理, FetchingData: 数据获取中, Embedding: 文档处理中, Error: 错误, Completed: 可用, Null: 未知)

WaitRefresh
titlestring

文档标题

公司文档
urlstring

文档链接

null
totalPageslong

总页数

10
totalRecordslong

总记录数

100
dataTypestring

数据类型

null
errCodestring

错误码

0
messagestring

错误信息

ok
requestIdstring

请求 id

7ADF010C-FD89-569D-A079-2D4D5247E943
successboolean

是否成功

true
timestring

时间戳

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"
}

错误码

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