Le traitement par lots est une approche puissante pour gérer efficacement de gros volumes de requêtes. Au lieu de traiter les requêtes une par une avec des réponses immédiates, le traitement par lots vous permet de soumettre plusieurs requêtes ensemble pour un traitement asynchrone. Ce modèle est particulièrement utile lorsque :

• Vous devez traiter de gros volumes de données
• Les réponses immédiates ne sont pas requises
• Vous voulez optimiser l’efficacité des coûts
• Vous effectuez des évaluations ou analyses à grande échelle

L’API Message Batches est notre première implémentation de ce modèle.

​

API Message Batches

L’API Message Batches est un moyen puissant et rentable de traiter de manière asynchrone de gros volumes de requêtes Messages. Cette approche est bien adaptée aux tâches qui ne nécessitent pas de réponses immédiates, la plupart des lots se terminant en moins d’1 heure tout en réduisant les coûts de 50% et en augmentant le débit.

Vous pouvez explorer directement la référence API, en plus de ce guide.

​

Comment fonctionne l’API Message Batches

Lorsque vous envoyez une requête à l’API Message Batches :

1. Le système crée un nouveau Message Batch avec les requêtes Messages fournies.
2. Le lot est ensuite traité de manière asynchrone, chaque requête étant gérée indépendamment.
3. Vous pouvez interroger le statut du lot et récupérer les résultats lorsque le traitement est terminé pour toutes les requêtes.

Ceci est particulièrement utile pour les opérations en masse qui ne nécessitent pas de résultats immédiats, telles que :

• Évaluations à grande échelle : Traiter efficacement des milliers de cas de test.
• Modération de contenu : Analyser de gros volumes de contenu généré par les utilisateurs de manière asynchrone.
• Analyse de données : Générer des insights ou des résumés pour de gros ensembles de données.
• Génération de contenu en masse : Créer de grandes quantités de texte à diverses fins (par exemple, descriptions de produits, résumés d’articles).

​

Limitations des lots

• Un Message Batch est limité à soit 100 000 requêtes Message ou 256 MB de taille, selon ce qui est atteint en premier.
• Nous traitons chaque lot aussi rapidement que possible, la plupart des lots se terminant dans l’heure. Vous pourrez accéder aux résultats du lot lorsque tous les messages seront terminés ou après 24 heures, selon ce qui arrive en premier. Les lots expireront si le traitement ne se termine pas dans les 24 heures.
• Les résultats des lots sont disponibles pendant 29 jours après la création. Après cela, vous pouvez toujours voir le Batch, mais ses résultats ne seront plus disponibles au téléchargement.
• Les lots sont limités à un Workspace. Vous pouvez voir tous les lots—et leurs résultats—qui ont été créés dans le Workspace auquel appartient votre clé API.
• Les limites de taux s’appliquent à la fois aux requêtes HTTP de l’API Batches et au nombre de requêtes dans un lot en attente de traitement. Voir Limites de taux de l’API Message Batches. De plus, nous pouvons ralentir le traitement en fonction de la demande actuelle et de votre volume de requêtes. Dans ce cas, vous pourriez voir plus de requêtes expirer après 24 heures.
• En raison du débit élevé et du traitement concurrent, les lots peuvent légèrement dépasser la limite de dépenses configurée de votre Workspace.

​

Modèles supportés

L’API Message Batches supporte actuellement :

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

​

Ce qui peut être traité par lots

Toute requête que vous pouvez faire à l’API Messages peut être incluse dans un lot. Cela inclut :

• Vision
• Utilisation d’outils
• Messages système
• Conversations multi-tours
• Toutes les fonctionnalités bêta

Puisque chaque requête dans le lot est traitée indépendamment, vous pouvez mélanger différents types de requêtes dans un seul lot.

​

Tarification

L’API Batches offre des économies de coûts significatives. Toute utilisation est facturée à 50% des prix API standard.

​

Comment utiliser l’API Message Batches

​

Préparer et créer votre lot

Un Message Batch est composé d’une liste de requêtes pour créer un Message. La forme d’une requête individuelle comprend :

• Un custom_id unique pour identifier la requête Messages
• Un objet params avec les paramètres standard de l’API Messages

Vous pouvez créer un lot en passant cette liste dans le paramètre 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"}
                ]
            }
        }
    ]
}'

Dans cet exemple, deux requêtes séparées sont regroupées ensemble pour un traitement asynchrone. Chaque requête a un custom_id unique et contient les paramètres standard que vous utiliseriez pour un appel à l’API Messages.

Lorsqu’un lot est créé pour la première fois, la réponse aura un statut de traitement 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
}

​

Suivre votre lot

Le champ processing_status du Message Batch indique l’étape de traitement dans laquelle se trouve le lot. Il commence par in_progress, puis se met à jour à ended une fois que toutes les requêtes du lot ont fini de traiter, et les résultats sont prêts. Vous pouvez surveiller l’état de votre lot en visitant la Console, ou en utilisant le point de terminaison de récupération :

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/'

Vous pouvez interroger ce point de terminaison pour savoir quand le traitement est terminé.

​

Récupérer les résultats du lot

Une fois le traitement du lot terminé, chaque requête Messages dans le lot aura un résultat. Il y a 4 types de résultats :

Vous verrez un aperçu de vos résultats avec les request_counts du lot, qui montrent combien de requêtes ont atteint chacun de ces quatre états.

Les résultats du lot sont disponibles au téléchargement à la propriété results_url sur le Message Batch, et si l’autorisation de l’organisation le permet, dans la Console. En raison de la taille potentiellement importante des résultats, il est recommandé de diffuser les résultats plutôt que de les télécharger tous en une fois.

#!/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

Les résultats seront au format .jsonl, où chaque ligne est un objet JSON valide représentant le résultat d’une seule requête dans le Message Batch. Pour chaque résultat diffusé, vous pouvez faire quelque chose de différent selon son custom_id et son type de résultat. Voici un exemple d’ensemble de résultats :

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

Si votre résultat a une erreur, son result.error sera défini sur notre forme d’erreur standard.

​

Utiliser la mise en cache des prompts avec Message Batches

L’API Message Batches supporte la mise en cache des prompts, vous permettant de potentiellement réduire les coûts et le temps de traitement pour les requêtes de lot. Les remises de tarification de la mise en cache des prompts et des Message Batches peuvent se cumuler, offrant des économies de coûts encore plus importantes lorsque les deux fonctionnalités sont utilisées ensemble. Cependant, puisque les requêtes de lot sont traitées de manière asynchrone et concurrente, les réussites de cache sont fournies sur la base du meilleur effort. Les utilisateurs expérimentent généralement des taux de réussite de cache allant de 30% à 98%, selon leurs modèles de trafic.

Pour maximiser la probabilité de réussites de cache dans vos requêtes de lot :

1. Incluez des blocs cache_control identiques dans chaque requête Message de votre lot
2. Maintenez un flux constant de requêtes pour empêcher les entrées de cache d’expirer après leur durée de vie de 5 minutes
3. Structurez vos requêtes pour partager autant de contenu mis en cache que possible

Exemple d’implémentation de la mise en cache des prompts dans un lot :

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."}
                ]
            }
        }
    ]
}'

Dans cet exemple, les deux requêtes du lot incluent des messages système identiques et le texte complet d’Orgueil et Préjugés marqué avec cache_control pour augmenter la probabilité de réussites de cache.

​

Meilleures pratiques pour un traitement par lots efficace

Pour tirer le meilleur parti de l’API Batches :

• Surveillez régulièrement le statut de traitement des lots et implémentez une logique de nouvelle tentative appropriée pour les requêtes échouées.
• Utilisez des valeurs custom_id significatives pour faire correspondre facilement les résultats avec les requêtes, puisque l’ordre n’est pas garanti.
• Considérez diviser de très gros ensembles de données en plusieurs lots pour une meilleure gérabilité.
• Effectuez un test à blanc d’une seule forme de requête avec l’API Messages pour éviter les erreurs de validation.

​

Dépannage des problèmes courants

Si vous rencontrez un comportement inattendu :

• Vérifiez que la taille totale de la requête de lot ne dépasse pas 256 MB. Si la taille de la requête est trop importante, vous pourriez obtenir une erreur 413 request_too_large.
• Vérifiez que vous utilisez des modèles supportés pour toutes les requêtes du lot.
• Assurez-vous que chaque requête du lot a un custom_id unique.
• Assurez-vous qu’il s’est écoulé moins de 29 jours depuis l’heure de created_at du lot (pas l’heure de ended_at du traitement). Si plus de 29 jours se sont écoulés, les résultats ne seront plus visibles.
• Confirmez que le lot n’a pas été annulé.

Notez que l’échec d’une requête dans un lot n’affecte pas le traitement des autres requêtes.

​

Stockage et confidentialité des lots

• Isolation des Workspaces : Les lots sont isolés dans le Workspace dans lequel ils sont créés. Ils ne peuvent être accessibles que par les clés API associées à ce Workspace, ou les utilisateurs ayant la permission de voir les lots du Workspace dans la Console.

• Disponibilité des résultats : Les résultats des lots sont disponibles pendant 29 jours après la création du lot, permettant un temps suffisant pour la récupération et le traitement.

​

FAQ