Как создать задание провижининга

Создайте рекомендации для нового или существующего движка и сохраните ИД задания, чтобы отслеживать выполнение и восстанавливаться после сбоев.

Провижининг выполняется в фоновом режиме и начинается, как только API принимает запрос. Все маршруты используют https://api.lingo.dev и аутентификацию API.

Создайте и наполните движок #

http
POST /v2/organizations/:orgId/provisioning/jobs
Content-Type: application/json
X-API-Key: YOUR_API_KEY
json
{
  "engine": { "name": "Acme support", "description": "Customer support content" },
  "kinds": {
    "glossary": { "name": "Product terminology" },
    "ruleset": { "name": "Support writing rules" },
    "brandVoice": { "name": "Support voice" }
  },
  "sources": [
    { "_tag": "Link", "url": "https://example.com/style-guide" },
    { "_tag": "Content", "text": "Use clear, direct sentences. Keep the product name Acme unchanged." }
  ]
}

Замените URL из примера на адрес доступной страницы с вашими рекомендациями или передайте текст вместо ссылки.

ПолеТребования
engineОбязательный объект для создания движка. name не должен быть пустым. description необязателен. Объект также может содержать конфигурации моделей, параметры охвата и настройки пайплайна.
kindsОбязательный объект, в котором выбран хотя бы один из вариантов: glossary, ruleset или brandVoice. Каждое выбранное значение — {} или { "name": "Nonempty name" }.
sourcesОбязательный непустой массив: не более десяти ссылок или текстовых источников.

Настройки движка должны соответствовать требованиям к его созданию. sourceCoverage и targetCoverage — массивы локалей, а [] охватывает все локали. Если не передать modelConfigs, будут заданы настройки моделей, принятые на платформе по умолчанию. При [] закреплённых конфигураций моделей не будет. Настройте модели движка, прежде чем использовать его для перевода.

Для вызова нужны разрешения на создание движка и запрошенных рекомендаций. Запрос может быть отклонён из-за ограничения числа движков, недоступных в вашем плане функций, недостаточного баланса учётной записи или превышения лимитов частоты запросов на провижининг.

Наполните существующий движок #

http
POST /v2/engines/:engineId/provisioning/jobs
Content-Type: application/json

Чтобы добавить наборы только тех типов, для которых у движка ещё нет прикреплённого набора:

json
{
  "kinds": { "_tag": "Empty" },
  "sources": [{ "_tag": "Content", "text": "Keep Acme unchanged. Use concise, friendly language." }]
}

Чтобы запросить конкретные новые наборы:

json
{
  "kinds": {
    "_tag": "Requested",
    "glossary": { "name": "Support terminology" },
    "ruleset": {}
  },
  "sources": [{ "_tag": "Link", "url": "https://example.com/support" }]
}

Requested может добавить глоссарий или набор правил в дополнение к существующим. Провижининг никогда не заменяет прикреплённую тональность бренда. Empty пропускает типы, для которых наборы уже прикреплены, в том числе если их прикрепили во время выполнения задания. Проверяйте результаты по каждому типу: не стоит ожидать, что каждый запрос создаст наборы всех трёх типов.

Для одного движка одновременно может выполняться только одно задание провижининга. ProvisioningJobRunning (409) содержит существующий jobId. Прежде чем отправлять новые запросы, проверьте ход выполнения этого задания. NothingToProvision (409) означает, что в текущем состоянии движка ни одна из запрошенных задач не позволит его наполнить.

Сохраните ответ #

Оба маршрута создания возвращают HTTP 200 с заданием провижининга. Сохраните id и engineId, прежде чем начать опрос состояния. Начальное состояние обычно — status: { "_tag": "Running" }.

Для создания заголовок идемпотентности не предусмотрен. Если ответ потерян, проверьте выполняющиеся задания и список движков, прежде чем повторять запрос на создание нового движка: повторный запрос может создать ещё один движок. В разделе Восстановление описаны эти проверки и повторные попытки для типов, которые не удалось создать.