Использование инструментов (вызов функций)

Claude способен взаимодействовать с внешними клиентскими инструментами и функциями, позволяя вам оснастить Claude вашими собственными пользовательскими инструментами для выполнения более широкого спектра задач.

Вот пример того, как предоставить инструменты Claude, используя Messages API:

​

Как работает использование инструментов

Интегрируйте внешние инструменты с Claude в следующие этапы:

Примечание: Шаги 3 и 4 являются необязательными. Для некоторых рабочих процессов запрос на использование инструмента Claude (шаг 2) может быть всем, что вам нужно, без отправки результатов обратно Claude.

​

Как реализовать использование инструментов

​

Выбор модели

В общем случае используйте Claude 3.5 Sonnet или Claude 3 Opus для сложных инструментов и неоднозначных запросов; они лучше справляются с несколькими инструментами и при необходимости запрашивают уточнения.

Используйте Claude 3 Haiku для простых инструментов, но учтите, что он может выводить отсутствующие параметры.

​

Указание инструментов

Инструменты указываются в параметре верхнего уровня tools API-запроса. Каждое определение инструмента включает:

{
  "name": "get_weather",
  "description": "Get the current weather in a given location",
  "input_schema": {
    "type": "object",
    "properties": {
      "location": {
        "type": "string",
        "description": "The city and state, e.g. San Francisco, CA"
      },
      "unit": {
        "type": "string",
        "enum": ["celsius", "fahrenheit"],
        "description": "The unit of temperature, either 'celsius' or 'fahrenheit'"
      }
    },
    "required": ["location"]
  }
}

​

Системный запрос для использования инструментов

Когда вы вызываете API Anthropic с параметром tools, мы создаем специальный системный запрос из определений инструментов, конфигурации инструментов и любого пользовательского системного запроса. Созданный запрос предназначен для инструктирования модели по использованию указанного инструмента(ов) и предоставления необходимого контекста для правильной работы инструмента:

In this environment you have access to a set of tools you can use to answer the user's question.
{{ FORMATTING INSTRUCTIONS }}
String and scalar parameters should be specified as is, while lists and objects should use JSON format. Note that spaces for string values are not stripped. The output is not expected to be valid XML and is parsed with regular expressions.
Here are the functions available in JSONSchema format:
{{ TOOL DEFINITIONS IN JSON SCHEMA }}
{{ USER SYSTEM PROMPT }}
{{ TOOL CONFIGURATION }}

​

Лучшие практики для определений инструментов

Чтобы получить наилучшую производительность от Claude при использовании инструментов, следуйте этим рекомендациям:

• Предоставляйте чрезвычайно подробные описания. Это безусловно самый важный фактор в производительности инструмента. Ваши описания должны объяснять каждую деталь об инструменте, включая:
  • Что делает инструмент
  • Когда его следует использовать (а когда нет)
  • Что означает каждый параметр и как он влияет на поведение инструмента
  • Любые важные предостережения или ограничения, такие как какую информацию инструмент не возвращает, если название инструмента неясно. Чем больше контекста вы можете дать Claude о ваших инструментах, тем лучше он будет в решении когда и как их использовать. Стремитесь к минимум 3-4 предложениям на описание каждого инструмента, больше если инструмент сложный.
• Отдавайте приоритет описаниям перед примерами. Хотя вы можете включить примеры использования инструмента в его описание или в сопровождающий запрос, это менее важно, чем иметь четкое и всестороннее объяснение назначения и параметров инструмента. Добавляйте примеры только после того, как вы полностью проработали описание.

{
  "name": "get_stock_price",
  "description": "Retrieves the current stock price for a given ticker symbol. The ticker symbol must be a valid symbol for a publicly traded company on a major US stock exchange like NYSE or NASDAQ. The tool will return the latest trade price in USD. It should be used when the user asks about the current or most recent price of a specific stock. It will not provide any other information about the stock or company.",
  "input_schema": {
    "type": "object",
    "properties": {
      "ticker": {
        "type": "string",
        "description": "The stock ticker symbol, e.g. AAPL for Apple Inc."
      }
    },
    "required": ["ticker"]
  }
}

{
  "name": "get_stock_price",
  "description": "Gets the stock price for a ticker.",
  "input_schema": {
    "type": "object",
    "properties": {
      "ticker": {
        "type": "string"
      }
    },
    "required": ["ticker"]
  }
}

Хорошее описание четко объясняет, что делает инструмент, когда его использовать, какие данные он возвращает и что означает параметр ticker. Плохое описание слишком краткое и оставляет Claude много открытых вопросов о поведении и использовании инструмента.

​

Управление выводом Claude

​

Принудительное использование инструмента

В некоторых случаях вы можете захотеть, чтобы Claude использовал определенный инструмент для ответа на вопрос пользователя, даже если Claude думает, что может предоставить ответ без использования инструмента. Вы можете сделать это, указав инструмент в поле tool_choice следующим образом:

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

При работе с параметром tool_choice у нас есть три возможных варианта:

• auto позволяет Claude решать, вызывать ли какие-либо предоставленные инструменты или нет. Это значение по умолчанию.
• any говорит Claude, что он должен использовать один из предоставленных инструментов, но не принуждает к конкретному инструменту.
• tool позволяет нам заставить Claude всегда использовать конкретный инструмент.

Эта диаграмма иллюстрирует, как работает каждый вариант:

Обратите внимание, что когда у вас tool_choice установлен как any или tool, мы предварительно заполним сообщение ассистента, чтобы принудительно использовать инструмент. Это означает, что модели не будут выводить блок контента text с цепочкой рассуждений перед блоками контента tool_use, даже если об этом явно попросили.

Наше тестирование показало, что это не должно снижать производительность. Если вы хотите сохранить цепочку рассуждений (особенно с Opus), продолжая запрашивать использование конкретного инструмента, вы можете использовать {"type": "auto"} для tool_choice (по умолчанию) и добавить явные инструкции в сообщение user. Например: What's the weather like in London? Use the get_weather tool in your response.

​

JSON вывод

Инструменты не обязательно должны быть клиентскими функциями — вы можете использовать инструменты всякий раз, когда хотите, чтобы модель возвращала JSON-вывод, соответствующий предоставленной схеме. Например, вы можете использовать инструмент record_summary с определенной схемой. См. примеры использования инструментов для полного рабочего примера.

​

Цепочка рассуждений

При использовании инструментов Claude часто показывает свою “цепочку рассуждений”, т.е. пошаговые рассуждения, которые он использует для разбора проблемы и решения, какие инструменты использовать. Модель Claude 3 Opus будет делать это, если tool_choice установлен на auto (это значение по умолчанию, см. [Принудительное использование инструм

ента](#forcing-tool-use)), а Sonnet и Haiku можно побудить делать это.

Например, получив запрос “What’s the weather like in San Francisco right now, and what time is it there?”, Claude может ответить:

{
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "<thinking>To answer this question, I will: 1. Use the get_weather tool to get the current weather in San Francisco. 2. Use the get_time tool to get the current time in the America/Los_Angeles timezone, which covers San Francisco, CA.</thinking>"
    },
    {
      "type": "tool_use",
      "id": "toolu_01A09q90qw90lq917835lq9",
      "name": "get_weather",
      "input": {"location": "San Francisco, CA"}
    }
  ]
}

Эта цепочка рассуждений дает представление о процессе рассуждений Claude и может помочь вам отладить неожиданное поведение.

С моделью Claude 3 Sonnet цепочка рассуждений менее распространена по умолчанию, но вы можете побудить Claude показать свои рассуждения, добавив что-то вроде "Before answering, explain your reasoning step-by-step in tags." в сообщение пользователя или системный запрос.

Важно отметить, что хотя теги <thinking> являются общепринятым соглашением, которое Claude использует для обозначения своей цепочки рассуждений, точный формат (например, как называется этот XML-тег) может со временем измениться. Ваш код должен обрабатывать цепочку рассуждений как любой другой текст, сгенерированный ассистентом, и не полагаться на наличие или конкретное форматирование тегов <thinking>.

​

Отключение параллельного использования инструментов

По умолчанию Claude может использовать несколько инструментов для ответа на запрос пользователя. Вы можете отключить это поведение, установив disable_parallel_tool_use=true в поле tool_choice.

• Когда тип tool_choice - auto, это гарантирует, что Claude использует максимум один инструмент
• Когда тип tool_choice - any или tool, это гарантирует, что Claude использует ровно один инструмент

​

Обработка блоков контента tool_use и tool_result

Когда Claude решает использовать один из предоставленных вами инструментов, он вернет ответ с stop_reason равным tool_use и одним или несколькими блоками контента tool_use в API-ответе, которые включают:

• id: Уникальный идентификатор для этого конкретного блока использования инструмента. Он будет использоваться для сопоставления с результатами инструмента позже.
• name: Имя используемого инструмента.
• input: Объект, содержащий входные данные, передаваемые инструменту, соответствующие input_schema инструмента.

{
  "id": "msg_01Aq9w938a90dw8q",
  "model": "claude-3-5-sonnet-20241022",
  "stop_reason": "tool_use",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "<thinking>I need to use the get_weather, and the user wants SF, which is likely San Francisco, CA.</thinking>"
    },
    {
      "type": "tool_use",
      "id": "toolu_01A09q90qw90lq917835lq9",
      "name": "get_weather",
      "input": {"location": "San Francisco, CA", "unit": "celsius"}
    }
  ]
}

Когда вы получаете ответ об использовании инструмента, вы должны:

1. Извлечь name, id и input из блока tool_use.
2. Запустить фактический инструмент в вашей кодовой базе, соответствующий этому имени инструмента, передав входные данные инструмента.
3. [необязательно] Продолжить разговор, отправив новое сообщение с role равным user и блоком content, содержащим тип tool_result и следующую информацию:
   • tool_use_id: id запроса на использование инструмента, для которого это результат.
   • content: Результат инструмента в виде строки (например, "content": "15 degrees") или списка вложенных блоков контента (например, "content": [{"type": "text", "text": "15 degrees"}]). Эти блоки контента могут использовать типы text или image.
   • is_error (необязательно): Установите в true, если выполнение инструмента привело к ошибке.

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

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

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

После получения результата инструмента Claude будет использовать эту информацию для продолжения генерации ответа на исходный запрос пользователя.

​

Устранение ошибок

При использовании инструментов с Claude могут возникнуть несколько типов ошибок:

{
  "role": "user",
  "content": [
    {
      "type": "tool_result",
      "tool_use_id": "toolu_01A09q90qw90lq917835lq9",
      "content": "ConnectionError: the weather service API is not available (HTTP 500)",
      "is_error": true
    }
  ]
}

{
  "role": "user",
  "content": [
    {
      "type": "tool_result",
      "tool_use_id": "toolu_01A09q90qw90lq917835lq9",
      "content": "Error: Missing required 'location' parameter",
      "is_error": true
    }
  ]
}

​

Примеры использования инструментов

Вот несколько примеров кода, демонстрирующих различные паттерны и техники использования инструментов. Для краткости инструменты простые, а описания инструментов короче, чем было бы идеально для обеспечения наилучшей производительности.

{
  "id": "msg_01Aq9w938a90dw8q",
  "model": "claude-3-5-sonnet-20241022",
  "stop_reason": "tool_use",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "<thinking>I need to call the get_weather function, and the user wants SF, which is likely 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-20241022",
  "stop_reason": "stop_sequence",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "The current weather in San Francisco is 15 degrees Celsius (59 degrees Fahrenheit). It's a cool day in the city by the bay!"
    }
  ]
}

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

​

Ценообразование

Запросы на использование инструментов оцениваются так же, как и любой другой запрос API Claude, на основе общего количества входных токенов, отправленных модели (включая параметр tools), и количества сгенерированных выходных токенов.”

Дополнительные токены от использования инструментов происходят из:

• Параметра tools в API-запросах (имена инструментов, описания и схемы)
• Блоков контента tool_use в API-запросах и ответах
• Блоков контента tool_result в API-запросах

Когда вы используете tools, мы также автоматически включаем специальный системный запрос для модели, который включает использование инструментов. Количество токенов для использования инструментов, необходимое для каждой модели, перечислено ниже (исключая дополнительные токены, перечисленные выше):

Эти количества токенов добавляются к вашим обычным входным и выходным токенам для расчета общей стоимости запроса. Обратитесь к нашей таблице обзора моделей для текущих цен по моделям.

Когда вы отправляете запрос на использование инструмента, как и любой другой API-запрос, ответ будет выводить количество как входных, так и выходных токенов как часть отчетных метрик usage.

​

Следующие шаги

Изучите наш репозиторий готовых к реализации примеров кода использования инструментов в наших сборниках: