Потребительское API
Потребительское API – это HTTP-вход инсталляции Ainergy, через который приложение потребителя обращается к нейросетям. Запрос приходит на адрес инсталляции, платформа проверяет токен и лимиты и передает запрос тому нексусу, который указан в запросе.
Раздел адресован разработчику на стороне потребителя. Создание и настройка нексусов, лицензий и токенов описаны в разделе Нексусы и в разделе Лицензии и потребители – они адресованы администратору инсталляции.
Доступ к потребительскому API определяется API-токеном и лицензией. Роли платформы на обращения к API не влияют.
Данные для первого запроса
| Что | Зачем и откуда | Кто выдает |
|---|---|---|
| Адрес инсталляции | Хост, на который отправляются запросы. Общего адреса для всех потребителей нет. | Администратор инсталляции |
| API-токен | Ключ, по которому платформа опознает потребителя и учитывает потребление по лицензии. | Администратор инсталляции |
| Путь конечной точки нексуса | Нужен для обращения по пути нейросети. Если путь неизвестен, используйте Обращение через конверт – там достаточно имени нексуса. | Администратор инсталляции |
| Имя нексуса | Определяет, какая нейросеть обработает запрос. | Приложение получает само – методом из статьи Доступные нексусы |
| Код клиента | Нужен для обращения через конверт. | Указан в профиле настроек Ainergy |
Адрес и токен администратор берет из файла AI-профиля: он выгружает файл действием Новый JSON AI-профиля на форме инсталляции клиента и передает вам параметры подключения.
В файле AI-профиля адрес лежит в ключе base_api_url, и это значение включает /v1. В примерах этого раздела /v1 указан отдельно, поэтому подставляйте адрес без него:
| Название | Значение |
|---|---|
base_api_url в файле AI-профиля | https://ai.example.com/v1 |
<адрес инсталляции> в примерах этого раздела | https://ai.example.com |
base_url для клиентских библиотек OpenAI | https://ai.example.com/v1 |
Платформа не приводит запросы к единому формату: формат запроса и ответа определяется сервисом, на который настроен нексус. Администратор инсталляции может изменить запрос и ответ в настройках нексуса – добавить заголовки и поля запроса, удалить отдельные поля ответа или вернуть в нем расход в кредитах. Читайте подробнее в статьях Обращение к нексусу и Ошибки и лимиты.
Аутентификация
Узнайте, как передается API-токен и что возвращает платформа, если токен не принят или заблокирован.
Доступные нексусы
Узнайте, как получить список нексусов, выданных вашей инсталляции, и что в этом списке не передается.
Обращение к нексусу
Основной способ обращения: запрос отправляется по пути нейросети, тело передается без преобразования. Нексусы, настроенные на конечные точки OpenAI, вызываются из официальных клиентских библиотек. В статье описаны выбор нексуса, заголовки запроса, потоковые ответы и ограничения.
Обращение через конверт
Второй способ: запрос и ответ упакованы в конверт с полями nexus, data, code и error. Способ применяется в трех случаях: путь конечной точки неизвестен, в запросе передаются файлы, у нексуса параметризованный путь.
Ошибки и лимиты
Изучите коды ответов, ограничения по частоте запросов и порядок учета расхода, а также узнайте, как отличить ошибку платформы от ошибки нейросети.