Как добавить ручную проверку в задания API
Отправляйте переводы на проверку, отслеживайте решения и получайте итоговые документы.
Добавьте ручную проверку, если перед передачей перевода нужно решение человека. Движок направляет каждый документ на каждом целевом языке в группу проверяющих. Проверяющие одобряют или редактируют единицы, доступные для проверки, затем пайплайн продолжает работу до подготовки файла для скачивания.
Сначала настройте перевод через API и убедитесь, что он работает. Вам также понадобятся доступ к ручной проверке в рамках вашего плана, группа проверяющих и проверяющий с доступом к переводам движка.
Настройте проверку перед запуском #
Откройте вкладку Пайплайн движка и включите Ручную проверку. Выберите группу проверяющих, языки и при необходимости ограничьте область проверки каталогом. Маршрутизация по каталогам сопоставляет пути со значением key, которое вы передаёте для каждого документа, поэтому используйте стабильные пути, например emails/order-confirmation.json.
Чтобы проверять весь заново переведённый контент в рамках маршрута, выберите Всё — в этом режиме фильтр качества отключён. Для выборочной проверки выберите Строгий, Средний или Мягкий уровень. Фильтр показывает ошибки с указанием серьёзности и категории. Выбранный уровень определяет, ошибки какой серьёзности требуют проверки. Перевод, который фильтру не удалось проверить, тоже отправляется на проверку. Описания см. в разделе уровни фильтра качества. Повторно используемые переводы доступны только для чтения: они служат контекстом и не становятся новыми задачами проверки автоматически.
Выберите срок ожидания с учётом работы команды проверяющих. Отсчёт начинается, когда целевой перевод готов. По истечении срока единицы без решения могут пройти дальше с предыдущими переводами. Если для каждого публикуемого перевода обязательно решение человека, приложение должно проверять соблюдение этого требования перед публикацией.
Настройте пайплайн через API, если настройка движка — часть работы вашего приложения.
Отправьте контент #
Создайте задание, загрузите недостающие артефакты и вызовите /start. Сохраните ИД задания вместе с версией исходного контента и выбранными правилами проверки. Конфигурация пайплайна движка фиксируется при запуске. Последующие изменения не влияют на правила проверки уже запущенного задания.
Получите ИД документов и целевые локали задания. Значение humanEdit в данных о ходе выполнения этапов целевого перевода указывает на проверку, а API проверки возвращает сами единицы и решения. Пока проверяющие работают, задание может оставаться в статусе Running.
Предоставьте проверяющим нужный контекст #
В панели управления проверяющие могут открыть раздел Очередь и в фильтре Тип выбрать Ручная проверка. Результаты фильтра качества показаны рядом с переводом. Проверяющие могут одобрить перевод без изменений или отредактировать его перед отправкой. Оставьте исходный текст, целевой язык, плейсхолдеры и нужную терминологию на виду у проверяющих.
Если вы используете собственный интерфейс проверки в приложении, получите список открытых проверок с помощью GET /v2/organizations/:orgId/localization/reviews, затем загрузите проверку для выбранного документа и локали. Отправляйте решения от имени проверяющего, используя для аутентификации личный ключ или пользовательскую сессию, а не ключ организации фонового сервиса.
Отправляйте решения Approved или Edited для единиц, требующих проверки. При внутренней проверке решения можно отправлять частями. Чтобы взять на себя внешнюю проверку, нужно за один раз отправить решения для всех оставшихся единиц, требующих проверки. При этом поставщик всё равно может взимать плату. Точные форматы запросов и ошибки описаны в справочнике по проверке.
Получите и проверьте итоговый результат #
После того как проверяющий отправит решения, продолжайте запрашивать данные задания локализации. Скачивайте целевой файл, только когда его статус станет Completed. Завершение проверки и готовность файла — разные события: постредактирование, обработка ограничений длины или обратный перевод ещё могут выполняться.
Если вам нужны в точности те формулировки, которые одобрил человек, отключите последующие этапы переформулирования и проверьте итоговый результат. Если нужно подтверждение одобрения, проверьте решения и единицы, для которых истёк срок ожидания. Само по себе завершение этапа не доказывает, что человек одобрил каждую единицу.
Публикуйте результат, только если версия исходного контента по-прежнему совпадает и обязательные правила проверки соблюдены. Перевод, завершившийся с опозданием, не должен заменять результат для более новой версии исходного контента.
Как продолжить работу после сбоев #
Если на стороне клиента истёк срок ожидания, сохраните исходные ИД задания и проверки. Новое задание запускает отдельный процесс перевода и проверки. Если ответ на отправку решения потерялся, получите данные проверки и проверьте сохранённые решения и ИД проверяющих. Тот же проверяющий может повторно отправить идентичное решение, пока для целевого перевода ещё принимаются решения. Но если работа над целевым переводом завершена, может вернуться код 409, даже если первая отправка прошла успешно. Принятые решения окончательны.
Когда срок проверки истечёт, проверьте принятые решения, единицы без ответа и полученный файл. Сохраните завершённую работу и осознанно выберите следующий шаг: отложить публикацию, провести ещё одну проверку или применить явно заданный запасной вариант.