SvayaИИ-платформаПлатформаПримерыПродуктыВнедрение

Svaya / Документация / Программный интерфейс

Модели (генерация и эмбеддинги по ключу доступа)

Здесь собраны адреса, параметры, поля запросов и коды ответов раздела «Модели (генерация и эмбеддинги по ключу доступа)». Каждая операция описана отдельно, с таблицами полей.

Описание собрано из договора m23-gateway-api, версия 1.2.1. Как получить токен и в каком формате приходят ошибки, написано на странице «Обзор и вход».

Обращение к модели (формат Chat Completions, включая поток)

POST /v1/chat/completions операция chatCompletions

Ключ — одной строкой в заголовке Authorization (Bearer), как у обычного ключа доступа к модели. Строка несёт идентификатор клиента приложения организации и его секрет; обмен на служебный токен выполняет контур доступа. Организация берётся из привязки ключа, никогда — из заголовка запроса. Поле model — класс модели установки (bm/{class}), не имя провайдера. Поток — text/event-stream в совместимом формате; usage — в финальном событии.

Параметры

ПолеТипОбязательноОписание
Authorization (заголовок)stringдаBearer и ключ контура доступа: префикс bmk_ и base64url без выравнивания от строки «{clientId}:{secret}». Префикс нужен сканерам утечек секретов. Секрет контур не хранит: отпечаток служит быстрым отказом, настоящую проверку делает хранилище личностей.
traceparent (заголовок)stringнет

Поля тела запроса

ПолеТипОбязательноОписание
modelstringдаКласс модели установки. Прямое имя провайдера и закрепление развёртывания не принимаются.
messagesobject[]да
messages[].rolestringдаЗначения: system, user, assistant, tool.
messages[].contentstring | object[] | anyнетС версии 1.2.0 допускается null (у сообщения ассистента с вызовом функции content бывает null, и клиент возвращает такое сообщение как получил): шлюз передаёт его дальше пустой строкой.
messages[].tool_callsobject[]нет
messages[].tool_calls[].idstringнет
messages[].tool_calls[].typestringнет
messages[].tool_calls[].functionobjectнет
messages[].tool_call_idstringнет
temperaturenumberнет
top_pnumberнет
max_tokensintegerнет
max_completion_tokensintegerнет
stopstring | string[]нет
streambooleanнет
stream_optionsobjectнет
stream_options.include_usagebooleanнет
toolsobject[]нет
tool_choiceanyнет
response_formatobjectнет

Ответы

200. Ответ модели с восстановленными значениями либо поток SSE.

Поля ответа

ПолеТипОбязательноОписание
idstringда
objectstringда
createdintegerнет
modelstringнет
choicesobject[]да
usageobjectнет
usage.prompt_tokensintegerнет
usage.completion_tokensintegerнет
usage.total_tokensintegerнет

400. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.

401. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.

403. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.

413. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.

422. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.

429. Предел исчерпан (rate-limited, quota-exhausted, router-budget-exhausted). Резерв снят, учётной записи не возникает.

500. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.

502. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.

503. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.

Эмбеддинги текстов (формат Embeddings); источник — внутри контура установки

POST /v1/embeddings операция createEmbeddings

Ключ — одной строкой в заголовке Authorization (Bearer), как у чата. Организация берётся из привязки ключа. Замены обозначениями нет: источник эмбеддингов у модуля моделей только внутренний (облачный невыразим), текст контур не покидает. Поле model — `bm/embeddings` (действующий источник установки), `bm/embeddings-platform` (модуль ML платформы) или `bm/embeddings@<деплоймент>` (названный сервер заказчика). Предел тела — 2 МБ. Расход ключа — `prompt_tokens` источника (нет его — оценка), `completion_tokens` 0. В ответе `model` — запрошенный идентификатор, а не имя развёртывания.

Параметры

ПолеТипОбязательноОписание
Authorization (заголовок)stringдаBearer и ключ контура доступа: префикс bmk_ и base64url без выравнивания от строки «{clientId}:{secret}». Префикс нужен сканерам утечек секретов. Секрет контур не хранит: отпечаток служит быстрым отказом, настоящую проверку делает хранилище личностей.
traceparent (заголовок)stringнет

Поля тела запроса

ПолеТипОбязательноОписание
modelstringда
inputstring | string[]да
encoding_formatstringнетЗначения: float, base64.
userstringнет

Ответы

200. Векторы в порядке `input`.

Поля ответа

ПолеТипОбязательноОписание
objectstringдаЗначения: list.
dataobject[]да
data[].objectstringдаЗначения: embedding.
data[].indexintegerда
data[].embeddingnumber[] | stringдаМассив чисел при `float`; строка base64 от float32 little-endian при `base64`.
modelstringнет
usageobjectнет
usage.prompt_tokensintegerнет
usage.total_tokensintegerнет

400. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.

401. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.

403. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.

413. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.

429. Предел исчерпан (rate-limited, quota-exhausted, router-budget-exhausted). Резерв снят, учётной записи не возникает.

500. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.

502. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.

503. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.