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

Обучение сервиса через REST API

1. Получите API-токен​

Чтобы вызывать методы REST API, вам необходимо вначале сгенерировать API-токен. Если он у вас уже есть, переходите к следующему шагу.

  1. Перейдите в раздел Мои сервисы → API-токены.
  2. Нажмите Создать токен и скопируйте токен. Он потребуется вам для отправки запросов.

Мы рекомендуем для каждого пользовательского приложения создавать отдельный API-токен. В будущем можно будет смотреть статистику использования по каждому токену.

2. Создайте производный сервис​

  1. Используйте метод POST /api/mlpgate/account/{account}/model/{model}/derived. С помощью него можно создать производный сервис на базе обучаемого: он будет наследовать параметры обучаемого.

Отправьте запрос. В качестве параметров используйте следующие значения:

  • account — идентификатор или имя аккаунта владельца сервиса.

  • model — идентификатор или название сервиса.

  • Значения account и model можно найти в URL карточки сервиса, который вы хотите обучить: https://caila.io/catalog/{account}/{model}.

  • name — название будущего обученного сервиса. Передается в запросе.

  • MLP-API-KEY — API-токен, скопированный в разделе API-токены. Передается в качестве заголовка.

В ответ вам придет JSON-объект с данными о созданном сервисе. Новый сервис появится в интерфейсе Caila в разделе Мои сервисы → Обученные.

  1. Скопируйте значения полей accountId и modelId, вложенных в id. Они понадобятся для отправки запроса метода обучения.

3. Обучите сервис​

Используйте метод обучения сервиса: POST /api/mlpgate/account/{account}/model/{model}/fit. Отправьте запрос. В качестве параметров используйте следующие значения:

  • account — идентификатор аккаунта, скопированный на предыдущем шаге.
  • model — идентификатор сервиса, скопированный на предыдущем шаге.
  • MLP-API-KEY — API-токен, скопированный в разделе API-токены. Передается в качестве заголовка.

В теле запроса передайте JSON-объект с полями:

  • config — конфигурация обучения. Необязательное поле. Указывайте согласно формату из описания обучаемого сервиса.
  • configId — идентификатор конфигурации обучения. Необязательное поле.

Список всех доступных конфигураций для сервиса можно получить с помощью запроса метода GET /api/mlpgate/account/{account}/model/{model}/fit-config. В качестве {account} и {model} используйте значения для обучаемого сервиса.

предупреждение
Укажите только один из параметров: config или configId.
  • datasetId — идентификатор датасета. Обязательное поле. Можно получить в интерфейсе Caila в разделе Датасеты (на странице нужного датасета) или с помощью метода GET /api/mlpgate/account/{account}/dataset.

В ответ вам придет JSON-объект с данными о запущенном процессе обучения.

Когда обученный сервис будет готов​

Процесс обучения может занять длительное время. Это зависит от объема датасета, на котором происходит обучение. Сервис будет готов к работе, когда статус обучения изменится на SUCCESS.

Чтобы узнать статус обучения, отправьте запрос метода GET /api/mlpgate/account/{account}/job/{jobId}.