ai-business-write/技术文档/测试页面使用指南.md

4.5 KiB
Raw Permalink Blame History

测试页面使用指南

🎯 概述

测试页面提供了两个API接口的可视化测试功能

  1. AI解析接口 - 从非结构化文本中提取结构化字段
  2. 文档生成接口 - 根据字段数据填充Word模板并生成文档

📋 功能说明

1. AI解析接口测试

功能描述

使用AI大模型从输入文本中提取结构化字段数据。

使用步骤

  1. 切换到"AI解析接口"标签页

    • 点击页面顶部的"AI解析接口"标签
  2. 添加输入字段

    • 输入字段编码(如:clue_info
    • 输入字段值(原始文本)
    • 可以添加多个输入字段
    • 点击"+ 添加输入字段"添加更多
  3. 添加输出字段

    • 输入需要提取的字段编码(如:target_name
    • 可以添加多个输出字段
    • 点击"+ 添加输出字段"添加更多
  4. 开始解析

    • 点击"开始解析"按钮
    • 等待AI处理可能需要一些时间
    • 查看解析结果

示例数据

输入字段:

字段编码: clue_info
字段值: 被举报用户名称是张三年龄30岁某公司总经理男性1980年5月出生中共党员正处级

输出字段:

target_name
target_gender
target_organization_and_position

预期结果

{
  "code": 0,
  "data": {
    "outData": [
      {
        "fieldCode": "target_name",
        "fieldValue": "张三"
      },
      {
        "fieldCode": "target_gender",
        "fieldValue": "男"
      },
      {
        "fieldCode": "target_organization_and_position",
        "fieldValue": "某公司总经理"
      }
    ]
  },
  "isSuccess": true
}

2. 文档生成接口测试

功能描述

根据字段数据填充Word模板生成填充后的文档并上传到MinIO。

使用步骤

  1. 切换到"文档生成接口"标签页

    • 点击页面顶部的"文档生成接口"标签
  2. 添加字段数据

    • 输入字段编码(如:target_name
    • 输入字段值(如:张三
    • 可以添加多个字段
    • 点击"+ 添加字段"添加更多
  3. 添加文件配置

    • 输入文件ID1
    • 输入文件名称(如:初步核实审批表.doc
    • 输入模板编码(如:PRELIMINARY_VERIFICATION_APPROVAL
    • 可以添加多个文件
    • 点击"+ 添加文件"添加更多
  4. 生成文档

    • 点击"生成文档"按钮
    • 等待文档生成和上传(可能需要一些时间)
    • 查看生成结果

示例数据

字段数据:

target_name: 张三
target_gender: 男
target_organization_and_position: 某公司总经理

文件配置:

文件ID: 1
文件名称: 初步核实审批表.doc
模板编码: PRELIMINARY_VERIFICATION_APPROVAL

预期结果

{
  "code": 0,
  "data": {
    "documentId": "DOC202411260001",
    "documentName": "初步核实审批表_张三.docx",
    "fpolicFieldParamFileList": [
      {
        "fileId": 1,
        "fileName": "初步核实审批表.doc",
        "filePath": "/202511261123/初步核实审批表.doc"
      }
    ]
  },
  "isSuccess": true
}

⚠️ 注意事项

AI解析接口

  1. 字段编码必须正确

    • 字段编码需要与数据库中的配置一致
    • 可以使用数据库中已有的字段编码
  2. 输出字段必须存在

    • 输出字段必须在数据库中已配置
    • 如果字段不存在,可能无法提取
  3. AI服务配置

    • 需要配置 SILICONFLOW_API_KEY.env 文件中
    • 如果未配置,解析将失败

文档生成接口

  1. 模板编码必须正确

    • 模板编码需要与数据库中的文件配置一致
    • 必须使用 template_code 字段的值
  2. MinIO配置

    • 需要配置MinIO连接信息
    • 模板文件必须存在于MinIO中
  3. 字段值匹配

    • Word模板中的占位符需要与字段编码匹配
    • 未匹配的占位符将保持为空

🔗 相关链接


📝 常见问题

Q: 解析接口一直加载怎么办?

A: 检查AI服务配置是否正确查看浏览器控制台是否有错误信息。

Q: 文档生成失败?

A:

  1. 检查模板编码是否正确
  2. 检查MinIO配置和连接
  3. 检查模板文件是否存在于MinIO

Q: 如何查看详细的接口文档?

A: 点击页面底部的"查看完整的API文档 (Swagger)"链接。


祝测试顺利! 🎉