Skip to main content

概述

本文档将指导您如何使用Apifox导入和调试文档抽取API。文档抽取API使用JSON格式的请求体,通过定义schema来指定要抽取的字段。

先决条件

curl命令示例

导入curl命令到Apifox

步骤1:复制curl命令

复制上面的curl命令。

步骤2:打开Apifox导入功能

  1. 打开Apifox应用
  2. 点击左侧菜单栏的 + 按钮,或使用快捷键 Ctrl+I (Windows) / Cmd+I (Mac)
点击导入按钮

步骤3:选择导入方式

  1. 在弹出的导入窗口中,将复制的curl命令粘贴到文本框中
选择cURL导入

步骤4:确认导入

  1. 在预览页面确认请求信息
  2. 点击 确定 按钮完成导入
确认导入

配置请求

修改API Key

  1. 点击 Headers 标签页
  2. 找到 x-ti-app-idx-ti-secret-code 两个header
  3. YOUR_APP_ID 替换为您的实际x-ti-app-id
  4. YOUR_SECRET_CODE 替换为您的实际x-ti-secret-code
修改API Key

修改JSON Body

文档抽取API的核心是JSON schema配置。您可以根据需要修改Body中的内容:
  1. 点击 Body 标签页
  2. 确保Body类型为 rawJSON
  3. 修改JSON内容,主要包括:
修改文件信息:
或者使用base64编码的文件:
修改抽取schema: 根据您的需求修改schema,例如抽取更多字段:
添加解析选项(可选):
添加抽取选项(可选):
修改JSON Body

发送请求

  1. 确认所有配置无误后,点击右上角的 发送 按钮
  2. 等待响应返回
  3. 在下方查看响应结果
发送请求

查看响应结果

响应结果会显示在Apifox下方的响应区域:
  • Body:查看JSON格式的响应内容,包括:
    • extracted_schema: 抽取的结构化数据
    • citations: 带坐标信息的抽取结果
    • pages: 文档页面信息
  • Headers:查看响应头信息
  • 状态码:查看HTTP状态码(200表示成功)
响应结果如上图。

常见问题

Q: 如何修改要抽取的字段?

A: 在Body标签页中修改schema字段,根据您的需求定义字段名称、类型和描述。详细说明请参考文档抽取快速启动

Q: 响应返回400错误?

A: 请检查JSON格式是否正确,确保schema格式符合JSON Schema规范。

Q: 响应返回401错误?

A: 请检查API Key是否正确设置,确保x-ti-app-id和x-ti-secret-code都已正确替换。

Q: 如何保存请求?

A: 可以将请求保存到项目中,方便后续重复使用。请求会自动保存到当前项目。

相关链接