Перейти к основному содержимому

Документация для разработчиков Caila

В этом разделе представлена информация для разработчиков по программным интерфейсам Caila.

Платформа Caila содержит две группы API:

  1. Caila Core — интерфейсы ядра системы. Здесь находятся методы создания сервисов, загрузки датасетов, создания серверов и т. п. На этом же уровне определены интерфейсы обращения (метод predict) к сервисам.
  2. Caila Apps — интерфейсы конкретных сервисов. Все сервисы в Caila являются независимыми, подключаемыми модулями и могут работать с различными типами данных.

Caila Core API

Интерфейсы Caila можно разделить на группы:

  • REST API — предоставляет доступ ко всем функциям платформы через REST-интерфейс
  • GRPC API — GRPC интерфейс используется для:
    • внутренней коммуникации с Caila-сервисами
    • обращения к сервисам, в частности в сценариях голосового взаимодействия
  • Caila Python SDK — содержит скомпилированные стабы и вспомогательные классы для работы с REST и GRPC API. Применяется для:
    • обращения к существующим сервисам
    • создания собственных сервисов
    • создания CI/CD пайплайнов
  • Caila Java SDK — содержит скомпилированные стабы и вспомогательные классы для работы с REST и GRPC API из кода на Java/Kotlin. Используется для:
    • обращения к сервисам
    • создания собственных сервисов

Caila Apps API

Интерфейс конкретного Caila-сервиса состоит из определения структур данных:

  • predict-request, predict-response и predict-config.
  • для обучаемых сервисов: fit-config и fit-data.

Типы задач — описывают базовые, рекомендуемые контракты для основных типов задач.

В общем же, интерфейсы конкретного сервиса могут быть произвольными. Описание типов данных надо искать на странице конкретного сервиса в каталоге.