新增单个文件类别字段
curl --request POST \
--url https://docflow.textin.com/api/app-api/sip/platform/v2/category/fields/add \
--header 'Content-Type: application/json' \
--header 'x-ti-app-id: <api-key>' \
--header 'x-ti-secret-code: <api-key>' \
--data '
{
"name": "发票代码",
"workspace_id": "1234567890",
"category_id": "1234567890",
"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"
}
},
"table_id": "1234567890",
"extract_model": "Acgpt",
"with_detail": true
}
'import requests
url = "https://docflow.textin.com/api/app-api/sip/platform/v2/category/fields/add"
payload = {
"name": "发票代码",
"workspace_id": "1234567890",
"category_id": "1234567890",
"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" }
},
"table_id": "1234567890",
"extract_model": "Acgpt",
"with_detail": True
}
headers = {
"x-ti-app-id": "<api-key>",
"x-ti-secret-code": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-ti-app-id': '<api-key>',
'x-ti-secret-code': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '发票代码',
workspace_id: '1234567890',
category_id: '1234567890',
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'}
},
table_id: '1234567890',
extract_model: 'Acgpt',
with_detail: true
})
};
fetch('https://docflow.textin.com/api/app-api/sip/platform/v2/category/fields/add', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://docflow.textin.com/api/app-api/sip/platform/v2/category/fields/add",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '发票代码',
'workspace_id' => '1234567890',
'category_id' => '1234567890',
'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'
]
],
'table_id' => '1234567890',
'extract_model' => 'Acgpt',
'with_detail' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-ti-app-id: <api-key>",
"x-ti-secret-code: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://docflow.textin.com/api/app-api/sip/platform/v2/category/fields/add"
payload := strings.NewReader("{\n \"name\": \"发票代码\",\n \"workspace_id\": \"1234567890\",\n \"category_id\": \"1234567890\",\n \"description\": \"发票代码描述\",\n \"prompt\": \"<string>\",\n \"use_prompt\": true,\n \"alias\": [\n \"发票号\",\n \"票号\",\n \"Invoice No.\"\n ],\n \"identity\": \"invoice_number\",\n \"multi_value\": true,\n \"duplicate_value_distinct\": true,\n \"transform_settings\": {\n \"datetime_settings\": {\n \"format\": \"yyyy-MM-dd\"\n },\n \"enumerate_settings\": {\n \"items\": [\n \"增值税专用发票\",\n \"增值税普通发票\",\n \"电子发票\"\n ]\n },\n \"regex_settings\": {\n \"match\": \"^(\\\\d{4})-(\\\\d{2})-(\\\\d{2})$\",\n \"replace\": \"$1/$2/$3\"\n },\n \"mismatch_action\": {\n \"default_value\": \"N/A\"\n }\n },\n \"table_id\": \"1234567890\",\n \"extract_model\": \"Acgpt\",\n \"with_detail\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-ti-app-id", "<api-key>")
req.Header.Add("x-ti-secret-code", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://docflow.textin.com/api/app-api/sip/platform/v2/category/fields/add")
.header("x-ti-app-id", "<api-key>")
.header("x-ti-secret-code", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"发票代码\",\n \"workspace_id\": \"1234567890\",\n \"category_id\": \"1234567890\",\n \"description\": \"发票代码描述\",\n \"prompt\": \"<string>\",\n \"use_prompt\": true,\n \"alias\": [\n \"发票号\",\n \"票号\",\n \"Invoice No.\"\n ],\n \"identity\": \"invoice_number\",\n \"multi_value\": true,\n \"duplicate_value_distinct\": true,\n \"transform_settings\": {\n \"datetime_settings\": {\n \"format\": \"yyyy-MM-dd\"\n },\n \"enumerate_settings\": {\n \"items\": [\n \"增值税专用发票\",\n \"增值税普通发票\",\n \"电子发票\"\n ]\n },\n \"regex_settings\": {\n \"match\": \"^(\\\\d{4})-(\\\\d{2})-(\\\\d{2})$\",\n \"replace\": \"$1/$2/$3\"\n },\n \"mismatch_action\": {\n \"default_value\": \"N/A\"\n }\n },\n \"table_id\": \"1234567890\",\n \"extract_model\": \"Acgpt\",\n \"with_detail\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://docflow.textin.com/api/app-api/sip/platform/v2/category/fields/add")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-ti-app-id"] = '<api-key>'
request["x-ti-secret-code"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"发票代码\",\n \"workspace_id\": \"1234567890\",\n \"category_id\": \"1234567890\",\n \"description\": \"发票代码描述\",\n \"prompt\": \"<string>\",\n \"use_prompt\": true,\n \"alias\": [\n \"发票号\",\n \"票号\",\n \"Invoice No.\"\n ],\n \"identity\": \"invoice_number\",\n \"multi_value\": true,\n \"duplicate_value_distinct\": true,\n \"transform_settings\": {\n \"datetime_settings\": {\n \"format\": \"yyyy-MM-dd\"\n },\n \"enumerate_settings\": {\n \"items\": [\n \"增值税专用发票\",\n \"增值税普通发票\",\n \"电子发票\"\n ]\n },\n \"regex_settings\": {\n \"match\": \"^(\\\\d{4})-(\\\\d{2})-(\\\\d{2})$\",\n \"replace\": \"$1/$2/$3\"\n },\n \"mismatch_action\": {\n \"default_value\": \"N/A\"\n }\n },\n \"table_id\": \"1234567890\",\n \"extract_model\": \"Acgpt\",\n \"with_detail\": true\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"msg": "<string>",
"result": {
"field_id": "1234567890",
"name": "<string>",
"description": "<string>",
"prompt": "<string>",
"use_prompt": true,
"alias": [
"<string>"
],
"identity": "<string>",
"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"
}
},
"extract_model": "<string>",
"enabled": 123
}
}已废弃
新增单个文件类别字段
在指定文件类别下新增一个字段，支持新增普通字段和表格字段
⚠️ 该接口目前仍在提供服务，但后续将停止维护。推荐使用 新增文件类别字段 接口替代。
POST
/
api
/
app-api
/
sip
/
platform
/
v2
/
category
/
fields
/
add
新增单个文件类别字段
curl --request POST \
--url https://docflow.textin.com/api/app-api/sip/platform/v2/category/fields/add \
--header 'Content-Type: application/json' \
--header 'x-ti-app-id: <api-key>' \
--header 'x-ti-secret-code: <api-key>' \
--data '
{
"name": "发票代码",
"workspace_id": "1234567890",
"category_id": "1234567890",
"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"
}
},
"table_id": "1234567890",
"extract_model": "Acgpt",
"with_detail": true
}
'import requests
url = "https://docflow.textin.com/api/app-api/sip/platform/v2/category/fields/add"
payload = {
"name": "发票代码",
"workspace_id": "1234567890",
"category_id": "1234567890",
"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" }
},
"table_id": "1234567890",
"extract_model": "Acgpt",
"with_detail": True
}
headers = {
"x-ti-app-id": "<api-key>",
"x-ti-secret-code": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-ti-app-id': '<api-key>',
'x-ti-secret-code': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '发票代码',
workspace_id: '1234567890',
category_id: '1234567890',
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'}
},
table_id: '1234567890',
extract_model: 'Acgpt',
with_detail: true
})
};
fetch('https://docflow.textin.com/api/app-api/sip/platform/v2/category/fields/add', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://docflow.textin.com/api/app-api/sip/platform/v2/category/fields/add",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '发票代码',
'workspace_id' => '1234567890',
'category_id' => '1234567890',
'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'
]
],
'table_id' => '1234567890',
'extract_model' => 'Acgpt',
'with_detail' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-ti-app-id: <api-key>",
"x-ti-secret-code: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://docflow.textin.com/api/app-api/sip/platform/v2/category/fields/add"
payload := strings.NewReader("{\n \"name\": \"发票代码\",\n \"workspace_id\": \"1234567890\",\n \"category_id\": \"1234567890\",\n \"description\": \"发票代码描述\",\n \"prompt\": \"<string>\",\n \"use_prompt\": true,\n \"alias\": [\n \"发票号\",\n \"票号\",\n \"Invoice No.\"\n ],\n \"identity\": \"invoice_number\",\n \"multi_value\": true,\n \"duplicate_value_distinct\": true,\n \"transform_settings\": {\n \"datetime_settings\": {\n \"format\": \"yyyy-MM-dd\"\n },\n \"enumerate_settings\": {\n \"items\": [\n \"增值税专用发票\",\n \"增值税普通发票\",\n \"电子发票\"\n ]\n },\n \"regex_settings\": {\n \"match\": \"^(\\\\d{4})-(\\\\d{2})-(\\\\d{2})$\",\n \"replace\": \"$1/$2/$3\"\n },\n \"mismatch_action\": {\n \"default_value\": \"N/A\"\n }\n },\n \"table_id\": \"1234567890\",\n \"extract_model\": \"Acgpt\",\n \"with_detail\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-ti-app-id", "<api-key>")
req.Header.Add("x-ti-secret-code", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://docflow.textin.com/api/app-api/sip/platform/v2/category/fields/add")
.header("x-ti-app-id", "<api-key>")
.header("x-ti-secret-code", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"发票代码\",\n \"workspace_id\": \"1234567890\",\n \"category_id\": \"1234567890\",\n \"description\": \"发票代码描述\",\n \"prompt\": \"<string>\",\n \"use_prompt\": true,\n \"alias\": [\n \"发票号\",\n \"票号\",\n \"Invoice No.\"\n ],\n \"identity\": \"invoice_number\",\n \"multi_value\": true,\n \"duplicate_value_distinct\": true,\n \"transform_settings\": {\n \"datetime_settings\": {\n \"format\": \"yyyy-MM-dd\"\n },\n \"enumerate_settings\": {\n \"items\": [\n \"增值税专用发票\",\n \"增值税普通发票\",\n \"电子发票\"\n ]\n },\n \"regex_settings\": {\n \"match\": \"^(\\\\d{4})-(\\\\d{2})-(\\\\d{2})$\",\n \"replace\": \"$1/$2/$3\"\n },\n \"mismatch_action\": {\n \"default_value\": \"N/A\"\n }\n },\n \"table_id\": \"1234567890\",\n \"extract_model\": \"Acgpt\",\n \"with_detail\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://docflow.textin.com/api/app-api/sip/platform/v2/category/fields/add")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-ti-app-id"] = '<api-key>'
request["x-ti-secret-code"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"发票代码\",\n \"workspace_id\": \"1234567890\",\n \"category_id\": \"1234567890\",\n \"description\": \"发票代码描述\",\n \"prompt\": \"<string>\",\n \"use_prompt\": true,\n \"alias\": [\n \"发票号\",\n \"票号\",\n \"Invoice No.\"\n ],\n \"identity\": \"invoice_number\",\n \"multi_value\": true,\n \"duplicate_value_distinct\": true,\n \"transform_settings\": {\n \"datetime_settings\": {\n \"format\": \"yyyy-MM-dd\"\n },\n \"enumerate_settings\": {\n \"items\": [\n \"增值税专用发票\",\n \"增值税普通发票\",\n \"电子发票\"\n ]\n },\n \"regex_settings\": {\n \"match\": \"^(\\\\d{4})-(\\\\d{2})-(\\\\d{2})$\",\n \"replace\": \"$1/$2/$3\"\n },\n \"mismatch_action\": {\n \"default_value\": \"N/A\"\n }\n },\n \"table_id\": \"1234567890\",\n \"extract_model\": \"Acgpt\",\n \"with_detail\": true\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"msg": "<string>",
"result": {
"field_id": "1234567890",
"name": "<string>",
"description": "<string>",
"prompt": "<string>",
"use_prompt": true,
"alias": [
"<string>"
],
"identity": "<string>",
"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"
}
},
"extract_model": "<string>",
"enabled": 123
}
}请求体
application/json
字段名称
示例:
"发票代码"
空间ID
示例:
"1234567890"
文件类别ID
示例:
"1234567890"
字段描述
示例:
"发票代码描述"
语义抽取提示词
是否使用语义提示词
字段别名。更新时：不传=不修改，传空数组[]=清空别名，传非空数组=覆盖
示例:
["发票号", "票号", "Invoice No."]
导出字段名。更新时：不传=不修改，传空字符串""=清空，传非空值=覆盖
示例:
"invoice_number"
是否多值抽取
是否重复值去重，仅当 multi_value 为 true 时有效
字段输出转换配置，对抽取结果进行格式化处理后再输出。
Show child attributes
Show child attributes
表格ID
- 不传或为空：创建普通字段，结果会出现在 result.fields 中
- 传入表格ID：创建对应表格下的表格字段，结果会出现在 result.tables[].fields 中
示例:
"1234567890"
选填，字段级抽取模型，仅普通字段（非表格字段）支持，不填则跟随分类级配置（分类级为 mixed 或 null 时默认 Auto）
- Auto: 智能匹配抽取模型
- Acgpt: 速度快，抽取结果稳定
- Acgpt-VL: 多模态，适用简单抽取（≤10 页）
- DF-M1: 适用复杂文档理解
可用选项:
Auto, Acgpt, Acgpt-VL, DF-M1 示例:
"Acgpt"
是否返回完整详情。传 true 时响应包含新建字段的完整信息。 不传或为 false 时仅返回 field_id。
⌘I