Перейти к содержимому

Использование API и Playground

Playground предназначен для быстрого онлайн-тестирования моделей ИИ: введите вопрос или инструкцию, пообщайтесь с моделью и посмотрите результат. Вход — «Playground» в левой навигации или /playground.

  1. Выберите группу и модель: под полем ввода выберите доступную группу моделей и конкретную модель для этого диалога.
  2. Задайте параметры запроса: нажмите кнопку параметров и при необходимости включите и настройте температуру, Top P, штраф за частоту, штраф за присутствие и максимальное число токенов.
  3. Введите текст: наберите вопрос, инструкцию или промпт в поле внизу.
  4. Отправьте запрос: проверив модель, параметры и текст, нажмите «Отправить».
  5. Посмотрите ответ: после завершения генерации прочитайте ответ в области диалога и продолжайте вводить новые вопросы для многошагового общения.

Адрес шлюза, совместимый с OpenAI, обычно выглядит так:

https://your-host/v1

В качестве Bearer-токена используйте API-ключ:

Authorization: Bearer sk-your-api-key

Пример для чата:

Окно терминала
curl https://your-host/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer sk-your-api-key" \
-d '{"model":"gpt-4o-mini","messages":[{"role":"user","content":"Привет"}]}'
from openai import OpenAI
client = OpenAI(
api_key="sk-xxxxxxxx",
base_url="https://your-host/v1",
)
response = client.chat.completions.create(
model="gpt-4o-mini",
messages=[{"role": "user", "content": "Привет"}],
)
print(response.choices[0].message.content)
Окно терминала
curl https://your-host/v1/messages \
-H "x-api-key: sk-xxxxxxxx" \
-H "anthropic-version: 2023-06-01" \
-H "content-type: application/json" \
-d '{"model": "claude-3-5-sonnet-20241022", "max_tokens": 1024, "messages": [{"role": "user", "content": "Hello"}]}'
Окно терминала
curl "https://your-host/v1beta/models/gemini-1.5-pro:generateContent?key=sk-xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"contents": [{"parts": [{"text": "Hello"}]}]}'
Конечная точка Путь Описание
Чат-дополнение POST /v1/chat/completions Эндпоинт, совместимый с OpenAI Chat Completions. Требует model и messages, поддерживает потоковые и обычные ответы.
Чат Playground POST /pg/chat/completions Служебный эндпоинт веб-Playground. Аутентифицируется сеансом входа, а не API-ключом; тарификация такая же, как у обычных вызовов.
Текстовое дополнение POST /v1/completions Классический эндпоинт текстового дополнения. Требует prompt и model.
Responses API POST /v1/responses Эндпоинт формата OpenAI Responses с поддержкой входных данных, инструментов и событий ответа.
Сжатие Responses POST /v1/responses/compact Сжимает контекст запроса Responses.
Claude Messages POST /v1/messages Эндпоинт, совместимый с Anthropic Claude Messages. Требует model и содержимое сообщений, при необходимости конвертируется в вышестоящий протокол.
Веб-поиск Codex POST /v1/alpha/search Отдельный формат веб-поиска Codex, поддерживается лишь частью моделей.
Диалог в реальном времени GET /v1/realtime (WebSocket) Двунаправленный эндпоинт в стиле OpenAI Realtime. Модель обычно передаётся параметром запроса, а API-ключ — Bearer-токеном или подпротоколом WebSocket.
Конечная точка Путь Описание
Эмбеддинги POST /v1/embeddings Преобразует текст или массив текстов в векторы. Требует input.
Эмбеддинги в стиле Gemini POST /v1/engines/{model}/embeddings Старый путь эмбеддингов в стиле Gemini: имя модели берётся из URL.
Переранжирование POST /v1/rerank Сортирует документы documents по релевантности запросу query. Запрос и список документов не должны быть пустыми.
Модерация POST /v1/moderations Выполняет модерацию текста или других входных данных. Если модель не указана, используется модель модерации по умолчанию.
Конечная точка Путь Описание
Генерация изображений POST /v1/images/generations Создаёт изображения по промпту. Доступные размеры, уровни качества и количество зависят от выбранной модели.
Редактирование изображений POST /v1/images/edits Редактирует изображение по исходной картинке и промпту. Поддерживает JSON и multipart/form-data.
Старый эндпоинт редактирования POST /v1/edits Сохранённый путь совместимости, ведущий в реле изображений. Новым клиентам рекомендуется /v1/images/edits.
Распознавание речи POST /v1/audio/transcriptions Преобразует аудио в текст и пересылает запрос в соответствующий канал распознавания в формате аудио-API OpenAI.
Перевод аудио POST /v1/audio/translations Распознаёт содержимое аудио и возвращает переведённый текст.
Синтез речи POST /v1/audio/speech Преобразует входной текст в аудио.

Асинхронные эндпоинты генерации видео, музыки и подобного описаны в разделе «Асинхронная генерация и задачи» страницы Журналы и асинхронные задачи.

Конечная точка Путь Описание
Список моделей GET /v1/models По умолчанию возвращает список в формате OpenAI. С заголовками Anthropic — формат Claude, с заголовком x-goog-api-key или параметром key — формат Gemini.
Сведения о модели GET /v1/models/{model} Возвращает сведения об одной модели; если её нет — объект ошибки model_not_found.
Список моделей Gemini GET /v1beta/models Возвращает доступные модели в формате Gemini; поля ответа — models и nextPageToken.
Список моделей в формате OpenAI GET /v1beta/openai/models Возвращает список в формате OpenAI внутри пространства имён, совместимого с Gemini.
Конечная точка Путь Описание
Нативный вызов Gemini POST /v1beta/models/{model}:{action} Эндпоинт нативного формата Gemini с поддержкой generateContent, streamGenerateContent и операций эмбеддинга.
Совместимый вызов Gemini POST /v1/models/{model}:{action} Принимает операции в стиле Gemini под префиксом /v1; разбор и конвертацию выполняет реле Gemini.