跳转到主要内容
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": [
    "<string>"
  ],
  "identity": "<string>",
  "multi_value": true,
  "duplicate_value_distinct": true,
  "transform_settings": {
    "type": "datetime",
    "datetime_settings": {
      "format": "yyyy-MM-dd HH:mm:ss"
    },
    "enumerate_settings": {
      "items": [
        "<string>"
      ]
    },
    "regex_settings": {
      "match": "^\\d{4}-\\d{2}-\\d{2}$",
      "replace": "$1-$2-$3"
    },
    "mismatch_action": {
      "mode": "default",
      "default_value": "<string>"
    }
  },
  "table_id": "1234567890"
}
'
{
  "code": 200,
  "msg": "<string>",
  "result": {
    "field_id": "1234567890"
  }
}

授权

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

请求体

application/json
name
string
必填

字段名称

示例:

"发票代码"

workspace_id
string
必填

空间ID

示例:

"1234567890"

category_id
string
必填

文件类别ID

示例:

"1234567890"

description
string

字段描述

示例:

"发票代码描述"

prompt
string

语义抽取提示词

use_prompt
boolean

是否使用语义提示词

alias
string[]

字段别名

identity
string

导出字段名

multi_value
boolean

是否多值抽取

duplicate_value_distinct
boolean

是否重复值去重,仅当 multi_value 为 true 时有效

transform_settings
object

转换配置

table_id
string

表格ID

  • 不传或为空:创建普通字段,结果会出现在 result.fields 中
  • 传入表格ID:创建对应表格下的表格字段,结果会出现在 result.tables[].fields 中
示例:

"1234567890"

响应

200 - application/json

成功新增文件类别字段

code
integer
必填

状态码

示例:

200

msg
string
必填

状态描述

result
object