Модерация с помощью настраиваемых списков терминов в консоли APIModerate with custom term lists in the API console

Стандартный глобальный список терминов в Azure Content Moderator достаточен для большинства задач модерации контента.The default global list of terms in Azure Content Moderator is sufficient for most content moderation needs. Тем не менее может потребоваться проверка специальных терминов, относящихся к вашей организации.However, you might need to screen for terms that are specific to your organization. Например, может потребоваться добавить теги с названиями конкурентов для более тщательной проверки.For example, you might want to tag competitor names for further review.

Используйте API управления списками, чтобы создать настраиваемые списки терминов, используемые в API модерации текста.Use the List Management API to create custom lists of terms to use with the Text Moderation API. Текст - операция экрана сканирует текст на ненормативную лексику, а также сравнивает текст с пользовательскими и общими блокировщиками.The Text - Screen operation scans your text for profanity, and also compares text against custom and shared blocklists.

Примечание

Существует максимальное ограничение в 5 списков терминов, каждый из которых может содержать не более 10 000 терминов.There is a maximum limit of 5 term lists with each list to not exceed 10,000 terms.

API управления списками можно использовать для выполнения следующих задач:You can use the List Management API to do the following tasks:

  • Создание спискаCreate a list.
  • добавление терминов в список;Add terms to a list.
  • проверка терминов по списку;Screen terms against the terms in a list.
  • удаление терминов из списка;Delete terms from a list.
  • удаление списка;Delete a list.
  • изменение сведений о списке;Edit list information.
  • обновление индекса для того, чтобы изменения в списке были учтены при новой проверке.Refresh the index so that changes to the list are included in a new scan.

Использование консоли APIUse the API console

Прежде чем можно будет опробовать API в веб-консоли, необходимо получить ключ подписки.Before you can test-drive the API in the online console, you need your subscription key. Этот ключ указан на вкладке Settings (Параметры) в поле Ocp-Apim-Subscription-Key.This key is located on the Settings tab, in the Ocp-Apim-Subscription-Key box. Дополнительные сведения см. в этом обзоре.For more information, see Overview.

Обновление индекса поискаRefresh search index

После внесения изменений в список терминов необходимо обновить его индекс, чтобы эти изменения учитывались в будущих проверках.After you make changes to a term list, you must refresh its index for changes to be included in future scans. Точно так же поисковая система на компьютере (если она включена) или поисковая система в Интернете постоянно обновляет свой индекс, чтобы добавлять новые файлы или страницы.This step is similar to how a search engine on your desktop (if enabled) or a web search engine continually refreshes its index to include new files or pages.

  1. В справочнике по API управления списками терминов в левом меню выберите Term Lists (Списки терминов) > Refresh Search Index (Обновить индекс поиска).In the Term List Management API reference, in the left menu, select Term Lists, and then select Refresh Search Index.

    Откроется страница Term Lists - Refresh Search Index (Списки терминов — обновление индекса поиска).The Term Lists - Refresh Search Index page opens.

  2. Для параметра Open API testing console (Открытая тестовая консоль API) выберите регион, лучше всего подходящий для вашего расположения.For Open API testing console, select the region that most closely describes your location.

    Выбор региона на странице "Term Lists - Refresh Search Index" (Списки терминов — обновление индекса поиска)

    Откроется консоль API Term Lists - Refresh Search Index (Списки терминов — обновление индекса поиска).The Term Lists - Refresh Search Index API console opens.

  3. В поле listId введите идентификатор списка.In the listId box, enter the list ID. Введите ключ подписки, а затем щелкните Send (Отправить).Enter your subscription key, and then select Send.

    Поле "Response content" (Содержимое ответа) в консоли "Term Lists - Refresh Search Index" (Списки терминов — обновление индекса поиска)

Создание списка терминовCreate a term list

  1. Перейдите к справочнику по API управления списками терминов.Go to the Term List Management API reference.

    Откроется страница Term Lists - Create (Списки терминов — создание).The Term Lists - Create page opens.

  2. Для параметра Open API testing console (Открытая тестовая консоль API) выберите регион, лучше всего подходящий для вашего расположения.For Open API testing console, select the region that most closely describes your location.

    Выбор региона на странице "Term Lists - Create" (Списки терминов — создание)

    Откроется консоль API Term Lists - Create (Списки терминов — создание).The Term Lists - Create API console opens.

  3. В поле Ocp-Apim-Subscription-Key введите свой ключ подписки.In the Ocp-Apim-Subscription-Key box, enter your subscription key.

  4. В поле Request body (Текст запроса) введите значения параметров Name (Имя) (например, MyList) и Description (Описание).In the Request body box, enter values for Name (for example, MyList) and Description.

    Ввод имени и описания в поле "Request body" (Текст запроса) в консоли "Term Lists - Create" (Списки терминов — создание)

  5. Используйте заполнители пар "ключ-значение", чтобы назначить более понятные метаданные для списка.Use key-value pair placeholders to assign more descriptive metadata to your list.

    {
       "Name": "MyExclusionList",
       "Description": "MyListDescription",
       "Metadata": 
       {
          "Category": "Competitors",
          "Type": "Exclude"
       }
    }
    

    Добавьте метаданные списка в виде пар "ключ-значение", а не фактических терминов.Add list metadata as key-value pairs, and not actual terms.

  6. Выберите Отправить.Select Send. Будет создан список.Your list is created. Запишите значение ID (Идентификатор) этого нового списка.Note the ID value that is associated with the new list. Этот идентификатор необходим для других функций управления списками терминов.You need this ID for other term list management functions.

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

  7. Добавьте термины в список MyList.Add terms to MyList. В левом меню в разделе Term (Термин) выберите Add Term (Добавить термин).In the left menu, under Term, select Add Term.

    Откроется страница Term - Add Term (Термин — добавление термина).The Term - Add Term page opens.

  8. Для параметра Open API testing console (Открытая тестовая консоль API) выберите регион, лучше всего подходящий для вашего расположения.For Open API testing console, select the region that most closely describes your location.

    Выбор региона на странице "Term - Add Term" (Термин — добавление термина)

    Откроется консоль API Term - Add Term (Термин — добавление термина).The Term - Add Term API console opens.

  9. В поле listId введите полученный идентификатор списка и выберите значение параметра language.In the listId box, enter the list ID that you generated, and select a value for language. Введите ключ подписки, а затем щелкните Send (Отправить).Enter your subscription key, and then select Send.

    Параметры запроса в консоли "Term - Add Term" (Термин — добавление термина)

  10. Чтобы убедиться, что термин добавлен в список, в левом меню выберите Term (Термин), а затем выберите Get All Terms (Получить все термины).To verify that the term has been added to the list, in the left menu, select Term, and then select Get All Terms.

    Откроется консоль API Term - Get All Terms (Термин — получение всех терминов).The Term - Get All Terms API console opens.

  11. В поле listId введите идентификатор списка, а затем введите свой ключ подписки.In the listId box, enter the list ID, and then enter your subscription key. Выберите Отправить.Select Send.

  12. В поле Response content (Содержимое ответа) проверьте введенные термины.In the Response content box, verify the terms you entered.

    Введенные термины в поле "Response content" (Содержимое ответа) в консоли "Term - Get All Terms" (Термин — получение всех терминов)

  13. Добавьте еще несколько терминов.Add a few more terms. Теперь, когда вы создали настраиваемый список терминов, попробуйте проверить какой-нибудь текст, используя этот список.Now that you have created a custom list of terms, try scanning some text by using the custom term list.

Удаление терминов и списковDelete terms and lists

Удалить термин или список достаточно просто.Deleting a term or a list is straightforward. С помощью API можно выполнить следующие задачи:You use the API to do the following tasks:

  • удаление терминаDelete a term. (страница Term - Delete (Термин — удаление));(Term - Delete)
  • удаление всех терминов в списке без удаления самого спискаDelete all the terms in a list without deleting the list. (страница Term - Delete All Terms (Термин — удаление всех терминов));(Term - Delete All Terms)
  • удаление списка и всего его содержимогоDelete a list and all of its contents. (страница Term Lists - Delete (Списки терминов — удаление)).(Term Lists - Delete)

В этом примере удаляется один термин.This example deletes a single term.

  1. В справочнике по API управления списками терминов в левом меню выберите Term (Термин) > Delete (Удалить).In the Term List Management API reference, in the left menu, select Term, and then select Delete.

    Откроется страница Term - Delete (Термин — удаление).The Term - Delete opens.

  2. Для параметра Open API testing console (Открытая тестовая консоль API) выберите регион, лучше всего подходящий для вашего расположения.For Open API testing console, select the region that most closely describes your location.

    Выбор региона на странице "Term - Delete" (Термин — удаление)

    Откроется консоль API Term - Delete (Термин — удаление).The Term - Delete API console opens.

  3. В поле listId введите идентификатор списка, из которого вы хотите удалить термин.In the listId box, enter the ID of the list that you want to delete a term from. Этим идентификатором является номер (в нашем примере — 122), возвращаемый консолью Term Lists - Get Details (Списки терминов — получение сведений) для MyList.This ID is the number (in our example, 122) that is returned in the Term Lists - Get Details console for MyList. Введите термин и выберите нужный язык.Enter the term and select a language.

    Параметры запроса в консоли "Term - Delete" (Термин — удаление)

  4. Введите ключ подписки, а затем щелкните Send (Отправить).Enter your subscription key, and then select Send.

  5. Чтобы убедиться, что термин удален, используйте консоль Term Lists - Get All (Списки терминов — получение всех).To verify that the term has been deleted, use the Term Lists - Get All console.

    Как видно в поле "Response content" (Содержимое ответа) в консоли "Term Lists - Get All" (Списки терминов — получение всех), термин удален

Изменение сведений о спискеChange list information

Можно изменить имя и описание списка, а также добавить элементы метаданных.You can edit a list’s name and description, and add metadata items.

  1. В справочнике по API управления списками терминов в левом меню выберите Term Lists (Списки терминов) > Update Details (Обновить сведения).In the Term List Management API reference, in the left menu, select Term Lists, and then select Update Details.

    Откроется страница Term Lists - Update Details (Списки терминов — обновление сведений).The Term Lists - Update Details page opens.

  2. Для параметра Open API testing console (Открытая тестовая консоль API) выберите регион, лучше всего подходящий для вашего расположения.For Open API testing console, select the region that most closely describes your location.

    Выбор региона на странице "Term Lists - Update" (Списки терминов — обновление)

    Откроется консоль API Term Lists - Update Details (Списки терминов — обновление сведений).The Term Lists - Update Details API console opens.

  3. В поле listId введите идентификатор списка, а затем введите свой ключ подписки.In the listId box, enter the list ID, and then enter your subscription key.

  4. В поле Request body (Текст запроса) внесите необходимые изменения, затем щелкните Send (Отправить).In the Request body box, make your edits, and then select Send.

    Внесение изменений в поле "Request body" (Текст запроса) в консоли "Term Lists - Update Details" (Списки терминов — обновление сведений)

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

Используйте в коде REST API или начните с краткого руководства по работе со списками терминов с помощью .NET, чтобы интегрировать эту функцию в приложение.Use the REST API in your code or start with the Term lists .NET quickstart to integrate with your application.