メインコンテンツへスキップ
文書カテゴリが事前に分かっている場合、ファイルアップロード時に category パラメータでファイルカテゴリを指定することで、DocFlow は自動分類プロセスをスキップして直接抽出ステージに進みます。
指定する category は、DocFlow ワークスペースで設定済みのファイルカテゴリでなければなりません。そうでない場合、処理が失敗します。
手動分類は処理時間を節約でき、同じ種類の文書を一括処理するシーンに特に適しています。

​
利用シーン

  1. 同一種類の文書の一括処理：請求書、契約書などの一括処理
  2. 文書タイプが既知の場合：ファイルアップロード前に文書カテゴリが確定している場合
  3. 処理効率の向上：分類ステップをスキップして直接抽出ステージに進む

​
アップロード時にカテゴリを指定

ファイルアップロード API に category パラメータを追加して手動分類を行います。 
curl -X POST \
  -H "x-ti-app-id: <your-app-id>" \
  -H "x-ti-secret-code: <your-secret-code>" \
  -F "file=@/path/to/invoice.pdf" \
  "https://docflow.textin.ai/api/app-api/sip/platform/v2/file/upload?workspace_id=<your-workspace-id>&category=invoice"

​
一括アップロード時にカテゴリを指定

一括アップロードの場合、すべてのファイルに同じカテゴリを指定できます。 
curl -X POST \
  -H "x-ti-app-id: <your-app-id>" \
  -H "x-ti-secret-code: <your-secret-code>" \
  -F "file=@/path/to/invoice1.pdf" \
  -F "file=@/path/to/invoice2.pdf" \
  -F "file=@/path/to/invoice3.pdf" \
  "https://docflow.textin.ai/api/app-api/sip/platform/v2/file/upload?workspace_id=<your-workspace-id>&category=invoice&batch_number=INV-2024-001"

​
処理ワークフローの比較

​
自動分類ワークフロー

アップロード → 解析 → 自動分類 → 抽出 → 完了

​
手動分類ワークフロー

アップロード（カテゴリ指定） → 解析 → 抽出 → 完了

​
注意事項

  1. カテゴリが設定済みであること: 指定する category は DocFlow ワークスペースで設定済みである必要があります。そうでない場合、エラーが返されます
  2. カテゴリ名の一致: カテゴリ名は設定された内容と完全に一致する必要があります（大文字・小文字を区別）
  3. 処理ステータス: 手動分類されたファイルは、確認結果で分類ステータスを直接スキップします
  4. エラーハンドリング: 指定されたカテゴリが存在しない場合、ファイル処理が失敗します。事前にファイルカテゴリの設定でカテゴリが正しく設定されていることを確認してください

​
処理結果の確認

手動分類されたファイルの処理が完了した後、file/fetch API で結果を確認できます。 
curl \
  -H "x-ti-app-id: <your-app-id>" \
  -H "x-ti-secret-code: <your-secret-code>" \
  "https://docflow.textin.ai/api/app-api/sip/platform/v2/file/fetch?workspace_id=<your-workspace-id>&file_id=<your-file-id>"

​
レスポンス例

{
  "code": 200,
  "result": {
    "files": [
      {
        "id": "202412190001",
        "name": "invoice_sample.pdf",
        "category": "invoice",
        "recognition_status": 1,
        "extract_result": {
          // Extraction result fields
        }
      }
    ]
  }
}

​
中国語ファイルカテゴリのパラメータ指定

中国語やその他の非英語ファイルカテゴリを指定する場合、category パラメータに対して UTF-8 URL エンコーディングを行う必要があります。

​
エンコーディング例

urllib.parse.quote() 関数を使用して中国語のカテゴリ名を URL エンコードします。
# Using encoded Chinese category
curl -X POST \
  -H "x-ti-app-id: <your-app-id>" \
  -H "x-ti-secret-code: <your-secret-code>" \
  -F "file=@/path/to/invoice.pdf" \
  "https://docflow.textin.ai/api/app-api/sip/platform/v2/file/upload?workspace_id=<your-workspace-id>&category=%E5%8F%91%E7%A5%A8"