Определение и использование заданий модерации (консоль API)

Внимание!

Средство проверки Content Moderator устарело и его поддержка будет прекращена 31 декабря 2021 г.

Задание модерации является разновидностью оболочки для функций контроля содержимого, рабочих процессов и проверок. В этом руководство показано, как использовать интерфейсы REST API для запуска и проверки заданий по модерации контента. Разобравшись со структурой интерфейсов API, вы сможете легко перенести эти вызовы на любую платформу, совместимую с REST.

Предварительные требования

Создание задания

Чтобы создать задание по модерации, перейдите на страницу справочника по API Задание — создание и нажмите кнопку для региона подписки. Вы можете определить свой регион по URL-адресу конечной точки на странице Учетные данные средства проверки. Запустится консоль API, где можно легко создавать и выполнять вызовы REST API.

Выбор региона на странице "Job - Create" (Задание — создание)

Ввод параметров вызова REST

Чтобы создать вызов REST, введите указанные ниже значения.

  • teamName: идентификатор команды, созданный при настройке учетной записи средства проверки (находится в поле Идентификатор на экране учетных данных средства проверки).
  • ContentType: может иметь значение Image, Text или Video.
  • ContentId: строка пользовательского идентификатора. эта строка передается в API и возвращается с помощью обратного вызова. Ее удобно использовать для связывания внутренних идентификаторов или метаданных с результатами задания модерации.
  • Workflowname: имя рабочего процесса, созданного ранее (или значение default для рабочего процесса по умолчанию).
  • CallbackEndpoint: (необязательно) URL-адрес для получения сведений об обратном вызове по завершении проверки.
  • Ocp-Apim-Subscription-Key: ключ Content Moderator. Его можно найти на вкладке Параметры средства проверки.

Заполнение текста запроса

Текст вызова функции REST содержит одно поле: ContentValue. Вставьте необработанное текстовое содержимое, если вы модерируете текст, или введите URL-адрес изображения или видео, если вы модерируете изображение или видео. Вы можете использовать следующий URL-адрес примера изображения: https://moderatorsampleimages.blob.core.windows.net/samples/sample2.jpg.

Параметры запроса, заголовки и поле "Request body" (Текст запроса) в консоли "Job - Create" (Задание — создание)

Отправка запроса

Нажмите кнопку Отправить. Если операция выполнена успешно, состояние ответа имеет значение 200 OK, а в поле Содержимое ответа отображается идентификатор задания. Скопируйте этот идентификатор, чтобы использовать на следующих шагах.

Идентификатор проверки в поле "Response content" (Содержимое ответа) в консоли "Review - Create" (Проверка — создание)

Получение состояния задания

Чтобы получить состояние и подробные сведения о выполняемом или завершенном задании, перейдите на страницу справки по API Задание — получение и нажмите кнопку для вашего региона (регион, в котором находится ваш ключ).

Выбор региона на странице "Задание — получение"

Введите параметры вызова REST, как показано в приведенном выше разделе. Для этого шага JobId — это уникальная строка идентификатора, полученная при создании задания. Нажмите кнопку Отправить. Если операция выполнена успешно, состояние ответа имеет значение 200 OK, а в поле Содержимое ответа отображается задание в формате JSON, как в следующем примере.

{  
  "Id":"2018014caceddebfe9446fab29056fd8d31ffe",
  "TeamName":"some team name",
  "Status":"Complete",
  "WorkflowId":"OCR",
  "Type":"Image",
  "CallBackEndpoint":"",
  "ReviewId":"201801i28fc0f7cbf424447846e509af853ea54",
  "ResultMetaData":[  
    {  
      "Key":"hasText",
      "Value":"True"
    },
    {  
      "Key":"ocrText",
      "Value":"IF WE DID \r\nALL \r\nTHE THINGS \r\nWE ARE \r\nCAPABLE \r\nOF DOING, \r\nWE WOULD \r\nLITERALLY \r\nASTOUND \r\nOURSELVE \r\n"
    }
  ],
  "JobExecutionReport":[  
    {  
      "Ts":"2018-01-07T00:38:29.3238715",
      "Msg":"Posted results to the Callbackendpoint: https://requestb.in/vxke1mvx"
    },
    {  
      "Ts":"2018-01-07T00:38:29.2928416",
      "Msg":"Job marked completed and job content has been removed"
    },
    {  
      "Ts":"2018-01-07T00:38:29.0856472",
      "Msg":"Execution Complete"
    },
    {  
      "Ts":"2018-01-07T00:38:26.7714671",
      "Msg":"Successfully got hasText response from Moderator"
    },
    {  
      "Ts":"2018-01-07T00:38:26.4181346",
      "Msg":"Getting hasText from Moderator"
    },
    {  
      "Ts":"2018-01-07T00:38:25.5122828",
      "Msg":"Starting Execution - Try 1"
    }
  ]
}

Ответ на вызов REST на странице "Задание — получение"

Просмотр новых проверок

Если задание модерации контента привело к созданию проверки, ее можно просмотреть в средстве проверки. Выберите Проверка > Изображение/Текст/Видео (в зависимости от используемого контента). Должен отобразиться контент для проверки человеком. После того как модератор-пользователь проверит автоматически назначенные теги и данные прогноза и отправит окончательное решение по модерации, API заданий отправит все сведения в указанную конечную точку обратного вызова.

Дальнейшие действия

В этом руководстве вы узнали, как создавать и запрашивать задания по модерации контента с помощью REST API. Далее интегрируйте задания в сквозной сценарий модерации, например описанный в учебнике по модерации для электронной коммерции.