Справочник по OpenAI API

Чат

Создать чат-ответ

POST https://api.rockapi.ru/openai/v1/chat/completions

Создает ответ модели для данного чата.

Тело запроса

Параметр	Тип	Обязательный	По умолчанию	Описание	Под-параметры
`messages`	array	Обязательный	-	Список сообщений, составляющих текущую беседу. Пример кода на Python.	- `role` (string): Обязательный. Роль автора сообщения. - `content` (string или array): Обязательный для большинства ролей. Содержание сообщения. - `name` (string): Необязательный. Имя участника. - `tool_calls` (array): Необязательный. Вызовы инструментов, сгенерированные моделью (для роли "assistant"). - `function_call` (object): Устарело. Информация о вызове функции (для роли "assistant"). - `tool_call_id` (string): Обязательный для роли "tool". ID вызова инструмента, на который дается ответ.
`model`	string	Обязательный	-	ID модели для использования. См. таблицу совместимости моделей с конечными точками для деталей о том, какие модели работают с Chat API.	-
`frequency_penalty`	number или null	Необязательный	0	Число от -2.0 до 2.0. Положительные значения штрафуют новые токены на основе их частоты в тексте до сих пор, уменьшая вероятность того, что модель повторит ту же строку дословно. Подробнее о штрафах за частоту и наличие.	-
`logit_bias`	map	Необязательный	null	Изменяет вероятность появления указанных токенов в завершении. Принимает объект JSON, который сопоставляет токены (указанные по их ID токенов в токенизаторе) с соответствующим значением смещения от -100 до 100.	-
`logprobs`	boolean или null	Необязательный	false	Возвращать ли логарифмические вероятности выходных токенов. Если true, возвращает логарифмические вероятности каждого выходного токена в `content` сообщения.	-
`top_logprobs`	integer или null	Необязательный	-	Число от 0 до 20, указывающее количество наиболее вероятных токенов для возвращения на каждой позиции токена, каждый с ассоциированной логарифмической вероятностью. `logprobs` должен быть установлен в `true`, если используется этот параметр.	-
`max_tokens`	integer или null	Необязательный	-	Максимальное количество токенов, которые могут быть сгенерированы в чат-завершении. Общая длина входных токенов и сгенерированных токенов ограничена длиной контекста модели. Пример кода на Python для подсчета токенов.	-
`n`	integer или null	Необязательный	1	Сколько вариантов завершений чата генерировать для каждого входного сообщения. Обратите внимание, что плата будет взиматься на основе количества сгенерированных токенов по всем вариантам. Оставьте `n` как `1`, чтобы минимизировать расходы.	-
`presence_penalty`	number или null	Необязательный	0	Число от -2.0 до 2.0. Положительные значения штрафуют новые токены на основе того, появляются ли они в тексте до сих пор, увеличивая вероятность того, что модель будет говорить о новых темах. Подробнее о штрафах за частоту и наличие.	-
`response_format`	object	Необязательный	-	Объект, указывающий формат, который модель должна выводить. Совместим с GPT-4 Turbo и всеми моделями GPT-3.5 Turbo, новее `gpt-3.5-turbo-1106`. Установка на `{"type": "json_object"}` включает режим JSON, который гарантирует, что сообщение, сгенерированное моделью, является допустимым JSON.	-
`seed`	integer или null	Необязательный	-	Эта функция находится в стадии бета-тестирования. Если указано, наша система постарается сделать выбор детерминированным, так что повторные запросы с одним и тем же `seed` и параметрами должны возвращать один и тот же результат. Детерминизм не гарантируется, и вы должны ссылаться на параметр ответа `system_fingerprint`, чтобы отслеживать изменения на заднем фоне.	-
`service_tier`	string или null	Необязательный	null	Указывает уровень обслуживания для обработки запроса. Этот параметр актуален для клиентов, подписанных на сервис уровня scale. Если установлен в 'auto', система будет использовать кредиты уровня scale до их исчерпания. Если установлен в 'default', запрос будет обработан с использованием уровня обслуживания по умолчанию с более низким SLA и без гарантий задержки. Когда этот параметр установлен, тело ответа будет включать использованный `service_tier`.	-
`stop`	string / array / null	Необязательный	null	До 4 последовательностей, где API прекратит генерацию дальнейших токенов.	-
`stream`	boolean или null	Необязательный	false	Если установлено, частичные дельты сообщений будут отправлены, как в ChatGPT. Токены будут отправлены как данные только событий сервера, как только они станут доступны, с завершением потока сообщением `data: [DONE]`. Пример кода на Python.	-
`stream_options`	object или null	Необязательный	null	Параметры для потокового ответа. Устанавливайте это только при установке `stream: true`.	-
`temperature`	number или null	Необязательный	1	Какую температуру выборки использовать, от 0 до 2. Более высокие значения, такие как 0.8, сделают выход более случайным, в то время как более низкие значения, такие как 0.2, сделают его более сфокусированным и детерминированным. Мы обычно рекомендуем изменять это или `top_p`, но не оба сразу.	-
`top_p`	number или null	Необязательный	1	Альтернатива выборке с температурой, называемая выборкой по ядру, при которой модель рассматривает результаты токенов с вероятностью топ_p. Так 0.1 означает, что учитываются только токены, составляющие верхние 10% вероятности. Мы обычно рекомендуем изменять это или `temperature`, но не оба сразу.	-
`tools`	array	Необязательный	-	Список инструментов, которые может вызвать модель. В настоящее время поддерживаются только функции как инструмент. Используйте это, чтобы предоставить список функций, для которых модель может генерировать JSON входные данные. Поддерживается максимум 128 функций.	- `type` (string): Обязательный. Тип инструмента. В настоящее время поддерживается только `function`. - `function` (object): Обязательный. Содержит `name` (string, обязательный), `description` (string, необязательный), и `parameters` (object, необязательный)
`tool_choice`	string или object	Необязательный	-	Управляет тем, какой (если есть) инструмент вызывается моделью. `none` означает, что модель не будет вызывать инструмент и вместо этого генерирует сообщение. `auto` означает, что модель может выбирать между генерацией сообщения или вызовом одного или нескольких инструментов. `required` означает, что модель должна вызвать один или несколько инструментов. Указание конкретного инструмента через `{"type": "function", "function": {"name": "my_function"}}` заставляет модель вызвать этот инструмент. `none` является значением по умолчанию, когда инструменты отсутствуют. `auto` является значением по умолчанию, если инструменты присутствуют.	Если объект: - `type` (string): Обязательный. Тип инструмента. В настоящее время поддерживается только `function`. - `function` (object): Обязательный. Содержит `name` (string), указывающее имя вызываемой функции.
`parallel_tool_calls`	boolean	Необязательный	true	Включить ли параллельный вызов функций при использовании инструмента.	-
`user`	string	Необязательный	-	Уникальный идентификатор, представляющий вашего конечного пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления. Подробнее.	-
`function_call`	string или object	Устарело	-	Устарело в пользу `tool_choice`. Управляет тем, какая (если есть) функция вызывается моделью. `none` означает, что модель не будет вызывать функцию и вместо этого генерирует сообщение. `auto` означает, что модель может выбирать между генерацией сообщения или вызовом функции. Указание конкретной функции через `{"name": "my_function"}` заставляет модель вызвать эту функцию. `none` является значением по умолчанию, когда функции отсутствуют. `auto` является значением по умолчанию, если функции присутствуют.	Если объект: - `name` (string): Имя вызываемой функции.
`functions`	array	Устарело	-	Устарело в пользу `tools`. Список функций, для которых модель может генерировать JSON входные данные.	- `name` (string): Обязательный. Имя функции. - `description` (string): Необязательный. Описание того, что делает функция. - `parameters` (object): Необязательный. Параметры, принимаемые функцией, описанные как объект JSON Schema.

Возвращает

Возвращает объект завершения чата, или поток последовательности объектов фрагмента завершения чата, если запрос передается потоком.

Пример запроса

curl https://api.rockapi.ru/openai/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ROCKAPI_API_KEY" \
  -d '{
    "model": "gpt-4o",
    "messages": [
      {
        "role": "system",
        "content": "You are a helpful assistant."
      },
      {
        "role": "user",
        "content": "Hello!"
      }
    ]
  }'

Пример ответа

{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "created": 1677652288,
  "model": "gpt-4o-mini",
  "system_fingerprint": "fp_44709d6fcb",
  "choices": [{
    "index": 0,
    "message": {
      "role": "assistant",
      "content": "\n\nHello there, how may I assist you today?",
    },
    "logprobs": null,
    "finish_reason": "stop"
  }],
  "usage": {
    "prompt_tokens": 9,
    "completion_tokens": 12,
    "total_tokens": 21
  }
}

Объект завершения чата

Представляет собой ответ на завершение чата, возвращенный моделью, на основе предоставленного ввода.

Поле	Тип	Описание
`id`	string	Уникальный идентификатор завершения чата.
`choices`	array	Список вариантов завершения чата. Может быть больше одного, если `n` больше 1.
`created`	integer	Unix временная метка (в секундах), когда было создано завершение чата.
`model`	string	Модель, использованная для завершения чата.
`service_tier`	string или null	Уровень обслуживания, использованный для обработки запроса. Это поле включается только, если параметр `service_tier` указан в запросе.
`system_fingerprint`	string	Этот отпечаток представляет конфигурацию бэкенда, с которой работает модель. Может использоваться вместе с параметром запроса `seed`, чтобы понять, когда были внесены изменения в бэкенд, которые могут повлиять на детерминизм.
`object`	string	Тип объекта, всегда `chat.completion`.
`usage`	object	Статистика использования для запроса завершения.

Пример

{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "created": 1677652288,
  "model": "gpt-4o-mini",
  "system_fingerprint": "fp_44709d6fcb",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "\n\nHello there, how may I assist you today?"
      },
      "logprobs": null,
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 9,
    "completion_tokens": 12,
    "total_tokens": 21
  }
}

Объект фрагмента завершения чата

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

Поле	Тип	Описание
`id`	string	Уникальный идентификатор завершения чата. Каждый фрагмент имеет тот же ID.
`choices`	array	Список вариантов завершения чата. Может содержать более одного элемента, если `n` больше 1. Может также быть пустым для последнего фрагмента, если вы установили `stream_options: {"include_usage": true}`.
`created`	integer	Unix временная метка (в секундах), когда было создано завершение чата. Каждый фрагмент имеет ту же временную метку.
`model`	string	Модель для генерации завершения.
`service_tier`	string или null	Уровень обслуживания, использованный для обработки запроса. Это поле включается только, если параметр `service_tier` указан в запросе.
`system_fingerprint`	string	Этот отпечаток представляет конфигурацию бэкенда, с которой работает модель. Может использоваться вместе с параметром запроса `seed`, чтобы понять, когда были внесены изменения в бэкенд, которые могут повлиять на детерминизм.
`object`	string	Тип объекта, всегда `chat.completion.chunk`.
`usage`	object	Необязательное поле, которое будет присутствовать только, если вы установите `stream_options: {"include_usage": true}` в вашем запросе. Когда присутствует, оно содержит null значение, за исключением последнего фрагмента, который содержит статистику использования токенов для всего запроса.

Пример

{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-4o-mini", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{"role":"assistant","content":""},"logprobs":null,"finish_reason":null}]}

{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-4o-mini", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{"content":"Hello"},"logprobs":null,"finish_reason":null}]}

....

{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-4o-mini", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{},"logprobs":null,"finish_reason":"stop"}]}

Изображения

Дает возможность создать изображение по текстовому описанию и/или входному изображению.

Связанный гайд: Создание изображений

Создать изображение

POST https://api.rockapi.ru/openai/v1/images/generations

Создает изображение по текстовому описанию.

Тело запроса

Параметр	Тип	Обязательный	По умолчанию	Описание
`prompt`	string	Обязательный	-	Текстовое описание желаемого изображения(й). Максимальная длина 1000 символов для `dall-e-2` и 4000 символов для `dall-e-3`.
`model`	string	Необязательный	`dall-e-2`	Модель для создания изображения. По умолчанию `dall-e-2`.
`n`	integer	Необязательный	1	Количество изображений для создания. Должно быть от 1 до 10. Для `dall-e-3` поддерживается только `n=1`. По умолчанию 1.
`quality`	string	Необязательный	-	Качество создаваемого изображения. `hd` создает изображения с более тонкими деталями и большей консистентностью. Этот параметр поддерживается только для `dall-e-3`.
`response_format`	string	Необязательный	`url`	Формат, в котором возвращаются сгенерированные изображения. Должен быть `url` или `b64_json`. URL-адреса действительны в течение 60 минут после создания изображения. По умолчанию `url`.
`size`	string	Необязательный	`1024x1024`	Размер создаваемых изображений. Должен быть `256x256`, `512x512` или `1024x1024` для `dall-e-2`. Должен быть `1024x1024`, `1792x1024` или `1024x1792` для `dall-e-3`. По умолчанию `1024x1024`.
`style`	string	Необязательный	-	Стиль создаваемых изображений. Должен быть `vivid` или `natural`. `Vivid` заставляет модель стремиться к созданию гиперреалистичных и драматичных изображений. `Natural` заставляет модель производить более естественные, менее гиперреалистичные изображения. Этот параметр поддерживается только для `dall-e-3`.
`user`	string	Необязательный	-	Уникальный идентификатор, представляющий вашего конечного пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления. Подробнее.

Возвращает

Возвращает список объектов изображения.

Пример запроса

curl https://api.rockapi.ru/openai/v1/images/generations \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ROCKAPI_API_KEY" \
  -d '{
    "model": "dall-e-3",
    "prompt": "A cute baby sea otter",
    "n": 1,
    "size": "1024x1024"
  }'

Ответ

{
  "created": 1589478378,
  "data": [
    {
      "revised_prompt": "...",
      "url": "https://..."
    },
    {
      "revised_prompt": "...",
      "url": "https://..."
    }
  ]
}

Создание редактированного изображения

Скоро

POST https://api.rockapi.ru/openai/v1/images/edits

Создает редактированное или расширенное изображение, исходя из оригинального изображения и текстового описания.

Тело запроса

Параметр	Тип	Обязательный	По умолчанию	Описание
`image`	file	Обязательный	-	Изображение для редактирования. Должно быть допустимым файлом PNG, менее 4 МБ и квадратным. Если маска не предоставлена, изображение должно иметь прозрачность, которая будет использована в качестве маски.
`prompt`	string	Обязательный	-	Текстовое описание желаемого изображения(й). Максимальная длина 1000 символов.
`mask`	file	Необязательный	-	Дополнительное изображение, чьи полностью прозрачные области (например, где альфа равен нулю) указывают, где `image` должно быть отредактировано. Должно быть допустимым файлом PNG, менее 4 МБ и иметь те же размеры, что и `image`.
`model`	string	Необязательный	`dall-e-2`	Модель для создания изображения. В настоящее время поддерживается только `dall-e-2`.
`n`	integer	Необязательный	1	Количество изображений для создания. Должно быть от 1 до 10. По умолчанию 1.
`size`	string	Необязательный	`1024x1024`	Размер создаваемых изображений. Должен быть `256x256`, `512x512` или `1024x1024`. По умолчанию `1024x1024`.
`response_format`	string	Необязательный	`url`	Формат, в котором возвращаются сгенерированные изображения. Должен быть `url` или `b64_json`. URL-адреса действительны в течение 60 минут после создания изображения. По умолчанию `url`.
`user`	string	Необязательный	-	Уникальный идентификатор, представляющий вашего конечного пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления. Подробнее.

Возвращает

Возвращает список объектов изображения.

Пример запроса

curl https://api.rockapi.ru/openai/v1/images/edits \
  -H "Authorization: Bearer $ROCKAPI_API_KEY" \
  -F image="@otter.png" \
  -F mask="@mask.png" \
  -F prompt="A cute baby sea otter wearing a beret" \
  -F n=2 \
  -F size="1024x1024"

Ответ

{
  "created": 1589478378,
  "data": [
    {
      "url": "https://..."
    },
    {
      "url": "https://..."
    }
  ]
}

Создание вариации изображения

Скоро

POST https://api.rockapi.ru/openai/v1/images/variations

Создает вариацию данного изображения.

Тело запроса

Параметр	Тип	Обязательный	По умолчанию	Описание
`image`	file	Обязательный	-	Изображение для использования в качестве основы для вариаций. Должно быть допустимым файлом PNG, менее 4 МБ и квадратным.
`model`	string	Необязательный	`dall-e-2`	Модель для создания изображения. В настоящее время поддерживается только `dall-e-2`.
`n`	integer	Необязательный	1	Количество изображений для создания. Должно быть от 1 до 10. Для `dall-e-3` поддерживается только `n=1`. По умолчанию 1.
`response_format`	string	Необязательный	`url`	Формат, в котором возвращаются сгенерированные изображения. Должен быть `url` или `b64_json`. URL-адреса действительны в течение 60 минут после создания изображения. По умолчанию `url`.
`size`	string	Необязательный	`1024x1024`	Размер создаваемых изображений. Должен быть `256x256`, `512x512` или `1024x1024`. По умолчанию `1024x1024`.
`user`	string	Необязательный	-	Уникальный идентификатор, представляющий вашего конечного пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления. Подробнее.

Возвращает

Возвращает список объектов изображения.

Пример запроса

curl https://api.rockapi.ru/openai/v1/images/variations \
  -H "Authorization: Bearer $ROCKAPI_API_KEY" \
  -F image="@otter.png" \
  -F n=2 \
  -F size="1024x1024"

Ответ

json
{
  "created": 1589478378,
  "data": [
    {
      "url": "https://..."
    },
    {
      "url": "https://..."
    }
  ]
}

Объект изображения

Представляет собой URL или содержимое изображения, сгенерированного OpenAI API.

Имя	Тип	Описание
`b64_json`	string	Base64-кодированный JSON сгенерированного изображения, если `response_format` установлен в `b64_json`.
`url`	string	URL сгенерированного изображения, если `response_format` установлен в `url` (по умолчанию).
`revised_prompt`	string	Описание, которое было использовано для создания изображения, если в описание были внесены изменения.

Пример

{
  "url": "...",
  "revised_prompt": "..."
}

Аудио

Научитесь преобразовывать аудио в текст или текст в аудио.

Связанный гайд: Речь в текст

Создание речи

POST https://api.rockapi.ru/openai/v1/audio/speech

Создает аудио из входного текста.

Тело запроса

Параметр	Тип	Обязательный	По умолчанию	Описание
`model`	string	Обязательный	-	Одна из доступных моделей TTS: `tts-1` или `tts-1-hd`.
`input`	string	Обязательный	-	Текст для создания аудио. Максимальная длина 4096 символов.
`voice`	string	Обязательный	-	Голос для использования при создании аудио. Поддерживаемые голоса: `alloy`, `echo`, `fable`, `onyx`, `nova`, и `shimmer`. Примеры голосов доступны в гайде по Text to Speech.
`response_format`	string	Необязательный	`mp3`	Формат для аудио. Поддерживаемые форматы: `mp3`, `opus`, `aac`, `flac`, `wav`, и `pcm`. По умолчанию mp3.
`speed`	number	Необязательный	1.0	Скорость создаваемого аудио. Выберите значение от `0.25` до `4.0`. По умолчанию 1.0.

Возвращает

Содержимое аудиофайла.

Пример запроса

curl https://api.rockapi.ru/openai/v1/audio/speech \
  -H "Authorization: Bearer $ROCKAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "tts-1",
    "input": "The quick brown fox jumped over the lazy dog.",
    "voice": "alloy"
  }' \
  --output speech.mp3

Создание транскрипции

POST https://api.rockapi.ru/openai/v1/audio/transcriptions

Преобразует аудио в текст на языке входного аудио.

Тело запроса

Параметр	Тип	Обязательный	По умолчанию	Описание
`file`	file	Обязательный	-	Аудиофайл для транскрипции, в одном из следующих форматов: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, или webm.
`model`	string	Обязательный	-	ID модели для использования. В настоящее время доступна только `whisper-1` (на базе нашей модели Whisper V2 с открытым исходным кодом).
`language`	string	Необязательный	-	Язык входного аудио. Указание языка входного аудио в формате ISO-639-1 улучшит точность и задержку.
`prompt`	string	Необязательный	-	Необязательный текст для направления стиля модели или продолжения предыдущего аудиосегмента. Описание должно соответствовать языку аудио.
`response_format`	string	Необязательный	`json`	Формат вывода транскрипции, в одном из следующих вариантов: `json`, `text`, `srt`, `verbose_json`, или `vtt`. По умолчанию json.
`temperature`	number	Необязательный	-	Температура выборки, от 0 до 1. Более высокие значения, такие как 0.8, сделают вывод более случайным, в то время как более низкие значения, такие как 0.2, сделают его более сфокусированным и детерминированным. Если установлено 0, модель будет использовать логарифмическую вероятность для автоматического увеличения температуры до достижения определенных порогов.
`timestamp_granularities`	array	Необязательный	-	Гранулярности временных меток для этой транскрипции. `response_format` должен быть установлен в `verbose_json`, чтобы использовать гранулярности временных меток. Поддерживаются следующие опции: `word`, или `segment`. Примечание: Нет дополнительной задержки для временных меток сегментов, но генерация временных меток слов влечет за собой дополнительную задержку.

Возвращает

Объект транскрипции или подробный объект транскрипции.

Пример запроса

curl https://api.rockapi.ru/openai/v1/audio/transcriptions \
  -H "Authorization: Bearer $ROCKAPI_API_KEY" \
  -H "Content-Type: multipart/form-data" \
  -F file="@/path/to/file/audio.mp3" \
  -F model="whisper-1"

Ответ

{
  "text": "Imagine the wildest idea that you've ever had, and you're curious about how it might scale to something that's a 100, a 1,000 times bigger. This is a place where you can get to do that."
}

Создание перевода

POST https://api.rockapi.ru/openai/v1/audio/translations

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

Тело запроса

Параметр	Тип	Обязательный	По умолчанию	Описание
`file`	file	Обязательный	-	Аудиофайл для перевода, в одном из следующих форматов: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, или webm.
`model`	string	Обязательный	-	ID модели для использования. В настоящее время доступна только `whisper-1` (на базе нашей модели Whisper V2 с открытым исходным кодом).
`prompt`	string	Необязательный	-	Необязательный текст для направления стиля модели или продолжения предыдущего аудиосегмента. Описание должно быть на английском языке.
`response_format`	string	Необязательный	`json`	Формат вывода транскрипции, в одном из следующих вариантов: `json`, `text`, `srt`, `verbose_json`, или `vtt`. По умолчанию json.
`temperature`	number	Необязательный	-	Температура выборки, от 0 до 1. Более высокие значения, такие как 0.8, сделают вывод более случайным, в то время как более низкие значения, такие как 0.2, сделают его более сфокусированным и детерминированным. Если установлено 0, модель будет использовать логарифмическую вероятность для автоматического увеличения температуры до достижения определенных порогов.

Возвращает

Переведенный текст.

Пример запроса

curl https://api.rockapi.ru/openai/v1/audio/translations \
  -H "Authorization: Bearer $ROCKAPI_API_KEY" \
  -H "Content-Type: multipart/form-data" \
  -F file="@/path

/to/file/german.m4a" \
  -F model="whisper-1"

Ответ

{
  "text": "Hello, my name is Wolfgang and I come from Germany. Where are you heading today?"
}

Объект транскрипции (JSON)

Представляет собой ответ транскрипции, возвращенный моделью, на основе предоставленного ввода.

Поле	Тип	Описание
`text`	string	Транскрибированный текст.

Пример

{
  "text": "Imagine the wildest idea that you've ever had, and you're curious about how it might scale to something that's a 100, a 1,000 times bigger. This is a place where you can get to do that."
}

Объект транскрипции (подробный JSON)

Представляет собой подробный JSON ответ транскрипции, возвращенный моделью, на основе предоставленного ввода.

Поле	Тип	Описание
`task`	string	Тип задачи.
`language`	string	Язык входного аудио.
`duration`	string	Длительность входного аудио.
`text`	string	Транскрибированный текст.
`segments`	array	Сегменты транскрибированного текста и их соответствующие детали.
`words`	array	Извлеченные слова и их соответствующие временные метки.

Пример

{
  "task": "transcribe",
  "language": "english",
  "duration": 8.470000267028809,
  "text": "The beach was a popular spot on a hot summer day. People were swimming in the ocean, building sandcastles, and playing beach volleyball.",
  "segments": [
    {
      "id": 0,
      "seek": 0,
      "start": 0.0,
      "end": 3.319999933242798,
      "text": " The beach was a popular spot on a hot summer day.",
      "tokens": [
        50364, 440, 7534, 390, 257, 3743, 4008, 322, 257, 2368, 4266, 786, 13, 50530
      ],
      "temperature": 0.0,
      "avg_logprob": -0.2860786020755768,
      "compression_ratio": 1.2363636493682861,
      "no_speech_prob": 0.00985979475080967
    },
    ...
  ]
}

Встраивания

Получите векторное представление данного ввода, которое может быть легко использовано моделями и алгоритмами машинного обучения.

Связанный гайд: Встраивания

Создание встраиваний

POST https://api.rockapi.ru/openai/v1/embeddings

Создает вектор встраивания, представляющий входной текст.

Тело запроса

Параметр	Тип	Обязательный	По умолчанию	Описание
`input`	string или array	Обязательный	-	Входной текст для встраивания, закодированный как строка или массив токенов. Для встраивания нескольких вводов в одном запросе, передайте массив строк или массив массивов токенов. Ввод не должен превышать максимальное количество входных токенов для модели (8192 токенов для `text-embedding-ada-002`), не может быть пустой строкой, и любой массив должен быть размером не более 2048. Пример кода на Python для подсчета токенов.
`model`	string	Обязательный	-	ID модели для использования. Вы можете использовать API Список моделей, чтобы увидеть все доступные вам модели, или ознакомиться с нашим Обзором моделей для их описания.
`encoding_format`	string	Необязательный	float	Формат для возвращения встраиваний. Может быть `float` или `base64`.
`dimensions`	integer	Необязательный	-	Количество измерений, которые должны иметь результирующие встраивания. Поддерживается только в моделях `text-embedding-3` и новее.
`user`	string	Необязательный	-	Уникальный идентификатор, представляющий вашего конечного пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления. Подробнее.

Возвращает

Список объектов встраивания.

Пример запроса

curl https://api.rockapi.ru/openai/v1/embeddings \
  -H "Authorization: Bearer $ROCKAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "input": "The food was delicious and the waiter...",
    "model": "text-embedding-ada-002",
    "encoding_format": "float"
  }'

Ответ

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        0.0023064255,
        -0.009327292,
        .... (1536 чисел с плавающей точкой для ada-002)
        -0.0028842222,
      ],
      "index": 0
    }
  ],
  "model": "text-embedding-ada-002",
  "usage": {
    "prompt_tokens": 8,
    "total_tokens": 8
  }
}

Объект встраивания

Представляет собой вектор встраивания, возвращенный конечной точкой встраивания.

Поле	Тип	Описание
`index`	integer	Индекс встраивания в списке встраиваний.
`embedding`	array	Вектор встраивания, который является списком чисел с плавающей точкой. Длина вектора зависит от модели, как указано в гайде по встраиваниям.
`object`	string	Тип объекта, всегда "embedding".

Пример

{
  "object": "embedding",
  "embedding": [
    0.0023064255,
    -0.009327292,
    .... (1536 чисел с плавающей точкой для ada-002)
    -0.0028842222,
  ],
  "index": 0
}

Модерация

Классифицирует вводимый текст как потенциально вредный по нескольким категориям.

Связанный гайд: Модерация

Создание модерации

POST https://api.rockapi.ru/openai/v1/moderations

Классифицирует текст как потенциально вредный.

Тело запроса

Параметр	Тип	Обязательный	По умолчанию	Описание
`input`	string или array	Обязательный	-	Входной текст для классификации.
`model`	string	Необязательный	`text-moderation-latest`	Доступны две модели модерации контента: `text-moderation-stable` и `text-moderation-latest`. По умолчанию используется `text-moderation-latest`, которая будет автоматически обновляться со временем. Это гарантирует, что вы всегда используете нашу самую точную модель. Если вы используете `text-moderation-stable`, мы предоставим предварительное уведомление перед обновлением модели. Точность `text-moderation-stable` может быть немного ниже, чем у `text-moderation-latest`.

Возвращает

Объект модерации.

Пример запроса

curl https://api.rockapi.ru/openai/v1/moderations \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ROCKAPI_API_KEY" \
  -d '{
    "input": "I want to kill them."
  }'

Ответ

{
  "id": "modr-XXXXX",
  "model": "text-moderation-

005",
  "results": [
    {
      "flagged": true,
      "categories": {
        "sexual": false,
        "hate": false,
        "harassment": false,
        "self-harm": false,
        "sexual/minors": false,
        "hate/threatening": false,
        "violence/graphic": false,
        "self-harm/intent": false,
        "self-harm/instructions": false,
        "harassment/threatening": true,
        "violence": true,
      },
      "category_scores": {
        "sexual": 1.2282071e-06,
        "hate": 0.010696256,
        "harassment": 0.29842457,
        "self-harm": 1.5236925e-08,
        "sexual/minors": 5.7246268e-08,
        "hate/threatening": 0.0060676364,
        "violence/graphic": 4.435014e-06,
        "self-harm/intent": 8.098441e-10,
        "self-harm/instructions": 2.8498655e-11,
        "harassment/threatening": 0.63055265,
        "violence": 0.99011886,
      }
    }
  ]
}

Объект модерации

Представляет собой классификацию данного текстового ввода как потенциально вредного.

Поле	Тип	Описание
`id`	string	Уникальный идентификатор для запроса модерации.
`model`	string	Модель, использованная для генерации результатов модерации.
`results`	array	Список объектов модерации.

Пример

{
  "id": "modr-XXXXX",
  "model": "text-moderation-005",
  "results": [
    {
      "flagged": true,
      "categories": {
        "sexual": false,
        "hate": false,
        "harassment": false,
        "self-harm": false,
        "sexual/minors": false,
        "hate/threatening": false,
        "violence/graphic": false,
        "self-harm/intent": false,
        "self-harm/instructions": false,
        "harassment/threatening": true,
        "violence": true,
      },
      "category_scores": {
        "sexual": 1.2282071e-06,
        "hate": 0.010696256,
        "harassment": 0.29842457,
        "self-harm": 1.5236925e-08,
        "sexual/minors": 5.7246268e-08,
        "hate/threatening": 0.0060676364,
        "violence/graphic": 4.435014e-06,
        "self-harm/intent": 8.098441e-10,
        "self-harm/instructions": 2.8498655e-11,
        "harassment/threatening": 0.63055265,
        "violence": 0.99011886,
      }
    }
  ]
}

Справочник по OpenAI API

Чат​

Создать чат-ответ​

Тело запроса​

Возвращает​

Пример запроса​

Пример ответа​

Объект завершения чата​

Пример​

Объект фрагмента завершения чата​

Пример​

Изображения​

Создать изображение​

Тело запроса​

Возвращает​

Пример запроса​

Ответ​

Создание редактированного изображения​

Тело запроса​

Возвращает​

Пример запроса​

Ответ​

Создание вариации изображения​

Тело запроса​

Возвращает​

Пример запроса​

Ответ​

Объект изображения​

Пример​

Аудио​

Создание речи​

Тело запроса​

Возвращает​

Пример запроса​

Создание транскрипции​

Тело запроса​

Возвращает​

Пример запроса​

Ответ​

Создание перевода​

Тело запроса​

Возвращает​

Пример запроса​

Ответ​

Объект транскрипции (JSON)​

Пример​

Объект транскрипции (подробный JSON)​

Пример​

Встраивания​

Создание встраиваний​

Тело запроса​

Возвращает​

Пример запроса​

Ответ​

Объект встраивания​

Пример​

Модерация​

Создание модерации​

Тело запроса​

Возвращает​

Пример запроса​

Ответ​

Объект модерации​

Пример​

Чат

Создать чат-ответ

Тело запроса

Возвращает

Пример запроса

Пример ответа

Объект завершения чата

Пример

Объект фрагмента завершения чата

Пример

Изображения

Создать изображение

Тело запроса

Возвращает

Пример запроса

Ответ

Создание редактированного изображения

Тело запроса

Возвращает

Пример запроса

Ответ

Создание вариации изображения

Тело запроса

Возвращает

Пример запроса

Ответ

Объект изображения

Пример

Аудио

Создание речи

Тело запроса

Возвращает

Пример запроса

Создание транскрипции

Тело запроса

Возвращает

Пример запроса

Ответ

Создание перевода

Тело запроса

Возвращает

Пример запроса

Ответ

Объект транскрипции (JSON)

Пример

Объект транскрипции (подробный JSON)

Пример

Встраивания

Создание встраиваний

Тело запроса

Возвращает

Пример запроса

Ответ

Объект встраивания

Пример

Модерация

Создание модерации

Тело запроса

Возвращает

Пример запроса

Ответ

Объект модерации

Пример