ListLumaDocuments - EventBridge: Central de Documentação do Alibaba Cloud

Lista os documentos em uma base de conhecimento vinculada a um Luma Agent, com suporte para filtragem por prefixo de nome de arquivo e status de processamento.

Descrição da operação

Lista os documentos em uma base de conhecimento vinculada a um Luma Agent, com suporte para filtragem por prefixo de nome de arquivo e status de processamento.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
AgentName	string	Sim	O nome do agente.	my_agent
Catalog	string	Sim	O nome do catálogo de dados vinculado ao agente. Você pode chamar ListLumaCatalogs para obter o nome do catálogo.	my_catalog
Namespace	string	Sim	O nome do namespace vinculado ao agente. Você pode chamar ListLumaNamespaces para obter o nome do namespace.	my_namespace
KnowledgeBaseName	string	Sim	O nome da base de conhecimento vinculada ao agente. Você pode chamar ListLumaKnowledgeBases para obter o nome da base de conhecimento.	my-knowledge-base
FileNamePrefix	string	Não	O prefixo do nome do arquivo usado para filtrar documentos.	manual-
Status	string	Não	O status de processamento usado para filtrar documentos. Valores válidos: Pending, Processing, Ready e Failed.	Ready
MaxResults	integer	Não	O número máximo de registros a serem retornados. Valores válidos: 1 a 100. Se este parâmetro não for especificado, o servidor usará um valor padrão.	20
NextToken	string	Não	O token de paginação. Não especifique este parâmetro na primeira solicitação. Para solicitações subsequentes, use o valor de NextToken retornado na resposta anterior. Este valor é uma string opaca. Não o analise.	ca1eb85f5d99c7d6a97e6****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Message	string	A mensagem retornada pela operação. O valor é Operation success se a chamada for bem-sucedida, ou uma descrição de erro específica se a chamada falhar.	Operation success
RequestId	string	O ID exclusivo da solicitação. Você pode usar este ID para solução de problemas e ao enviar um ticket.	34AD682D-5B91-5773-8132-AA38C130****
Data	object	O resultado da lista de documentos, que contém entradas de documentos e informações de paginação.
Documents	array	A lista de entradas de documentos.	[{"DocumentId":"doc-bp1xxxxxxxxxxxx","FileName":"manual.pdf","Status":"COMPLETED"}]
	KnowledgeBaseDocument	Os detalhes de um documento, incluindo o nome do arquivo, o status de processamento, o tamanho e o número de chunks.
NextToken	string	O token de paginação para a próxima página. Esta é uma string opaca. Passe este valor como o parâmetro NextToken na próxima solicitação para recuperar a próxima página. Um valor vazio indica que não há mais dados disponíveis.	ca1eb85f5d99c7d6a97e6****
TotalCount	integer	O número total de documentos que correspondem às condições de filtro.	10
Code	string	O código de resposta. O valor Success indica que a chamada foi bem-sucedida. Se a chamada falhar, um código de erro específico será retornado.	Success
Success	boolean	Indica se a chamada foi bem-sucedida. O valor true indica que a chamada foi bem-sucedida.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "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": "falha na análise do pdf",
        "FileName": "manual.pdf",
        "FileSize": 1048576,
        "Metadata": [
          {
            "Key": "departamento",
            "Value": "R&D"
          }
        ],
        "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
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
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

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.