Структурный вывод

Структурный вывод позволяет получать ответы от AI моделей в строгом JSON формате, соответствующем заданной схеме.

Поддержка структурного вывода зависит от модели. Проверяйте возможности в каталоге моделей.

Зачем это нужно?

Парсинг данных

Извлечение структурированной информации из текста

API интеграции

Получение данных в формате, готовом для обработки

Валидация

Гарантия соответствия ответа заданной структуре

Автоматизация

Надёжная интеграция с бизнес-процессами

Способы получения структурного вывода

1. response_format (рекомендуется)

Самый надёжный способ — использовать параметр response_format с JSON Schema:

import OpenAI from 'openai';

const openai = new OpenAI({
  baseURL: 'https://polza.ai/api/v1',
  apiKey: '<POLZA_AI_API_KEY>'
});

const completion = await openai.chat.completions.create({
  model: 'openai/gpt-4o',
  messages: [
    {
      role: 'user',
      content: 'Извлеки информацию о товаре: iPhone 15 Pro, 256GB, цена 89990 рублей, в наличии'
    }
  ],
  response_format: {
    type: 'json_schema',
    json_schema: {
      name: 'product',
      strict: true,
      schema: {
        type: 'object',
        properties: {
          name: { type: 'string', description: 'Название товара' },
          storage: { type: 'string', description: 'Объём памяти' },
          price: { type: 'number', description: 'Цена в рублях' },
          in_stock: { type: 'boolean', description: 'Наличие на складе' }
        },
        required: ['name', 'storage', 'price', 'in_stock'],
        additionalProperties: false
      }
    }
  }
});

const product = JSON.parse(completion.choices[0].message.content);
console.log(product);
// { name: "iPhone 15 Pro", storage: "256GB", price: 89990, in_stock: true }

from openai import OpenAI
import json

client = OpenAI(
    base_url="https://polza.ai/api/v1",
    api_key="<POLZA_AI_API_KEY>"
)

completion = client.chat.completions.create(
    model="openai/gpt-4o",
    messages=[
        {
            "role": "user",
            "content": "Извлеки информацию о товаре: iPhone 15 Pro, 256GB, цена 89990 рублей, в наличии"
        }
    ],
    response_format={
        "type": "json_schema",
        "json_schema": {
            "name": "product",
            "strict": True,
            "schema": {
                "type": "object",
                "properties": {
                    "name": {"type": "string", "description": "Название товара"},
                    "storage": {"type": "string", "description": "Объём памяти"},
                    "price": {"type": "number", "description": "Цена в рублях"},
                    "in_stock": {"type": "boolean", "description": "Наличие на складе"}
                },
                "required": ["name", "storage", "price", "in_stock"],
                "additionalProperties": False
            }
        }
    }
)

product = json.loads(completion.choices[0].message.content)
print(product)
# {'name': 'iPhone 15 Pro', 'storage': '256GB', 'price': 89990, 'in_stock': True}

curl -X POST "https://polza.ai/api/v1/chat/completions" \
  -H "Authorization: Bearer <POLZA_AI_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/gpt-4o",
    "messages": [
      {"role": "user", "content": "Извлеки информацию о товаре: iPhone 15 Pro, 256GB, цена 89990 рублей, в наличии"}
    ],
    "response_format": {
      "type": "json_schema",
      "json_schema": {
        "name": "product",
        "strict": true,
        "schema": {
          "type": "object",
          "properties": {
            "name": {"type": "string"},
            "storage": {"type": "string"},
            "price": {"type": "number"},
            "in_stock": {"type": "boolean"}
          },
          "required": ["name", "storage", "price", "in_stock"],
          "additionalProperties": false
        }
      }
    }
  }'

2. json_object (простой JSON)

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

const completion = await openai.chat.completions.create({
  model: 'openai/gpt-4o',
  messages: [
    {
      role: 'system',
      content: 'Всегда отвечай в формате JSON с полями: name, price, currency'
    },
    { role: 'user', content: 'Цена на MacBook Air?' }
  ],
  response_format: { type: 'json_object' }
});

completion = client.chat.completions.create(
    model="openai/gpt-4o",
    messages=[
        {
            "role": "system",
            "content": "Всегда отвечай в формате JSON с полями: name, price, currency"
        },
        {"role": "user", "content": "Цена на MacBook Air?"}
    ],
    response_format={"type": "json_object"}
)

Примеры схем

Извлечение контактов

{
  "type": "object",
  "properties": {
    "name": { "type": "string" },
    "email": { "type": "string", "format": "email" },
    "phone": { "type": "string" },
    "company": { "type": "string" }
  },
  "required": ["name"]
}

Анализ отзыва

{
  "type": "object",
  "properties": {
    "sentiment": {
      "type": "string",
      "enum": ["positive", "negative", "neutral"]
    },
    "score": { "type": "number", "minimum": 1, "maximum": 5 },
    "topics": {
      "type": "array",
      "items": { "type": "string" }
    },
    "summary": { "type": "string" }
  },
  "required": ["sentiment", "score", "summary"]
}

Список задач

{
  "type": "object",
  "properties": {
    "tasks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": { "type": "string" },
          "priority": { "type": "string", "enum": ["low", "medium", "high"] },
          "due_date": { "type": "string", "format": "date" }
        },
        "required": ["title", "priority"]
      }
    }
  },
  "required": ["tasks"]
}

Параметр strict

Значение	Описание
`true`	Ответ точно соответствует схеме. Рекомендуется.
`false`	Модель может отклоняться от схемы. Не рекомендуется.

При strict: true модель гарантированно вернёт JSON, соответствующий схеме, или ошибку.

Обработка массивов

Для извлечения списка объектов:

const completion = await openai.chat.completions.create({
  model: 'openai/gpt-4o',
  messages: [
    {
      role: 'user',
      content: 'Извлеки все упомянутые компании: Apple выпустила iPhone, Google показала Pixel, Microsoft представила Surface'
    }
  ],
  response_format: {
    type: 'json_schema',
    json_schema: {
      name: 'companies',
      strict: true,
      schema: {
        type: 'object',
        properties: {
          items: {
            type: 'array',
            items: {
              type: 'object',
              properties: {
                company: { type: 'string' },
                product: { type: 'string' }
              },
              required: ['company', 'product'],
              additionalProperties: false
            }
          }
        },
        required: ['items'],
        additionalProperties: false
      }
    }
  }
});

completion = client.chat.completions.create(
    model="openai/gpt-4o",
    messages=[
        {
            "role": "user",
            "content": "Извлеки все упомянутые компании: Apple выпустила iPhone, Google показала Pixel, Microsoft представила Surface"
        }
    ],
    response_format={
        "type": "json_schema",
        "json_schema": {
            "name": "companies",
            "strict": True,
            "schema": {
                "type": "object",
                "properties": {
                    "items": {
                        "type": "array",
                        "items": {
                            "type": "object",
                            "properties": {
                                "company": {"type": "string"},
                                "product": {"type": "string"}
                            },
                            "required": ["company", "product"],
                            "additionalProperties": False
                        }
                    }
                },
                "required": ["items"],
                "additionalProperties": False
            }
        }
    }
)

Советы и лучшие практики

Всегда используйте strict: true

Это гарантирует соответствие ответа схеме и предотвращает ошибки парсинга.

Добавляйте описания полей

Описания помогают модели лучше понять, что ожидается в каждом поле.

Используйте enum для ограниченных значений

Если поле должно содержать одно из нескольких значений, используйте enum.

Ограничивайте additionalProperties

Установите additionalProperties: false чтобы модель не добавляла лишние поля.

Оборачивайте массивы в объект

Вместо type: "array" на верхнем уровне, используйте объект с полем-массивом.

Начало работы

Продвинутое

Генерация медиа

Интеграции

Структурный вывод

Зачем это нужно?

Парсинг данных

API интеграции

Валидация

Автоматизация

Способы получения структурного вывода

1. response_format (рекомендуется)

2. json_object (простой JSON)

Примеры схем

Извлечение контактов

Анализ отзыва

Список задач

Параметр strict

Обработка массивов

Советы и лучшие практики

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

Tool Calling

Плагины

​Зачем это нужно?

Парсинг данных

API интеграции

Валидация

Автоматизация

​Способы получения структурного вывода

​1. response_format (рекомендуется)

​2. json_object (простой JSON)

​Примеры схем

​Извлечение контактов

​Анализ отзыва

​Список задач

​Параметр strict

​Обработка массивов

​Советы и лучшие практики

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

Tool Calling

Плагины

Зачем это нужно?

Способы получения структурного вывода

1. response_format (рекомендуется)

2. json_object (простой JSON)

Примеры схем

Извлечение контактов

Анализ отзыва

Список задач

Параметр strict

Обработка массивов

Советы и лучшие практики

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