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/create
DocFlow-平台化接口 审核部分
创建审核规则,调用接口前需要调用一些前置接口。
前置接口:/api/app-api/sip/platform/v2/review/listExecuteTasksByFileBatchNo
作用:获取批次下的所有分类id
关键返回结果字段:taskClassificationIdNo(分类id)
前置接口:/api/app-api/sip/platform/v2/review/listModelFieldInfoByClassificationIdNoList
作用:获取分类下的字段信息
关键返回结果字段:id(含义同fieldId)、fieldName、blockType(区分是普通字段还是表格字段)、classificationIdNo(区分字段属于哪个分类)、 tableIdNo(表格id,如果字段是表格字段)、tableName(表格名称,如果字段是表格字段)
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://docflow.textin.com/api/app-api/sip/platform/v2/review/create' \
--header 'x-ti-app-id;' \
--header 'x-ti-secret-code;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ruleName": "审核规则123",
    "rulePrompt": "审核规则提示内容",
    "classificationIdNoList": [
        123
    ],
    "fileBatchNo": "abcd",
    "workspaceIdNo": 123,
    "fields": [
        {
            "classificationIdNo": 1234,
            "classificationName": "身份证",
            "basicFields": [
                {
                    "fieldId": 1234,
                    "fieldName": "卡号"
                }
            ],
            "tableFields": [
                {
                    "tableId": -1,
                    "tableName": "Table1",
                    "fields": [
                        {
                            "fieldId": 1234,
                            "fieldName": "卡号"
                        }
                    ]
                }
            ]
        }
    ]
}'
响应示例响应示例
{
    "code": 200,
    "data": {
        "ruleIdNo": 1234
    },
    "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
创建规则ReqVO
ruleName
string 
审核规则名称
必需
>= 0 字符<= 255 字符
示例值:
审核规则123
rulePrompt
string 
审核规则提示
必需
>= 0 字符<= 1000 字符
示例值:
审核规则提示内容
classificationIdNoList
array[string]
分类ID列表
必需
>= 1 items<= 2147483647 items
fileBatchNo
string 
文件批次号
必需
示例值:
abcd
workspaceIdNo
string 
工作空间ID
必需
示例值:
123
fields
array[object (Field) {4}] 
关联的字段信息
可选
classificationIdNo
string 
分类id
可选
示例值:
1234
classificationName
string 
分类名称
可选
示例值:
身份证
basicFields
array[object (BasicField) {2}] 
可选
tableFields
array[object (TableField) {3}] 
可选
示例

返回响应

🟢200成功
*/*
OK
Body
code
integer 
状态码
可选
示例值:
200
data
object (ApiRuleReviewCreateRespVO) 
可选
创建规则返回结果VO
ruleIdNo
integer 
可选
审核规则唯一id,含义同reviewRuleIdNo
示例值:
1234
msg
string 
状态信息
可选
示例值:
成功
traceId
string 
链路id
可选
示例值:
1234abcd
上一页
模型字段列表
下一页
更新审核规则
Built with