Как посмотреть результаты провижининга
Проверьте задание, созданные наборы, пропущенную работу и частичные сбои.
Получите данные задания провижининга по ИД, возвращённому при создании:
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 указывает время начала этого этапа. |
Done | setId указывает прикреплённый набор, а itemCount — количество созданных элементов. |
Skipped | reason объясняет, почему данные этого типа остались без изменений. |
Failed | message объясняет, почему не удалось заполнить данные этого типа. |
Например, в этом фрагменте результата есть созданный глоссарий и набор правил, который не удалось создать:
{
"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 и просмотрите все страницы каждого списка. Проверьте терминологию, применимость к языкам, непереводимые названия и все допущения, которые добавила модель. Количество элементов показывает, сколько записей создано, а не насколько они корректны.
Если данные какого-либо типа не удалось заполнить, см. повторные попытки и восстановление. Сохраните готовые наборы, а не создавайте новый движок, чтобы повторить всю работу.