调用本接口编辑知识库内具体文档解析配置,并提交后续执行任务。调用当前接口后,相关任务仅被提交、尚未正式执行,必须继续调用开始解析文档才会真正开始执行。
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
doc_id | Number 或 Array | 是 | 文档ID,支持传入单个ID,也支持以数字形式传入多个ID |
parser_id | String | 是 | 新解析器ID |
source_type | String | 否 | 解析模型来源类型 |
config | Object | 否 | 解析配置,支持多种,包括:飞书解析配置、报告解析配置、Sophon 解析配置,详情请参见下文 config 章节 |
chunk_settings | Object | 否 | 统一切片配置,详情请参见下文 chunk_settings 表 |
file_parse_type_overrides | Array | 否 | 文档解析类型清单,详情请参见下文 file_parse_type_overrides 表 |
quality_settings | Object | 否 | 统一质量检测配置,详情请参见下文 quality_settings 表 |
labels | Array | 否 | 文档标签列表,详情请参见下文 labels 表 |
template_id | String | 否 | 解析器模板ID,将覆盖parser_config |
video_parser_config | Object | 否 | 视频解析配置,详情请参见下文 video_parser_config 表 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
auto_keywords | Number | 是 | 自动关键词数量 |
auto_questions | Number | 是 | 自动问题数量 |
strategy | Number | 是 | 切片拆分策略 |
chunk_size | Number | 是 | 切片最大长度 |
detect_pdf_table | Boolean | 否 | 是否识别 PDF 表格 |
detect_pdf_img | Boolean | 否 | 是否识别 PDF 图片 |
page_size_limit | Number | 否 | 分页大小限制 |
merge_small_chunks | Boolean | 否 | 是否合并小切片 |
pdf_with_ocr | Boolean | 否 | 是否启用 PDF OCR |
doctree_with_outline | Boolean | 否 | 是否输出带大纲的文档树 |
custom_splitter | String | 否 | 自定义切分符 |
to_md | Boolean | 否 | 是否转换为 Markdown |
md_collapsed | Boolean | 否 | Markdown 是否折叠 |
tos_bucket_name | String | 否 | TOS Bucket 名称 |
tos_access_key | String | 否 | TOS 访问密钥 |
detect_header | Boolean | 否 | excel解析是否开启表格识别 |
file_trans_timeout | Number | 否 | pptx/ppt解析中转换图片的超时时间设置 |
slides_full_page_as_image | Boolean | 否 | 在 PPT 类文件中,使用整页图片代替小图片 |
open_access_token | String | 否 | 飞书开放平台 access_token |
lark_doc_user_id | String | 否 | 云文档/多维表格/飞书表格域间网关鉴权所需用户ID |
chunk_with_vlm | Boolean | 否 | 是否使用 VLM 能力,包括章节理解、图片理解等 |
expected_level | Number | 否 | 章节预期最大层级 |
deduplicate | Boolean | 否 | 是否自动去重 |
spell_check | Boolean | 否 | 是否开启错别字检测 |
completeness_check | Boolean | 否 | 是否开启完整度检测 |
sensitive_word_check | Boolean | 否 | 是否开启敏感词检测 |
enable_llm_tag | Boolean | 否 | 是否开启非结构化打标 |
tableExtraction | Boolean | 否 | 表格提取开关 |
imageExtraction | Boolean | 否 | 图片提取开关 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
delimiter | String | 否 | 分隔符 |
deduplicate | Boolean | 否 | 是否自动去重 |
enable_llm_tag | Boolean | 否 | 是否开启非结构化打标 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
imageExtraction | Boolean | 否 | 图片提取开关 |
tableExtraction | Boolean | 否 | 表格提取开关 |
chunkType | String | 否 | 分片策略类型 |
genAtomicQuestion | Boolean | 否 | 是否生成原子问题 |
maxSegmentLength | Number | 否 | 分片最大字符数 |
maxToken | Number | 否 | 已废弃:兼容旧字段,当前本地上传按字符解释 |
removeSpaces | Boolean | 否 | 去除空白字符 |
removeUrlsPics | Boolean | 否 | 去除图片 URL |
separator | String | 否 | 分隔符 |
customSeparator | String | 否 | 自定义分隔符 |
mergeSmallChunks | Boolean | 否 | 是否合并连续小分段 |
smallChunkTokenThreshold | Number | 否 | 小分段阈值,单位 token |
pipelineTypeEnum | String | 否 | 解析方式,如 VISION_MODEL |
visionPagesPerChunk | Number | 否 | Vision model 模式下每次处理的页数 |
spell_check | Boolean | 否 | 是否开启错别字检测 |
completeness_check | Boolean | 否 | 是否开启完整度检测 |
sensitive_word_check | Boolean | 否 | 是否开启敏感词检测 |
enable_llm_tag | Boolean | 否 | 是否开启非结构化打标 |
deduplicate | Boolean | 否 | 是否自动去重 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
text | Object | 否 | text 文档类型切片配置,详情请参见下文 test/other/pdf 表 |
other | Object | 否 | 其他文档类型切片配置,详情请参见下文 test/other/pdf 表 |
Object | 否 | PDF文档类型切片配置,详情请参见下文 test/other/pdf 表 | |
ppt | Object | 否 | PPT 类型切片配置,详情请参见下文 ppt 表 |
image | Object | 否 | 图片类型切片配置,详情请参见下文 image 表 |
table | Object | 否 | 表格类型切片配置,详情请参见下文 table 表 |
audio | Object | 否 | 音频类型切片配置,详情请参见下文 audio 表 |
video | Object | 否 | 视频类型切片配置,详情请参见下文 video 表 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
mode | String | 否 | 切片模式:
|
max_segment_length | Number | 否 | 分段最大字符数 |
custom_separator | String | 否 | 自定义分隔符 |
associate_chunk_title | Boolean | 否 | 自定义分段时是否关联标题 |
merge_small_chunks | Boolean | 否 | 自定义分段时是否自动合并连续小分段 |
small_chunk_token_threshold | Number | 否 | 小分段阈值,单位 token |
extract_images | Boolean | 否 | 是否提取图片,默认开启 |
image_understand | Boolean | 否 | 是否在 OCR 后启用图片 VLM 后处理,不影响主解析 pipeline |
image_understand_max_tokens | Number | 否 | 图片深度理解最大 tokens |
image_ocr | Boolean | 否 | 图片是否经过OCR |
extract_tables | Boolean | 否 | 是否提取表格 |
exclude_header_footer | Boolean | 否 | 是否过滤页眉页脚 |
pipelineTypeEnum | String | 否 | 解析方式,如 VISION_MODEL |
visionPagesPerChunk | Number | 否 | vision model mode 下,每次处理的页数 |
file_overrides | Array | 否 | 当前类型下按匹配条件覆盖切片配置,详情请参见下文 file_overrides 表 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
mode | String | 否 | 切片模式:
|
max_segment_length | Number | 否 | 分段最大字符数 |
custom_separator | String | 否 | 自定义分隔符 |
associate_chunk_title | Boolean | 否 | 自定义分段时是否关联标题 |
merge_small_chunks | Boolean | 否 | 自定义分段时是否自动合并连续小分段 |
small_chunk_token_threshold | Number | 否 | 小分段阈值,单位 token |
extract_images | Boolean | 否 | 是否提取图片,默认开启 |
image_understand | Boolean | 否 | 是否在 OCR 后启用图片 VLM 后处理,不影响主解析 pipeline |
image_understand_max_tokens | Number | 否 | 图片深度理解最大 tokens |
image_ocr | Boolean | 否 | 图片是否经过OCR |
extract_tables | Boolean | 否 | 是否提取表格 |
exclude_header_footer | Boolean | 否 | 是否过滤页眉页脚 |
pipelineTypeEnum | String | 否 | 解析方式,如 VISION_MODEL |
visionPagesPerChunk | Number | 否 | vision model mode 下,每次处理的页数 |
match | Object | 否 | 切片配置匹配条件,详情请参见下文 match 表 |
file_id | Number | 否 | 已废弃:请使用 match.file_id |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
file_id | Number | 否 | 本地文件 ID |
file_ids | Array | 否 | 本地文件 ID 列表 |
source_key | String | 否 | 对象存储源文件 key |
source_keys | Array | 否 | 对象存储源文件 key 列表 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
mode | String | 否 | PPT 仅支持默认分段 |
max_segment_length | Number | 否 | 分段最大字符数 |
exclude_master_content | Boolean | 否 | 是否过滤 PPT 母版噪声 |
exclude_header_footer | Boolean | 否 | 是否过滤页眉页脚 |
pipelineTypeEnum | String | 否 | 解析方式,如 VISION_MODEL |
file_overrides | Array | 否 | 当前类型下按匹配条件覆盖切片配置,详情请参见下文 file_overrides 表 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
mode | String | 否 | PPT 仅支持默认分段 |
max_segment_length | Number | 否 | 分段最大字符数 |
exclude_master_content | Boolean | 否 | 是否过滤 PPT 母版噪声 |
exclude_header_footer | Boolean | 否 | 是否过滤页眉页脚 |
pipelineTypeEnum | String | 否 | 解析方式,如 VISION_MODEL |
match | Object | 否 | 切片配置匹配条件,详情请参见上文 match 表 |
file_id | Number | 否 | 已废弃:请使用 match.file_id |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
mode | String | 否 | 图片仅支持默认分段,兼容 auto
|
max_segment_length | Number | 否 | 分段最大字符数 |
image_understand | Boolean | 否 | 是否在 OCR 后启用图片 VLM 后处理,不影响主解析 pipeline |
image_understand_max_tokens | Number | 否 | 图片深度理解最大 tokens |
image_ocr | Boolean | 否 | 图片是否经过OCR |
file_overrides | Array | 否 | 当前类型下按匹配条件覆盖切片配置,详情请参见下文 file_overrides 表 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
mode | String | 否 | 图片仅支持默认分段,兼容 auto
|
max_segment_length | Number | 否 | 分段最大字符数 |
image_understand | Boolean | 否 | 是否在 OCR 后启用图片 VLM 后处理,不影响主解析 pipeline |
image_understand_max_tokens | Number | 否 | 图片深度理解最大 tokens |
image_ocr | Boolean | 否 | 图片是否经过OCR |
match | Object | 否 | 切片配置匹配条件,详情请参见上文 match 表 |
file_id | Number | 否 | 已废弃:请使用 match.file_id |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
mode | String | 否 | 表格切片模式:
|
max_segment_length | Number | 否 | 分段最大字符数 |
parse_strategy | String | 否 | 表格自动解析策略:
|
header_row | Number | 否 | 规则配置下的表头所在行,1开始计数 |
data_start_row | Number | 否 | 规则配置下的数据起始行,1开始计数 |
sheets | Array | 否 | 自定义分段下的 Excel 多 sheet 配置,详情请参见下文 sheets 表 |
pipelineTypeEnum | String | 否 | 解析方式,如 VISION_MODEL |
file_overrides | Array | 否 | 当前类型下按匹配条件覆盖切片配置,详情请参见下文 file_overrides 表 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
sheet_name | String | 否 | sheet 名称 |
sheet_id | String | 否 | 工作表ID |
header_row | Number | 否 | 表头所在行,1开始计数 |
data_start_row | Number | 否 | 数据起始行,1开始计数 |
columns | Array | 否 | 当前 sheet 的列配置,详情请参见下文 columns 表 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
source_name | String | 否 | 原始列名 |
target_name | String | 否 | 导入后的列名 |
enabled | Boolean | 否 | 是否启用该列参与召回 |
data_type | String | 否 | 表格列数据类型:
|
description | String | 否 | 列描述 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
mode | String | 否 | 表格切片模式:
|
max_segment_length | Number | 否 | 分段最大字符数 |
parse_strategy | String | 否 | 表格自动解析策略:
|
header_row | Number | 否 | 规则配置下的表头所在行,1开始计数 |
data_start_row | Number | 否 | 规则配置下的数据起始行,1开始计数 |
sheets | Array | 否 | 自定义分段下的 Excel 多 sheet 配置,详情请参见上文 sheets 表 |
pipelineTypeEnum | String | 否 | 解析方式,如 VISION_MODEL |
match | Object | 否 | 切片配置匹配条件,详情请参见上文 match 表 |
file_id | Number | 否 | 已废弃:请使用 match.file_id |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
asr_model | String 或 Object | 否 | ASR 模型,详情请参见下文 asr_model 章节 |
mode | String | 否 | 音频仅支持默认解析模式 |
file_overrides | Array | 否 | 当前类型下按匹配条件覆盖切片配置,详情请参见下文 file_overrides 章节 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
host | String | 否 | 服务地址 |
api_key | String | 否 | 接口密钥 |
access_token | String | 是 | 访问令牌 |
app_id | String | 是 | 应用ID |
resourceId | String | 是 | 资源ID |
endpoint_id | String | 否 | 端点ID |
temperature | Number | 否 | 采样温度 |
top_p | Number | 否 | 核采样概率 Top P |
model_id | Number | 否 | 模型ID |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
operator_key | String | 是 | 算子标识 |
model_id | Number | 是 | 模型ID |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
asr_model | String 或 Object | 否 | ASR 模型,详情请参见上文 asr_model 章节 |
mode | String | 否 | 音频仅支持默认解析模式 |
match | Object | 否 | 切片配置匹配条件,详情请参见上文 match 表 |
file_id | Number | 否 | 已废弃:请使用 match.file_id |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
fuse_video_asr | Boolean | 否 | 是否使用音视频融合解析 |
asr_model | String 或 Object | 否 | ASR 模型,详情请参见上文 asr_model 章节 |
video_model | String 或 Object | 否 | 视频模型,详情请参见下文 video_model 章节 |
fuse_model | String 或 Object | 否 | 融合模型,详情请参见下文 fuse_model 章节 |
mode | String | 否 | 视频仅支持默认解析模式 |
file_overrides | Array | 否 | 当前类型下按匹配条件覆盖切片配置,详情请参见下文 file_overrides 章节 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
url | String | 是 | 模型访问地址 |
model_name | String | 是 | 模型名称 |
api_key | String | 是 | 接口密钥 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
operator_key | String | 是 | 算子标识 |
model_id | Number | 是 | 模型ID |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
url | String | 是 | 模型访问地址 |
model_name | String | 是 | 模型名称 |
api_key | String | 是 | 接口密钥 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
operator_key | String | 是 | 算子标识 |
model_id | Number | 是 | 模型ID |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
fuse_video_asr | Boolean | 否 | 是否使用音视频融合解析 |
asr_model | String 或 Object | 否 | ASR 模型,详情请参见上文 asr_model 章节 |
video_model | String 或 Object | 否 | 视频模型,详情请参见上文 video_model 章节 |
fuse_model | String 或 Object | 否 | 融合模型,详情请参见上文 fuse_model 章节 |
mode | String | 否 | 视频仅支持默认解析模式 |
match | Object | 否 | 切片配置匹配条件,详情请参见上文 match 表 |
file_id | Number | 否 | 已废弃:请使用 match.file_id |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
match | Object | 否 | 切片配置匹配条件,详情请参见上文 match 表 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
text | Object | 否 | 质量检测配置,详情请参见下文质量检测配置参数表 |
other | Object | 否 | 质量检测配置,详情请参见下文质量检测配置参数表 |
Object | 否 | 质量检测配置,详情请参见下文质量检测配置参数表 | |
ppt | Object | 否 | 质量检测配置,详情请参见下文质量检测配置参数表 |
image | Object | 否 | 质量检测配置,详情请参见下文质量检测配置参数表 |
table | Object | 否 | 质量检测配置,详情请参见下文质量检测配置参数表 |
audio | Object | 否 | 质量检测配置,详情请参见下文质量检测配置参数表 |
video | Object | 否 | 质量检测配置,详情请参见下文质量检测配置参数表 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
spell_check | Boolean | 否 | 是否开启错别字检测 |
completeness_check | Boolean | 否 | 是否开启完整度检测 |
sensitive_word_check | Boolean | 否 | 是否开启敏感词检测 |
duplicate_doc_check | Boolean | 否 | 是否开启重复文档检测 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
label_name | String | 是 | 标签名称 |
label_type | String | 是 | 文档标签类型:
|
label_value | Array | 是 | 标签值列表 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
fuse_video_asr | Boolean | 否 | 是否使用音视频融合解析 |
asr_model | String 或 Object | 否 | ASR 模型,详情请参见上文 asr_model 表 |
video_model | String 或 Object | 否 | 视频模型,详情请参见上文 video_model 表 |
fuse_model | String 或 Object | 否 | 融合模型,详情请参见上文 fuse_model 表 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
code | Number | 是 | 响应码:0=成功,非0=失败 |
msg | String | 否 | Code非0时,返回错误信息 |
message | String | 否 | 错误信息 |
data | Boolea | 否 | 编辑成功返回true |