Uso de herramientas (llamadas a funciones)

Claude es capaz de interactuar con herramientas y funciones externas del lado del cliente, lo que le permite equipar a Claude con sus propias herramientas personalizadas para realizar una amplia variedad de tareas.

Aquí hay un ejemplo de cómo proporcionar herramientas a Claude usando la API de Messages:

​

Cómo funciona el uso de herramientas

Integre herramientas externas con Claude en estos pasos:

Nota: Los pasos 3 y 4 son opcionales. Para algunos flujos de trabajo, la solicitud de uso de herramienta de Claude (paso 2) podría ser todo lo que necesita, sin enviar los resultados de vuelta a Claude.

​

Cómo implementar el uso de herramientas

​

Elegir un modelo

En general, use Claude 3 Opus para herramientas complejas y consultas ambiguas; maneja mejor múltiples herramientas y busca aclaraciones cuando es necesario.

Use Haiku para herramientas sencillas, pero tenga en cuenta que puede inferir parámetros faltantes.

​

Especificar herramientas

Las herramientas se especifican en el parámetro de nivel superior tools de la solicitud de API. Cada definición de herramienta incluye:

{
  "name": "get_weather",
  "description": "Obtener el clima actual en una ubicación determinada",
  "input_schema": {
    "type": "object",
    "properties": {
      "location": {
        "type": "string",
        "description": "La ciudad y el estado, por ejemplo, San Francisco, CA"
      },
      "unit": {
        "type": "string",
        "enum": ["celsius", "fahrenheit"],
        "description": "La unidad de temperatura, ya sea 'celsius' o 'fahrenheit'"
      }
    },
    "required": ["location"]
  }
}

​

Mejores prácticas para definiciones de herramientas

Para obtener el mejor rendimiento de Claude al usar herramientas, siga estas pautas:

• Proporcione descripciones extremadamente detalladas. Este es, por mucho, el factor más importante en el rendimiento de las herramientas. Sus descripciones deben explicar cada detalle sobre la herramienta, incluyendo:
  • Lo que hace la herramienta
  • Cuándo debe usarse (y cuándo no)
  • Qué significa cada parámetro y cómo afecta el comportamiento de la herramienta
  • Cualquier advertencia o limitación importante, como qué información no devuelve la herramienta si el nombre de la herramienta no es claro. Cuanto más contexto pueda darle a Claude sobre sus herramientas, mejor podrá decidir cuándo y cómo usarlas. Apunte a al menos 3-4 oraciones por descripción de herramienta, más si la herramienta es compleja.
• Priorice las descripciones sobre los ejemplos. Si bien puede incluir ejemplos de cómo usar una herramienta en su descripción o en el mensaje adjunto, esto es menos importante que tener una explicación clara y completa del propósito y los parámetros de la herramienta. Solo agregue ejemplos después de haber desarrollado completamente la descripción.

{
  "name": "get_stock_price",
  "description": "Recupera el precio actual de las acciones para un símbolo de ticker determinado. El símbolo del ticker debe ser un símbolo válido para una empresa que cotiza en bolsa en una bolsa de valores importante de EE. UU., como NYSE o NASDAQ. La herramienta devolverá el último precio de negociación en USD. Debe usarse cuando el usuario pregunta sobre el precio actual o más reciente de una acción específica. No proporcionará ninguna otra información sobre la acción o la empresa.",
  "input_schema": {
    "type": "object",
    "properties": {
      "ticker": {
        "type": "string",
        "description": "El símbolo del ticker de la acción, por ejemplo, AAPL para Apple Inc."
      }
    },
    "required": ["ticker"]
  }
}

{
  "name": "get_stock_price",
  "description": "Obtiene el precio de la acción para un ticker.",
  "input_schema": {
    "type": "object",
    "properties": {
      "ticker": {
        "type": "string"
      }
    },
    "required": ["ticker"]
  }
}

La buena descripción explica claramente qué hace la herramienta, cuándo usarla, qué datos devuelve y qué significa el parámetro ticker. La descripción deficiente es demasiado breve y deja a Claude con muchas preguntas abiertas sobre el comportamiento y el uso de la herramienta.

​

Controlar la salida de Claude

​

Forzar el uso de herramientas

En algunos casos, es posible que desee que Claude use una herramienta específica para responder la pregunta del usuario, incluso si Claude cree que puede proporcionar una respuesta sin usar una herramienta. Puede hacer esto especificando la herramienta en el campo tool_choice de la siguiente manera:

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

Cuando se trabaja con el parámetro tool_choice, tenemos tres opciones posibles:

• auto permite que Claude decida si llamar o no a las herramientas proporcionadas. Este es el valor predeterminado.
• any le dice a Claude que debe usar una de las herramientas proporcionadas, pero no fuerza una herramienta en particular.
• tool nos permite forzar a Claude a usar siempre una herramienta en particular.

Este diagrama ilustra cómo funciona cada opción:

Tenga en cuenta que cuando tiene tool_choice como any o tool, rellenaremos previamente el mensaje del asistente para forzar el uso de una herramienta. Esto significa que los modelos no emitirán un bloque de contenido text de cadena de pensamiento antes de los bloques de contenido tool_use, incluso si se les pide explícitamente que lo hagan.

Nuestras pruebas han demostrado que esto no debería reducir el rendimiento. Si desea mantener la cadena de pensamiento (particularmente con Opus) y aun así solicitar que el modelo use una herramienta específica, puede usar {"type": "auto"} para tool_choice (el valor predeterminado) y agregar instrucciones explícitas en un mensaje de user. Por ejemplo: ¿Cómo está el clima en Londres? Use la herramienta get_weather en su respuesta.

​

Salida JSON

Las herramientas no necesariamente tienen que ser funciones del lado del cliente; puede usar herramientas en cualquier momento que desee que el modelo devuelva una salida JSON que siga un esquema proporcionado. Por ejemplo, puede usar una herramienta record_summary con un esquema particular. Consulte ejemplos de uso de herramientas para obtener un ejemplo completo y funcional.

​

Cadena de pensamiento

Cuando usa herramientas, Claude a menudo mostrará su “cadena de pensamiento”, es decir, el razonamiento paso a paso que usa para desglosar el problema y decidir qué herramientas usar. El modelo Claude 3 Opus hará esto si tool_choice se establece en auto (este es el valor predeterminado, consulte Forzar el uso de herramientas), y Sonnet y Haiku pueden ser inducidos a hacerlo.

Por ejemplo, dado el mensaje “¿Cómo está el clima en San Francisco en este momento y qué hora es allí?”, Claude podría responder con:

{
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "<thinking>Para responder esta pregunta, haré lo siguiente: 1. Usar la herramienta get_weather para obtener el clima actual en San Francisco. 2. Usar la herramienta get_time para obtener la hora actual en la zona horaria America/Los_Angeles, que cubre San Francisco, CA.</thinking>"
    },
    {
      "type": "tool_use",
      "id": "toolu_01A09q90qw90lq917835lq9",
      "name": "get_weather",
      "input": {"location": "San Francisco, CA"}
    }
  ]
}

Esta cadena de pensamiento brinda información sobre el proceso de razonamiento de Claude y puede ayudarlo a depurar comportamientos inesperados.

Con el modelo Claude 3 Sonnet, la cadena de pensamiento es menos común de forma predeterminada, pero puede indicarle a Claude que muestre su razonamiento agregando algo como "Antes de responder, explique su razonamiento paso a paso entre etiquetas." al mensaje del usuario o al mensaje del sistema.

Es importante tener en cuenta que, si bien las etiquetas <thinking> son una convención común que Claude usa para denotar su cadena de pensamiento, el formato exacto (como el nombre de esta etiqueta XML) puede cambiar con el tiempo. Su código debe tratar la cadena de pensamiento como cualquier otro texto generado por el asistente y no depender de la presencia o el formato específico de las etiquetas <thinking>.

​

Manejo de bloques de contenido de uso de herramientas y resultados de herramientas

Cuando Claude decide usar una de las herramientas que ha proporcionado, devolverá una respuesta con un stop_reason de tool_use y uno o más bloques de contenido tool_use en la respuesta de la API que incluyen:

• id: Un identificador único para este bloque de uso de herramienta en particular. Esto se usará para hacer coincidir los resultados de la herramienta más adelante.
• name: El nombre de la herramienta que se está utilizando.
• input: Un objeto que contiene la entrada que se pasa a la herramienta, de acuerdo con el input_schema de la herramienta.

{
  "id": "msg_01Aq9w938a90dw8q",
  "model": "claude-3-5-sonnet-20240620",
  "stop_reason": "tool_use",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "<thinking>Necesito usar get_weather, y el usuario quiere SF, que probablemente sea San Francisco, CA.</thinking>"
    },
    {
      "type": "tool_use",
      "id": "toolu_01A09q90qw90lq917835lq9",
      "name": "get_weather",
      "input": {"location": "San Francisco, CA", "unit": "celsius"}
    }
  ]
}

Cuando reciba una respuesta de uso de herramienta, debe:

1. Extraer el name, id e input del bloque tool_use.
2. Ejecutar la herramienta real en su base de código correspondiente a ese nombre de herramienta, pasando la input de la herramienta.
3. [opcional] Continuar la conversación enviando un nuevo mensaje con el role de user y un bloque de content que contenga el tipo tool_result y la siguiente información:
   • tool_use_id: El id de la solicitud de uso de herramienta para la que este es un resultado.
   • content: El resultado de la herramienta, como una cadena (por ejemplo, "content": "15 grados") o una lista de bloques de contenido anidados (por ejemplo, "content": [{"type": "text", "text": "15 grados"}]). Estos bloques de contenido pueden usar los tipos text o image.
   • is_error (opcional): Establecer en true si la ejecución de la herramienta resultó en un error.

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

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

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

Después de recibir el resultado de la herramienta, Claude usará esa información para continuar generando una respuesta al mensaje original del usuario.

​

Solución de problemas de errores

Hay algunos tipos diferentes de errores que pueden ocurrir al usar herramientas con Claude:

{
  "role": "user",
  "content": [
    {
      "type": "tool_result",
      "tool_use_id": "toolu_01A09q90qw90lq917835lq9",
      "content": "ConnectionError: la API del servicio meteorológico no está disponible (HTTP 500)",
      "is_error": true
    }
  ]
}

{
  "role": "user",
  "content": [
    {
      "type": "tool_result",
      "tool_use_id": "toolu_01A09q90qw90lq917835lq9",
      "content": "Error: Falta el parámetro requerido 'location'",
      "is_error": true
    }
  ]
}

​

Ejemplos de uso de herramientas

Aquí hay algunos ejemplos de código que demuestran varios patrones y técnicas de uso de herramientas. Por motivos de brevedad, las herramientas son herramientas simples y las descripciones de las herramientas son más cortas de lo que sería ideal para garantizar el mejor rendimiento.

{
  "id": "msg_01Aq9w938a90dw8q",
  "model": "claude-3-5-sonnet-20240620",
  "stop_reason": "tool_use",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "<thinking>Necesito llamar a la función get_weather, y el usuario quiere SF, que probablemente sea 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": "El clima actual en San Francisco es de 15 grados Celsius (59 grados Fahrenheit). ¡Es un día fresco en la ciudad junto a la bahía!"
    }
  ]
}

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

​

Precios

Las solicitudes de uso de herramientas tienen el mismo precio que cualquier otra solicitud de la API de Claude, según el número total de tokens de entrada enviados al modelo (incluidos en el parámetro tools) y el número de tokens de salida generados.”

Los tokens adicionales del uso de herramientas provienen de:

• El parámetro tools en las solicitudes de la API (nombres de herramientas, descripciones y esquemas)
• Bloques de contenido tool_use en solicitudes y respuestas de la API
• Bloques de contenido tool_result en solicitudes de la API

Cuando usa tools, también incluimos automáticamente un mensaje del sistema especial para el modelo que habilita el uso de herramientas. El número de tokens de uso de herramientas requeridos para cada modelo se enumeran a continuación (excluyendo los tokens adicionales enumerados anteriormente):

Estos recuentos de tokens se suman a sus tokens de entrada y salida normales para calcular el costo total de una solicitud. Consulte nuestra tabla de resumen de modelos para conocer los precios actuales por modelo.

Cuando envía un mensaje de uso de herramienta, al igual que cualquier otra solicitud de la API, la respuesta generará recuentos de tokens de entrada y salida como parte de las métricas de usage informadas.

​

Próximos pasos

Explore nuestro repositorio de ejemplos de código de uso de herramientas listos para implementar en nuestros libros de cocina: