メインコンテンツへスキップ
POST
/
api
/
app-api
/
sip
/
platform
/
v2
/
category
/
update
ファイルカテゴリを更新
curl --request POST \
  --url https://docflow.textin.com/api/app-api/sip/platform/v2/category/update \
  --header 'Content-Type: application/json' \
  --header 'x-ti-app-id: <api-key>' \
  --header 'x-ti-secret-code: <api-key>' \
  --data '
{
  "workspace_id": "1234567890",
  "category_id": "1234567890",
  "name": "インボイス",
  "category_prompt": "VAT インボイス。インボイスコード、インボイス番号などのフィールドを含みます。",
  "extract_model": "Model 1",
  "with_detail": true
}
'
{
  "code": 200,
  "msg": "<string>",
  "result": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "category_prompt": "<string>",
    "extract_model": "<string>",
    "enabled": 123
  }
}

承認

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

ボディ

application/json
workspace_id
string
必須

ワークスペース ID

:

"1234567890"

category_id
string
必須

ファイルカテゴリ ID

:

"1234567890"

name
string

ファイルカテゴリ名

Maximum string length: 50
:

"インボイス"

category_prompt
string

分類用プロンプト

Maximum string length: 150
:

"VAT インボイス。インボイスコード、インボイス番号などのフィールドを含みます。"

enabled
enum<integer>

有効化ステータス

  • 0: 無効
  • 1: 有効
  • 2: 下書き
利用可能なオプション:
0,
1,
2
extract_model
enum<string>

抽出モデル, cascades to all fields and tables when set

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

"Model 1"

with_detail
boolean

完全な詳細を返すかどうか。true の場合、子レベルのフィールド/テーブルを除くカテゴリ自身の情報を返します。 未設定または false の場合、code/msg のみを返します。

レスポンス

200 - application/json

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

code
integer
必須

ステータスコード

:

200

msg
string
必須

ステータス説明

result
object

with_detail=true の場合はカテゴリ自身の情報、それ以外は null