创建文件类别
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"
}
]
}
}文件类别
创建文件类别
在指定空间中创建一个新的文件类别,需要上传至少一个样本文件并配置至少一个字段。
支持一站式创建:可同时传入 tables 参数,创建表格及表格内嵌字段。
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"
}
]
}
}请求体
multipart/form-data
空间ID
示例:
"1234567890"
文件类别名称
Maximum string length:
50示例:
"发票"
抽取模型
- Model 1: 速度快,抽取结果稳定
- Model 2: 适用复杂文档理解
- Model 3: 多模态,适用简单抽取
可用选项:
Model 1, Model 2, Model 3 示例:
"Model 1"
样本文件列表,至少上传一个样本文件,一个类别最多有20个样本文件
Required array length:
1 - 10 elements字段配置列表,至少配置一个字段
Minimum array length:
1Show child attributes
Show child attributes
用于分类的提示词
Maximum string length:
150示例:
"增值税发票,包含发票代码、发票号码等字段"
文件类别描述
选填,表格配置列表(一站式创建),支持内嵌 fields
Show child attributes
Show child attributes
是否返回完整详情。传 true 时响应包含完整的分类信息(含字段、表格、样本)。 不传或为 false 时仅返回 category_id。
⌘I

