メッセージバッチ

メッセージバッチAPIは、大量のメッセージリクエストを非同期で処理する強力で費用対効果の高い方法です。このアプローチは即時の応答を必要としないタスクに適しており、コストを50%削減しながらスループットを向上させます。

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

​

メッセージバッチAPIの仕組み

メッセージバッチAPIにリクエストを送信すると：

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

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

• 大規模な評価：数千のテストケースを効率的に処理
• コンテンツモデレーション：大量のユーザー生成コンテンツを非同期で分析
• データ分析：大規模なデータセットの洞察や要約を生成
• 一括コンテンツ生成：様々な目的（製品説明、記事の要約など）のための大量のテキスト作成

​

バッチの制限

• メッセージバッチは、100,000件のメッセージリクエストまたは256 MBのサイズのいずれか先に達した方に制限されます。
• バッチは応答の生成に最大24時間かかりますが、処理はそれより早く終了する場合があります。バッチの結果は、バッチ全体の処理が終了するまで利用できません。24時間以内に処理が完了しないバッチは期限切れとなります。
• バッチ結果は作成後29日間利用可能です。それ以降もバッチの閲覧は可能ですが、結果のダウンロードはできなくなります。
• バッチはワークスペース内でスコープ化されています。APIキーが属するワークスペース内で作成されたすべてのバッチとその結果を閲覧できます。
• レート制限は、バッチAPIのHTTPリクエストと処理待ちのバッチ内のリクエスト数の両方に適用されます。メッセージバッチAPIのレート制限を参照してください。また、現在の需要とリクエスト量に基づいて処理速度が遅くなる場合があります。その場合、24時間後に期限切れとなるリクエストが増える可能性があります。
• 高スループットと並行処理のため、バッチはワークスペースの設定された支出制限をわずかに超える場合があります。

​

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

メッセージバッチAPIは現在、以下をサポートしています：

• 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)

​

バッチ処理可能なもの

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

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

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

​

価格設定

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

​

メッセージバッチAPIの使用方法

​

バッチの準備と作成

メッセージバッチは、メッセージを作成するリクエストのリストで構成されています。個々のリクエストの形式は以下で構成されます：

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

このリストをrequestsパラメータに渡してバッチを作成できます：

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

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

{
  "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
}

​

バッチの追跡

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

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

​

バッチ結果の取得

バッチ処理が終了すると、バッチ内の各メッセージリクエストに結果が設定されます。結果には4つのタイプがあります：

バッチのrequest_countsで、これら4つの状態それぞれに何件のリクエストが達したかの概要を確認できます。

バッチの結果は、コンソールとメッセージバッチのresults_urlの両方でダウンロードできます。結果のサイズが大きくなる可能性があるため、すべてを一度にダウンロードするのではなく、結果をストリーミングすることをお勧めします。

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

{"custom_id":"my-second-request","result":{"type":"succeeded","message":{"id":"msg_014VwiXbi91y3JMjcpyGBHX5","type":"message","role":"assistant","model":"claude-3-5-sonnet-20241022","content":[{"type":"text","text":"こんにちは！お会いできて嬉しいです。今日はどのようにお手伝いできますか？特にお話ししたいことや質問はありますか？"}],"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-5-sonnet-20241022","content":[{"type":"text","text":"こんにちは！どのようにお手伝いできますか？質問や話したいことがありましたら、お気軽にお申し付けください。"}],"stop_reason":"end_turn","stop_sequence":null,"usage":{"input_tokens":10,"output_tokens":34}}}}

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

​

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

バッチAPIを最大限活用するために：

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

​

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

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

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

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

​

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

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

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

​

よくある質問

import anthropic

client = anthropic.Anthropic()

message_batch = client.beta.messages.batches.create(
    betas: ["max-tokens-3-5-sonnet-2024-07-15"],
    ...
)