自定义模板从零开始：Hyper-Extract YAML 模板设计完整教程

自定义模板从零开始Hyper-Extract YAML 模板设计完整教程【免费下载链接】Hyper-ExtractHypergraph is more powerful. Transform unstructured text into structured knowledge with LLMs. Graphs, hypergraphs, and spatio-temporal extractions — with one command.项目地址: https://gitcode.com/GitHub_Trending/hy/Hyper-ExtractHyper-Extract 是一个用 LLM 把非结构化文本转成结构化知识的开源项目支持图谱、超图与时空抽取一条命令即可完成。当你发现内置模板不匹配业务场景时只需编写一个Hyper-Extract YAML 模板就能自定义提取什么、如何提取、如何展示。本教程带你从零设计、校验并运行自己的知识抽取模板。一、YAML 模板是什么模板是一个 YAML 文件定义了四件事组成部分作用类比output输出 schema要提取哪些字段数据库表结构guideline给 LLM 的提取规则岗位操作手册identifiers实体/关系的 ID 生成规则主键定义display可视化标签格式报表样式项目内置了 30 个预设模板按领域组织在 hyperextract/templates/presets/ 目录下覆盖金融、法律、医学、中医、工业、教育等场景。例如财报摘要模板 hyperextract/templates/presets/finance/earnings_summary.yaml通用图谱模板 hyperextract/templates/presets/general/base_graph.yaml。 写自定义模板前强烈建议先读一遍官方模板格式说明docs/zh/concepts/templates-format.md。二、第一步为数据选择 Auto-Type类型选错后面全部返工。Hyper-Extract 提供 8 种 Auto-Type分为记录类型和图类型两大家族类型选择决策树摘自官方设计指南需要建模关系吗 ├─ 否 → 记录类型 │ ├─ 单个对象 → model │ ├─ 有序列表 → list │ └─ 去重集合 → set └─ 是 → 图类型 ├─ 二元关系 (A→B) → graph └─ 多元关系 (ABC→D) → hypergraph 图类型扩展 ├─ 时间维度 → temporal_graph ├─ 空间维度 → spatial_graph └─ 两者 → spatio_temporal_graph以从财报电话会提取业绩数据为例输出是一个单对象 → 选model从传记提取人物与事件关系 → 选graph或带时间的temporal_graph。完整决策依据见 hyperextract/templates/DESIGN_GUIDE_zh.md。三、动手写一个最小可用的 graph 模板步骤 1放置模板文件自定义模板放在用户目录按领域建子文件夹mkdir -p ~/.hyperextract/templates/my_domain之后模板将以my_domain/my_template路径被引用。步骤 2编写 YAML 骨架language: [zh, en] name: my_template # 模板标识符 type: graph # Auto-Type tags: [custom, domain] # 分类标签小写 description: zh: 从行业报告中提取实体与关系 en: Extract entities and relations from reports output: entities: fields: - name: name type: str required: true - name: type type: str required: true - name: description type: str required: false relations: fields: - name: source type: str required: true - name: target type: str required: true - name: type type: str required: true可用的字段类型有str、int、float、bool、list[str]、datetime。记录类型model/list/set直接用output.fields而不是entities/relations写法可参考 hyperextract/templates/presets/finance/earnings_summary.yaml。步骤 3写提取规则guidelineguideline是模板的灵魂决定 LLM 的提取质量guideline: target: zh: 你是行业分析专家从报告中提取关键实体和关系。 rules_for_entities: zh: - 同一实体全文保持命名一致 - 不提取纯代词、泛称 rules_for_relations: zh: - 仅在文本明确表达关系时创建不凭常识补充规则越具体LLM 发挥越稳定。步骤 4配置标识符与展示identifiers: entity_id: name relation_id: {source}|{type}|{target} relation_members: source: source target: target display: entity_label: {name} ({type}) relation_label: {type}⚠️ 这里有两个高频坑identifiers引用的字段必须真实存在于outputschema 中display里的{占位符}必须对应实际字段名——校验器会帮你提前拦截这两类错误。四、一条命令校验he template validate保存模板后先别急着跑抽取用内置校验器体检he template validate ~/.hyperextract/templates/my_domain/my_template.yaml校验器会对模板做 9 项语义检查规则定义见 hyperextract/utils/template_engine/validator.py编码检查项级别HE-T001YAML 可解析errorHE-T002符合 TemplateCfg 结构errorHE-T003identifiers 字段在 schema 中存在errorHE-T005display 占位符与 schema 匹配errorHE-T006时序/空间类型缺 time/location 字段errorHE-T008字段数超过上限 5warning存在 error 时退出码为 1方便接入 CI。加--json输出机器可读诊断加--all可批量校验整个目录。更多用法见 docs/zh/cli/commands/template.md。五、运行抽取看成果校验通过后一条命令开始提取he parse document.md -t my_domain/my_template -o ./output/ -l zh运行he show ./output/即可可视化抽取出的知识图谱后续还能对知识库做语义检索与问答he search ./output/ 查询内容、he talk ./output/。六、5 条最佳实践字段别贪多— 实体/关系字段建议 ≤ 5 个按必要 → 重要 → 可选排序官方上限见 HE-T008描述要具体— 提取产品信息含名称、价格、类别 远胜于 产品信息规则给约束— 明确枚举值、数值精度、取舍标准LLM 才不会自由发挥双语齐全—language声明了哪种语言description等字段就要补哪种语言避免 HE-T007 警告用样例试跑— 抽完先看result.data质量再迭代规则七、进阶资源导航资源路径模板格式完整参考docs/zh/concepts/templates-format.md自定义模板指南docs/zh/python/guides/custom-templates.md模板设计指南含常见错误hyperextract/templates/DESIGN_GUIDE_zh.md预设模板库hyperextract/templates/presets/模板引擎源码hyperextract/utils/template_engine/模板校验规则集hyperextract-skills/yaml-validator/照着选类型 → 写 schema → 定规则 → 配标识 → 校验 → 试跑这条路径走完你就拥有了一个可复用、可分享的 Hyper-Extract 自定义 YAML 模板 【免费下载链接】Hyper-ExtractHypergraph is more powerful. Transform unstructured text into structured knowledge with LLMs. Graphs, hypergraphs, and spatio-temporal extractions — with one command.项目地址: https://gitcode.com/GitHub_Trending/hy/Hyper-Extract创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考