|
名称 |
类型 |
描述 |
示例值 |
|---|---|---|---|
|
object |
知识库中的单个文档条目,包含文档 ID、文件名、处理状态、文件大小、切片数量、客户元数据、分块配置快照与来源信息 |
||
| ChunkConfiguration |
object |
该文档实际使用的文档级分块策略快照,仅在上传(BeginUpload)或更新(UpdateDocument)时显式指定过 ChunkConfiguration 才返回;未指定时该文档按知识库级默认配置分块,本字段不返回(不回显知识库级配置,避免知识库级配置后续变更时误导该文档的实际分块依据) |
|
| HeadingLevel |
integer |
BY_HEADING 策略的切分标题级数(1~6),小于等于该级的标题都作为切分边界,更深级标题保留在切片正文中 |
2 |
| MaxChunkSize |
integer |
单个分块的最大字符长度(与入参口径一致,修订 22 起为字符制,取值 [1, 6000]) |
600 |
| OverlapSize |
integer |
仅 BY_LENGTH 策略生效。相邻分块的重叠字符长度:大于 0 时后一个切片头部重复前一个切片尾部该窗口内的内容,重叠不会使切片超过 MaxChunkSize。0 表示不重叠 |
40 |
| PreprocessRules |
object |
预处理规则快照 |
|
| RemoveUrlsAndEmails |
boolean |
是否在解析时删除 URL 与邮箱地址 |
false |
| ReplaceConsecutiveWhitespace |
boolean |
是否将连续的空白字符(空格、换行、制表符)替换为单个空格 |
true |
| Separator |
string |
BY_SEPARATOR 策略下的分隔符,按字面字符串整体匹配切分(非正则),最长 32 个字符 |
\\n\\n |
| Strategy |
string |
AUTO 表示智能切分(标题感知+段落打包);BY_LENGTH 表示按长度滑动窗口切分,可指定 OverlapSize;BY_SEPARATOR 表示按分隔符切分,必须指定 Separator;BY_HEADING 表示按标题级数切分,必须指定 HeadingLevel |
BY_SEPARATOR |
| ChunkCount |
integer |
处理完成后生成的 Chunk 数量 |
120 |
| CreatedAt |
string |
创建时间 |
2026-08-24T10:00:00Z |
| DocumentId |
string |
文档的唯一标识 |
doc-bp1xxxxxxxxxxxx |
| ErrorCode |
string |
处理失败时的稳定错误码 |
FILE_CORRUPTED |
| ErrorMessage |
string |
处理失败时的脱敏错误信息 |
parse pdf failed |
| FileName |
string |
文档文件名 |
manual.pdf |
| FileSize |
integer |
文档文件大小,单位字节 |
1048576 |
| Metadata |
array |
文档级元数据键值对,包含常量字段值和系统变量值;未指定元数据时不返回 |
[{"Key":"department","Value":"研发"}] |
|
object |
元数据键值对 |
||
| Key |
string |
元数据字段名 |
department |
| Value |
string |
元数据字段值 |
研发 |
| SourceModifiedTime |
integer |
上游源系统最后修改时间,epoch 毫秒;无来源信息时为空 |
1788000000000 |
| SourceType |
string |
文档进入知识库的投递渠道,由系统写入,客户不可指定。UPLOAD 表示控制台/API 手动上传;OSS 表示 OSS 事件流导入。未来接入新渠道时扩展新取值,不做枚举限定 |
UPLOAD |
| SourceUri |
string |
文档原始来源地址,如 oss://bucket/path/file.md;手动上传时可能为空 |
oss://my-bucket/docs/handbook.pdf |
| Status |
string |
UPLOADING 表示上传中,PENDING 表示上传完成已入队待处理(通常为秒级的过渡状态),PROCESSING 表示解析处理中,COMPLETED 表示处理完成可检索,FAILED 表示处理失败,DELETING 表示删除中 |
COMPLETED |
| UpdatedAt |
string |
最近更新时间 |
2026-08-24T10:00:00Z |