OpenAI-формат

Описание

OpenAI-формат взаимодействия с LLM через GenAPI доступен по специальному поддомену, отличному от основного:

На нём доступен основной эндопинт /v1/chat/completions

Авторизация

Авторизация запросов производится с помощью Bearer токена (вашего API-ключа, созданного на сайте GenAPI) абсолютно аналогично, как и для всего остального нашего функционала. Подробно описано в разделе Авторизация.

Выбор модели

Указание конкретной модели, к которой идёт запрос, осуществляется через параметр model. Параметр model берётся из id нейросети.

Примеры выбора модели в запросе

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

Вариант 1. Использование общего идентификатора нейросети (slug)

В этом случае в параметре model передаётся идентификатор нейросети с сайта GenAPI (например, gpt-4). Запрос будет обработан одной из доступных подверсий модели (обычно базовой или наиболее свежей).

Вариант 2. Использование конкретной подверсии

Если нейросеть имеет несколько подверсий (например, gpt-4-turbo, gpt-4-32k), можно указать точное имя подверсии — ключ модели, который также отображается на сайте GenAPI.

Само тело запроса в нейросеть полностью соответствует стандартам OpenAI-формата, то есть то, как формируется тело запроса вы можете ознакомиться в документации OpenAI и прочих провайдеров. Тем не менее, здесь мы также пропишем основные возможности.

Общая структура запроса

Базовая структура запроса в OpenAI-формате:

Прикладывание изображений (vision)

Изображения передаются в массиве content через image_url (base64 или URL):

Можно передавать несколько изображений в одном запросе:

Инструменты (tools)

Инструменты позволяют модели вызывать внешние функции. Опишите функции в параметре tools:

Модель вернёт вызов инструмента в поле tool_calls:

Потоковая генерация (stream)

Включите stream: true для получения ответа по частям:

Сервер отправляет данные в формате SSE:

Особенности мышления (reasoning)

Для моделей с поддержкой мышления (o1, o3) используйте параметр reasoning_effort (low, medium, high):

Финальный пример

Пример запроса, объединяющего все возможности OpenAI-формата: vision, tools, stream и reasoning:

В этом примере:

• vision — анализ изображения в сообщении
• tools — инструменты для получения данных
• stream: true — потоковая передача ответа
• reasoning_effort — расширенное мышление модели