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

Caila Predict API

Чтобы обратиться к конкретному сервису, вам понадобится:

  1. Идентификатор сервиса, например, just-ai/openai-proxy. Идентификатор всегда состоит из двух частей: <author>/<service>. Идентификатор сервиса можно найти на странице в Каталоге или скопировать последние два элемента из URL страницы сервиса — https://caila.io/catalog/just-ai/openai-proxy
  2. API-ключ. Ключи создаются в Рабочем пространстве — https://caila.io/workspace/api-tokens
  3. Тип данных запроса и ответа, а также примеры запроса. Эта информация обычно приведена на странице сервиса в Каталоге.

Для обращения к сервисам по HTTP есть два основных метода:

  • predict
  • predict-with-config

Структура запроса predict

curl --request POST 'https://caila.io/api/mlpgate/account/{author}/model/{service}/predict' \
--header 'MLP-API-KEY: {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{predict-request-json}'

Структура запроса predict-with-config

curl --request POST 'https://caila.io/api/mlpgate/account/{author}/model/{service}/predict-with-config' \
--header 'MLP-API-KEY: {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"data": {predict-request-json},
"config": {predict-config-json}
}'

Описание параметров

  • author — первая часть идентификатора сервиса, указывающая на аккаунт владельца сервиса
  • service — вторая часть идентификатора сервиса, указывающая имя сервиса
  • api_token — ключ доступа
  • predict-request-json — JSON-объект с телом запроса. Информация о формате запроса находится на странице сервиса в Каталоге.
  • predict-config-json — JSON-объект с настройками. Информация о формате настроек находится на странице сервиса в Каталоге.

Другие методы

  • predict-with-config-v2 — является копией predict-with-config и появился из-за того, что некоторые кодогенераторы некорректно обрабатывают тип Any для полей data и config в методе predict-with-config. Чтобы обойти эту проблему, мы добавили метод predict-with-config-v2, в котором поля data и config имеют тип string
  • Полную и актуальную спецификацию REST API смотрите здесь: https://caila.io/swagger-ui
  • GRPC — к сервисам можно обращаться по GRPC. Спецификация доступна здесь — https://caila.io/static/mlpgate/mlp-grpc.proto, а подробное описание в разделе GRPC API.