Skip to content

抽取模板说明

extract_fields 是抽取接口最核心的入参。它描述了你要抽取哪些字段、哪些表头,以及每个字段的提示词。

基本结构

无论 mode=vision 还是 mode=layoutextract_fields 都使用同一份单个 schema 结构:

json
{
  "name": "Invoice",
  "keys": {
    "Title": { "prompt": "发票标题", "mapping": null },
    "Date":  { "prompt": "发票日期", "mapping": null }
  },
  "tableHeaders": {
    "明细表": {
      "品名": { "prompt": "商品名称", "mapping": null },
      "金额": { "prompt": "商品金额", "mapping": null }
    }
  }
}
  • 自定义字段抽取:填写 keys / tableHeaders 表示按已知 schema 抽取。

你可以在 Online Tools 页面里调试 schema 并通过"导出 Schema"按钮拿到上述 JSON:visionlayout 模式都直接粘贴到 extract_fields

字段说明

字段类型说明
namestring当前 schema 名称,便于识别模板
keysobject普通键值字段定义
tableHeadersobject表格字段定义,按表名组织
promptstring给模型的字段提示词,可为空
mappingstring字段映射信息,可按业务需要扩展,可为空

什么时候填写 keys

当你已经知道要抽哪些字段时,直接在 keys 中声明,例如:

  • 发票号码
  • 开票日期
  • 收货单位
  • 合同编号

什么时候填写 tableHeaders

如果目标文档中包含明细表、商品表、费用表等结构,建议把表头字段写进 tableHeaders,这样结果更容易稳定落到统一结构。

json
{
  "name": "auto",
  "keys": {},
  "tableHeaders": {}
}

下一步可查看 响应结构说明 了解返回结果如何承载字段值与定位信息。