Как посмотреть результаты провижининга

Проверьте задание, созданные наборы, пропущенную работу и частичные сбои.

Получите данные задания провижининга по ИД, возвращённому при создании:

http
GET /v2/provisioning/jobs/:id
X-API-Key: YOUR_API_KEY

Поля задания #

ПолеЗначение
id, organizationId, engineIdИД задания, а также организация и движок, которым оно принадлежит.
statusСостояние с меткой Running, Completed или Failed. Failed включает message.
kindsРезультаты запрошенной работы для типов glossary, ruleset и brandVoice. Типы, которые не запрашивались, могут отсутствовать.
sourcesНеобязательные данные о ходе чтения источника или отчёт.
websiteПервый указанный URL сайта. Отсутствует, если входные данные содержат только текст.
createdAtДата и время создания в формате ISO.
finishedAtДата и время завершения в формате ISO. Появляется после завершения обработки.

Состояния по типам #

Проверьте каждый запрошенный тип, даже если задание в целом находится в состоянии Completed:

kinds.<kind>._tagПоля и их значения
PendingРабота продолжается. Необязательное поле step принимает значение reading, generating или saving. startedAt указывает время начала этого этапа.
DonesetId указывает прикреплённый набор, а itemCount — количество созданных элементов.
Skippedreason объясняет, почему данные этого типа остались без изменений.
Failedmessage объясняет, почему не удалось заполнить данные этого типа.

Например, в этом фрагменте результата есть созданный глоссарий и набор правил, который не удалось создать:

json
{
  "glossary": { "_tag": "Done", "setId": "YOUR_GLOSSARY_ID", "itemCount": 12 },
  "ruleset": { "_tag": "Failed", "message": "Could not generate rules from the supplied material." }
}

Данные каждого типа сохраняются независимо. Готовые рекомендации остаются доступными, даже если при создании данных другого типа произошёл сбой. К движку также могут прикрепить набор, пока идёт генерация. Из-за этого заполнение только пустых наборов или заполнение тональности бренда может быть пропущено.

Как проверить созданные записи #

Откройте движок в Studio и перейдите к прикреплённому глоссарию, набору правил или тональности бренда. Для чтения через API используйте:

  • GET /v2/glossaries/:id/terms для записей глоссария.
  • GET /v2/rulesets/:id/rules для правил.
  • GET /v2/brand-voices/:id/variations для вариантов тональности.

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

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