バッチ処理は、大量のリクエストを効率的に処理するための強力なアプローチです。リクエストを一度に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は、100,000件のMessageリクエストまたは256 MBのサイズのいずれか先に達した方に制限されます。
  • 各バッチはできるだけ早く処理され、ほとんどのバッチは1時間以内に完了します。すべてのメッセージが完了した時点、または24時間後のいずれか早い方でバッチ結果にアクセスできます。24時間以内に処理が完了しないバッチは期限切れになります。
  • バッチ結果は作成後29日間利用可能です。その後もバッチを表示できますが、結果はダウンロードできなくなります。
  • バッチはワークスペースにスコープされています。APIキーが属するワークスペース内で作成されたすべてのバッチとその結果を表示できます。
  • レート制限は、Batches API HTTPリクエストと処理待ちのバッチ内のリクエスト数の両方に適用されます。Message Batches APIのレート制限を参照してください。さらに、現在の需要とリクエスト量に基づいて処理速度が遅くなる場合があります。その場合、24時間後に期限切れになるリクエストが増える可能性があります。
  • 高いスループットと並行処理のため、バッチはワークスペースの設定された支出制限をわずかに超える場合があります。

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

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

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

​
バッチ処理できるもの

Messages APIに対して行えるリクエストはすべてバッチに含めることができます。これには以下が含まれます：

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

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

​
価格設定

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

ModelBatch inputBatch output
Claude Opus 4$7.50 / MTok$37.50 / MTok
Claude Sonnet 4$1.50 / MTok$7.50 / MTok
Claude Sonnet 3.7$1.50 / MTok$7.50 / MTok
Claude Sonnet 3.5$1.50 / MTok$7.50 / MTok
Claude Haiku 3.5$0.40 / MTok$2 / MTok
Claude Opus 3$7.50 / MTok$37.50 / MTok
Claude Haiku 3$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-opus-4-20250514",
                "max_tokens": 1024,
                "messages": [
                    {"role": "user", "content": "Hello, world"}
                ]
            }
        },
        {
            "custom_id": "my-second-request",
            "params": {
                "model": "claude-opus-4-20250514",
                "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-opus-4-20250514","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-opus-4-20250514","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-opus-4-20250514",
                "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-opus-4-20250514",
                "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でマークされたプライドと偏見の全文が含まれており、キャッシュヒットの可能性を高めています。

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

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

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

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

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

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

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

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

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

  • 結果の可用性：バッチ結果はバッチが作成されてから29日間利用可能で、取得と処理のための十分な時間を提供します。

​
FAQ