跳到主要内容

数据集 Schema 详解

本页列出数据集域核心 Pydantic Schema 的关键字段,便于联调时快速查阅。完整定义以 Redoc 为准。

DatasetCreate

创建数据集时的请求体。

字段类型必填说明
namestringYes数据集名称,租户内唯一
descriptionstringNo描述信息
permissionenumNoonly_me / all_team_members / partial_members,默认 all_team_members
partial_member_liststring[]Nopartial_members 模式下的用户 ID 列表
partial_group_liststring[]Nopartial_members 模式下的组 ID 列表
default_parser_backendstringNo默认解析后端(如 unstructuredmineru
default_chunk_strategystringNo默认分块策略
rag_defaultsobjectNo默认 RAG 检索配置(详见下方)
pipelineobjectNo默认 pipeline 配置覆盖
retention_policyobjectNo文档保留策略

DatasetUpdate

PATCH 更新时的请求体,所有字段均可选。

字段类型说明
namestring新名称
descriptionstring新描述
permissionenum变更权限模式
partial_member_liststring[]覆盖用户白名单
partial_group_liststring[]覆盖组白名单
rag_defaultsobject更新 RAG 默认配置
pipelineobject更新 pipeline 配置

DatasetOut(响应)

DatasetRAGDefaults

数据集级别的默认 RAG 配置,聊天请求未指定时自动使用。

字段类型说明
retrieval_profilestring检索预设
intent_routerbool是否启用意图路由
top_kint (1-100)默认检索 top_k
score_thresholdfloat (0-1)相关性分数阈值
retrieval_modestringhybrid / vector / keyword / mmr / auto
retrieval_contract_modestring检索合约模式
alphafloat (0-1)混合检索向量权重
enable_multi_querybool是否启用多查询扩展
multi_query_countint (1-8)多查询生成数量
enable_hierarchy_recallbool是否启用层级召回
枚举值速查

permission: only_me | all_team_members | partial_members

retrieval_mode: hybrid | vector | keyword | mmr | auto

retrieval_contract_mode: 见 app/rag/retrieval/contract.pyVALID_RETRIEVAL_CONTRACT_MODES

DatasetChunkTargetsV2

画像质量目标配置,用于画像检查与分块自动调优。

字段类型说明
token_p50_min / token_p50_maxint (0-4000)P50 chunk token 长度目标区间
short_pct_warn / short_pct_failint (0-100)短 chunk 比例阈值
long_pct_warn / long_pct_failint (0-100)长 chunk 比例阈值
overlap_waste_p50_warn / _failint (0-100)overlap 浪费 P50 阈值
coverage_p50_warn / _failint (0-100)覆盖率 P50 阈值

相关链接