ListLumaDocuments - 列出 Luma Agent 绑定的知识库中的文档 - 事件总线EventBridge

接口说明

列出 Luma Agent 绑定的知识库中的文档，支持按文件名前缀和处理状态过滤。

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
AgentName	string	是	Agent 名称	my_agent
Catalog	string	是	Agent 已绑定的数据目录名称。可通过 ListLumaCatalogs 获取	my_catalog
Namespace	string	是	Agent 已绑定的命名空间名称。可通过 ListLumaNamespaces 获取	my_namespace
KnowledgeBaseName	string	是	Agent 已绑定的知识库名称。可通过 ListLumaKnowledgeBases 获取	my-knowledge-base
FileNamePrefix	string	否	按文件名前缀过滤	manual-
Status	string	否	按处理状态过滤，取值：Pending、Processing、Ready、Failed	Ready
MaxResults	integer	否	取值范围 1~100，不传时由服务端取默认值	20
NextToken	string	否	首次查询不传；后续翻页使用上一次响应中返回的 NextToken。该值为不透明字符串，请勿解析	ca1eb85f5d99c7d6a97e6****

返回参数

名称	类型	描述	示例值
	object
Message	string	接口返回的提示信息，成功时为 Operation success，失败时为具体错误描述	Operation success
RequestId	string	本次请求的唯一标识，用于问题排查与工单反馈	34AD682D-5B91-5773-8132-AA38C130****
Data	object	文档列表，包含文档条目与分页信息
Documents	array	文档条目列表	[{"DocumentId":"doc-bp1xxxxxxxxxxxx","FileName":"manual.pdf","Status":"COMPLETED"}]
	KnowledgeBaseDocument	单个文档的详细信息，包含文件名、处理状态、大小与切片数
NextToken	string	下一页翻页令牌（不透明字符串），传入下次请求的 NextToken 可获取下一页；为空表示已无更多数据	ca1eb85f5d99c7d6a97e6****
TotalCount	integer	满足过滤条件的文档总数	10
Code	string	接口返回码，Success 表示成功，失败时为具体错误码	Success
Success	boolean	本次调用是否成功，true 表示成功	true

示例

正常返回示例

JSON格式

{
  "Message": "Operation success",
  "RequestId": "34AD682D-5B91-5773-8132-AA38C130****",
  "Data": {
    "Documents": [
      {
        "ChunkConfiguration": {
          "HeadingLevel": 2,
          "MaxChunkSize": 600,
          "OverlapSize": 40,
          "PreprocessRules": {
            "RemoveUrlsAndEmails": false,
            "ReplaceConsecutiveWhitespace": true
          },
          "Separator": "\\\\n\\\\n",
          "Strategy": "BY_SEPARATOR"
        },
        "ChunkCount": 120,
        "CreatedAt": "2026-08-24T10:00:00Z",
        "DocumentId": "doc-bp1xxxxxxxxxxxx",
        "ErrorCode": "FILE_CORRUPTED",
        "ErrorMessage": "parse pdf failed",
        "FileName": "manual.pdf",
        "FileSize": 1048576,
        "Metadata": [
          {
            "Key": "department",
            "Value": "研发"
          }
        ],
        "SourceModifiedTime": 1788000000000,
        "SourceType": "UPLOAD",
        "SourceUri": "oss://my-bucket/docs/handbook.pdf",
        "Status": "COMPLETED",
        "UpdatedAt": "2026-08-24T10:00:00Z"
      }
    ],
    "NextToken": "ca1eb85f5d99c7d6a97e6****",
    "TotalCount": 10
  },
  "Code": "Success",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息
400	InvalidParameter	The specified parameter is invalid
403	ServiceNotEnable	Service not enable
404	AgentNotFound	Agent not found
404	ResourceNotFound	The specified resource is not bound to the agent

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

变更历史

更多信息，参考变更详情。