メインコンテンツへスキップ
POST
/
api
/
app-api
/
sip
/
platform
/
v2
/
category
/
fields
/
update
単一ファイルカテゴリフィールドを更新
curl --request POST \
  --url https://docflow.textin.com/api/app-api/sip/platform/v2/category/fields/update \
  --header 'Content-Type: application/json' \
  --header 'x-ti-app-id: <api-key>' \
  --header 'x-ti-secret-code: <api-key>' \
  --data '
{
  "field_id": "1234567890",
  "workspace_id": "1234567890",
  "category_id": "1234567890",
  "name": "<string>",
  "description": "<string>",
  "prompt": "<string>",
  "use_prompt": true,
  "alias": [
    "インボイス No.",
    "請求書番号"
  ],
  "identity": "invoice_number",
  "multi_value": true,
  "duplicate_value_distinct": true,
  "transform_settings": {
    "datetime_settings": {
      "format": "yyyy-MM-dd"
    },
    "enumerate_settings": {
      "items": [
        "VAT 専用インボイス",
        "VAT 一般インボイス",
        "電子インボイス"
      ]
    },
    "regex_settings": {
      "match": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "replace": "$1/$2/$3"
    },
    "mismatch_action": {
      "default_value": "N/A"
    }
  },
  "extract_model": "Model 1",
  "table_id": "1234567890",
  "with_detail": true
}
'
{
  "code": 200,
  "msg": "<string>"
}

承認

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

ボディ

application/json

フィールド更新項目(multi_value/duplicate_value_distinct はこのエンドポイントでは変更できません)

field_id
string
必須

フィールド ID

:

"1234567890"

workspace_id
string
必須

ワークスペース ID

:

"1234567890"

category_id
string
必須

ファイルカテゴリ ID

:

"1234567890"

name
string

フィールド名

description
string

フィールドの説明

prompt
string

意味抽出プロンプト

use_prompt
boolean

意味抽出プロンプトを使用するかどうか

alias
string[]

フィールド別名。省略=変更なし、空配列 []=クリア、空でない配列=上書き

:
["インボイス No.", "請求書番号"]
identity
string

エクスポート時のフィールド名。省略=変更なし、空文字列 ""=クリア、空でない値=上書き

:

"invoice_number"

multi_value
boolean

複数値抽出を有効にするかどうか。省略=変更なし

duplicate_value_distinct
boolean

値を重複排除するかどうか。multi_value が true の場合のみ有効です。省略=変更なし

transform_settings
object

フィールド出力変換設定。抽出結果を出力前に整形します。

extract_model
enum<string>

フィールド単位の抽出モデル。通常フィールドのみ個別に設定でき、テーブルフィールドは設定できません。 省略すると既存設定を保持します。

  • Model 1: 高速で安定した抽出結果
  • Model 2: 複雑な文書理解に適しています
  • Model 3: VLM。シンプルな抽出に適しています
利用可能なオプション:
Model 1,
Model 2,
Model 3
:

"Model 1"

table_id
string

テーブル ID

  • 通常フィールドでは不要です
  • テーブルフィールドでは必須です(フィールドが属するテーブル ID を指定してください)
:

"1234567890"

with_detail
boolean

完全な詳細を返すかどうか。true の場合、更新後フィールドの完全な情報を返します。 未設定または false の場合、code/msg のみを返します。

レスポンス

200 - application/json

ファイルカテゴリフィールドの更新に成功

code
integer
必須

ステータスコード

:

200

msg
string
必須

ステータス説明