跳转到主要内容
POST
/
api
/
app-api
/
sip
/
platform
/
v2
/
category
/
create
创建文件类别
curl --request POST \
  --url https://docflow.textin.com/api/app-api/sip/platform/v2/category/create \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-ti-app-id: <api-key>' \
  --header 'x-ti-secret-code: <api-key>' \
  --form workspace_id=1234567890 \
  --form 'name=发票' \
  --form 'extract_model=Model 1' \
  --form 'sample_files=<string>' \
  --form 'fields={
  "name": "发票代码",
  "description": "发票代码描述",
  "prompt": "<string>",
  "use_prompt": true,
  "alias": [
    "发票号",
    "票号",
    "Invoice No."
  ],
  "identity": "invoice_number",
  "multi_value": true,
  "duplicate_value_distinct": true,
  "transform_settings": {
    "datetime_settings": {
      "format": "yyyy-MM-dd"
    },
    "enumerate_settings": {
      "items": [
        "增值税专用发票",
        "增值税普通发票",
        "电子发票"
      ]
    },
    "regex_settings": {
      "match": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "replace": "$1/$2/$3"
    },
    "mismatch_action": {
      "default_value": "N/A"
    }
  }
}' \
  --form 'category_prompt=增值税发票,包含发票代码、发票号码等字段' \
  --form 'description=<string>' \
  --form 'tables={
  "name": "明细表",
  "prompt": "<string>",
  "collect_from_multi_table": true,
  "fields": [
    {
      "name": "发票代码",
      "description": "发票代码描述",
      "prompt": "<string>",
      "use_prompt": true,
      "alias": [
        "发票号",
        "票号",
        "Invoice No."
      ],
      "identity": "invoice_number",
      "multi_value": true,
      "duplicate_value_distinct": true,
      "transform_settings": {
        "datetime_settings": {
          "format": "yyyy-MM-dd"
        },
        "enumerate_settings": {
          "items": [
            "增值税专用发票",
            "增值税普通发票",
            "电子发票"
          ]
        },
        "regex_settings": {
          "match": "^(\\d{4})-(\\d{2})-(\\d{2})$",
          "replace": "$1/$2/$3"
        },
        "mismatch_action": {
          "default_value": "N/A"
        }
      }
    }
  ]
}' \
  --form with_detail=true \
  --form sample_files.items='@example-file'
{
  "code": 200,
  "msg": "<string>",
  "result": {
    "category_id": "1234567890",
    "name": "<string>",
    "description": "<string>",
    "category_prompt": "<string>",
    "extract_model": "<string>",
    "enabled": 123,
    "fields": [
      {
        "name": "发票代码",
        "description": "发票代码描述",
        "prompt": "<string>",
        "use_prompt": true,
        "alias": [
          "发票号",
          "票号",
          "Invoice No."
        ],
        "identity": "invoice_number",
        "multi_value": true,
        "duplicate_value_distinct": true,
        "transform_settings": {
          "datetime_settings": {
            "format": "yyyy-MM-dd"
          },
          "enumerate_settings": {
            "items": [
              "增值税专用发票",
              "增值税普通发票",
              "电子发票"
            ]
          },
          "regex_settings": {
            "match": "^(\\d{4})-(\\d{2})-(\\d{2})$",
            "replace": "$1/$2/$3"
          },
          "mismatch_action": {
            "default_value": "N/A"
          }
        },
        "id": "1234567890",
        "extract_model": "Model 1"
      }
    ],
    "tables": [
      {
        "id": "1234567890",
        "name": "表格1",
        "description": "表格描述",
        "prompt": "请抽取每行的品名、数量和金额",
        "collect_from_multi_table": true,
        "extract_model": "Model 1",
        "fields": [
          {
            "name": "发票代码",
            "description": "发票代码描述",
            "prompt": "<string>",
            "use_prompt": true,
            "alias": [
              "发票号",
              "票号",
              "Invoice No."
            ],
            "identity": "invoice_number",
            "multi_value": true,
            "duplicate_value_distinct": true,
            "transform_settings": {
              "datetime_settings": {
                "format": "yyyy-MM-dd"
              },
              "enumerate_settings": {
                "items": [
                  "增值税专用发票",
                  "增值税普通发票",
                  "电子发票"
                ]
              },
              "regex_settings": {
                "match": "^(\\d{4})-(\\d{2})-(\\d{2})$",
                "replace": "$1/$2/$3"
              },
              "mismatch_action": {
                "default_value": "N/A"
              }
            },
            "id": "1234567890",
            "extract_model": "Model 1"
          }
        ]
      }
    ],
    "samples": [
      {
        "sample_id": "1234567890",
        "file_name": "invoice_sample.pdf"
      }
    ]
  }
}

授权

x-ti-app-id
string
header
必填
x-ti-secret-code
string
header
必填

请求体

multipart/form-data
workspace_id
string
必填

空间ID

示例:

"1234567890"

name
string
必填

文件类别名称

Maximum string length: 50
示例:

"发票"

extract_model
enum<string>
必填

抽取模型

  • Model 1: 速度快,抽取结果稳定
  • Model 2: 适用复杂文档理解
  • Model 3: 多模态,适用简单抽取
可用选项:
Model 1,
Model 2,
Model 3
示例:

"Model 1"

sample_files
file[]
必填

样本文件列表,至少上传一个样本文件,一个类别最多有20个样本文件

Required array length: 1 - 10 elements
fields
object[]
必填

字段配置列表,至少配置一个字段

Minimum array length: 1
category_prompt
string

用于分类的提示词

Maximum string length: 150
示例:

"增值税发票,包含发票代码、发票号码等字段"

description
string

文件类别描述

tables
object[]

选填,表格配置列表(一站式创建),支持内嵌 fields

with_detail
boolean

是否返回完整详情。传 true 时响应包含完整的分类信息(含字段、表格、样本)。 不传或为 false 时仅返回 category_id。

响应

200 - application/json

成功创建文件类别

code
integer
必填

状态码

示例:

200

msg
string
必填

状态描述

result
object