Använda en blockeringslista

Varning

Exempeldata i den här guiden kan innehålla stötande innehåll. Användarens diskretion rekommenderas.

Ai-standardklassificerarna räcker för de flesta kon tältläge rationsbehov. Du kan dock behöva skärma för objekt som är specifika för ditt användningsfall.

Förutsättningar

• En Azure-prenumeration – Skapa en kostnadsfritt
• När du har din Azure-prenumeration skapar du en content Valv ty-resurs i Azure-portalen för att hämta din nyckel och slutpunkt. Ange ett unikt namn för resursen, välj din prenumeration och välj en resursgrupp, region som stöds (USA, östra eller Europa, västra) och prisnivån som stöds. Välj sedan Skapa.
  • Det tar några minuter att distribuera resursen. När den är klar väljer du Gå till resurs. I den vänstra rutan under Resurshantering väljer du Prenumerationsnyckel och Slutpunkt. Slutpunkten och någon av nycklarna används för att anropa API:er.
• Något av följande installerat:
  • cURL för REST API-anrop.
  • Python 3.x installerat
    • Python-installationen bör innehålla pip. Du kan kontrollera om du har pip installerat genom att köra pip --version på kommandoraden. Hämta pip genom att installera den senaste versionen av Python.
    • Om du använder Python måste du installera Azure AI Content Valv ty-klientbiblioteket för Python. Kör kommandot pip install azure-ai-contentsafety i projektkatalogen.
  • .NET Runtime installerat.
    • .NET Core SDK installerat.
    • Om du använder .NET måste du installera Azure AI Content Valv ty-klientbiblioteket för .NET. Kör kommandot dotnet add package Azure.AI.ContentSafety --prerelease i projektkatalogen.

Skapa miljövariabler

I det här exemplet skriver du dina autentiseringsuppgifter till miljövariabler på den lokala dator som kör programmet.

Dricks

Inkludera inte nyckeln direkt i koden och publicera den aldrig offentligt. Mer autentiseringsalternativ som Azure Key Vault finns i säkerhetsartikeln för Azure AI-tjänster.

Om du vill ange miljövariabeln för din nyckel och slutpunkt öppnar du ett konsolfönster och följer anvisningarna för operativsystemet och utvecklingsmiljön.

1. Om du vill ange CONTENT_SAFETY_KEY miljövariabeln ersätter du YOUR_CONTENT_SAFETY_KEY med en av nycklarna för resursen.
2. Om du vill ange CONTENT_SAFETY_ENDPOINT miljövariabeln ersätter du YOUR_CONTENT_SAFETY_ENDPOINT med slutpunkten för resursen.

Windows

setx CONTENT_SAFETY_KEY 'YOUR_CONTENT_SAFETY_KEY'

setx CONTENT_SAFETY_ENDPOINT 'YOUR_CONTENT_SAFETY_ENDPOINT'

När du har lagt till miljövariablerna kan du behöva starta om alla program som körs som läser miljövariablerna, inklusive konsolfönstret.

Linux

export CONTENT_SAFETY_KEY='YOUR_CONTENT_SAFETY_KEY'

export CONTENT_SAFETY_ENDPOINT='YOUR_CONTENT_SAFETY_ENDPOINT'

När du har lagt till miljövariablerna kör source ~/.bashrc du från konsolfönstret för att göra ändringarna effektiva.

Analysera text med en blockeringslista

Du kan skapa blocklistor som ska användas med text-API:et. Följande steg hjälper dig att komma igång.

Skapa eller ändra en blockeringslista

REST-API

Kopiera cURL-kommandot nedan till en textredigerare och gör följande ändringar:

1. Ersätt <endpoint> med slutpunkts-URL:en.
2. Ersätt <enter_your_key_here> med din nyckel.
3. Ersätt <your_list_name> (i URL:en) med ett anpassat namn för listan. Ersätt även den sista termen för REST-URL:en med samma namn. Tillåtna tecken: 0-9, A-Z, a-z, - . _ ~.
4. Du kan också ersätta värdet för fältet "description" med en anpassad beskrivning.

curl --location --request PATCH '<endpoint>/contentsafety/text/blocklists/<your_list_name>?api-version=2023-10-01' \
--header 'Ocp-Apim-Subscription-Key: <enter_your_key_here>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "This is a violence list"
}'

Svarskoden ska vara 201(skapa en ny lista) eller 200(uppdatera en befintlig lista).

C#

Skapa en ny C#-konsolapp och öppna den i önskad redigerare eller IDE. Klistra in följande kod.

string endpoint = Environment.GetEnvironmentVariable("CONTENT_SAFETY_ENDPOINT");
string key = Environment.GetEnvironmentVariable("CONTENT_SAFETY_KEY");

BlocklistClient blocklistClient = new BlocklistClient(new Uri(endpoint), new AzureKeyCredential(key));

var blocklistName = "<your_list_name>";
var blocklistDescription = "<description>";

var data = new
{
    description = blocklistDescription,
};

var createResponse = blocklistClient.CreateOrUpdateTextBlocklist(blocklistName, RequestContent.Create(data));

if (createResponse.Status == 201)
{
    Console.WriteLine("\nBlocklist {0} created.", blocklistName);
}
else if (createResponse.Status == 200)
{
    Console.WriteLine("\nBlocklist {0} updated.", blocklistName);
}

1. Ersätt <your_list_name> med ett anpassat namn för listan. Tillåtna tecken: 0-9, A-Z, a-z, - . _ ~.
2. Alternativt kan du ersätta <description> med en anpassad beskrivning.
3. Kör koden.

Java

Skapa ett Java-program och öppna det i önskad redigerare eller IDE. Klistra in följande kod.

String endpoint = Configuration.getGlobalConfiguration().get("CONTENT_SAFETY_ENDPOINT");
String key = Configuration.getGlobalConfiguration().get("CONTENT_SAFETY_KEY");
BlocklistClient blocklistClient = new BlocklistClientBuilder()
        .credential(new KeyCredential(key))
        .endpoint(endpoint).buildClient();

String blocklistName = "<your_list_name>";


Map<String, String> description = new HashMap<>();
description.put("description", "<description>");
BinaryData resource = BinaryData.fromObject(description);
RequestOptions requestOptions = new RequestOptions();
Response<BinaryData> response =
        blocklistClient.createOrUpdateTextBlocklistWithResponse(blocklistName, resource, requestOptions);
if (response.getStatusCode() == 201) {
    System.out.println("\nBlocklist " + blocklistName + " created.");
} else if (response.getStatusCode() == 200) {
    System.out.println("\nBlocklist " + blocklistName + " updated.");
}

1. Ersätt <your_list_name> med ett anpassat namn för listan. Tillåtna tecken: 0-9, A-Z, a-z, - . _ ~.
2. Alternativt kan du ersätta <description> med en anpassad beskrivning.
3. Kör koden.

Python

Skapa ett nytt Python-skript och öppna det i önskad redigerare eller IDE. Klistra in följande kod.

import os
from azure.ai.contentsafety import BlocklistClient
from azure.core.credentials import AzureKeyCredential
from azure.ai.contentsafety.models import TextBlocklist
from azure.core.exceptions import HttpResponseError

key = os.environ["CONTENT_SAFETY_KEY"]
endpoint = os.environ["CONTENT_SAFETY_ENDPOINT"]
  
# Create a Blocklist client
client = BlocklistClient(endpoint, AzureKeyCredential(key))

blocklist_name = "<your_list_name>"
blocklist_description = "<description>"

try:
    blocklist = client.create_or_update_text_blocklist(
        blocklist_name=blocklist_name,
        options=TextBlocklist(blocklist_name=blocklist_name, description=blocklist_description),
    )
    if blocklist:
        print("\nBlocklist created or updated: ")
        print(f"Name: {blocklist.blocklist_name}, Description: {blocklist.description}")
except HttpResponseError as e:
    print("\nCreate or update text blocklist failed: ")
    if e.error:
        print(f"Error code: {e.error.code}")
        print(f"Error message: {e.error.message}")
        raise
    print(e)
    raise

1. Ersätt <your_list_name> med ett anpassat namn för listan. Tillåtna tecken: 0-9, A-Z, a-z, - . _ ~.
2. Ersätt <description> med en anpassad beskrivning.
3. Kör skriptet.

JavaScript

Skapa ett nytt JavaScript-skript och öppna det i önskad redigerare eller IDE. Klistra in följande kod.

const ContentSafetyClient = require("@azure-rest/ai-content-safety").default,
  { isUnexpected } = require("@azure-rest/ai-content-safety");
const { AzureKeyCredential } = require("@azure/core-auth");

// Load the .env file if it exists
require("dotenv").config();

const endpoint = process.env["CONTENT_SAFETY_ENDPOINT"] || "<endpoint>";
const key = process.env["CONTENT_SAFETY_API_KEY"] || "<key>";

const credential = new AzureKeyCredential(key);
const client = ContentSafetyClient(endpoint, credential);

async function createOrUpdateTextBlocklist() {
  const blocklistName = "<your_list_name>";
  const blocklistDescription = "<description>";

  const createOrUpdateTextBlocklistParameters = {
    contentType: "application/merge-patch+json",
    body: {
      description: blocklistDescription,
    },
  };

  const result = await client
    .path("/text/blocklists/{blocklistName}", blocklistName)
    .patch(createOrUpdateTextBlocklistParameters);

  if (isUnexpected(result)) {
    throw result;
  }

  console.log(
    "Blocklist created or updated. Name: ",
    result.body.blocklistName,
    ", Description: ",
    result.body.description
  );
}

(async () => {
  await createOrUpdateTextBlocklist();
})().catch((err) => {
  console.error("The sample encountered an error:", err);
});

1. Ersätt <your_list_name> med ett anpassat namn för listan. Tillåtna tecken: 0-9, A-Z, a-z, - . _ ~.
2. Alternativt kan du ersätta <description> med en anpassad beskrivning.
3. Kör skriptet.

Lägg till blocklistItems i listan

Kommentar

Det finns en maximal gräns på totalt 10 000 termer i alla listor. Du kan lägga till högst 100 blocklistItems i en begäran.

REST-API

Kopiera cURL-kommandot nedan till en textredigerare och gör följande ändringar:

1. Ersätt <endpoint> med slutpunkts-URL:en.
2. Ersätt <enter_your_key_here> med din nyckel.
3. Ersätt <your_list_name> (i URL:en) med det namn som du använde i listskapandesteget.
4. Du kan också ersätta värdet för fältet "description" med en anpassad beskrivning.
5. Ersätt värdet för fältet "text" med det objekt som du vill lägga till i blocklistan. Den maximala längden på en blocklistItem är 128 tecken.

curl --location --request POST '<endpoint>/contentsafety/text/blocklists/<your_list_name>:addOrUpdateBlocklistItems?api-version=2023-10-01' \
--header 'Ocp-Apim-Subscription-Key: <enter_your_key_here>' \
--header 'Content-Type: application/json' \
--data-raw '"blocklistItems": [{
    "description": "string",
    "text": "bleed"
}]'

Dricks

Du kan lägga till flera blocklistItems i ett API-anrop. Gör begärandetexten till en JSON-matris med datagrupper:

{
   "blocklistItems": [
       {
           "description": "string",
           "text": "bleed"
       },
       {
           "description": "string",
           "text": "blood"
       }
   ]
}

Svarskoden ska vara 200.

{
"blocklistItems:"[
  {
  "blocklistItemId": "string",
  "description": "string",
  "text": "bleed"
  
   }
 ]
}

C#

Skapa en ny C#-konsolapp och öppna den i önskad redigerare eller IDE. Klistra in följande kod.

string endpoint = Environment.GetEnvironmentVariable("CONTENT_SAFETY_ENDPOINT");
string key = Environment.GetEnvironmentVariable("CONTENT_SAFETY_KEY");
BlocklistClient blocklistClient = new BlocklistClient(new Uri(endpoint), new AzureKeyCredential(key));

var blocklistName = "<your_list_name>";


string blocklistItemText1 = "<block_item_text_1>";
string blocklistItemText2 = "<block_item_text_2>";

var blocklistItems = new TextBlocklistItem[] { new TextBlocklistItem(blocklistItemText1), new TextBlocklistItem(blocklistItemText2) };
var addedBlocklistItems = blocklistClient.AddOrUpdateBlocklistItems(blocklistName, new AddOrUpdateTextBlocklistItemsOptions(blocklistItems));

if (addedBlocklistItems != null && addedBlocklistItems.Value != null)
{
    Console.WriteLine("\nBlocklistItems added:");
    foreach (var addedBlocklistItem in addedBlocklistItems.Value.BlocklistItems)
    {
        Console.WriteLine("BlocklistItemId: {0}, Text: {1}, Description: {2}", addedBlocklistItem.BlocklistItemId, addedBlocklistItem.Text, addedBlocklistItem.Description);
    }
}

1. Ersätt <your_list_name> med det namn som du använde i steget för att skapa listan.
2. Ersätt värdena för fälten blocklistItemText1 och blocklistItemText2 med de objekt som du vill lägga till i blocklistan. Den maximala längden på en blockItem är 128 tecken.
3. Du kan också lägga till fler blockItem-strängar i parametern blockItems .
4. Kör koden.

Java

Skapa ett Java-program och öppna det i önskad redigerare eller IDE. Klistra in följande kod.

String endpoint = Configuration.getGlobalConfiguration().get("CONTENT_SAFETY_ENDPOINT");
String key = Configuration.getGlobalConfiguration().get("CONTENT_SAFETY_KEY");
BlocklistClient blocklistClient = new BlocklistClientBuilder()
        .credential(new KeyCredential(key))
        .endpoint(endpoint).buildClient();

String blocklistName = "<your_list_name>";

String blockItemText1 = "<block_item_text_1>";
String blockItemText2 = "<block_item_text_2>";
List<TextBlocklistItem> blockItems = Arrays.asList(new TextBlocklistItem(blockItemText1).setDescription("Kill word"),
        new TextBlocklistItem(blockItemText2).setDescription("Hate word"));
AddOrUpdateTextBlocklistItemsResult addedBlockItems = blocklistClient.addOrUpdateBlocklistItems(blocklistName,
        new AddOrUpdateTextBlocklistItemsOptions(blockItems));
if (addedBlockItems != null && addedBlockItems.getBlocklistItems() != null) {
    System.out.println("\nBlockItems added:");
    for (TextBlocklistItem addedBlockItem : addedBlockItems.getBlocklistItems()) {
        System.out.println("BlockItemId: " + addedBlockItem.getBlocklistItemId() + ", Text: " + addedBlockItem.getText() + ", Description: " + addedBlockItem.getDescription());
    }
}

1. Ersätt <your_list_name> med det namn som du använde i steget för att skapa listan.
2. Ersätt värdena för fälten blockItemText1 och blockItemText2 med de objekt som du vill lägga till i blocklistan. Den maximala längden på en blockItem är 128 tecken.
3. Du kan också lägga till fler blockItem-strängar i parametern blockItems .
4. Kör koden.

Python

Skapa ett nytt Python-skript och öppna det i önskad redigerare eller IDE. Klistra in följande kod.

import os
from azure.ai.contentsafety import BlocklistClient
from azure.core.credentials import AzureKeyCredential
from azure.ai.contentsafety.models import (
    AddOrUpdateTextBlocklistItemsOptions, TextBlocklistItem
)
from azure.core.exceptions import HttpResponseError

key = os.environ["CONTENT_SAFETY_KEY"]
endpoint = os.environ["CONTENT_SAFETY_ENDPOINT"]

# Create a Blocklist client
client = BlocklistClient(endpoint, AzureKeyCredential(key))

blocklist_name = "<your_list_name>"
blocklist_item_text_1 = "<block_item_text_1>"
blocklist_item_text_2 = "<block_item_text_2>"

blocklist_items = [TextBlocklistItem(text=blocklist_item_text_1), TextBlocklistItem(text=blocklist_item_text_2)]
try:
    result = client.add_or_update_blocklist_items(
        blocklist_name=blocklist_name, options=AddOrUpdateTextBlocklistItemsOptions(blocklist_items=blocklist_items)
    for blocklist_item in result.blocklist_items:
        print(
            f"BlocklistItemId: {blocklist_item.blocklist_item_id}, Text: {blocklist_item.text}, Description: {blocklist_item.description}"
        )
except HttpResponseError as e:
    print("\nAdd blocklistItems failed: ")
    if e.error:
        print(f"Error code: {e.error.code}")
        print(f"Error message: {e.error.message}")
        raise
    print(e)
    raise

1. Ersätt <your_list_name> med det namn som du använde i steget för att skapa listan.
2. Ersätt värdena för fälten blocklist_item_text_1 och blocklist_item_text_2 med de objekt som du vill lägga till i blocklistan. Den maximala längden på en blockItem är 128 tecken.
3. Du kan också lägga till fler blockItem-strängar i parametern block_items .
4. Kör skriptet.

JavaScript

const ContentSafetyClient = require("@azure-rest/ai-content-safety").default,
  { isUnexpected } = require("@azure-rest/ai-content-safety");
const { AzureKeyCredential } = require("@azure/core-auth");

// Load the .env file if it exists
require("dotenv").config();

const endpoint = process.env["CONTENT_SAFETY_ENDPOINT"] || "<endpoint>";
const key = process.env["CONTENT_SAFETY_API_KEY"] || "<key>";

const credential = new AzureKeyCredential(key);
const client = ContentSafetyClient(endpoint, credential);

async function addBlocklistItems() {
  const blocklistName = "<your_list_name>";
  const blocklistItemText1 = "<block_item_text_1>";
  const blocklistItemText2 = "<block_item_text_2>";
  const addOrUpdateBlocklistItemsParameters = {
    body: {
      blocklistItems: [
        {
          description: "Test blocklist item 1",
          text: blocklistItemText1,
        },
        {
          description: "Test blocklist item 2",
          text: blocklistItemText2,
        },
      ],
    },
  };

  const result = await client
    .path("/text/blocklists/{blocklistName}:addOrUpdateBlocklistItems", blocklistName)
    .post(addOrUpdateBlocklistItemsParameters);

  if (isUnexpected(result)) {
    throw result;
  }

  console.log("Blocklist items added: ");
  if (result.body.blocklistItems) {
    for (const blocklistItem of result.body.blocklistItems) {
      console.log(
        "BlocklistItemId: ",
        blocklistItem.blocklistItemId,
        ", Text: ",
        blocklistItem.text,
        ", Description: ",
        blocklistItem.description
      );
    }
  }
}
(async () => {
  await addBlocklistItems();
})().catch((err) => {
  console.error("The sample encountered an error:", err);
});

1. Ersätt <your_list_name> med det namn som du använde i steget för att skapa listan.
2. Ersätt värdena för fälten block_item_text_1 och block_item_text_2 med de objekt som du vill lägga till i blocklistan. Den maximala längden på en blockItem är 128 tecken.
3. Du kan också lägga till fler blockItem-strängar i parametern blocklistItems .
4. Kör skriptet.

Kommentar

Det blir en viss fördröjning efter att du har lagt till eller redigerat en blockItem innan den börjar gälla för textanalys, vanligtvis inte mer än fem minuter.

Analysera text med en blockeringslista

REST-API

Kopiera cURL-kommandot nedan till en textredigerare och gör följande ändringar:

1. Ersätt <endpoint> med slutpunkts-URL:en.
2. Ersätt <enter_your_key_here> med din nyckel.
3. Ersätt <your_list_name> med det namn som du använde i steget för att skapa listan. Fältet "blocklistNames" kan innehålla en matris med flera list-ID:t.
4. Du kan också ändra värdet "breakByBlocklists"för . true anger att när en blocklista har matchats returneras analysen omedelbart utan modellutdata. false kommer att göra att modellen fortsätter att göra analys i standardkategorierna.
5. Du kan också ändra värdet för fältet "text" till den text som du vill analysera.

curl --location --request POST '<endpoint>/contentsafety/text:analyze?api-version=2023-10-01&' \
--header 'Ocp-Apim-Subscription-Key: <enter_your_key_here>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "text": "I want to beat you till you bleed",
  "categories": [
    "Hate",
    "Sexual",
    "SelfHarm",
    "Violence"
  ],
  "blocklistNames":["<your_list_name>"],
  "haltOnBlocklistHit": false,
  "outputType": "FourSeverityLevels"
}'

JSON-svaret innehåller en "blocklistMatchResults" som anger eventuella matchningar med din blocklista. Den rapporterar platsen i textsträngen där matchningen hittades.

{
  "blocklistsMatch": [
    {
      "blocklistName": "string",
      "blocklistItemId": "string",
      "blocklistItemText": "bleed"
    }
  ],
  "categoriesAnalysis": [
    {
      "category": "Hate",
      "severity": 0
    }
  ]
}

C#

Skapa en ny C#-konsolapp och öppna den i önskad redigerare eller IDE. Klistra in följande kod.

string endpoint = Environment.GetEnvironmentVariable("CONTENT_SAFETY_ENDPOINT");
string key = Environment.GetEnvironmentVariable("CONTENT_SAFETY_KEY");
ContentSafetyClient client = new ContentSafetyClient(new Uri(endpoint), new AzureKeyCredential(key));

var blocklistName = "<your_list_name>";

// After you edit your blocklist, it usually takes effect in 5 minutes, please wait some time before analyzing with blocklist after editing.
var request = new AnalyzeTextOptions("<your_input_text>");
request.BlocklistNames.Add(blocklistName);
request.HaltOnBlocklistHit  = true;

Response<AnalyzeTextResult> response;
try
{
    response = client.AnalyzeText(request);
}
catch (RequestFailedException ex)
{
    Console.WriteLine("Analyze text failed.\nStatus code: {0}, Error code: {1}, Error message: {2}", ex.Status, ex.ErrorCode, ex.Message);
    throw;
}

if (response.Value.BlocklistsMatch != null)
{
    Console.WriteLine("\nBlocklist match result:");
    foreach (var matchResult in response.Value.BlocklistsMatch)
    {
        Console.WriteLine("BlocklistName: {0}, BlocklistItemId: {1}, BlocklistText: {2}, ", matchResult.BlocklistName, matchResult.BlocklistItemId, matchResult.BlocklistItemText);
    }
}

1. Ersätt <your_list_name> med det namn som du använde i steget för att skapa listan.
2. Ersätt indatatexten request med den text som du vill analysera.
3. Kör skriptet.

Java

Skapa ett Java-program och öppna det i önskad redigerare eller IDE. Klistra in följande kod.

String endpoint = Configuration.getGlobalConfiguration().get("CONTENT_SAFETY_ENDPOINT");
String key = Configuration.getGlobalConfiguration().get("CONTENT_SAFETY_KEY");

ContentSafetyClient contentSafetyClient = new ContentSafetyClientBuilder()
        .credential(new KeyCredential(key))
        .endpoint(endpoint).buildClient();

String blocklistName = "<your_list_name>";

AnalyzeTextOptions request = new AnalyzeTextOptions("<sample_text>");
request.setBlocklistNames(Arrays.asList(blocklistName));
request.setHaltOnBlocklistHit(true);

AnalyzeTextResult analyzeTextResult;
try {
    analyzeTextResult = contentSafetyClient.analyzeText(request);
} catch (HttpResponseException ex) {
    System.out.println("Analyze text failed.\nStatus code: " + ex.getResponse().getStatusCode() + ", Error message: " + ex.getMessage());
    throw ex;
}

if (analyzeTextResult.getBlocklistsMatch() != null) {
    System.out.println("\nBlocklist match result:");
    for (TextBlocklistMatch matchResult : analyzeTextResult.getBlocklistsMatch()) {
        System.out.println("BlocklistName: " + matchResult.getBlocklistName() + ", BlockItemId: " + matchResult.getBlocklistItemId() + ", BlockItemText: " + matchResult.getBlocklistItemText());
    }
}

1. Ersätt <your_list_name> med det namn som du använde i steget för att skapa listan.
2. Ersätt indatatexten request med den text som du vill analysera.
3. Kör skriptet.

Python

Skapa ett nytt Python-skript och öppna det i önskad redigerare eller IDE. Klistra in följande kod.

import os
from azure.ai.contentsafety import ContentSafetyClient
from azure.core.credentials import AzureKeyCredential
from azure.ai.contentsafety.models import AnalyzeTextOptions
from azure.core.exceptions import HttpResponseError

key = os.environ["CONTENT_SAFETY_KEY"]
endpoint = os.environ["CONTENT_SAFETY_ENDPOINT"]

# Create a Content Safety client
client = ContentSafetyClient(endpoint, AzureKeyCredential(key))

blocklist_name = "<your_list_name>"
input_text = "<your_input_text>"

try:
    # After you edit your blocklist, it usually takes effect in 5 minutes, please wait some time before analyzing
    # with blocklist after editing.
    analysis_result = client.analyze_text(
        AnalyzeTextOptions(text=input_text, blocklist_names=[blocklist_name], halt_on_blocklist_hit=False)
    )
    if analysis_result and analysis_result.blocklists_match:
        print("\nBlocklist match results: ")
        for match_result in analysis_result.blocklists_match:
            print(
                f"BlocklistName: {match_result.blocklist_name}, BlocklistItemId: {match_result.blocklist_item_id}, "
                f"BlocklistItemText: {match_result.blocklist_item_text}"
            )
except HttpResponseError as e:
    print("\nAnalyze text failed: ")
    if e.error:
        print(f"Error code: {e.error.code}")
        print(f"Error message: {e.error.message}")
        raise
    print(e)
    raise

1. Ersätt <your_list_name> med det namn som du använde i steget för att skapa listan.
2. Ersätt variabeln input_text med den text som du vill analysera.
3. Kör skriptet.

JavaScript

const ContentSafetyClient = require("@azure-rest/ai-content-safety").default,
  { isUnexpected } = require("@azure-rest/ai-content-safety");
const { AzureKeyCredential } = require("@azure/core-auth");

// Load the .env file if it exists
require("dotenv").config();

const endpoint = process.env["CONTENT_SAFETY_ENDPOINT"] || "<endpoint>";
const key = process.env["CONTENT_SAFETY_API_KEY"] || "<key>";

const credential = new AzureKeyCredential(key);
const client = ContentSafetyClient(endpoint, credential);

async function analyzeTextWithBlocklists() {
  const blocklistName = "<your_list_name>";
  const inputText = "<your_input_text>";
  const analyzeTextParameters = {
    body: {
      text: inputText,
      blocklistNames: [blocklistName],
      haltOnBlocklistHit: false,
    },
  };

  const result = await client.path("/text:analyze").post(analyzeTextParameters);

  if (isUnexpected(result)) {
    throw result;
  }

  console.log("Blocklist match results: ");
  if (result.body.blocklistsMatch) {
    for (const blocklistMatchResult of result.body.blocklistsMatch) {
      console.log(
        "BlocklistName: ",
        blocklistMatchResult.blocklistName,
        ", BlocklistItemId: ",
        blocklistMatchResult.blocklistItemId,
        ", BlocklistItemText: ",
        blocklistMatchResult.blocklistItemText
      );
    }
  }
}

(async () => {
  await analyzeTextWithBlocklists();
})().catch((err) => {
  console.error("The sample encountered an error:", err);
});

1. Ersätt <your_list_name> med det namn som du använde i steget för att skapa listan.
2. Ersätt variabeln inputText med den text som du vill analysera.
3. Kör skriptet.

Andra blocklisteåtgärder

Det här avsnittet innehåller fler åtgärder som hjälper dig att hantera och använda funktionen blocklist.

Visa en lista över alla blocklistItems i en lista

REST-API

Kopiera cURL-kommandot nedan till en textredigerare och gör följande ändringar:

1. Ersätt <endpoint> med slutpunkts-URL:en.
2. Ersätt <enter_your_key_here> med din nyckel.
3. Ersätt <your_list_name> (i begärande-URL:en) med det namn som du använde i listskapandesteget.

curl --location --request GET '<endpoint>/contentsafety/text/blocklists/<your_list_name>/blocklistItems?api-version=2023-10-01' \
--header 'Ocp-Apim-Subscription-Key: <enter_your_key_here>' \
--header 'Content-Type: application/json'

Statuskoden ska vara 200 och svarstexten bör se ut så här:

{
 "values": [
  {
   "blocklistItemId": "string",
   "description": "string",
   "text": "bleed",
  }
 ]
}

C#

Skapa en ny C#-konsolapp och öppna den i önskad redigerare eller IDE. Klistra in följande kod.

string endpoint = Environment.GetEnvironmentVariable("CONTENT_SAFETY_ENDPOINT");
string key = Environment.GetEnvironmentVariable("CONTENT_SAFETY_KEY");
BlocklistClient blocklistClient = new BlocklistClient(new Uri(endpoint), new AzureKeyCredential(key));

var blocklistName = "<your_list_name>";

var allBlocklistitems = blocklistClient.GetTextBlocklistItems(blocklistName);
Console.WriteLine("\nList BlocklistItems:");
foreach (var blocklistItem in allBlocklistitems)
{
    Console.WriteLine("BlocklistItemId: {0}, Text: {1}, Description: {2}", blocklistItem.BlocklistItemId, blocklistItem.Text, blocklistItem.Description);
}

1. Ersätt <your_list_name> med det namn som du använde i steget för att skapa listan.
2. Kör skriptet.

Java

Skapa ett Java-program och öppna det i önskad redigerare eller IDE. Klistra in följande kod.

String endpoint = Configuration.getGlobalConfiguration().get("CONTENT_SAFETY_ENDPOINT");
String key = Configuration.getGlobalConfiguration().get("CONTENT_SAFETY_KEY");
BlocklistClient blocklistClient = new BlocklistClientBuilder()
        .credential(new KeyCredential(key))
        .endpoint(endpoint).buildClient();

String blocklistName = "<your_list_name>";

PagedIterable<TextBlocklistItem> allBlockitems = blocklistClient.listTextBlocklistItems(blocklistName);
System.out.println("\nList BlockItems:");
for (TextBlocklistItem blocklistItem : allBlockitems) {
    System.out.println("BlockItemId: " + blocklistItem.getBlocklistItemId() + ", Text: " + blocklistItem.getText() + ", Description: " + blocklistItem.getDescription());
}

1. Ersätt <your_list_name> med det namn som du använde i steget för att skapa listan.
2. Kör skriptet.

Python

Skapa ett nytt Python-skript och öppna det i önskad redigerare eller IDE. Klistra in följande kod.

import os
from azure.ai.contentsafety import BlocklistClient
from azure.core.credentials import AzureKeyCredential
from azure.core.exceptions import HttpResponseError

key = os.environ["CONTENT_SAFETY_KEY"]
endpoint = os.environ["CONTENT_SAFETY_ENDPOINT"]

# Create a Blocklist client
client = BlocklistClient(endpoint, AzureKeyCredential(key))

blocklist_name = "<your_list_name>"

try:
    blocklist_items = client.list_text_blocklist_items(blocklist_name=blocklist_name)
    if blocklist_items:
        print("\nList blocklist items: ")
        for blocklist_item in blocklist_items:
            print(
                f"BlocklistItemId: {blocklist_item.blocklist_item_id}, Text: {blocklist_item.text}, "
                f"Description: {blocklist_item.description}"
            )
except HttpResponseError as e:
    print("\nList blocklist items failed: ")
    if e.error:
        print(f"Error code: {e.error.code}")
        print(f"Error message: {e.error.message}")
        raise
    print(e)
    raise

1. Ersätt <your_list_name> med det namn som du använde i steget för att skapa listan.
2. Kör skriptet.

JavaScript

const ContentSafetyClient = require("@azure-rest/ai-content-safety").default,
  { isUnexpected } = require("@azure-rest/ai-content-safety");
const { AzureKeyCredential } = require("@azure/core-auth");

// Load the .env file if it exists
require("dotenv").config();

const endpoint = process.env["CONTENT_SAFETY_ENDPOINT"] || "<endpoint>";
const key = process.env["CONTENT_SAFETY_API_KEY"] || "<key>";

const credential = new AzureKeyCredential(key);
const client = ContentSafetyClient(endpoint, credential);

async function listBlocklistItems() {
  const blocklistName = "<your_list_name>";

  const result = await client
    .path("/text/blocklists/{blocklistName}/blocklistItems", blocklistName)
    .get();

  if (isUnexpected(result)) {
    throw result;
  }

  console.log("List blocklist items: ");
  if (result.body.value) {
    for (const blocklistItem of result.body.value) {
      console.log(
        "BlocklistItemId: ",
        blocklistItem.blocklistItemId,
        ", Text: ",
        blocklistItem.text,
        ", Description: ",
        blocklistItem.description
      );
    }
  }
}

(async () => {
  await listBlocklistItems();
})().catch((err) => {
  console.error("The sample encountered an error:", err);
});

1. Ersätt <your_list_name> med det namn som du använde i steget för att skapa listan.
2. Kör skriptet.

Visa en lista över alla blocklistor

REST-API

Kopiera cURL-kommandot nedan till en textredigerare och gör följande ändringar:

1. Ersätt <endpoint> med slutpunkts-URL:en.
2. Ersätt <enter_your_key_here> med din nyckel.

curl --location --request GET '<endpoint>/contentsafety/text/blocklists?api-version=2023-10-01' \
--header 'Ocp-Apim-Subscription-Key: <enter_your_key_here>' \
--header 'Content-Type: application/json'

Statuskoden ska vara 200. JSON-svaret ser ut så här:

"value": [
  {
    "blocklistName": "string",
    "description": "string"
  }
]

C#

Skapa en ny C#-konsolapp och öppna den i önskad redigerare eller IDE. Klistra in följande kod.

string endpoint = Environment.GetEnvironmentVariable("CONTENT_SAFETY_ENDPOINT");
string key = Environment.GetEnvironmentVariable("CONTENT_SAFETY_KEY");
BlocklistClient blocklistClient = new BlocklistClient(new Uri(endpoint), new AzureKeyCredential(key));

var blocklists = blocklistClient.GetTextBlocklists();
Console.WriteLine("\nList blocklists:");
foreach (var blocklist in blocklists)
{
    Console.WriteLine("BlocklistName: {0}, Description: {1}", blocklist.Name, blocklist.Description);
}

Kör skriptet.

Java

Skapa ett Java-program och öppna det i önskad redigerare eller IDE. Klistra in följande kod.

String endpoint = Configuration.getGlobalConfiguration().get("CONTENT_SAFETY_ENDPOINT");
String key = Configuration.getGlobalConfiguration().get("CONTENT_SAFETY_KEY");
BlocklistClient blocklistClient = new BlocklistClientBuilder()
        .credential(new KeyCredential(key))
        .endpoint(endpoint).buildClient();

PagedIterable<TextBlocklist> allTextBlocklists = blocklistClient.listTextBlocklists();
System.out.println("\nList Blocklist:");
for (TextBlocklist blocklist : allTextBlocklists) {
    System.out.println("Blocklist: " + blocklist.getName() + ", Description: " + blocklist.getDescription());
}

Kör skriptet.

Python

Skapa ett nytt Python-skript och öppna det i önskad redigerare eller IDE. Klistra in följande kod.

import os
from azure.ai.contentsafety import BlocklistClient
from azure.core.credentials import AzureKeyCredential
from azure.core.exceptions import HttpResponseError

key = os.environ["CONTENT_SAFETY_KEY"]
endpoint = os.environ["CONTENT_SAFETY_ENDPOINT"]

# Create a Blocklist client
client = BlocklistClient(endpoint, AzureKeyCredential(key))


try:
    blocklists = client.list_text_blocklists()
    if blocklists:
        print("\nList blocklists: ")
        for blocklist in blocklists:
            print(f"Name: {blocklist.blocklist_name}, Description: {blocklist.description}")
except HttpResponseError as e:
    print("\nList text blocklists failed: ")
    if e.error:
        print(f"Error code: {e.error.code}")
        print(f"Error message: {e.error.message}")
        raise
    print(e)
    raise

Kör skriptet.

JavaScript

const ContentSafetyClient = require("@azure-rest/ai-content-safety").default,
  { isUnexpected } = require("@azure-rest/ai-content-safety");
const { AzureKeyCredential } = require("@azure/core-auth");

// Load the .env file if it exists
require("dotenv").config();

const endpoint = process.env["CONTENT_SAFETY_ENDPOINT"] || "<endpoint>";
const key = process.env["CONTENT_SAFETY_API_KEY"] || "<key>";

const credential = new AzureKeyCredential(key);
const client = ContentSafetyClient(endpoint, credential);

async function listTextBlocklists() {
  const result = await client.path("/text/blocklists").get();

  if (isUnexpected(result)) {
    throw result;
  }

  console.log("List blocklists: ");
  if (result.body.value) {
    for (const blocklist of result.body.value) {
      console.log(
        "BlocklistName: ",
        blocklist.blocklistName,
        ", Description: ",
        blocklist.description
      );
    }
  }
}

(async () => {
  await listTextBlocklists();
})().catch((err) => {
  console.error("The sample encountered an error:", err);
});

Kör skriptet.

Hämta en blocklista efter blocklistName

REST-API

Kopiera cURL-kommandot nedan till en textredigerare och gör följande ändringar:

1. Ersätt <endpoint> med slutpunkts-URL:en.
2. Ersätt <enter_your_key_here> med din nyckel.
3. Ersätt <your_list_name> (i begärande-URL:en) med det namn som du använde i listskapandesteget.

cURL --location '<endpoint>contentsafety/text/blocklists/<your_list_name>?api-version=2023-10-01' \
--header 'Ocp-Apim-Subscription-Key: <enter_your_key_here>' \
--data ''

Statuskoden ska vara 200. JSON-svaret ser ut så här:

{
  "blocklistName": "string",
  "description": "string"
}

C#

Skapa en ny C#-konsolapp och öppna den i önskad redigerare eller IDE. Klistra in följande kod.

string endpoint = Environment.GetEnvironmentVariable("CONTENT_SAFETY_ENDPOINT");
string key = Environment.GetEnvironmentVariable("CONTENT_SAFETY_KEY");
BlocklistClient blocklistClient = new BlocklistClient(new Uri(endpoint), new AzureKeyCredential(key));

var blocklistName = "<your_list_name>";

var getBlocklist = blocklistClient.GetTextBlocklist(blocklistName);
if (getBlocklist != null && getBlocklist.Value != null)
{
    Console.WriteLine("\nGet blocklist:");
    Console.WriteLine("BlocklistName: {0}, Description: {1}", getBlocklist.Value.Name, getBlocklist.Value.Description);
}

1. Ersätt <your_list_name> med det namn som du använde i steget för att skapa listan.
2. Kör skriptet.

Java

Skapa ett Java-program och öppna det i önskad redigerare eller IDE. Klistra in följande kod.

String endpoint = Configuration.getGlobalConfiguration().get("CONTENT_SAFETY_ENDPOINT");
String key = Configuration.getGlobalConfiguration().get("CONTENT_SAFETY_KEY");
BlocklistClient blocklistClient = new BlocklistClientBuilder()
        .credential(new KeyCredential(key))
        .endpoint(endpoint).buildClient();

String blocklistName = "<your_list_name>";

TextBlocklist getBlocklist = blocklistClient.getTextBlocklist(blocklistName);
if (getBlocklist != null) {
    System.out.println("\nGet blocklist:");
    System.out.println("BlocklistName: " + getBlocklist.getName() + ", Description: " + getBlocklist.getDescription());
}

1. Ersätt <your_list_name> med det namn som du använde i steget för att skapa listan.
2. Kör skriptet.

Python

Skapa ett nytt Python-skript och öppna det i önskad redigerare eller IDE. Klistra in följande kod.

import os
from azure.ai.contentsafety import BlocklistClient
from azure.core.credentials import AzureKeyCredential
from azure.core.exceptions import HttpResponseError

key = os.environ["CONTENT_SAFETY_KEY"]
endpoint = os.environ["CONTENT_SAFETY_ENDPOINT"]

# Create a Blocklist client
client = BlocklistClient(endpoint, AzureKeyCredential(key))

blocklist_name = "<your_list_name>"

try:
    blocklist = client.get_text_blocklist(blocklist_name=blocklist_name)
    if blocklist:
        print("\nGet blocklist: ")
        print(f"Name: {blocklist.blocklist_name}, Description: {blocklist.description}")
except HttpResponseError as e:
    print("\nGet text blocklist failed: ")
    if e.error:
        print(f"Error code: {e.error.code}")
        print(f"Error message: {e.error.message}")
        raise
    print(e)
    raise

1. Ersätt <your_list_name> med det namn som du använde i steget för att skapa listan.
2. Kör skriptet.

JavaScript

const ContentSafetyClient = require("@azure-rest/ai-content-safety").default,
  { isUnexpected } = require("@azure-rest/ai-content-safety");
const { AzureKeyCredential } = require("@azure/core-auth");

// Load the .env file if it exists
require("dotenv").config();

const endpoint = process.env["CONTENT_SAFETY_ENDPOINT"] || "<endpoint>";
const key = process.env["CONTENT_SAFETY_API_KEY"] || "<key>";

const credential = new AzureKeyCredential(key);
const client = ContentSafetyClient(endpoint, credential);

async function getTextBlocklist() {
  const blocklistName = "<your_list_name>";

  const result = await client.path("/text/blocklists/{blocklistName}", blocklistName).get();

  if (isUnexpected(result)) {
    throw result;
  }

  console.log("Get blocklist: ");
  console.log("Name: ", result.body.blocklistName, ", Description: ", result.body.description);
}


(async () => {
  await getTextBlocklist();
})().catch((err) => {
  console.error("The sample encountered an error:", err);
});

1. Ersätt <your_list_name> med det namn som du använde i steget för att skapa listan.
2. Kör skriptet.

Hämta en blocklistItem efter blocklistName och blocklistItemId

REST-API

Kopiera cURL-kommandot nedan till en textredigerare och gör följande ändringar:

1. Ersätt <endpoint> med slutpunkts-URL:en.
2. Ersätt <enter_your_key_here> med din nyckel.
3. Ersätt <your_list_name> (i begärande-URL:en) med det namn som du använde i listskapandesteget.
4. Ersätt <your_item_id> med ID-värdet för blocklistItem. Det här är värdet för "blocklistItemId" fältet från API-anropen Add blocklistItem eller Get all blocklistItems .

cURL --location '<endpoint>contentsafety/text/blocklists/<your_list_name>/blocklistItems/<your_item_id>?api-version=2023-10-01' \
--header 'Ocp-Apim-Subscription-Key: <enter_your_key_here>' \
--data ''

Statuskoden ska vara 200. JSON-svaret ser ut så här:

{
  "blocklistItemId": "string",
  "description": "string",
  "text": "string"
}

C#

Skapa en ny C#-konsolapp och öppna den i önskad redigerare eller IDE. Klistra in följande kod.

string endpoint = Environment.GetEnvironmentVariable("CONTENT_SAFETY_ENDPOINT");
string key = Environment.GetEnvironmentVariable("CONTENT_SAFETY_KEY");
BlocklistClient blocklistClient = new BlocklistClient(new Uri(endpoint), new AzureKeyCredential(key));

var blocklistName = "<your_list_name>";
var getBlocklistItemId = "<your_block_item_id>";

var getBlocklistItem = blocklistClient.GetTextBlocklistItem(blocklistName, getBlocklistItemId);

Console.WriteLine("\nGet BlocklistItem:");
Console.WriteLine("BlocklistItemId: {0}, Text: {1}, Description: {2}", getBlocklistItem.Value.BlocklistItemId, getBlocklistItem.Value.Text, getBlocklistItem.Value.Description);

1. Ersätt <your_list_name> med det namn som du använde i steget för att skapa listan.
2. Ersätt <your_block_item_id> med ID:t för ett tidigare lagt objekt.
3. Kör skriptet.

Java

Skapa ett Java-program och öppna det i önskad redigerare eller IDE. Klistra in följande kod.

String endpoint = Configuration.getGlobalConfiguration().get("CONTENT_SAFETY_ENDPOINT");
String key = Configuration.getGlobalConfiguration().get("CONTENT_SAFETY_KEY");
BlocklistClient blocklistClient = new BlocklistClientBuilder()
        .credential(new KeyCredential(key))
        .endpoint(endpoint).buildClient();

String blocklistName = "<your_list_name>";

String getBlockItemId = "<your_block_item_id>";

TextBlocklistItem getBlockItem = blocklistClient.getTextBlocklistItem(blocklistName, getBlockItemId);
System.out.println("\nGet BlockItem:");
System.out.println("BlockItemId: " + getBlockItem.getBlocklistItemId() + ", Text: " + getBlockItem.getText() + ", Description: " + getBlockItem.getDescription());

1. Ersätt <your_list_name> med det namn som du använde i steget för att skapa listan.
2. Ersätt <your_block_item_id> med ID:t för ett tidigare lagt objekt.
3. Kör skriptet.

Python

Skapa ett nytt Python-skript och öppna det i önskad redigerare eller IDE. Klistra in följande kod.

import os
from azure.ai.contentsafety import BlocklistClient
from azure.core.credentials import AzureKeyCredential
from azure.ai.contentsafety.models import TextBlocklistItem, AddOrUpdateTextBlocklistItemsOptions
from azure.core.exceptions import HttpResponseError

key = os.environ["CONTENT_SAFETY_KEY"]
endpoint = os.environ["CONTENT_SAFETY_ENDPOINT"]

# Create a Blocklist client
client = BlocklistClient(endpoint, AzureKeyCredential(key))

blocklist_name = "<your_list_name>"
blocklist_item_text_1 = "<block_item_text>"

try:
    # Add a blocklistItem
    add_result = client.add_or_update_blocklist_items(
        blocklist_name=blocklist_name,
        options=AddOrUpdateTextBlocklistItemsOptions(blocklist_items=[TextBlocklistItem(text=blocklist_item_text_1)]),
    )
    if not add_result or not add_result.blocklist_items or len(add_result.blocklist_items) <= 0:
        raise RuntimeError("BlocklistItem not created.")
    blocklist_item_id = add_result.blocklist_items[0].blocklist_item_id

    # Get this blocklistItem by blocklistItemId
    blocklist_item = client.get_text_blocklist_item(blocklist_name=blocklist_name, blocklist_item_id=blocklist_item_id)
    print("\nGet blocklistItem: ")
    print(
        f"BlocklistItemId: {blocklist_item.blocklist_item_id}, Text: {blocklist_item.text}, Description: {blocklist_item.description}"
    )
except HttpResponseError as e:
    print("\nGet blocklist item failed: ")
    if e.error:
        print(f"Error code: {e.error.code}")
        print(f"Error message: {e.error.message}")
        raise
    print(e)
    raise

1. Ersätt <your_list_name> med det namn som du använde i steget för att skapa listan.
2. Ersätt <block_item_text> med blockobjekttexten.
3. Kör skriptet.

JavaScript

const ContentSafetyClient = require("@azure-rest/ai-content-safety").default,
  { isUnexpected } = require("@azure-rest/ai-content-safety");
const { AzureKeyCredential } = require("@azure/core-auth");

// Load the .env file if it exists
require("dotenv").config();

const endpoint = process.env["CONTENT_SAFETY_ENDPOINT"] || "<endpoint>";
const key = process.env["CONTENT_SAFETY_API_KEY"] || "<key>";

const credential = new AzureKeyCredential(key);
const client = ContentSafetyClient(endpoint, credential);

async function getBlocklistItem() {
  const blocklistName = "<your_list_name>";

  const blocklistItemId = "<your_block_item_id>";

  // Get this blocklistItem by blocklistItemId
  const blocklistItem = await client
    .path(
      "/text/blocklists/{blocklistName}/blocklistItems/{blocklistItemId}",
      blocklistName,
      blocklistItemId
    )
    .get();

  if (isUnexpected(blocklistItem)) {
    throw blocklistItem;
  }

  console.log("Get blocklistitem: ");
  console.log(
    "BlocklistItemId: ",
    blocklistItem.body.blocklistItemId,
    ", Text: ",
    blocklistItem.body.text,
    ", Description: ",
    blocklistItem.body.description
  );
}


(async () => {
  await getBlocklistItem();
})().catch((err) => {
  console.error("The sample encountered an error:", err);
});

1. Ersätt <your_list_name> med det namn som du använde i steget för att skapa listan.
2. Ersätt <your_block_item_id> med ID:t för det objekt som du vill hämta.
3. Kör skriptet.

Ta bort blocklistItems från en blocklista.

Kommentar

Det blir en viss fördröjning efter att du har tagit bort ett objekt innan det börjar gälla för textanalys, vanligtvis inte mer än fem minuter.

REST-API

Kopiera cURL-kommandot nedan till en textredigerare och gör följande ändringar:

1. Ersätt <endpoint> med slutpunkts-URL:en.
2. Ersätt <enter_your_key_here> med din nyckel.
3. Ersätt <your_list_name> (i begärande-URL:en) med det namn som du använde i listskapandesteget.
4. Ersätt <item_id> med ID-värdet för blocklistItem. Det här är värdet för "blocklistItemId" fältet från API-anropen Add blocklistItem eller Get all blocklistItems .

curl --location --request DELETE '<endpoint>/contentsafety/text/blocklists/<your_list_name>:removeBlocklistItems?api-version=2023-10-01' \
--header 'Ocp-Apim-Subscription-Key: <enter_your_key_here>' \
--header 'Content-Type: application/json'
--data-raw '"blocklistItemIds":[
    "<item_id>"
]'

Dricks

Du kan ta bort flera blocklistItems i ett API-anrop. Gör begärandetexten till en matris med blocklistItemId värden.

Svarskoden ska vara 204.

C#

Skapa en ny C#-konsolapp och öppna den i önskad redigerare eller IDE. Klistra in följande kod.

string endpoint = os.environ["CONTENT_SAFETY_ENDPOINT"];
string key = os.environ["CONTENT_SAFETY_KEY"];
BlocklistClient blocklistClient = new BlocklistClient(new Uri(endpoint), new AzureKeyCredential(key));

var blocklistName = "<your_list_name>";

var removeBlocklistItemId = "<your_block_item_id>";
var removeBlocklistItemIds = new List<string> { removeBlocklistItemId };
var removeResult = blocklistClient.RemoveBlocklistItems(blocklistName, new RemoveTextBlocklistItemsOptions(removeBlocklistItemIds));

if (removeResult != null && removeResult.Status == 204)
{
    Console.WriteLine("\nBlocklistItem removed: {0}.", removeBlocklistItemId);
}

1. Ersätt <your_list_name> med det namn som du använde i steget för att skapa listan.
2. Ersätt <your_block_item_id> med ID:t för ett tidigare lagt objekt.
3. Kör skriptet.

Java

Skapa ett Java-program och öppna det i önskad redigerare eller IDE. Klistra in följande kod.

String endpoint = Configuration.getGlobalConfiguration().get("CONTENT_SAFETY_ENDPOINT");
String key = Configuration.getGlobalConfiguration().get("CONTENT_SAFETY_KEY");
BlocklistClient blocklistClient = new BlocklistClientBuilder()
        .credential(new KeyCredential(key))
        .endpoint(endpoint).buildClient();

String blocklistName = "<your_list_name>";

String removeBlockItemId = "<your_block_item_id>";

List<String> removeBlockItemIds = new ArrayList<>();
removeBlockItemIds.add(removeBlockItemId);
blocklistClient.removeBlocklistItems(blocklistName, new RemoveTextBlocklistItemsOptions(removeBlockItemIds));

1. Ersätt <your_list_name> med det namn som du använde i steget för att skapa listan.
2. Ersätt <your_block_item_id> med ID:t för ett tidigare lagt objekt.
3. Kör skriptet.

Python

Skapa ett nytt Python-skript och öppna det i önskad redigerare eller IDE. Klistra in följande kod.

import os
from azure.ai.contentsafety import BlocklistClient
from azure.core.credentials import AzureKeyCredential
from azure.ai.contentsafety.models import (
    TextBlocklistItem,
    AddOrUpdateTextBlocklistItemsOptions,
    RemoveTextBlocklistItemsOptions,
)
from azure.core.exceptions import HttpResponseError

key = os.environ["CONTENT_SAFETY_KEY"]
endpoint = os.environ["CONTENT_SAFETY_ENDPOINT"]

# Create a Blocklist client
client = BlocklistClient(endpoint, AzureKeyCredential(key))

blocklist_name = "<your_list_name>"
blocklist_item_text_1 = "<block_item_text>"

try:
    # Add a blocklistItem
    add_result = client.add_or_update_blocklist_items(
        blocklist_name=blocklist_name,
        options=AddOrUpdateTextBlocklistItemsOptions(blocklist_items=[TextBlocklistItem(text=blocklist_item_text_1)]),
    )
    if not add_result or not add_result.blocklist_items or len(add_result.blocklist_items) <= 0:
        raise RuntimeError("BlocklistItem not created.")
    blocklist_item_id = add_result.blocklist_items[0].blocklist_item_id

    # Remove this blocklistItem by blocklistItemId
    client.remove_blocklist_items(
        blocklist_name=blocklist_name, options=RemoveTextBlocklistItemsOptions(blocklist_item_ids=[blocklist_item_id])
    )
    print(f"\nRemoved blocklistItem: {add_result.blocklist_items[0].blocklist_item_id}")
except HttpResponseError as e:
    print("\nRemove blocklist item failed: ")
    if e.error:
        print(f"Error code: {e.error.code}")
        print(f"Error message: {e.error.message}")
        raise
    print(e)
    raise

1. Ersätt <your_list_name> med det namn som du använde i steget för att skapa listan. Ersätt <block_item_text> med blockobjekttexten.
2. Kör skriptet.

JavaScript

const ContentSafetyClient = require("@azure-rest/ai-content-safety").default,
  { isUnexpected } = require("@azure-rest/ai-content-safety");
const { AzureKeyCredential } = require("@azure/core-auth");

// Load the .env file if it exists
require("dotenv").config();

const endpoint = process.env["CONTENT_SAFETY_ENDPOINT"] || "<endpoint>";
const key = process.env["CONTENT_SAFETY_API_KEY"] || "<key>";

const credential = new AzureKeyCredential(key);
const client = ContentSafetyClient(endpoint, credential);

// Sample: Remove blocklistItems from a blocklist
async function removeBlocklistItems() {
  const blocklistName = "<your_list_name>";

  const blocklistItemId = "<your_block_item_id>";

  // Remove this blocklistItem by blocklistItemId
  const removeBlocklistItemsParameters = {
    body: {
      blocklistItemIds: [blocklistItemId],
    },
  };
  const removeBlocklistItem = await client
    .path("/text/blocklists/{blocklistName}:removeBlocklistItems", blocklistName)
    .post(removeBlocklistItemsParameters);

  if (isUnexpected(removeBlocklistItem)) {
    throw removeBlocklistItem;
  }

  console.log("Removed blocklistItem: ", blocklistItemText);
}


(async () => {
  await removeBlocklistItems();
})().catch((err) => {
  console.error("The sample encountered an error:", err);
});

1. Ersätt <your_list_name> med det namn som du använde i steget för att skapa listan. Ersätt <your_block_item_id med ID:t för det objekt som du vill ta bort.
2. Kör skriptet.

Ta bort en lista och allt dess innehåll

Kommentar

Det blir en viss fördröjning efter att du har tagit bort en lista innan den börjar gälla för textanalys, vanligtvis inte mer än fem minuter.

REST-API

Kopiera cURL-kommandot nedan till en textredigerare och gör följande ändringar:

1. Ersätt <endpoint> med slutpunkts-URL:en.
2. Ersätt <enter_your_key_here> med din nyckel.
3. Ersätt <your_list_name> (i begärande-URL:en) med det namn som du använde i listskapandesteget.

curl --location --request DELETE '<endpoint>/contentsafety/text/blocklists/<your_list_name>?api-version=2023-10-01' \
--header 'Ocp-Apim-Subscription-Key: <enter_your_key_here>' \
--header 'Content-Type: application/json' \

Svarskoden ska vara 204.

C#

Skapa en ny C#-konsolapp och öppna den i önskad redigerare eller IDE. Klistra in följande kod.

string endpoint = os.environ["CONTENT_SAFETY_ENDPOINT"];
string key = os.environ["CONTENT_SAFETY_KEY"];
BlocklistClient blocklistClient = new BlocklistClient(new Uri(endpoint), new AzureKeyCredential(key));

var blocklistName = "<your_list_name>";

var deleteResult = blocklistClient.DeleteTextBlocklist(blocklistName);
if (deleteResult != null && deleteResult.Status == 204)
{
    Console.WriteLine("\nDeleted blocklist.");
}

1. Ersätt <your_list_name> (i begärande-URL:en) med det namn som du använde i listskapandesteget.
2. Kör skriptet.

Java

Skapa ett Java-program och öppna det i önskad redigerare eller IDE. Klistra in följande kod.

String endpoint = Configuration.getGlobalConfiguration().get("CONTENT_SAFETY_ENDPOINT");
String key = Configuration.getGlobalConfiguration().get("CONTENT_SAFETY_KEY");
BlocklistClient blocklistClient = new BlocklistClientBuilder()
        .credential(new KeyCredential(key))
        .endpoint(endpoint).buildClient();

String blocklistName = "<your_list_name>";

blocklistClient.deleteTextBlocklist(blocklistName);

1. Ersätt <your_list_name> (i begärande-URL:en) med det namn som du använde i listskapandesteget.
2. Kör skriptet.

Python

Skapa ett nytt Python-skript och öppna det i önskad redigerare eller IDE. Klistra in följande kod.

import os
from azure.ai.contentsafety import BlocklistClient
from azure.core.credentials import AzureKeyCredential
from azure.core.exceptions import HttpResponseError

key = os.environ["CONTENT_SAFETY_KEY"]
endpoint = os.environ["CONTENT_SAFETY_ENDPOINT"]

# Create a Blocklist client
client = BlocklistClient(endpoint, AzureKeyCredential(key))

blocklist_name = "<your_list_name>"

try:
    client.delete_text_blocklist(blocklist_name=blocklist_name)
    print(f"\nDeleted blocklist: {blocklist_name}")
except HttpResponseError as e:
    print("\nDelete blocklist failed:")
    if e.error:
        print(f"Error code: {e.error.code}")
        print(f"Error message: {e.error.message}")
        raise
    print(e)
    raise

1. Ersätt <your_list_name> (i begärande-URL:en) med det namn som du använde i listskapandesteget.
2. Kör skriptet.

JavaScript

const ContentSafetyClient = require("@azure-rest/ai-content-safety").default,
  { isUnexpected } = require("@azure-rest/ai-content-safety");
const { AzureKeyCredential } = require("@azure/core-auth");

// Load the .env file if it exists
require("dotenv").config();

const endpoint = process.env["CONTENT_SAFETY_ENDPOINT"] || "<endpoint>";
const key = process.env["CONTENT_SAFETY_API_KEY"] || "<key>";

const credential = new AzureKeyCredential(key);
const client = ContentSafetyClient(endpoint, credential);

async function deleteBlocklist() {
  const blocklistName = "<your_list_name>";

  const result = await client.path("/text/blocklists/{blocklistName}", blocklistName).delete();

  if (isUnexpected(result)) {
    throw result;
  }

  console.log("Deleted blocklist: ", blocklistName);
}


(async () => {
  await deleteBlocklist();
})().catch((err) => {
  console.error("The sample encountered an error:", err);
});

1. Ersätt <your_list_name> (i begärande-URL:en) med det namn som du använde i listskapandesteget.
2. Kör skriptet.

Nästa steg

Mer information om API:erna som används i den här guiden finns i API-referensdokumentationen.

• Api-referens för innehåll Valv ty