Beheren met aangepaste termenlijsten in de API-console

Artikel
11/29/2022
4 minuten om te lezen

De standaardlijst met algemene termen van Azure Content Moderator is voldoende voor de meeste moderatietaken voor inhoudsbeheer. Het is echter mogelijk dat u inhoud moet controleren op termen die specifiek zijn voor uw organisatie. Zo is het bijvoorbeeld mogelijk dat u namen van concurrenten wilt taggen voor nader onderzoek.

Gebruik de Lijstbeheer-API om aangepaste lijsten met termen te maken voor gebruik met de Tekstbeheer-API. De bewerking Tekst - Scherm scant uw tekst op scheldwoorden en vergelijkt tekst ook met aangepaste en gedeelde bloklijsten.

Notitie

Er is een maximumlimiet van 5 terminologielijsten waarbij elke lijst niet meer dan 10.000 termen mag bevatten.

U kunt de List Management-API gebruiken om de volgende taken uit te voeren:

Een lijst maken.
Termen toevoegen aan een lijst.
Termen vergelijken met de termen in een lijst.
Termen verwijderen uit een lijst.
Een lijst verwijderen.
Lijstgegevens bewerken.
De index vernieuwen zodat wijzigingen in de lijst worden gebruikt in een nieuwe scan.

De API-console gebruiken

Voordat u de API in de onlineconsole kunt testen, hebt u uw abonnementssleutel nodig. Deze sleutel bevindt zich op het tabblad Instellingen in het vak Ocp-Apim-Subscription-Key . Zie Overzicht voor meer informatie.

Zoekindex vernieuwen

Nadat u wijzigingen hebt aangebracht in een termenlijst, moet u de index vernieuwen voordat wijzigingen worden opgenomen in toekomstige scans. Deze stap is vergelijkbaar met de manier waarop een zoekmachine op uw bureaublad (indien ingeschakeld) of een webzoekmachine de index voortdurend vernieuwt om nieuwe bestanden of pagina's op te nemen.

Selecteer in de API-verwijzing voor beheer van termenlijsten in het linkermenu termenlijsten en selecteer vervolgens Zoekindex vernieuwen.

De pagina Termenlijsten - Zoekindex vernieuwen wordt geopend.
Selecteer voor de Open API-testconsole de regio die het dichtst bij uw locatie staat.

De API-console Termenlijsten - Vernieuw zoekindex wordt geopend.
Voer in het vak listId de lijst-id in. Voer uw abonnementssleutel in en selecteer vervolgens Verzenden.

Een termenlijst maken

Ga naar de naslaginformatie over de Beheer-API voor termenlijsten.

De pagina Termenlijsten - Maken wordt geopend.
Selecteer voor de Open API-testconsole de regio die het dichtst bij uw locatie staat.

De console Termenlijsten - API maken wordt geopend.
Voer in het vak Ocp-Apim-Subscription-Key uw abonnementssleutel in.
Voer in het vak Aanvraagtekst waarden in voor Naam (bijvoorbeeld MyList) en Beschrijving.
Gebruik tijdelijke aanduidingen voor sleutel-waardeparen om meer beschrijvende metagegevens toe te wijzen aan uw lijst.
```
{
    "Name": "MyExclusionList",
    "Description": "MyListDescription",
    "Metadata": 
    {
        "Category": "Competitors",
        "Type": "Exclude"
    }
}
```
Voeg lijstmetagegevens toe als sleutel-waardeparen en niet als werkelijke termen.
Selecteer Verzenden. De lijst is gemaakt. Noteer de id-waarde die is gekoppeld aan de nieuwe lijst. U hebt deze id nodig voor andere beheerfuncties voor termenlijsten.
Voeg termen toe aan MyList. Selecteer in het linkermenu onder Term de optie Term toevoegen.

De pagina Term - Term toevoegen wordt geopend.
Selecteer voor de Open API-testconsole de regio die het dichtst bij uw locatie staat.

De console Term - Term-API toevoegen wordt geopend.
Voer in het vak listId de lijst-id in die u hebt gegenereerd en selecteer een waarde voor taal. Voer uw abonnementssleutel in en selecteer vervolgens Verzenden.
Als u wilt controleren of de term is toegevoegd aan de lijst , selecteert u term in het linkermenu en selecteert u vervolgens Alle voorwaarden ophalen.

De API-console Term - Alle voorwaarden ophalen wordt geopend.
Voer in het vak listId de lijst-id in en voer vervolgens uw abonnementssleutel in. Selecteer Verzenden.
Controleer in het vak Antwoordinhoud de termen die u hebt ingevoerd.
Voeg nog een paar termen toe. Nu u een aangepaste lijst met termen hebt gemaakt, kunt u proberen wat tekst te scannen met behulp van de aangepaste termenlijst.

Termen en lijsten verwijderen

U kunt eenvoudig term of lijsten verwijderen. U gebruikt de API om de volgende taken uit te voeren:

Een term verwijderen. (Term - Verwijderen)
Alle termen in een lijst verwijderen zonder de lijst te verwijderen. (Term - Alle voorwaarden verwijderen)
Een lijst en alle inhoud verwijderen. (Termenlijsten - Verwijderen)

In dit voorbeeld wordt één term verwijderd.

Selecteer in de naslaginformatie over de Beheer-API voor termenlijst in het linkermenu de optie Term en selecteer vervolgens Verwijderen.

De Term - Verwijderen wordt geopend.
Selecteer voor de Open API-testconsole de regio die het dichtst bij uw locatie staat.

De console Term - API verwijderen wordt geopend.
Voer in het vak listId de id in van de lijst waaruit u een term wilt verwijderen. Deze id is het nummer (in ons voorbeeld 122) dat wordt geretourneerd in de console Termenlijsten - Details ophalen voor MyList. Voer de term in en selecteer een taal.
Voer uw abonnementssleutel in en selecteer vervolgens Verzenden.
Als u wilt controleren of de term is verwijderd, gebruikt u de console Termenlijsten - Alles ophalen .

Lijstgegevens wijzigen

U kunt de naam en beschrijving van een lijst bewerken en metagegevensitems toevoegen.

Selecteer in de api-verwijzing voor beheer van termenlijsten in het linkermenu de optie Termenlijsten en selecteer vervolgens Details bijwerken.

De pagina Termenlijsten - Details bijwerken wordt geopend.
Selecteer voor de Open API-testconsole de regio die het dichtst bij uw locatie staat.

De API-console Termenlijsten - Updatedetails wordt geopend.
Voer in het vak listId de lijst-id in en voer vervolgens uw abonnementssleutel in.
Breng in het vak Aanvraagtekst de gewenste wijzigingen aan en selecteer vervolgens Verzenden.

Volgende stappen

Gebruik de REST API in uw code of begin met de quickstart Termenlijsten .NET om te integreren met uw toepassing.