Embeddings API
Преобразуйте текст в вектор для поиска, кластеризации и сравнения близости документов.
POST
/v1/embeddingsЗаголовки
AuthorizationBearer <API_KEY>Обязательно- Ключ компании из раздела «API-ключи». Храните на сервере или в переменной окружения. Не вставляйте секретный ключ в браузерный код.
Content-Typeapplication/jsonДля JSON-тела- Кодировка UTF-8. Для файлов используйте multipart/form-data; curl и SDK сами добавят boundary. Для GET и DELETE без тела не нужен.
Acceptapplication/json | text/event-streamНеобязательно- Ожидаемый формат ответа. Для включения SSE нужно также передать stream: true в JSON. Синтез речи и скачивание видео возвращают бинарные данные.
Адрес метода: https://gateway.orlime.ru/v1/embeddings
Входные параметры
modelstringОбязательно- Публичный ID из GET /v1/models. Возможности и допустимые параметры смотрите в карточке модели.
inputstring | arrayОбязательно- Один текст или массив текстов. Некоторые модели также принимают массивы ID токенов.
encoding_formatstringНеобязательно- float — массив чисел; base64 — кодированное представление.
dimensionsinteger > 0При поддержке модели- Размерность вектора. Допустимые значения зависят от модели.
Пример запроса
curl --fail-with-body https://gateway.orlime.ru/v1/embeddings \
-H "Authorization: Bearer $ORLIME_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "openai/text-embedding-3-small",
"input": [
"Как пополнить баланс?",
"Оплата по счёту"
],
"encoding_format": "float"
}'Ответ
object"list"Всегда- Тип списка.
modelstringВсегда- Публичный ID модели.
data[].object / index"embedding" / integerЕсли доступно- Тип элемента и индекс соответствующего входного текста.
data[].embeddingnumber[] | stringВ ответе- Вектор или base64 согласно encoding_format. Длина зависит от модели и dimensions.
usageobjectЕсли доступно- prompt_tokens и total_tokens.
usage.cost_rubstringЕсли расчёт завершён- Сумма фактического списания в рублях за весь запрос. Десятичная строка с 12 знаками после запятой. Отсутствие поля не означает бесплатный запрос.
{
"object": "list",
"model": "openai/text-embedding-3-small",
"data": [
{
"object": "embedding",
"index": 0,
"embedding": [
0.12,
-0.34,
0.56
]
}
],
"usage": {
"prompt_tokens": 8,
"total_tokens": 8,
"cost_rub": "0.000100000000"
}
}Заголовки ответа
x-request-idstringОтвет Gateway- ID операции для поиска в журнале и обращения в поддержку. В Chat Completions и Responses совпадает с верхнеуровневым id ответа.
Content-TypestringОтвет Gateway- application/json, text/event-stream или MIME-тип аудио/видео. Ошибки файловых методов могут возвращаться как JSON.
Retry-AfterintegerЕсли возвращён- Число секунд до рекомендуемого повтора. Отсутствие заголовка не означает, что запрос следует немедленно повторять.
Особенности
- В примере вектор сокращён. Для сохранения используйте полный массив из реального ответа. Streaming не поддерживается.
Ошибки
Ошибки возвращаются в объекте error с полями message, type, code и param. Сохраните x-request-id для поиска запроса. Формат и справочник ошибок
