Svaya / Документация / Программный интерфейс
Модели (генерация и эмбеддинги по ключу доступа)
Здесь собраны адреса, параметры, поля запросов и коды ответов раздела «Модели (генерация и эмбеддинги по ключу доступа)». Каждая операция описана отдельно, с таблицами полей.
Обращение к модели (формат Chat Completions, включая поток)
POST /v1/chat/completions
Ключ — одной строкой в заголовке Authorization (Bearer), как у обычного ключа доступа к модели. Строка несёт идентификатор клиента приложения организации и его секрет; обмен на служебный токен выполняет контур доступа. Организация берётся из привязки ключа, никогда — из заголовка запроса. Поле model — класс модели установки (bm/{class}), не имя провайдера. Поток — text/event-stream в совместимом формате; usage — в финальном событии.
Параметры
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
Authorization (заголовок) | string | да | Bearer и ключ контура доступа: префикс bmk_ и base64url без выравнивания от строки «{clientId}:{secret}». Префикс нужен сканерам утечек секретов. Секрет контур не хранит: отпечаток служит быстрым отказом, настоящую проверку делает хранилище личностей. |
traceparent (заголовок) | string | нет |
Поля тела запроса
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
model | string | да | Класс модели установки. Прямое имя провайдера и закрепление развёртывания не принимаются. |
messages | object[] | да | |
messages[].role | string | да | Значения: system, user, assistant, tool. |
messages[].content | string | object[] | any | нет | С версии 1.2.0 допускается null (у сообщения ассистента с вызовом функции content бывает null, и клиент возвращает такое сообщение как получил): шлюз передаёт его дальше пустой строкой. |
messages[].tool_calls | object[] | нет | |
messages[].tool_calls[].id | string | нет | |
messages[].tool_calls[].type | string | нет | |
messages[].tool_calls[].function | object | нет | |
messages[].tool_call_id | string | нет | |
temperature | number | нет | |
top_p | number | нет | |
max_tokens | integer | нет | |
max_completion_tokens | integer | нет | |
stop | string | string[] | нет | |
stream | boolean | нет | |
stream_options | object | нет | |
stream_options.include_usage | boolean | нет | |
tools | object[] | нет | |
tool_choice | any | нет | |
response_format | object | нет |
Ответы
200. Ответ модели с восстановленными значениями либо поток SSE.
Поля ответа
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id | string | да | |
object | string | да | |
created | integer | нет | |
model | string | нет | |
choices | object[] | да | |
usage | object | нет | |
usage.prompt_tokens | integer | нет | |
usage.completion_tokens | integer | нет | |
usage.total_tokens | integer | нет |
400. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.
401. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.
403. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.
413. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.
422. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.
429. Предел исчерпан (rate-limited, quota-exhausted, router-budget-exhausted). Резерв снят, учётной записи не возникает.
500. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.
502. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.
503. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.
Эмбеддинги текстов (формат Embeddings); источник — внутри контура установки
POST /v1/embeddings
Ключ — одной строкой в заголовке 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 | нет |
Поля тела запроса
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
model | string | да | |
input | string | string[] | да | |
encoding_format | string | нет | Значения: float, base64. |
user | string | нет |
Ответы
200. Векторы в порядке `input`.
Поля ответа
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
object | string | да | Значения: list. |
data | object[] | да | |
data[].object | string | да | Значения: embedding. |
data[].index | integer | да | |
data[].embedding | number[] | string | да | Массив чисел при `float`; строка base64 от float32 little-endian при `base64`. |
model | string | нет | |
usage | object | нет | |
usage.prompt_tokens | integer | нет | |
usage.total_tokens | integer | нет |
400. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.
401. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.
403. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.
413. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.
429. Предел исчерпан (rate-limited, quota-exhausted, router-budget-exhausted). Резерв снят, учётной записи не возникает.
500. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.
502. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.
503. Ошибка в совместимом формате с кодом из закрытого перечня кодов ошибок платформы.