Lista os fragmentos de texto em uma base de conhecimento vinculada a um Luma Agent, com suporte para filtragem por documento, palavra-chave e status de ativação.
Descrição da operação
Lista os fragmentos de texto em uma base de conhecimento vinculada a um Luma Agent, com suporte para filtragem por documento, palavra-chave e status de ativação.
Experimente agora
Testar
Autorização RAM
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 esse valor. |
my_catalog |
| Namespace |
string |
Sim |
O nome do namespace vinculado ao agente. Você pode chamar ListLumaNamespaces para obter esse valor. |
my_namespace |
| KnowledgeBaseName |
string |
Sim |
O nome da base de conhecimento vinculada ao agente. Você pode chamar ListLumaKnowledgeBases para obter esse valor. |
my-knowledge-base |
| DocumentId |
string |
Não |
O ID do documento usado para filtrar fragmentos de texto. Se este parâmetro não for especificado, os fragmentos de texto de todos os documentos na base de conhecimento serão retornados. |
doc-a1b2c3d4 |
| Keyword |
string |
Não |
A palavra-chave usada para filtrar fragmentos de texto por conteúdo. |
Event rule |
| Enabled |
boolean |
Não |
Especifica se deve retornar apenas fragmentos de texto ativados. Se este parâmetro não for especificado, os fragmentos de texto não serão filtrados pelo status de ativação. |
true |
| 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. Use este ID para solução de problemas e ao enviar um ticket. |
34AD682D-5B91-5773-8132-AA38C130**** |
| Data |
object |
O resultado da lista de fragmentos, que contém entradas de fragmentos e informações de paginação. |
|
| Chunks |
array |
A lista de entradas de fragmentos. |
[{"DocumentId":"doc-bp1xxxxxxxxxxxx","ChunkSeq":1}] |
| KnowledgeBaseChunk |
Os detalhes de um único fragmento, incluindo o número de sequência do fragmento, corpo, caminho do título e status de ativação. |
||
| NextToken |
string |
O token de paginação para a próxima página (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 fragmentos no documento. |
120 |
| Code |
string |
O código de resposta. Um valor de 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. Um valor true indica sucesso. |
true |
Exemplos
Resposta de sucesso
JSON formato
{
"Message": "Operation success",
"RequestId": "34AD682D-5B91-5773-8132-AA38C130****",
"Data": {
"Chunks": [
{
"ChunkSeq": 12,
"ChunkSize": 128,
"Content": "O EventBridge suporta o roteamento de eventos para vários serviços de destino",
"CreatedAt": "2026-08-24T10:00:00Z",
"DocumentId": "doc-bp1xxxxxxxxxxxx",
"Enabled": true,
"FileName": "product-handbook.pdf",
"SourceLocation": "p.3",
"TitlePath": "Guia de instalação>Pré-requisitos",
"UpdatedAt": "2026-08-24T10:00:00Z"
}
],
"NextToken": "ca1eb85f5d99c7d6a97e6****",
"TotalCount": 120
},
"Code": "Success",
"Success": true
}
Códigos de erro
|
Código de status HTTP |
Código de erro |
Mensagem de erro |
Descrição |
|---|---|---|---|
| 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.