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/listReviewRuleAndTask
DocFlow-平台化接口 审核部分
审核规则任务列表,请求参数需从前置接口获取。
前置接口:/api/app-api/sip/platform/v2/review/listByFileBatchNo
作用:根据workspaceIdNo获取批次列表信息,workspaceIdNo从页面获取
关键返回结果字段:fileBatchNo
前置接口:/api/app-api/sip/platform/v2/review/listExecuteTasksByFileBatchNo
作用:获取批次下的所有分类id
关键返回结果字段:taskClassificationIdNo(分类id)
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://docflow.textin.com/api/app-api/sip/platform/v2/review/listReviewRuleAndTask' \
--header 'x-ti-app-id;' \
--header 'x-ti-secret-code;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workspaceIdNo": 1234,
    "fileBatchNo": "abcd",
    "classificationIdNoList": [
        1234
    ]
}'
响应示例响应示例
{
    "code": 200,
    "data": [
        {
            "reviewRule": {
                "id": 1,
                "reviewRuleIdNo": 123,
                "reviewRuleType": "single",
                "reviewRulePrompt": "审核规则提示内容",
                "fileBatchNo": "abcd",
                "reviewRuleName": "审核规则名称",
                "workspaceIdNo": 123456,
                "classificationIdNoList": [
                    1234
                ],
                "version": 1,
                "fieldInfoList": [
                    {
                        "fieldId": 1234,
                        "fieldName": "名称",
                        "blockType": 0,
                        "tableId": -1,
                        "tableName": "Table1",
                        "classificationIdNo": 123,
                        "classificationName": "身份证"
                    }
                ]
            },
            "latestReviewRuleTask": {
                "gmtCreate": "string",
                "gmtModified": "string",
                "creatorId": 1,
                "operatorId": 1,
                "deleted": 0,
                "id": 1,
                "reviewRuleIdNo": 1,
                "reviewRuleVersion": 1,
                "processStatus": 1,
                "thinkOutput": "思考输出内容",
                "evalOutput": "评估输出内容",
                "bindingTaskIds": [
                    1234
                ],
                "resultHighlights": [
                    {
                        "fileId": 12345,
                        "taskId": 1234,
                        "text": "文本内容",
                        "position": [
                            1
                        ],
                        "page": 0,
                        "angel": 0,
                        "startPos": 0,
                        "endPos": 100
                    }
                ],
                "evalResult": true,
                "duration": 100,
                "eval": false,
                "manualAuditStatus": "0:未确认、1:已确认",
                "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
返回审核规则和任务列表 Request VO
workspaceIdNo
string 
工作空间ID
必需
示例值:
1234
fileBatchNo
string 
文件批次ID
必需
示例值:
abcd
classificationIdNoList
array[string]
分类ID列表
可选
示例

返回响应

🟢200成功
*/*
OK
Body
code
integer 
状态码
可选
示例值:
200
data
array[object (ApiReviewRuleAndTaskRespVO) {2}] 
可选
reviewRule
object (ReviewRuleDTO) 
规则审核DTO
可选
latestReviewRuleTask
object (ReviewRuleTaskDO) 
可选
msg
string 
状态信息
可选
示例值:
成功
traceId
string 
链路id
可选
示例值:
1234abcd
上一页
提交审核任务
下一页
上传文件
Built with