バッチ処理は、大量のリクエストを効率的に処理するための強力なアプローチです。リクエストを1つずつ即時レスポンスで処理する代わりに、バッチ処理では複数のリクエストをまとめて非同期処理のために送信できます。このパターンは以下の場合に特に有用です:

  • 大量のデータを処理する必要がある場合
  • 即時のレスポンスが不要な場合
  • コスト効率を最適化したい場合
  • 大規模な評価や分析を実行している場合

Message Batches APIは、このパターンの最初の実装です。


Message Batches API

Message Batches APIは、大量のMessagesリクエストを非同期で処理する強力でコスト効率の良い方法です。このアプローチは即時のレスポンスを必要としないタスクに適しており、ほとんどのバッチは1時間以内に完了し、コストを50%削減しながらスループットを向上させます。

このガイドに加えて、API リファレンスを直接参照することもできます。

Message Batches APIの仕組み

Message Batches APIにリクエストを送信すると:

  1. システムは提供されたMessagesリクエストで新しいMessage Batchを作成します。
  2. バッチは非同期で処理され、各リクエストは独立して処理されます。
  3. バッチのステータスをポーリングし、すべてのリクエストの処理が終了したら結果を取得できます。

これは、即時の結果を必要としない以下のような一括操作に特に有用です:

  • 大規模な評価:数千のテストケースを効率的に処理
  • コンテンツモデレーション:大量のユーザー生成コンテンツを非同期で分析
  • データ分析:大規模なデータセットに対するインサイトや要約の生成
  • 一括コンテンツ生成:様々な目的(例:商品説明、記事の要約)のための大量のテキスト作成

バッチの制限

  • Message Batchは、10万件のMessageリクエストまたは256 MBのサイズのいずれか先に到達した方に制限されます。
  • 各バッチはできるだけ早く処理され、ほとんどのバッチは1時間以内に完了します。すべてのメッセージが完了した時点、または24時間後のいずれか早い方でバッチ結果にアクセスできます。24時間以内に処理が完了しないバッチは期限切れとなります。
  • バッチ結果は作成後29日間利用可能です。その後もバッチは表示できますが、結果はダウンロードできなくなります。
  • Claude 3.7 Sonnetは拡張出力機能を使用して最大128Kトークンをサポートします。
  • バッチはワークスペースにスコープされています。APIキーが属するワークスペース内で作成されたすべてのバッチとその結果を表示できます。
  • レート制限は、Batches APIのHTTPリクエストと、処理待ちのバッチ内のリクエスト数の両方に適用されます。Message Batches APIのレート制限を参照してください。さらに、現在の需要とリクエスト量に基づいて処理を遅くする場合があります。その場合、24時間後に期限切れとなるリクエストが増える可能性があります。
  • 高スループットと並行処理により、バッチはワークスペースの設定された支出制限をわずかに超える可能性があります。

サポートされているモデル

Message Batches APIは現在、以下をサポートしています:

  • Claude 3.7 Sonnet (claude-3-7-sonnet-20250219)
  • Claude 3.5 Sonnet (claude-3-5-sonnet-20240620およびclaude-3-5-sonnet-20241022)
  • Claude 3.5 Haiku (claude-3-5-haiku-20241022)
  • Claude 3 Haiku (claude-3-haiku-20240307)
  • Claude 3 Opus (claude-3-opus-20240229)

バッチ処理可能なもの

Messages APIに送信できるリクエストはすべてバッチに含めることができます。これには以下が含まれます:

  • Vision
  • ツールの使用
  • システムメッセージ
  • マルチターン会話
  • すべてのベータ機能

バッチ内の各リクエストは独立して処理されるため、1つのバッチ内で異なるタイプのリクエストを混在させることができます。


価格設定

Batches APIは大幅なコスト削減を提供します。すべての使用量は標準APIの価格の50%で課金されます。

モデルバッチ入力バッチ出力
Claude 3.7 Sonnet$1.50 / MTok$7.50 / MTok
Claude 3.5 Sonnet$1.50 / MTok$7.50 / MTok
Claude 3 Opus$7.50 / MTok$37.50 / MTok
Claude 3.5 Haiku$0.40 / MTok$2 / MTok
Claude 3 Haiku$0.125 / MTok$0.625 / MTok

Message Batches APIの使用方法

バッチの準備と作成

Message Batchは、Messageを作成するためのリクエストのリストで構成されます。個々のリクエストの形式は以下で構成されます:

  • Messagesリクエストを識別するための一意のcustom_id
  • 標準のMessages APIパラメータを含むparamsオブジェクト

バッチを作成するには、このリストをrequestsパラメータに渡します:

curl https://api.anthropic.com/v1/messages/batches \
     --header "x-api-key: $ANTHROPIC_API_KEY" \
     --header "anthropic-version: 2023-06-01" \
     --header "content-type: application/json" \
     --data \
'{
    "requests": [
        {
            "custom_id": "my-first-request",
            "params": {
                "model": "claude-3-7-sonnet-20250219",
                "max_tokens": 1024,
                "messages": [
                    {"role": "user", "content": "Hello, world"}
                ]
            }
        },
        {
            "custom_id": "my-second-request",
            "params": {
                "model": "claude-3-7-sonnet-20250219",
                "max_tokens": 1024,
                "messages": [
                    {"role": "user", "content": "Hi again, friend"}
                ]
            }
        }
    ]
}'

この例では、2つの別々のリクエストが非同期処理のためにバッチ処理されています。各リクエストには一意のcustom_idがあり、Messages APIで使用する標準パラメータが含まれています。

Messages APIでバッチリクエストをテストする

各メッセージリクエストのparamsオブジェクトのバリデーションは非同期で実行され、バリデーションエラーはバッチ全体の処理が終了したときに返されます。リクエストの形式が正しく構築されていることを確認するために、まずMessages APIでリクエストの形式を検証することができます。

バッチが最初に作成されると、レスポンスの処理ステータスはin_progressになります。

JSON
{
  "id": "msgbatch_01HkcTjaV5uDC8jWR4ZsDV8d",
  "type": "message_batch",
  "processing_status": "in_progress",
  "request_counts": {
    "processing": 2,
    "succeeded": 0,
    "errored": 0,
    "canceled": 0,
    "expired": 0
  },
  "ended_at": null,
  "created_at": "2024-09-24T18:37:24.100435Z",
  "expires_at": "2024-09-25T18:37:24.100435Z",
  "cancel_initiated_at": null,
  "results_url": null
}

バッチの追跡

Message Batchのprocessing_statusフィールドは、バッチの処理段階を示します。最初はin_progressで始まり、バッチ内のすべてのリクエストの処理が完了し、結果が準備できるとendedに更新されます。コンソールを訪れるか、取得エンドポイントを使用してバッチの状態を監視できます:

curl https://api.anthropic.com/v1/messages/batches/msgbatch_01HkcTjaV5uDC8jWR4ZsDV8d \
 --header "x-api-key: $ANTHROPIC_API_KEY" \
 --header "anthropic-version: 2023-06-01" \
 | sed -E 's/.*"id":"([^"]+)".*"processing_status":"([^"]+)".*/Batch \1 processing status is \2/'

処理が終了したことを知るために、このエンドポイントをポーリングすることができます。

バッチ結果の取得

バッチ処理が終了すると、バッチ内の各Messagesリクエストに結果が得られます。結果のタイプは4つあります:

結果タイプ説明
succeededリクエストは成功しました。メッセージ結果が含まれます。
erroredリクエストでエラーが発生し、メッセージは作成されませんでした。無効なリクエストや内部サーバーエラーなどが考えられます。これらのリクエストには課金されません。
canceledこのリクエストがモデルに送信される前にユーザーがバッチをキャンセルしました。これらのリクエストには課金されません。
expiredこのリクエストがモデルに送信される前にバッチが24時間の期限に達しました。これらのリクエストには課金されません。

バッチのrequest_countsで結果の概要を確認でき、これらの4つの状態それぞれに達したリクエスト数が表示されます。

バッチの結果は、Message Batchのresults_urlプロパティでダウンロードでき、組織の権限が許可する場合はコンソールでも利用できます。結果のサイズが大きくなる可能性があるため、すべてを一度にダウンロードするのではなく、結果をストリーミングすることをお勧めします。

#!/bin/sh
curl "https://api.anthropic.com/v1/messages/batches/msgbatch_01HkcTjaV5uDC8jWR4ZsDV8d" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_API_KEY" \
  | grep -o '"results_url":[[:space:]]*"[^"]*"' \
  | cut -d'"' -f4 \
  | while read -r url; do
    curl -s "$url" \
      --header "anthropic-version: 2023-06-01" \
      --header "x-api-key: $ANTHROPIC_API_KEY" \
      | sed 's/}{/}\n{/g' \
      | while IFS= read -r line
    do
      result_type=$(echo "$line" | sed -n 's/.*"result":[[:space:]]*{[[:space:]]*"type":[[:space:]]*"\([^"]*\)".*/\1/p')
      custom_id=$(echo "$line" | sed -n 's/.*"custom_id":[[:space:]]*"\([^"]*\)".*/\1/p')
      error_type=$(echo "$line" | sed -n 's/.*"error":[[:space:]]*{[[:space:]]*"type":[[:space:]]*"\([^"]*\)".*/\1/p')

      case "$result_type" in
        "succeeded")
          echo "Success! $custom_id"
          ;;
        "errored")
          if [ "$error_type" = "invalid_request" ]; then
            # リクエストの本文を修正してから再送信する必要があります
            echo "Validation error: $custom_id"
          else
            # リクエストを直接再試行できます
            echo "Server error: $custom_id"
          fi
          ;;
        "expired")
          echo "Expired: $line"
          ;;
      esac
    done
  done

結果は.jsonl形式で、各行がMessage Batch内の単一のリクエストの結果を表す有効なJSONオブジェクトです。ストリーミングされた各結果に対して、そのcustom_idと結果タイプに応じて異なる処理を行うことができます。以下は結果の例です:

.jsonl file
{"custom_id":"my-second-request","result":{"type":"succeeded","message":{"id":"msg_014VwiXbi91y3JMjcpyGBHX5","type":"message","role":"assistant","model":"claude-3-7-sonnet-20250219","content":[{"type":"text","text":"Hello again! It's nice to see you. How can I assist you today? Is there anything specific you'd like to chat about or any questions you have?"}],"stop_reason":"end_turn","stop_sequence":null,"usage":{"input_tokens":11,"output_tokens":36}}}}
{"custom_id":"my-first-request","result":{"type":"succeeded","message":{"id":"msg_01FqfsLoHwgeFbguDgpz48m7","type":"message","role":"assistant","model":"claude-3-7-sonnet-20250219","content":[{"type":"text","text":"Hello! How can I assist you today? Feel free to ask me any questions or let me know if there's anything you'd like to chat about."}],"stop_reason":"end_turn","stop_sequence":null,"usage":{"input_tokens":10,"output_tokens":34}}}}

結果にエラーがある場合、そのresult.errorは標準のエラー形式に設定されます。

バッチ結果は入力順序と一致しない場合があります

バッチ結果は任意の順序で返される可能性があり、バッチ作成時のリクエストの順序と一致しない場合があります。上記の例では、2番目のバッチリクエストの結果が最初のものより前に返されています。結果を対応するリクエストと正しくマッチさせるために、常にcustom_idフィールドを使用してください。

Message Batchesでのプロンプトキャッシュの使用

Message Batches APIはプロンプトキャッシュをサポートしており、バッチリクエストのコストと処理時間を潜在的に削減することができます。プロンプトキャッシュとMessage Batchesの価格割引は重ねることができ、両方の機能を一緒に使用するとさらに大きなコスト削減が可能です。ただし、バッチリクエストは非同期かつ並行して処理されるため、キャッシュヒットはベストエフォートで提供されます。ユーザーは通常、トラフィックパターンに応じて30%から98%のキャッシュヒット率を経験します。

バッチリクエストでキャッシュヒットの可能性を最大化するには:

  1. バッチ内のすべてのMessageリクエストに同一のcache_controlブロックを含める
  2. キャッシュエントリが5分の寿命で期限切れになるのを防ぐため、安定したリクエストストリームを維持する
  3. できるだけ多くのキャッシュされたコンテンツを共有できるようにリクエストを構造化する

バッチでプロンプトキャッシュを実装する例:

curl https://api.anthropic.com/v1/messages/batches \
     --header "x-api-key: $ANTHROPIC_API_KEY" \
     --header "anthropic-version: 2023-06-01" \
     --header "content-type: application/json" \
     --data \
'{
    "requests": [
        {
            "custom_id": "my-first-request",
            "params": {
                "model": "claude-3-7-sonnet-20250219",
                "max_tokens": 1024,
                "system": [
                    {
                        "type": "text",
                        "text": "You are an AI assistant tasked with analyzing literary works. Your goal is to provide insightful commentary on themes, characters, and writing style.\n"
                    },
                    {
                        "type": "text",
                        "text": "<the entire contents of Pride and Prejudice>",
                        "cache_control": {"type": "ephemeral"}
                    }
                ],
                "messages": [
                    {"role": "user", "content": "Analyze the major themes in Pride and Prejudice."}
                ]
            }
        },
        {
            "custom_id": "my-second-request",
            "params": {
                "model": "claude-3-7-sonnet-20250219",
                "max_tokens": 1024,
                "system": [
                    {
                        "type": "text",
                        "text": "You are an AI assistant tasked with analyzing literary works. Your goal is to provide insightful commentary on themes, characters, and writing style.\n"
                    },
                    {
                        "type": "text",
                        "text": "<the entire contents of Pride and Prejudice>",
                        "cache_control": {"type": "ephemeral"}
                    }
                ],
                "messages": [
                    {"role": "user", "content": "Write a summary of Pride and Prejudice."}
                ]
            }
        }
    ]
}'

この例では、バッチ内の両方のリクエストに同一のシステムメッセージとcache_controlでマークされたPride and Prejudiceの全文が含まれており、キャッシュヒットの可能性を高めています。

効果的なバッチ処理のベストプラクティス

Batches APIを最大限活用するには:

  • バッチ処理のステータスを定期的に監視し、失敗したリクエストに適切な再試行ロジックを実装する。
  • 順序が保証されないため、結果をリクエストと簡単にマッチングできるよう、意味のあるcustom_id値を使用する。
  • より良い管理のために、非常に大きなデータセットを複数のバッチに分割することを検討する。
  • バリデーションエラーを避けるため、Messages APIで単一のリクエスト形式を事前テストする。

一般的な問題のトラブルシューティング

予期しない動作が発生した場合:

  • バッチリクエストの総サイズが256 MBを超えていないことを確認する。リクエストサイズが大きすぎる場合、413 request_too_largeエラーが発生する可能性があります。
  • バッチ内のすべてのリクエストでサポートされているモデルを使用していることを確認する。
  • バッチ内の各リクエストに一意のcustom_idがあることを確認する。
  • バッチのcreated_at時間(処理のended_at時間ではない)から29日未満であることを確認する。29日を超えると、結果は表示できなくなります。
  • バッチがキャンセルされていないことを確認する。

バッチ内の1つのリクエストの失敗は、他のリクエストの処理には影響しないことに注意してください。


バッチのストレージとプライバシー

  • ワークスペースの分離: バッチは作成されたワークスペース内で分離されています。そのワークスペースに関連付けられたAPIキー、またはコンソールでワークスペースのバッチを表示する権限を持つユーザーのみがアクセスできます。

  • 結果の利用可能性: バッチ結果はバッチ作成後29日間利用可能で、取得と処理のための十分な時間が確保されています。


FAQ