メインコンテンツへスキップ
抽出が完了したタスクに対して、特定フィールド抽出 API を使用して、追加フィールドの抽出や既存の個別フィールドの再抽出を行うことができます。この API は全フィールドの完全な抽出結果を返します。

機能

  • 追加フィールドの抽出:抽出済みタスクに新しいフィールド抽出を追加
  • フィールドの再抽出:既存フィールドを再抽出し、抽出結果の修正や最適化に利用可能
  • テーブルフィールド対応:テーブル内の特定フィールドを抽出可能
  • 完全な結果を返却: 全フィールドの完全な抽出結果を返し、構造は /api/app-api/sip/platform/v2/file/fetch と同じ

フィールド抽出ルール

API は、フィールドが元の分類設定に存在するかどうかに基づいて、異なる抽出戦略を採用します。

追加フィールド(元の結果に存在しないフィールド)

元の抽出結果に存在しないフィールド(追加フィールド)に対しては、リクエストで指定された prompt を使用して抽出を行います:
  • リクエストで prompt が指定されている場合、それを使用してフィールド抽出をガイドします
  • リクエストで prompt が指定されていない場合、デフォルトの抽出ロジックが使用されます
利用シーン:分類設定で定義されていない新しいフィールドを文書から抽出する必要がある場合。

設定済みフィールド(元の分類設定に既に存在するフィールド)

元の分類設定に既に存在するフィールドに対しては、分類設定の内容を優先して抽出を行います:
  • 分類設定の prompt を使用(設定されている場合)
  • 分類設定の後処理ルールを適用
  • リクエストで渡された prompt パラメータは無視されます
利用シーン:既存フィールドを再抽出し、統一された分類設定ルールを使用して抽出結果の一貫性を維持する場合。

使用上の推奨事項

  • 新しいフィールドを抽出する場合:リクエストで prompt を指定すると、システムはその prompt を使用して抽出を行います
  • 既存フィールドを再抽出する場合key を指定するだけで、システムが自動的に分類設定のルールを使用します。リクエストで prompt を指定する必要はありません

API エンドポイント

エンドポイント: POST /api/app-api/sip/platform/v2/file/extract_fields リクエストパラメータ:

フィールド構造

ExtractFieldReqVO:
テーブル構造:

サンプルコード

リクエスト例

基本フィールドのみを抽出

テーブルフィールドのみを抽出

基本フィールドとテーブルフィールドの両方を抽出

返却データ例

注意事項

  1. タスクステータス:この API は抽出が完了したタスク(recognition_status が 1 または 2)にのみ適用されます
  2. フィールド名key フィールド名は、設定済みフィールドテンプレートのフィールド名(設定済みフィールドの場合)またはカスタム名(追加フィールドの場合)と一致する必要があります
  3. フィールドヒント(prompt)
    • 追加フィールド(元の結果に存在しない)の場合、prompt が有効になり、抽出ロジックをガイドするために使用できます
    • 設定済みフィールド(元の分類設定に既に存在する)の場合、prompt は無視され、システムは分類設定のルールを使用します
  4. レスポンス: API は全フィールドの完全な抽出結果を返します。以前に抽出されたフィールドと新しく抽出されたフィールドの両方が含まれます
  5. テーブル名tables 内の name は、文書内の実際のテーブル名と一致する必要があります

関連ページ