|
Parâmetro |
Tipo |
Descrição |
Exemplo |
|---|---|---|---|
|
object |
As informações sobre uma única entrada de documento em uma base de conhecimento, incluindo o ID do documento, o nome do arquivo, o status de processamento, o tamanho do arquivo, a contagem de fragmentos, os metadados personalizados, o snapshot da configuração de fragmentação e as informações de origem. |
||
| ChunkConfiguration |
object |
O snapshot da política de fragmentação no nível do documento realmente utilizada para este documento. Este campo é retornado apenas se ChunkConfiguration foi explicitamente especificado durante o upload (BeginUpload) ou a atualização (UpdateDocument). Se não for especificado, o documento é fragmentado com base nas configurações padrão no nível da base de conhecimento, e este campo não é retornado. A configuração no nível da base de conhecimento não é retornada para evitar induzir os usuários ao erro sobre a base real de fragmentação deste documento quando a configuração no nível da base de conhecimento for alterada posteriormente. |
|
| HeadingLevel |
integer |
O nível de título (1 a 6) usado para divisão na estratégia BY_HEADING. Títulos neste nível ou acima servem como limites de divisão. Títulos de níveis mais profundos são mantidos no corpo do fragmento. |
2 |
| MaxChunkSize |
integer |
O comprimento máximo em caracteres de um único fragmento. A partir da revisão 22, este valor é baseado em caracteres. Valores válidos: 1 a 6000. |
600 |
| OverlapSize |
integer |
O comprimento em caracteres da sobreposição entre fragmentos adjacentes. Este parâmetro entra em vigor apenas para a estratégia BY_LENGTH. Se o valor for maior que 0, o início do próximo fragmento repete o conteúdo do final do fragmento anterior dentro desta janela. A sobreposição não faz com que um fragmento exceda MaxChunkSize. Um valor de 0 indica que não há sobreposição. |
40 |
| PreprocessRules |
object |
O snapshot das regras de pré-processamento. |
|
| RemoveUrlsAndEmails |
boolean |
Especifica se URLs e endereços de e-mail devem ser removidos durante a análise. |
false |
| ReplaceConsecutiveWhitespace |
boolean |
Especifica se caracteres de espaço em branco consecutivos (espaços, quebras de linha e caracteres de tabulação) devem ser substituídos por um único espaço. |
true |
| Separator |
string |
O separador usado na estratégia BY_SEPARATOR. O separador é correspondido como uma string literal (não uma expressão regular). O comprimento máximo é de 32 caracteres. |
\\n\\n |
| Strategy |
string |
A estratégia de fragmentação. Valores válidos:
|
BY_SEPARATOR |
| ChunkCount |
integer |
O número de fragmentos gerados após a conclusão do processamento. |
120 |
| CreatedAt |
string |
A hora em que o documento foi criado. |
2026-08-24T10:00:00Z |
| DocumentId |
string |
O identificador exclusivo do documento. |
doc-bp1xxxxxxxxxxxx |
| ErrorCode |
string |
O código de erro estável retornado quando o processamento falha. |
FILE_CORRUPTED |
| ErrorMessage |
string |
A mensagem de erro com dados sensíveis mascarados retornada quando o processamento falha. |
falha na análise do pdf |
| FileName |
string |
O nome do arquivo do documento. |
manual.pdf |
| FileSize |
integer |
O tamanho do arquivo do documento, em bytes. |
1048576 |
| Metadata |
array |
Os pares chave-valor de metadados no nível do documento, incluindo valores de campos constantes e valores de variáveis do sistema. Este campo não é retornado se nenhum metadado for especificado. |
[{"Key":"departamento","Value":"P&D"}] |
|
object |
O par chave-valor de metadados. |
||
| Key |
string |
O nome do campo de metadados. |
departamento |
| Value |
string |
O valor do campo de metadados. |
R&D |
| SourceModifiedTime |
integer |
A última hora de modificação no sistema de origem upstream, em milissegundos de época. Este campo estará vazio se nenhuma informação de origem estiver disponível. |
1788000000000 |
| SourceType |
string |
O canal de entrega pelo qual o documento entrou na base de conhecimento. Este valor é gravado pelo sistema e não pode ser especificado pelos usuários. Valores válidos:
Novos valores podem ser adicionados quando novos canais forem suportados. Os valores não se restringem a uma enumeração fixa. |
UPLOAD |
| SourceUri |
string |
O endereço de origem original do documento, como oss://bucket/path/file.md. Este campo pode estar vazio para documentos carregados manualmente. |
oss://my-bucket/docs/handbook.pdf |
| Status |
string |
O status de processamento do documento. Valores válidos:
|
COMPLETED |
| UpdatedAt |
string |
A hora em que o documento foi atualizado pela última vez. |
2026-08-24T10:00:00Z |