Obtém os detalhes de um documento especificado na base de conhecimento vinculada a um Luma Agent.
Descrição da operação
Obtém os detalhes de um documento especificado na base de conhecimento vinculada a um Luma Agent.
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 |
Sim |
O identificador exclusivo do documento. Você pode chamar ListLumaDocuments para obter esse valor. |
doc-a1b2c3d4 |
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 identificador exclusivo da solicitação, usado para solução de problemas e envio de tickets. |
34AD682D-5B91-5773-8132-AA38C130**** |
| Data | KnowledgeBaseDocument |
Os detalhes do documento, incluindo o status de processamento e os metadados. |
|
| Code |
string |
O código de resposta retornado pela operação. O valor Success indica que a chamada foi bem-sucedida. Caso contrário, um código de erro específico é 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": {
"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"
},
"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.