Authorizations
Query Parameters
当上传的是pdf时,page_start 表示从第几页开始抽取,不传该参数时默认从首页开始
当上传的是pdf时,page_count 表示要进行抽取的pdf页数。
- Prompt模式总页数不得超过20页,默认为20页;
 - 字段(自定义key)模式总页数不得超过100页,默认为100页。
 
pdf文档的解析模式,默认为scan模式。图片不用设置,均默认按scan模式处理。
- auto 综合文字识别和解析模式:对pdf电子档解析,会直接提取pdf中的文字
 - scan 仅按文字识别模式:将pdf当成图片处理
 
可用选项: 
auto, scan 仅Prompt模式生效,获取图片,默认为objects,返回整页图像和图像对象。
- none 不返回任何图像
 - page 返回每一页的整页图像:即pdf页的完整页图片
 - objects 返回页面内的子图像:即pdf页内的各个子图片
 - both 返回整页图像和图像对象
 
可用选项: 
none, page, objects, both 是否进行切边矫正处理,默认为0,不进行切边矫正
- 0 不进行切边矫正
 - 1 进行切边矫正
 
可用选项: 
0, 1 是否进行去水印处理,默认为0,不去水印
- 0 不去水印
 - 1 去水印
 
可用选项: 
0, 1 公式识别等级,默认为0,全识别。
- 0 全识别
 - 1 仅识别行间公式,行内公式不识别
 - 2 不识别
 
可用选项: 
0, 1, 2 待抽取样本的文件名(含后缀名)
Example:
"temp_file.jpg"
Body
application/json
支持的文件格式:png, jpg, jpeg, pdf, bmp, tiff, webp, doc, docx, html, mhtml, xls, xlsx, csv, ppt, pptx, txt, ofd;
- 
API支持的最大文档处理页数为100页,超出部分的文档信息将被忽略。
 - 
支持两种模式:
- prompt模式:
- 提供一个prompt,系统将根据该prompt进行抽取;
 - 同时有prompt输入和key输入时,按prompt模式调用。
 
 - 自定义key模式:
- 提供一个fields与table_fields列表,系统将根据该列表进行抽取。
 
 
 - prompt模式:
 - 
API支持的最大抽取字段数量为
fields数组中的元素数量与table_fields数组中每个对象的fields子数组的元素数量之和,总计不得超过100个字段。 - 
如果提供的字段总数超出限制,系统将优先抽取
fields数组中的字段元素,超出部分的字段将被忽略。 
Response
200 - application/json
抽取结果
版本号
Example:
"v1.6.5"
状态码
- 200: OK
 - 40101: x-ti-app-id 或 x-ti-secret-code 为空
 - 40102: x-ti-app-id 或 x-ti-secret-code 无效,验证失败
 - 40103: 客户端IP不在白名单
 - 40003: 余额不足,请充值后再使用
 - 40004: 参数错误,请查看技术文档,检查传参
 - 40007: 机器人不存在或未发布
 - 40008: 机器人未开通,请至市场开通后重试
 - 40301: 图片类型不支持
 - 40302: 上传文件大小不符,文件大小不超过 50M
 - 40303: 文件类型不支持,接口会返回实际检测到的文件类型,如“当前文件类型为.gif”
 - 40304: 图片尺寸不符,长宽比小于2的图片宽高需在20~20000像素范围内,其他图片的宽高需在20~10000像素范围内
 - 40305: 识别文件未上传
 - 40306: qps超过限制
 - 40400: 无效的请求链接,请检查链接是否正确
 - 30203: 基础服务故障,请稍后重试
 - 500: 服务器内部错误
 
可用选项: 
200, 40101, 40102, 40103, 40003, 40004, 40007, 40008, 40301, 40302, 40303, 40304, 40305, 40306, 40400, 30203, 500 Example:
200
错误信息
Example:
"success"
推理时间(ms)
Example:
2825

