Структурированные выходы

​

Обзор

• Получайте последовательные, типобезопасные выходные данные.
• Избегайте ошибок синтаксического анализа и галлюцинаторных полей. — Упростите обработку ответов в вашем приложении.

​

Использование структурированных выходных данных

{
  "messages": [
    { "role": "user", "content": "What's the weather like in London?" }
  ],
  "response_format": {
    "type": "json_schema",
    "json_schema": {
      "name": "weather",
      "strict": true,
      "schema": {
        "type": "object",
        "properties": {
          "location": {
            "type": "string",
            "description": "City or location name"
          },
          "temperature": {
            "type": "number",
            "description": "Temperature in Celsius"
          },
          "conditions": {
            "type": "string",
            "description": "Weather conditions description"
          }
        },
        "required": ["location", "temperature", "conditions"],
        "additionalProperties": false
      }
    }
  }
}

{
  "location": "London",
  "temperature": 18,
  "conditions": "Partly cloudy with light drizzle"
}

​

Поддержка моделей

• OpenAI
• Google Близнецы
• Anthropic
• Фейерверк

1. Проверьте поддерживаемые параметры модели на странице модели
2. Установить require_parameters: true в настройках вашего провайдера (см. Маршрутизация провайдера)
3. Включить response_format и установил type: json_schema в необходимых параметрах

​

Лучшие практики

1. Включайте описания: добавьте четкие описания к свойствам схемы, чтобы направлять модель.
2. Использовать строгий режим: Установите strict: true , чтобы поставщики с собственным строгим режимом точно применяли вашу схему. Принудительное соблюдение зависит от поставщика: некоторые гарантируют вывод, соответствующий схеме, в то время как другие переводят вашу схему в свой собственный формат структурированного вывода или рассматривают это как сильный намек, поэтому точное соответствие не гарантируется на каждой эндпоинту. Строгие режимы также могут ограничивать возможности использования JSON-схемы — подробности см. в документации поставщика.

​

Пример реализации

​

Потоковая передача со структурированным выводом

{
  "stream": true,
  "response_format": {
    "type": "json_schema",
    // ... rest of your schema
  }
}

​

Обработка ошибок

1. Модель не поддерживает структурированные выходные данные: запрос завершится с ошибкой, указывающей на отсутствие поддержки.
2. Неверная схема: модель вернет ошибку, если ваша схема JSON недействительна.

​

Починка ответов