ListIndexDocuments - 查询索引下的文档列表

获取指定知识库中一个或多个文档的详细信息。

接口说明

  • 调用本接口前,请确保您的知识库已经创建完成且未被删除(即知识库 IDIndexId有效)。
  • 本接口具有幂等性。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
sfm:ListIndexFileslist
*全部资源
*

请求语法

GET /{WorkspaceId}/index/list_index_documents HTTP/1.1

请求参数

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

知识库 ID,即 CreateIndex 接口返回的Data.Id

79c0alxxxx
DocumentStatusstring

即通过文档导入状态对接口返回的文档列表进行过滤。取值范围:

  • INSERT_ERROR:文档导入失败。
  • RUNNING:文档导入中。
  • DELETED:文档已删除。
  • FINISH:文档导入成功。

默认值为空,即不使用文档导入状态对结果进行过滤。

FINISH
DocumentNamestring

即通过文档名称对接口返回的文档列表进行过滤。默认值为空,即不使用文档名称对结果进行过滤。

翻译平台运维文档
PageNumberinteger

指定要查询的页码。起始值为 1。默认值为 1。

1
PageSizeinteger

指定分页查询时每页展示的文档数量。最大值不限。 默认值为 10。

10
WorkspaceIdstring

知识库所属的业务空间 ID。在百炼的控制台首页,单击页面左上角业务空间详情图标获取。

llm-3z7uw7fwz0vexxxx

返回参数

名称类型描述示例值
object

Schema of Response

Codestring

错误状态码。

InvalidParameter
Dataobject

接口业务数据字段。

Documentsarray<object>

知识库下的文档列表。

rowsobject

文档对象。

Codestring

文档导入错误状态码。

110002
DocumentTypestring

文档格式类型。可能值为: pdf、docx、doc、txt、md、pptx、ppt、png、jpg、jpeg、bmp、gif、EXCEL。

pdf
Idstring

文档 ID。

doc_c134aa2073204a5d936d870bf960f56axxxxxxxx
Messagestring

文档导入错误信息。

check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid
Namestring

文档名称。

翻译平台运维文档
Sizeinteger

文档大小,单位字节 Byte。

996764
SourceIdstring

对于非结构化知识库指的是类目 ID,即 AddCategory 接口返回的CategoryId。您也可以在数据管理-非结构化数据页面,单击类目名称旁的 ID 图标获取。

对于结构化知识库则表示数据表 ID。您可以在数据管理-结构化数据页面,单击数据表名称旁的 ID 图标获取。

cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx
Statusstring

文档导入状态。可能值为:

  • INSERT_ERROR:文档导入失败。
  • RUNNING:文档导入中。
  • DELETED:文档已删除。
  • FINISH:文档导入成功。
RUNNING
IndexIdstring

知识库 ID。

pno97txxxx
PageNumberinteger

返回指定的页码。

1
PageSizeinteger

返回指定的每页条数。

10
TotalCountlong

返回结果的总条数。

2437
Messagestring

错误信息。

Required parameter(%s) missing or invalid, please check the request parameters.
RequestIdstring

请求 ID。

35A267BF-xxxx-54DB-8394-AA3B0742D833
Statusstring

接口返回的状态码。

200
Successboolean

接口调用是否成功,可能值:

  • true:成功。
  • false:失败。
true

示例

正常返回示例

JSON格式

{
  "Code": "InvalidParameter",
  "Data": {
    "Documents": [
      {
        "Code": "110002",
        "DocumentType": "pdf",
        "Id": "doc_c134aa2073204a5d936d870bf960f56axxxxxxxx",
        "Message": "check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid",
        "Name": "翻译平台运维文档",
        "Size": 996764,
        "SourceId": "cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx",
        "Status": "RUNNING"
      }
    ],
    "IndexId": "pno97txxxx",
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 2437
  },
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "RequestId": "35A267BF-xxxx-54DB-8394-AA3B0742D833",
  "Status": "200",
  "Success": true
}

错误码

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