Textin DocFlow API文档
  1. 智能审核
Textin DocFlow API文档
  • REST API 开发者文档概述
  • DocFlow业务处理流程
  • 接口认证
  • 状态码列表
  • 应用场景
    • 文档解析
    • 文档分类
    • 信息抽取
    • 智能审核
  • REST API 列表
    • 智能审核
      • 审核接口使用教程说明
      • 审核接口字段依赖
      • 文件批次列表
        GET
      • 文件任务类别列表
        GET
      • 审核规则列表
        POST
      • 文件任务列表
        POST
      • 模型字段列表
        POST
      • 创建审核规则
        POST
      • 更新审核规则
        POST
      • 删除审核规则
        POST
      • 试运行审核规则
        POST
      • 提交审核任务
        POST
      • 审核规则任务列表
        POST
    • 上传文件
      POST
    • 获取文件处理结果列表
      GET
    • 更新文件处理结果
      POST
  1. 智能审核

试运行审核规则

POST
/api/app-api/sip/platform/v2/review/runRule
DocFlow-平台化接口 审核部分
试运行审核规则,部分请求参数需从前置接口获取。
前置接口:/api/app-api/sip/platform/v2/review/listTaskDetailInfoByClassificationIdNo
作用:获取任务id
关键返回结果字段:executeTaskId(任务id)
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://docflow.textin.com/api/app-api/sip/platform/v2/review/runRule' \
--header 'x-ti-app-id;' \
--header 'x-ti-secret-code;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ruleIdNo": 123,
    "executeTaskIdList": [
        123
    ]
}'
响应示例响应示例
{
    "code": 200,
    "data": {
        "id": 1234,
        "reviewRuleIdNo": 1234,
        "reviewRuleVersion": 1,
        "processStatus": 0,
        "thinkOutput": "思考输出内容",
        "evalOutput": "评估输出内容",
        "bindingTaskIds": [
            123
        ],
        "resultHighlights": [
            {
                "fileId": 12345,
                "taskId": 1234,
                "text": "文本内容",
                "position": [
                    1
                ],
                "page": 0,
                "angel": 0,
                "startPos": 0,
                "endPos": 100
            }
        ],
        "evalResult": true,
        "duration": 12345,
        "eval": true,
        "manualAuditStatus": 0,
        "manualAuditMessage": "批注内容"
    },
    "msg": "成功",
    "traceId": "1234ABCD"
}

请求参数

Header 参数
x-ti-app-id
string 
必需
x-ti-app-id
示例值:
1234abcd
x-ti-secret-code
string 
必需
x-ti-secret-code
示例值:
1234abcd
Body 参数application/json
审核API - 单次运行审核规则 Request VO
ruleIdNo
string 
必需
审核规则唯一ID,含义同reviewRuleIdNo
示例值:
123
executeTaskIdList
array[string]
任务ID列表
必需
示例

返回响应

🟢200成功
*/*
OK
Body
code
integer 
状态码
可选
示例值:
200
data
object (ApiReviewRuleTaskVO) 
审核任务VO
可选
id
integer 
可选
主键ID(此处无意义)
示例值:
1234
reviewRuleIdNo
integer 
审核规则唯一id
可选
示例值:
1234
reviewRuleVersion
integer 
审核规则版本
可选
示例值:
1
processStatus
integer 
可选
任务状态 (0:待审核 1:审核成功 2:审核失败 3:审核中)
示例值:
0
thinkOutput
string 
思考输出
可选
示例值:
思考输出内容
evalOutput
string 
评估输出
可选
示例值:
评估输出内容
bindingTaskIds
array[integer]
绑定任务ID列表
可选
resultHighlights
array[object (DocumentOcrPosition) {8}] 
结果高亮信息
可选
evalResult
boolean 
可选
评估结果 True: 通过 False: 不通过
示例值:
true
duration
integer 
可选
任务耗时(单位:毫秒)
示例值:
12345
eval
boolean 
可选
是否为测试运行 True: 是 False: 否
示例值:
true
manualAuditStatus
integer 
可选
评估结果人工确认 0: 未确认 1: 已确认
示例值:
0
manualAuditMessage
string 
人工批注
可选
示例值:
批注内容
msg
string 
状态信息
可选
示例值:
成功
traceId
string 
链路id
可选
示例值:
1234ABCD
上一页
删除审核规则
下一页
提交审核任务
Built with