Методы API модуля ADP
Методы обработки задач /api/v1/task и получения результата /api/v1/result/<inference_id> используются внутренними сервисами IVA Terra. Начиная с версии модуля ADP 6.0, также доступен OpenAI-совместимый API для клиентов и фреймворков, поддерживающих данный формат запросов.
API-запросы для обработки задачи
Метод API: POST
URL-адрес для API-запросов:
http://<ADP_HOST>:<ADP_API_PORT>/api/v1/task
где:
<ADP_HOST> — адрес хоста для подключения к модулю ADP
<ADP_API_PORT> — порт для подключения к ADP
API-запросы результата обработанной задачи
Метод API: GET
URL-адрес для API-запросов:
http://<ADP_HOST>:<ADP_API_PORT>/api/v1/result/<inference_id>
где:
<ADP_HOST> — адрес хоста для подключения к модулю ADP
<ADP_API_PORT> — порт для подключения к ADP
<inference_id> — уникальный идентификатор задачи, возвращаемый сервисом ADP при создании запроса
OpenAI-совместимый API
Для генерации ответа через OpenAI-совместимый API используется метод POST.
URL-адрес для API-запросов:
http://<ADP_HOST>:<ADP_API_PORT>/v1/chat/completions
где:
<ADP_HOST> — адрес хоста для подключения к модулю ADP
<ADP_API_PORT> — порт для подключения к ADP
<API_KEY> — ключ доступа, указанный в параметре API_KEYS файла .env
Для подключения клиента указать адрес модуля ADP в формате http://<ADP_HOST>:<ADP_API_PORT> и ключ <API_KEY>. Здесь <ADP_HOST> — адрес хоста, <ADP_API_PORT> — порт API модуля ADP, <API_KEY> — один из ключей параметра API_KEYS файла .env. В поле model запроса указать имя модели из параметра SERVED_MODEL_NAME файла .env.
Для проверки доступности API предусмотрены методы:
-
GET /version — версия сервиса
-
GET /v1/models — список доступных имен модели
Методы /tokenize и /detokenize используются для подсчета токенов тем же токенайзером, который применяется при генерации.
Пример проверки списка моделей:
curl http://<ADP_HOST>:<ADP_API_PORT>/v1/models -H "Authorization: Bearer <API_KEY>"OpenAI-совместимый API модуля ADP используется в IVA Terra 6.0 для формирования документов по пользовательским шаблонам.