Review Rule Task List

curl --request POST \
  --url https://docflow.textin.ai/api/app-api/sip/platform/v2/review/listReviewRuleAndTask \
  --header 'Content-Type: application/json' \
  --header 'x-ti-app-id: <api-key>' \
  --header 'x-ti-secret-code: <api-key>' \
  --data '
{
  "workspaceIdNo": 1234,
  "fileBatchNo": "abcd",
  "classificationIdNoList": [
    1234
  ]
}
'

{
  "code": 200,
  "data": [
    {
      "reviewRule": {
        "id": 1,
        "reviewRuleIdNo": 123,
        "reviewRuleType": "single",
        "reviewRulePrompt": "Review rule prompt content",
        "fileBatchNo": "abcd",
        "reviewRuleName": "Review rule name",
        "workspaceIdNo": 123456,
        "classificationIdNoList": [
          1234
        ],
        "version": 1,
        "fieldInfoList": [
          {
            "fieldId": 1234,
            "fieldName": "Name",
            "blockType": 0,
            "tableId": -1,
            "tableName": "Table1",
            "classificationIdNo": 123,
            "classificationName": "ID Card"
          }
        ]
      },
      "latestReviewRuleTask": {
        "gmtCreate": "<string>",
        "gmtModified": "<string>",
        "creatorId": 1,
        "operatorId": 1,
        "deleted": 0,
        "id": 1,
        "reviewRuleIdNo": 1,
        "reviewRuleVersion": 1,
        "processStatus": 1,
        "thinkOutput": "Thinking output content",
        "evalOutput": "Evaluation output content",
        "bindingTaskIds": [
          1234
        ],
        "resultHighlights": [
          {
            "fileId": 12345,
            "taskId": 1234,
            "text": "Text content",
            "position": [
              1
            ],
            "page": 0,
            "angel": 0,
            "startPos": 0,
            "endPos": 100
          }
        ],
        "evalResult": true,
        "duration": 100,
        "eval": false,
        "manualAuditStatus": 0,
        "manualAuditMessage": "Manual annotation content"
      }
    }
  ],
  "msg": "Success",
  "traceId": "1234abcd"
}

File Review

Review Rule Task List

Review rule task list, request parameters need to be obtained from the prerequisite interface.

Prerequisite interface: /api/app-api/sip/platform/v2/review/listByFileBatchNo
Purpose: Get batch list information based on workspaceIdNo, workspaceIdNo is obtained from the page
Key return result field:

fileBatchNo

Prerequisite interface: /api/app-api/sip/platform/v2/review/listExecuteTasksByFileBatchNo Purpose: Get all classification IDs under the batch Key return result field:

taskClassificationIdNo: classification ID

POST

api

app-api

sip

platform

review

listReviewRuleAndTask

Review Rule Task List

curl --request POST \
  --url https://docflow.textin.ai/api/app-api/sip/platform/v2/review/listReviewRuleAndTask \
  --header 'Content-Type: application/json' \
  --header 'x-ti-app-id: <api-key>' \
  --header 'x-ti-secret-code: <api-key>' \
  --data '
{
  "workspaceIdNo": 1234,
  "fileBatchNo": "abcd",
  "classificationIdNoList": [
    1234
  ]
}
'

{
  "code": 200,
  "data": [
    {
      "reviewRule": {
        "id": 1,
        "reviewRuleIdNo": 123,
        "reviewRuleType": "single",
        "reviewRulePrompt": "Review rule prompt content",
        "fileBatchNo": "abcd",
        "reviewRuleName": "Review rule name",
        "workspaceIdNo": 123456,
        "classificationIdNoList": [
          1234
        ],
        "version": 1,
        "fieldInfoList": [
          {
            "fieldId": 1234,
            "fieldName": "Name",
            "blockType": 0,
            "tableId": -1,
            "tableName": "Table1",
            "classificationIdNo": 123,
            "classificationName": "ID Card"
          }
        ]
      },
      "latestReviewRuleTask": {
        "gmtCreate": "<string>",
        "gmtModified": "<string>",
        "creatorId": 1,
        "operatorId": 1,
        "deleted": 0,
        "id": 1,
        "reviewRuleIdNo": 1,
        "reviewRuleVersion": 1,
        "processStatus": 1,
        "thinkOutput": "Thinking output content",
        "evalOutput": "Evaluation output content",
        "bindingTaskIds": [
          1234
        ],
        "resultHighlights": [
          {
            "fileId": 12345,
            "taskId": 1234,
            "text": "Text content",
            "position": [
              1
            ],
            "page": 0,
            "angel": 0,
            "startPos": 0,
            "endPos": 100
          }
        ],
        "evalResult": true,
        "duration": 100,
        "eval": false,
        "manualAuditStatus": 0,
        "manualAuditMessage": "Manual annotation content"
      }
    }
  ],
  "msg": "Success",
  "traceId": "1234abcd"
}

Authorizations

x-ti-app-id

string

header

required

x-ti-secret-code

string

header

required

Headers

x-ti-app-id

string

required

x-ti-app-id

Example:

"1234abcd"

x-ti-secret-code

string

required

x-ti-secret-code

Example:

"1234abcd"

Body

application/json

Return review rule and task list Request VO

workspaceIdNo

string

required

Workspace ID

Example:

1234

fileBatchNo

string

required

File Batch ID

Example:

"abcd"

classificationIdNoList

string[]

Classification ID List

Classification ID

Response

200 - */*

code

integer

Status code

Example:

200

data

object[]

Show child attributes

data.reviewRule

object

Rule review DTO

Show child attributes

data.reviewRule.id

integer

Primary key ID

Example:

1

data.reviewRule.reviewRuleIdNo

integer

Review rule unique ID

Example:

123

data.reviewRule.reviewRuleType

string

Review rule type

Example:

"single"

data.reviewRule.reviewRulePrompt

string

Review rule prompt

Example:

"Review rule prompt content"

data.reviewRule.fileBatchNo

string

File batch number

Example:

"abcd"

data.reviewRule.reviewRuleName

string

Review rule name

Example:

"Review rule name"

data.reviewRule.workspaceIdNo

integer

Workspace unique number

Example:

123456

data.reviewRule.classificationIdNoList

integer[]

Classification ID list

Classification ID

data.reviewRule.version

integer

Review rule version

Example:

1

data.reviewRule.fieldInfoList

object[]

Field information flat list

Show child attributes

data.reviewRule.fieldInfoList.fieldId

integer

Field ID

Example:

1234

data.reviewRule.fieldInfoList.fieldName

string

Field name

Example:

"Name"

data.reviewRule.fieldInfoList.blockType

integer

Field type 0: Basic field 1: Table field

Example:

0

data.reviewRule.fieldInfoList.tableId

integer

Table ID

Example:

-1

data.reviewRule.fieldInfoList.tableName

string

Table name

Example:

"Table1"

data.reviewRule.fieldInfoList.classificationIdNo

integer

Classification ID

Example:

123

data.reviewRule.fieldInfoList.classificationName

string

Classification name

Example:

"ID Card"

data.latestReviewRuleTask

object

Show child attributes

data.latestReviewRuleTask.gmtCreate

string

data.latestReviewRuleTask.gmtModified

string

data.latestReviewRuleTask.creatorId

integer

Creator user ID

Example:

1

data.latestReviewRuleTask.operatorId

integer

Operator user ID

Example:

1

data.latestReviewRuleTask.deleted

integer

Whether deleted, 0-Not deleted, 1-Deleted

Example:

0

data.latestReviewRuleTask.id

integer

Review rule task unique ID

Example:

1

data.latestReviewRuleTask.reviewRuleIdNo

integer

Review rule unique ID

Example:

1

data.latestReviewRuleTask.reviewRuleVersion

integer

Review rule version

Example:

1

data.latestReviewRuleTask.processStatus

integer

Review task status (0: Pending review, 1: Review successful, 2: Review failed, 3: Reviewing)

Example:

1

data.latestReviewRuleTask.thinkOutput

string

Thinking output

Example:

"Thinking output content"

data.latestReviewRuleTask.evalOutput

string

Evaluation output

Example:

"Evaluation output content"

data.latestReviewRuleTask.bindingTaskIds

integer[]

Binding task ID list

Binding task ID

data.latestReviewRuleTask.resultHighlights

object[]

Show child attributes

data.latestReviewRuleTask.resultHighlights.fileId

integer

File ID

Example:

12345

data.latestReviewRuleTask.resultHighlights.taskId

integer

Task ID

Example:

1234

data.latestReviewRuleTask.resultHighlights.text

string

Text

Example:

"Text content"

data.latestReviewRuleTask.resultHighlights.position

integer[]

Position information

data.latestReviewRuleTask.resultHighlights.page

integer

Page number

Example:

0

data.latestReviewRuleTask.resultHighlights.angel

integer

Rotation angle

Example:

0

data.latestReviewRuleTask.resultHighlights.startPos

integer

Start position

Example:

0

data.latestReviewRuleTask.resultHighlights.endPos

integer

End position

Example:

100

data.latestReviewRuleTask.evalResult

boolean

Evaluation result (true: Pass, false: Fail)

Example:

true

data.latestReviewRuleTask.duration

integer

Task duration

Example:

100

data.latestReviewRuleTask.eval

boolean

Whether it is a test run

Example:

false

data.latestReviewRuleTask.manualAuditStatus

integer

Evaluation result manual confirmation

Example:

0

data.latestReviewRuleTask.manualAuditMessage

string

Manual annotation

Example:

"Manual annotation content"

msg

string

Status message

Example:

"Success"

traceId

string

Trace ID

Example:

"1234abcd"

Submit Review Task

⌘I

API Reference

File Review

Authorizations

Headers

Body

Response