Utilisation d'outils (appel de fonctions)

Claude est capable d’interagir avec des outils et des fonctions externes côté client, vous permettant d’équiper Claude avec vos propres outils personnalisés pour effectuer une plus grande variété de tâches.

Voici un exemple de comment fournir des outils à Claude en utilisant l’API Messages :

​

Comment fonctionne l’utilisation d’outils

Intégrez des outils externes avec Claude en suivant ces étapes :

Note : Les étapes 3 et 4 sont facultatives. Pour certains workflows, la requête d’utilisation d’outil de Claude (étape 2) peut être tout ce dont vous avez besoin, sans renvoyer les résultats à Claude.

​

Comment implémenter l’utilisation d’outils

​

Choisir un modèle

En général, utilisez Claude 3 Opus pour les outils complexes et les requêtes ambiguës ; il gère mieux plusieurs outils et demande des clarifications si nécessaire.

Utilisez Haiku pour les outils simples, mais notez qu’il peut déduire les paramètres manquants.

​

Spécifier les outils

Les outils sont spécifiés dans le paramètre de niveau supérieur tools de la requête API. Chaque définition d’outil comprend :

{
  "name": "get_weather",
  "description": "Obtenir la météo actuelle pour un lieu donné",
  "input_schema": {
    "type": "object",
    "properties": {
      "location": {
        "type": "string",
        "description": "La ville et l'état, par ex. San Francisco, CA"
      },
      "unit": {
        "type": "string",
        "enum": ["celsius", "fahrenheit"],
        "description": "L'unité de température, soit 'celsius' soit 'fahrenheit'"
      }
    },
    "required": ["location"]
  }
}

​

Bonnes pratiques pour les définitions d’outils

Pour obtenir les meilleures performances de Claude lors de l’utilisation d’outils, suivez ces directives :

• Fournissez des descriptions extrêmement détaillées. C’est de loin le facteur le plus important pour la performance des outils. Vos descriptions doivent expliquer chaque détail sur l’outil, y compris :
  • Ce que fait l’outil
  • Quand il doit être utilisé (et quand il ne doit pas l’être)
  • Ce que signifie chaque paramètre et comment il affecte le comportement de l’outil
  • Toute mise en garde ou limitation importante, comme les informations que l’outil ne renvoie pas si le nom de l’outil n’est pas clair. Plus vous pouvez donner de contexte à Claude sur vos outils, mieux il sera capable de décider quand et comment les utiliser. Visez au moins 3-4 phrases par description d’outil, plus si l’outil est complexe.
• Privilégiez les descriptions par rapport aux exemples. Bien que vous puissiez inclure des exemples d’utilisation d’un outil dans sa description ou dans la requête qui l’accompagne, c’est moins important que d’avoir une explication claire et complète de l’objectif et des paramètres de l’outil. N’ajoutez des exemples qu’après avoir pleinement développé la description.

{
  "name": "get_stock_price",
  "description": "Récupère le cours actuel d'une action pour un symbole boursier donné. Le symbole boursier doit être un symbole valide pour une société cotée en bourse sur une grande bourse américaine comme le NYSE ou le NASDAQ. L'outil renverra le dernier prix de transaction en USD. Il doit être utilisé lorsque l'utilisateur demande le prix actuel ou le plus récent d'une action spécifique. Il ne fournira aucune autre information sur l'action ou la société.",
  "input_schema": {
    "type": "object",
    "properties": {
      "ticker": {
        "type": "string",
        "description": "Le symbole boursier, par ex. AAPL pour Apple Inc."
      }
    },
    "required": ["ticker"]
  }
}

{
  "name": "get_stock_price",
  "description": "Obtient le cours d'une action pour un symbole boursier.",
  "input_schema": {
    "type": "object",
    "properties": {
      "ticker": {
        "type": "string"
      }
    },
    "required": ["ticker"]
  }
}

La bonne description explique clairement ce que fait l’outil, quand l’utiliser, quelles données il renvoie et ce que signifie le paramètre ticker. La mauvaise description est trop brève et laisse Claude avec de nombreuses questions ouvertes sur le comportement et l’utilisation de l’outil.

​

Contrôler la sortie de Claude

​

Forcer l’utilisation d’un outil

Dans certains cas, vous pouvez vouloir que Claude utilise un outil spécifique pour répondre à la question de l’utilisateur, même si Claude pense pouvoir fournir une réponse sans utiliser d’outil. Vous pouvez le faire en spécifiant l’outil dans le champ tool_choice comme ceci :

tool_choice = {"type": "tool", "name": "get_weather"}

Lorsque vous travaillez avec le paramètre tool_choice, nous avons trois options possibles :

• auto permet à Claude de décider d’appeler ou non les outils fournis. C’est la valeur par défaut.
• any indique à Claude qu’il doit utiliser l’un des outils fournis, mais ne force pas un outil particulier.
• tool nous permet de forcer Claude à toujours utiliser un outil particulier.

Ce diagramme illustre le fonctionnement de chaque option :

Notez que lorsque vous avez tool_choice comme any ou tool, nous pré-remplirons le message de l’assistant pour forcer l’utilisation d’un outil. Cela signifie que les modèles n’émettront pas de bloc de contenu text de chaîne de pensée avant les blocs de contenu tool_use, même si cela est explicitement demandé.

Nos tests ont montré que cela ne devrait pas réduire les performances. Si vous souhaitez conserver la chaîne de pensée (en particulier avec Opus) tout en demandant au modèle d’utiliser un outil spécifique, vous pouvez utiliser {"type": "auto"} pour tool_choice (la valeur par défaut) et ajouter des instructions explicites dans un message user. Par exemple : Quel temps fait-il à Londres ? Utilisez l'outil get_weather dans votre réponse.

​

Sortie JSON

Les outils ne doivent pas nécessairement être des fonctions côté client - vous pouvez utiliser des outils chaque fois que vous voulez que le modèle renvoie une sortie JSON qui suit un schéma fourni. Par exemple, vous pouvez utiliser un outil record_summary avec un schéma particulier. Voir exemples d’utilisation d’outils pour un exemple complet fonctionnel.

​

Chaîne de pensée

Lors de l’utilisation d’outils, Claude montrera souvent sa “chaîne de pensée”, c’est-à-dire le raisonnement étape par étape qu’il utilise pour décomposer le problème et décider quels outils utiliser. Le modèle Claude 3 Opus le fera si tool_choice est défini sur auto (c’est la valeur par défaut, voir Forcer l’utilisation d’un outil), et Sonnet et Haiku peuvent être incités à le faire.

Par exemple, étant donné la requête “Quel temps fait-il à San Francisco en ce moment, et quelle heure est-il là-bas ?”, Claude pourrait répondre avec :

{
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "<thinking>Pour répondre à cette question, je vais : 1. Utiliser l'outil get_weather pour obtenir la météo actuelle à San Francisco. 2. Utiliser l'outil get_time pour obtenir l'heure actuelle dans le fuseau horaire America/Los_Angeles, qui couvre San Francisco, CA.</thinking>"
    },
    {
      "type": "tool_use",
      "id": "toolu_01A09q90qw90lq917835lq9",
      "name": "get_weather",
      "input": {"location": "San Francisco, CA"}
    }
  ]
}

Cette chaîne de pensée donne un aperçu du processus de raisonnement de Claude et peut vous aider à déboguer un comportement inattendu.

Avec le modèle Claude 3 Sonnet, la chaîne de pensée est moins courante par défaut, mais vous pouvez inciter Claude à montrer son raisonnement en ajoutant quelque chose comme "Avant de répondre, expliquez votre raisonnement étape par étape dans des balises." au message utilisateur ou à l’invite système.

Il est important de noter que bien que les balises <thinking> soient une convention courante que Claude utilise pour désigner sa chaîne de pensée, le format exact (comme le nom de cette balise XML) peut changer au fil du temps. Votre code doit traiter la chaîne de pensée comme n’importe quel autre texte généré par l’assistant, et ne pas compter sur la présence ou le formatage spécifique des balises <thinking>.

​

Gérer les blocs de contenu tool_use et tool_result

Lorsque Claude décide d’utiliser l’un des outils que vous avez fournis, il renverra une réponse avec une stop_reason de tool_use et un ou plusieurs blocs de contenu tool_use dans la réponse de l’API qui incluent :

• id : Un identifiant unique pour ce bloc d’utilisation d’outil particulier. Il sera utilisé pour faire correspondre les résultats de l’outil plus tard.
• name : Le nom de l’outil utilisé.
• input : Un objet contenant l’entrée passée à l’outil, conforme au input_schema de l’outil.

{
  "id": "msg_01Aq9w938a90dw8q",
  "model": "claude-3-5-sonnet-20240620",
  "stop_reason": "tool_use",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "<thinking>J'ai besoin d'utiliser get_weather, et l'utilisateur veut SF, qui est probablement San Francisco, CA.</thinking>"
    },
    {
      "type": "tool_use",
      "id": "toolu_01A09q90qw90lq917835lq9",
      "name": "get_weather",
      "input": {"location": "San Francisco, CA", "unit": "celsius"}
    }
  ]
}

Lorsque vous recevez une réponse d’utilisation d’outil, vous devez :

1. Extraire le name, l’id et l’input du bloc tool_use.
2. Exécuter l’outil réel dans votre base de code correspondant à ce nom d’outil, en passant l’input de l’outil.
3. [facultatif] Poursuivre la conversation en envoyant un nouveau message avec le role de user, et un bloc content contenant le type tool_result et les informations suivantes :
   • tool_use_id : L’id de la requête d’utilisation d’outil pour laquelle c’est un résultat.
   • content : Le résultat de l’outil, sous forme de chaîne (par ex. "content": "15 degrés") ou de liste de blocs de contenu imbriqués (par ex. "content": [{"type": "text", "text": "15 degrés"}]). Ces blocs de contenu peuvent utiliser les types text ou image.
   • is_error (facultatif) : Définir à true si l’exécution de l’outil a entraîné une erreur.

{
  "role": "user",
  "content": [
    {
      "type": "tool_result",
      "tool_use_id": "toolu_01A09q90qw90lq917835lq9",
      "content": "15 degrés"
    }
  ]
}

{
  "role": "user",
  "content": [
    {
      "type": "tool_result",
      "tool_use_id": "toolu_01A09q90qw90lq917835lq9",
      "content": [
        {"type": "text", "text": "15 degrés"},
        {
          "type": "image",
          "source": {
            "type": "base64",
            "media_type": "image/jpeg",
            "data": "/9j/4AAQSkZJRg...",
          }
        }
      ]
    }
  ]
}

{
  "role": "user",
  "content": [
    {
      "type": "tool_result",
      "tool_use_id": "toolu_01A09q90qw90lq917835lq9",
    }
  ]
}

Après avoir reçu le résultat de l’outil, Claude utilisera ces informations pour continuer à générer une réponse à la requête initiale de l’utilisateur.

​

Dépannage des erreurs

Il existe quelques types d’erreurs différents qui peuvent se produire lors de l’utilisation d’outils avec Claude :

{
  "role": "user",
  "content": [
    {
      "type": "tool_result",
      "tool_use_id": "toolu_01A09q90qw90lq917835lq9",
      "content": "ConnectionError: l'API du service météo n'est pas disponible (HTTP 500)",
      "is_error": true
    }
  ]
}

{
  "role": "user",
  "content": [
    {
      "type": "tool_result",
      "tool_use_id": "toolu_01A09q90qw90lq917835lq9",
      "content": "Erreur : Paramètre 'location' requis manquant",
      "is_error": true
    }
  ]
}

​

Exemples d’utilisation d’outils

Voici quelques exemples de code démontrant divers modèles et techniques d’utilisation d’outils. Par souci de concision, les outils sont des outils simples et les descriptions d’outils sont plus courtes que ce qui serait idéal pour garantir les meilleures performances.

{
  "id": "msg_01Aq9w938a90dw8q",
  "model": "claude-3-5-sonnet-20240620",
  "stop_reason": "tool_use",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "<thinking>Je dois appeler la fonction get_weather, et l'utilisateur veut SF, qui est probablement San Francisco, CA.</thinking>"
    },
    {
      "type": "tool_use",
      "id": "toolu_01A09q90qw90lq917835lq9", 
      "name": "get_weather",
      "input": {"location": "San Francisco, CA", "unit": "celsius"}
    }
  ]
}

{
  "id": "msg_01Aq9w938a90dw8q",
  "model": "claude-3-5-sonnet-20240620",
  "stop_reason": "stop_sequence",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "La météo actuelle à San Francisco est de 15 degrés Celsius (59 degrés Fahrenheit). C'est une journée fraîche dans la ville au bord de la baie !"
    }
  ]
}

{
  "type": "tool_use",
  "id": "toolu_01A09q90qw90lq917835lq9",
  "name": "get_weather", 
  "input": {"location": "New York, NY", "unit": "fahrenheit"}
}

​

Tarification

Les requêtes d’utilisation d’outils sont facturées de la même manière que toute autre requête d’API Claude, en fonction du nombre total de tokens d’entrée envoyés au modèle (y compris dans le paramètre tools) et du nombre de tokens de sortie générés.”

Les tokens supplémentaires de l’utilisation d’outils proviennent de :

• Le paramètre tools dans les requêtes d’API (noms d’outils, descriptions et schémas)
• Les blocs de contenu tool_use dans les requêtes et réponses d’API
• Les blocs de contenu tool_result dans les requêtes d’API

Lorsque vous utilisez tools, nous incluons également automatiquement une invite système spéciale pour le modèle qui active l’utilisation d’outils. Le nombre de tokens d’utilisation d’outils requis pour chaque modèle est indiqué ci-dessous (à l’exclusion des tokens supplémentaires listés ci-dessus) :

Ces nombres de tokens sont ajoutés à vos tokens d’entrée et de sortie normaux pour calculer le coût total d’une requête. Reportez-vous à notre tableau de présentation des modèles pour les prix actuels par modèle.

Lorsque vous envoyez une invite d’utilisation d’outil, comme pour toute autre requête d’API, la réponse affichera à la fois les nombres de tokens d’entrée et de sortie dans le cadre des métriques d’usage rapportées.

​

Prochaines étapes

Explorez notre référentiel d’exemples de code d’utilisation d’outils prêts à implémenter dans nos recueils :