Руководства

Когда базовые запросы к API уже работают, выберите руководство по задаче, которую нужно решить. Каждое руководство содержит готовые к запуску примеры; поддерживаемые протоколы указаны на соответствующей странице.

Основные функции

Управление тем, как модель отвечает: посимвольный вывод, вызов ваших функций, ответ в фиксированном формате, анализ изображений.

Задача	Руководство	Ключевые моменты
Отображать ответ по мере генерации, не дожидаясь его завершения	Потоковые ответы	Передача через SSE; восстановление соединения и вызов функций в потоковом режиме
Позволить модели вызывать мои функции или внешние API	Вызов функций	Определение `tools`, параллельные вызовы и `tool_choice`
Получать вывод строго в формате JSON	Структурированный вывод	Ограничения JSON Mode и JSON Schema
Передать модели изображение	Анализ изображений	URL изображения или Base64, сравнение нескольких изображений

Экономия и стабильность

Те же запросы с меньшими затратами и без прерываний при сбоях.

Задача	Руководство	Ключевые моменты
Снизить стоимость при повторной отправке длинных промптов	Кэширование промптов	Кэширование повторяющихся префиксов снижает расходы на токены и задержку
Повторно использовать большой контекст Gemini в разных запросах	Явное кэширование Gemini	Явное создание cachedContents и ссылка на них дают более предсказуемые попадания в кэш
Указать, какой провайдер обрабатывает запрос	Маршрутизация провайдеров	По умолчанию маршрутизация автоматическая; при необходимости укажите `provider.type`
Автоматически переключаться на резервную модель при ошибке основной	Аварийное переключение	`provider.fallback`, не более 3 резервных моделей

При ошибках

Если запрос завершился ошибкой, был ограничен или заблокирован, начните отсюда.

Ситуация	Руководство	Ключевые моменты
Ошибка: как её обработать и нужно ли повторять запрос	Обработка ошибок и повторные попытки	Коды состояния, формат ошибок, экспоненциальный откат и тайм-ауты
429 Too Many Requests	Лимиты запросов	По умолчанию 100 RPM суммарно на команду; время ожидания определяется по заголовкам ответа
Запрос заблокирован или приостановлен проверкой безопасности контента	Безопасность контента	Правила срабатывания, длительность приостановки и способ восстановления

SDK и фреймворки

Подключение из кода с помощью готовых SDK или фреймворков: изменяются только адрес API и Key.

Что вы используете	Руководство
Официальный OpenAI SDK (перенос существующего проекта)	OpenAI SDK
LangChain	LangChain
LlamaIndex	LlamaIndex