批量处理是一种高效处理大量请求的强大方法。与逐一处理请求并立即返回响应不同,批量处理允许您将多个请求一起提交以进行异步处理。这种模式在以下情况下特别有用:
Message Batches API 是 Anthropic 对这种模式的首次实现。
This feature is not eligible for Zero Data Retention (ZDR). Data is retained according to the feature's standard retention policy.
Message Batches API 是一种强大且经济高效的方式,用于异步处理大量 Messages 请求。这种方法非常适合不需要立即响应的任务,大多数批次在不到 1 小时内完成,同时将成本降低 50% 并提高吞吐量。
除本指南外,您还可以直接浏览 API 参考。
当您向 Message Batches API 发送请求时:
这对于不需要立即结果的批量操作特别有用,例如:
所有活跃模型均支持 Message Batches API。
您可以向 Messages API 发出的任何请求都可以包含在批次中。这包括:
由于批次中的每个请求都是独立处理的,您可以在单个批次中混合不同类型的请求。
由于批次处理时间可能超过 5 分钟,在处理具有共享上下文的批次时,请考虑将1 小时缓存持续时间与提示缓存结合使用,以获得更好的缓存命中率。
Batches API 提供显著的成本节省。所有使用量按标准 API 价格的 50% 收费。
| Model | Batch input | Batch output |
|---|---|---|
| Claude Opus 4.6 | $2.50 / MTok | $12.50 / MTok |
| Claude Opus 4.5 | $2.50 / MTok | $12.50 / MTok |
| Claude Opus 4.1 | $7.50 / MTok | $37.50 / MTok |
| Claude Opus 4 | $7.50 / MTok | $37.50 / MTok |
| Claude Sonnet 4.6 | $1.50 / MTok | $7.50 / MTok |
| Claude Sonnet 4.5 | $1.50 / MTok | $7.50 / MTok |
| Claude Sonnet 4 | $1.50 / MTok | $7.50 / MTok |
| Claude Sonnet 3.7 (deprecated) | $1.50 / MTok | $7.50 / MTok |
| Claude Haiku 4.5 | $0.50 / MTok | $2.50 / MTok |
| Claude Haiku 3.5 | $0.40 / MTok | $2 / MTok |
| Claude Opus 3 (deprecated) | $7.50 / MTok | $37.50 / MTok |
| Claude Haiku 3 | $0.125 / MTok | $0.625 / MTok |
一个 Message Batch 由一系列创建 Message 的请求组成。单个请求的结构包括:
custom_idparams 对象您可以通过将此列表传入 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-6",
"max_tokens": 1024,
"messages": [
{"role": "user", "content": "Hello, world"}
]
}
},
{
"custom_id": "my-second-request",
"params": {
"model": "claude-opus-4-6",
"max_tokens": 1024,
"messages": [
{"role": "user", "content": "Hi again, friend"}
]
}
}
]
}'在此示例中,两个独立的请求被批量在一起进行异步处理。每个请求都有一个唯一的 custom_id,并包含您在 Messages API 调用中使用的标准参数。
使用 Messages API 测试您的批次请求
每个消息请求的 params 对象的验证是异步执行的,验证错误在整个批次处理结束时返回。您可以通过先使用 Messages 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
}Message Batch 的 processing_status 字段指示批次所处的处理阶段。它从 in_progress 开始,然后在批次中所有请求完成处理且结果准备就绪后更新为 ended。您可以通过访问控制台或使用检索端点来监控批次状态。
要轮询 Message Batch,您需要其 id,该 id 在创建批次时的响应中提供,或通过列出批次获取。您可以实现一个轮询循环,定期检查批次状态,直到处理结束:
import anthropic
import time
client = anthropic.Anthropic()
message_batch = None
while True:
message_batch = client.messages.batches.retrieve(MESSAGE_BATCH_ID)
if message_batch.processing_status == "ended":
break
print(f"Batch {MESSAGE_BATCH_ID} is still processing...")
time.sleep(60)
print(message_batch)您可以使用列表端点列出工作区中的所有 Message Batches。API 支持分页,根据需要自动获取额外页面:
import anthropic
client = anthropic.Anthropic()
# 根据需要自动获取更多页面。
for message_batch in client.messages.batches.list(limit=20):
print(message_batch)批次处理结束后,批次中的每个 Messages 请求都将有一个结果。共有 4 种结果类型:
| 结果类型 | 描述 |
|---|---|
succeeded | 请求成功。包含消息结果。 |
errored | 请求遇到错误,未创建消息。可能的错误包括无效请求和内部服务器错误。这些请求不会向您收费。 |
canceled | 用户在此请求发送到模型之前取消了批次。这些请求不会向您收费。 |
expired | 批次在此请求发送到模型之前达到了 24 小时过期时间。这些请求不会向您收费。 |
您将通过批次的 request_counts 看到结果概览,其中显示有多少请求达到了这四种状态中的每一种。
批次结果可在 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
# Request body must be fixed before re-sending request
echo "Validation error: $custom_id"
else
# Request can be retried directly
echo "Server error: $custom_id"
fi
;;
"expired")
echo "Expired: $line"
;;
esac
done
done
结果将采用 .jsonl 格式,其中每行是一个有效的 JSON 对象,表示 Message Batch 中单个请求的结果。对于每个流式传输的结果,您可以根据其 custom_id 和结果类型执行不同的操作。以下是一组示例结果:
{"custom_id":"my-second-request","result":{"type":"succeeded","message":{"id":"msg_014VwiXbi91y3JMjcpyGBHX5","type":"message","role":"assistant","model":"claude-opus-4-6","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-6","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 将被设置为标准错误形状。
批次结果可能与输入顺序不匹配
批次结果可以以任何顺序返回,可能与创建批次时的请求顺序不匹配。在上面的示例中,第二个批次请求的结果在第一个之前返回。要正确地将结果与其对应的请求匹配,请始终使用 custom_id 字段。
您可以使用取消端点取消当前正在处理的 Message Batch。取消后立即,批次的 processing_status 将为 canceling。您可以使用上述相同的轮询技术等待取消完成。已取消的批次最终状态为 ended,可能包含取消前已处理的请求的部分结果。
import anthropic
client = anthropic.Anthropic()
message_batch = client.messages.batches.cancel(
MESSAGE_BATCH_ID,
)
print(message_batch)响应将显示批次处于 canceling 状态:
{
"id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
"type": "message_batch",
"processing_status": "canceling",
"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": "2024-09-24T18:39:03.114875Z",
"results_url": null
}消息批处理 API 支持提示缓存,可帮助您降低批量请求的成本并缩短处理时间。提示缓存和消息批处理的价格折扣可以叠加,当两个功能同时使用时可获得更大的成本节省。但是,由于批量请求是异步并发处理的,缓存命中是尽力而为的。用户通常会根据其流量模式获得 30% 到 98% 的缓存命中率。
为了最大化批量请求中缓存命中的可能性:
cache_control 块在批次中实现提示缓存的示例:
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-6",
"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-6",
"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 的《傲慢与偏见》全文,以提高缓存命中的可能性。
为了充分利用批处理 API:
custom_id 值,以便轻松将结果与请求匹配,因为顺序不能保证。如果遇到意外行为:
request_too_large 错误。custom_id。created_at(而非处理 ended_at)时间起不超过 29 天。如果超过 29 天,结果将不再可查看。请注意,批次中一个请求的失败不会影响其他请求的处理。
工作区隔离:批次在创建它们的工作区内隔离。只有与该工作区关联的 API 密钥,或在控制台中具有查看工作区批次权限的用户才能访问它们。
结果可用性:批次结果在批次创建后 29 天内可用,提供充足的时间进行检索和处理。
批处理会在批次创建后最多 29 天内存储请求和响应数据。您可以在处理完成后随时使用 DELETE /v1/messages/batches/{batch_id} 端点删除消息批次。异步处理需要在服务器端存储输入和输出,直到批次完成并检索结果。
有关所有功能的 ZDR 资格,请参阅 API 和数据保留。
Was this page helpful?