ファイルカテゴリを作成
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": [
"インボイス 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"
}
}
}' \
--form 'category_prompt=VAT インボイス。インボイスコード、インボイス番号などのフィールドを含みます。' \
--form 'description=<string>' \
--form 'tables={
"name": "明細テーブル",
"prompt": "<string>",
"collect_from_multi_table": true,
"fields": [
{
"name": "インボイスコード",
"description": "インボイスコードの説明",
"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"
}
}
}
]
}' \
--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": [
"インボイス 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"
}
},
"id": "1234567890",
"extract_model": "Model 1"
}
],
"tables": [
{
"id": "1234567890",
"name": "Table 1",
"description": "テーブルの説明",
"prompt": "各行から品目名、数量、金額を抽出します",
"collect_from_multi_table": true,
"extract_model": "Model 1",
"fields": [
{
"name": "インボイスコード",
"description": "インボイスコードの説明",
"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"
}
},
"id": "1234567890",
"extract_model": "Model 1"
}
]
}
],
"samples": [
{
"sample_id": "1234567890",
"file_name": "invoice_sample.pdf"
}
]
}
}ファイルカテゴリ
ファイルカテゴリを作成
指定したワークスペースに新しいファイルカテゴリを作成します。少なくとも 1 つのサンプルファイルと 1 つのフィールド設定が必要です。
一括作成に対応しています。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": [
"インボイス 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"
}
}
}' \
--form 'category_prompt=VAT インボイス。インボイスコード、インボイス番号などのフィールドを含みます。' \
--form 'description=<string>' \
--form 'tables={
"name": "明細テーブル",
"prompt": "<string>",
"collect_from_multi_table": true,
"fields": [
{
"name": "インボイスコード",
"description": "インボイスコードの説明",
"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"
}
}
}
]
}' \
--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": [
"インボイス 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"
}
},
"id": "1234567890",
"extract_model": "Model 1"
}
],
"tables": [
{
"id": "1234567890",
"name": "Table 1",
"description": "テーブルの説明",
"prompt": "各行から品目名、数量、金額を抽出します",
"collect_from_multi_table": true,
"extract_model": "Model 1",
"fields": [
{
"name": "インボイスコード",
"description": "インボイスコードの説明",
"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"
}
},
"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: VLM。シンプルな抽出に適しています
利用可能なオプション:
Model 1, Model 2, Model 3 例:
"Model 1"
サンプルファイルリスト。少なくとも 1 つのサンプルファイルをアップロードする必要があります。1 つのカテゴリには最大 20 個のサンプルファイルを設定できます
Required array length:
1 - 10 elementsフィールド設定リスト。少なくとも 1 つのフィールドを設定する必要があります
Minimum array length:
1Show child attributes
Show child attributes
分類用プロンプト
Maximum string length:
150例:
"VAT インボイス。インボイスコード、インボイス番号などのフィールドを含みます。"
ファイルカテゴリの説明
任意。テーブル設定リスト(一括作成)。ネストされたフィールドに対応しています
Show child attributes
Show child attributes
完全な詳細を返すかどうか。true の場合、レスポンスにカテゴリの完全な情報(フィールド、テーブル、サンプルを含む)が含まれます。 未設定または false の場合、category_id のみを返します。
⌘I

