Použití vlastní kategorie (rychlé) rozhraní API (Preview)

Článek
09/01/2024

Rozhraní API vlastních kategorií (rychlé) umožňuje rychle reagovat na vznikající škodlivé incidenty obsahu. Incident můžete definovat několika příklady v konkrétním tématu a služba začne zjišťovat podobný obsah.

Pomocí těchto kroků definujte incident s několika příklady textového obsahu a pak analyzujte nový textový obsah, abyste zjistili, jestli incident odpovídá.

Důležité

Tato nová funkce je dostupná jenom ve vybraných oblastech Azure. Viz Dostupnost oblastí.

Upozornění

Ukázková data v této příručce můžou obsahovat urážlivý obsah. Doporučuje se, aby uživatel rozhodoval.

Požadavky

Předplatné Azure – Vytvoření předplatného zdarma
Jakmile budete mít předplatné Azure, vytvořte na webu Azure Portal prostředek zabezpečení obsahu, abyste získali svůj klíč a koncový bod. Zadejte jedinečný název vašeho prostředku, vyberte své předplatné a vyberte skupinu prostředků, podporovanou oblast (viz Dostupnost oblastí) a podporovanou cenovou úroveň. Pak vyberte Vytvořit.
- Nasazení prostředku trvá několik minut. Po dokončení vyberte přejít k prostředku. V levém podokně v části Správa prostředků vyberte Klíč předplatného a koncový bod. Koncový bod a jeden z klíčů se používají k volání rozhraní API.
Pokud tam chcete nahrát obrázky, vytvořte také kontejner úložiště objektů blob. Alternativně můžete obrázky zakódovat jako řetězce Base64 a použít je přímo ve voláních rozhraní API.
Nainstalujte jednu z následujících instalací:
- cURL pro volání rozhraní REST API.
- Nainstalovaný Python 3.x

Testování vlastních kategorií textu (rychlé) rozhraní API

Pomocí vzorového kódu v této části vytvořte textový incident, přidejte do incidentu ukázky, nasaďte incident a pak detekujte textové incidenty.

V následujícíchpříkazch <your_api_key><your_endpoint>

Následující příkaz vytvoří incident s názvem a definicí.

curl --location --request PATCH 'https://<endpoint>/contentsafety/text/incidents/<text-incident-name>?api-version=2024-02-15-preview' \
--header 'Ocp-Apim-Subscription-Key: <your-content-safety-key>' \
--header 'Content-Type: application/json' \
--data '{ \"incidentName\": \"<test-incident>\", \"incidentDefinition\": \"<string>\"}'

Nejprve je potřeba nainstalovat požadovanou knihovnu Pythonu:

pip install requests

Pak definujte potřebné proměnné s vlastními podrobnostmi o prostředcích Azure:

import requests

API_KEY = '<your_api_key>'
ENDPOINT = '<your_endpoint>'

headers = {
    'Ocp-Apim-Subscription-Key': API_KEY,
    'Content-Type': 'application/json'
}

Následující příkaz vytvoří incident s názvem a definicí.

import requests
import json

url = "https://<endpoint>/contentsafety/text/incidents/<text-incident-name>?api-version=2024-02-15-preview"

payload = json.dumps({
  "incidentName": "<text-incident-name>",
  "incidentDefinition": "string"
})
headers = {
  'Ocp-Apim-Subscription-Key': '<your-content-safety-key>',
  'Content-Type': 'application/json'
}

response = requests.request("PATCH", url, headers=headers, data=payload)

print(response.text)

Přidání ukázek k incidentu

K přidání textových příkladů k incidentu použijte následující příkaz.

cURL
Python

curl --location 'https://<endpoint>/contentsafety/text/incidents/<text-incident-name>:addIncidentSamples?api-version=2024-02-15-preview' \
--header 'Ocp-Apim-Subscription-Key: <your-content-safety-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
  \"IncidentSamples\": [
    { \"text\":    \"<text-example-1>\"},
    { \"text\":    \"<text-example-2>\"},
    ...
  ]
}'

import requests
import json

url = "https://<endpoint>/contentsafety/text/incidents/<text-incident-name>:addIncidentSamples?api-version=2024-02-15-preview"

payload = json.dumps({
  "IncidentSamples": [
    {
      "text": "<text-example-1>"
    },
    {
      "text": "<text-example-1>"
    },
    ...
  ]
})
headers = {
  'Ocp-Apim-Subscription-Key': '<your-content-safety-key>',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Nasazení incidentu

K nasazení incidentu použijte následující příkaz a zpřístupňuje ho k analýze nového obsahu.

cURL
Python

curl --location 'https://<endpoint>/contentsafety/text/incidents/<text-incident-name>:deploy?api-version=2024-02-15-preview' \
--header 'Ocp-Apim-Subscription-Key: <your-content-safety-key>' \
--header 'Content-Type: application/json'

import requests
import json

url = "https://<endpoint>/contentsafety/text/incidents/<text-incident-name>:deploy?api-version=2024-02-15-preview"

payload = {}
headers = {
  'Ocp-Apim-Subscription-Key': '<your-content-safety-key>',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Detekce textových incidentů

Spuštěním následujícího příkazu analyzujte ukázkový textový obsah pro incident, který jste právě nasadili.

cURL
Python

curl --location 'https://<endpoint>/contentsafety/text:detectIncidents?api-version=2024-02-15-preview' \
--header 'Ocp-Apim-Subscription-Key: <your-content-safety-key>' \
--header 'Content-Type: application/json' \
--data '{
  \"text\":  \"<test-text>\",
  \"incidentNames\": [
    \"<text-incident-name>\"
  ]
}'

import requests
import json

url = "https://<endpoint>/contentsafety/text:detectIncidents?api-version=2024-02-15-preview"

payload = json.dumps({
  "text": "<test-text>",
  "incidentNames": [
    "<text-incident-name>"
  ]
})
headers = {
  'Ocp-Apim-Subscription-Key': '<your-content-safety-key>',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Testování vlastní kategorie imagí (rychlé) rozhraní API

Pomocí vzorového kódu v této části vytvořte incident image, přidejte do incidentu ukázky, nasaďte incident a pak detekujte incidenty obrázků.

Vytvoření incidentu

cURL
Python

V následujícíchpříkazch <your_api_key><your_endpoint>

Následující příkaz vytvoří incident image:

curl --location --request PATCH 'https://<endpoint>/contentsafety/image/incidents/<image-incident-name>?api-version=2024-02-15-preview' \
--header 'Ocp-Apim-Subscription-Key: <your-content-safety-key>' \
--header 'Content-Type: application/json' \
--data '{
  \"incidentName\": \"<image-incident-name>\"
}'

Ujistěte se, že jste nainstalovali požadované knihovny Pythonu:

pip install requests

Definujte potřebné proměnné s vlastními podrobnostmi o prostředcích Azure:

import requests

API_KEY = '<your_api_key>'
ENDPOINT = '<your_endpoint>'

headers = {
    'Ocp-Apim-Subscription-Key': API_KEY,
    'Content-Type': 'application/json'
}

Následující příkaz vytvoří incident image:

import requests
import json

url = "https://<endpoint>/contentsafety/image/incidents/<image-incident-name>?api-version=2024-02-15-preview"

payload = json.dumps({
  "incidentName": "<image-incident-name>"
})
headers = {
  'Ocp-Apim-Subscription-Key': '<your-content-safety-key>',
  'Content-Type': 'application/json'
}

response = requests.request("PATCH", url, headers=headers, data=payload)

print(response.text)

Přidání ukázek k incidentu

Pomocí následujícího příkazu přidejte do incidentu příklady obrázků. Ukázky obrázků můžou být adresy URL odkazující na obrázky v kontejneru úložiště objektů blob v Azure nebo můžou být řetězce Base64.

cURL
Python

curl --location 'https://<endpoint>/contentsafety/image/incidents/<image-incident-name>:addIncidentSamples?api-version=2024-02-15-preview' \
--header 'Ocp-Apim-Subscription-Key: <your-content-safety-key>' \
--header 'Content-Type: application/json' \
--data '{
  \"IncidentSamples\": [
    {
      \"image\": {
        \"content\": \"<base64-data>\",
        \"bloburl\": \"<your-blob-storage-url>.png\"
      }
    }
  ]
}'

import requests
import json

url = "https://<endpoint>/contentsafety/image/incidents/<image-incident-name>:addIncidentSamples?api-version=2024-02-15-preview"

payload = json.dumps({
  "IncidentSamples": [
    {
      "image": {
        "content": "<base64-data>",
        "bloburl": "<your-blob-storage-url>/image.png"
      }
    }
  ]
})
headers = {
  'Ocp-Apim-Subscription-Key': '<your-content-safety-key>',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Nasazení incidentu

K nasazení incidentu použijte následující příkaz a zpřístupňuje ho k analýze nového obsahu.

cURL
Python

curl --location 'https://<endpoint>/contentsafety/image/incidents/<image-incident-name>:deploy?api-version=2024-02-15-preview' \
--header 'Ocp-Apim-Subscription-Key: <your-content-safety-key>' \
--header 'Content-Type: application/json'

import requests
import json

url = "https://<endpoint>/contentsafety/image/incidents/<image-incident-name>:deploy?api-version=2024-02-15-preview"

payload = {}
headers = {
  'Ocp-Apim-Subscription-Key': '<your-content-safety-key>',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Detekce incidentů obrázků

Pomocí následujícího příkazu nahrajte ukázkový obrázek a otestujte ho proti incidentu, který jste nasadili. Můžete použít adresu URL odkazující na obrázek v kontejneru úložiště objektů blob v Azure, nebo můžete data image přidat jako řetězec Base64.

cURL
Python

curl --location 'https://<endpoint>/contentsafety/image:detectIncidents?api-version=2024-02-15-preview' \
--header 'Ocp-Apim-Subscription-Key: <your-content-safety-key>' \
--header 'Content-Type: application/json' \
--data '{
    \"image\": {
      \"url\": \"<your-blob-storage-url>/image.png\",
      "content": "<base64-data>"
    },
    \"incidentNames\": [
      \"<image-incident-name>\"
    ]
  }
}'

import requests
import json

url = "https://<endpoint>/contentsafety/image:detectIncidents?api-version=2024-02-15-preview"

payload = json.dumps({
  "image": {
    "url": "<your-blob-storage-url>/image.png",
    "content": "<base64-data>"
  },
  "incidentNames": [
    "<image-incident-name>"
  ]
})
headers = {
  'Ocp-Apim-Subscription-Key': '<your-content-safety-key>',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Jiné operace incidentů

Následující operace jsou užitečné pro správu incidentů a ukázek incidentů.

Rozhraní API pro incidenty textu

Výpis všech incidentů

cURL
Python

curl --location GET 'https://<endpoint>/contentsafety/text/incidents?api-version=2024-02-15-preview' \
--header 'Ocp-Apim-Subscription-Key: <your-content-safety-key>'

import requests

url = "https://<endpoint>/contentsafety/text/incidents?api-version=2024-02-15-preview"

payload = {}
headers = {
  'Ocp-Apim-Subscription-Key': '<your-content-safety-key>'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Získání podrobností o incidentu

cURL
Python

curl --location GET 'https://<endpoint>/contentsafety/text/incidents/<text-incident-name>?api-version=2024-02-15-preview' \
--header 'Ocp-Apim-Subscription-Key: <your-content-safety-key>'

import requests

url = "https://<endpoint>/contentsafety/text/incidents/<text-incident-name>?api-version=2024-02-15-preview"

payload = {}
headers = {
  'Ocp-Apim-Subscription-Key': '<your-content-safety-key>'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Odstranění incidentu

cURL
Python

curl --location --request DELETE 'https://<endpoint>/contentsafety/text/incidents/<text-incident-name>?api-version=2024-02-15-preview' \
--header 'Ocp-Apim-Subscription-Key: <your-content-safety-key>'

import requests

url = "https://<endpoint>/contentsafety/text/incidents/<text-incident-name>?api-version=2024-02-15-preview"

payload = {}
headers = {
  'Ocp-Apim-Subscription-Key': '<your-content-safety-key>'
}

response = requests.request("DELETE", url, headers=headers, data=payload)

print(response.text)

Výpis všech ukázek v rámci incidentu

Tento příkaz načte jedinečná ID všech ukázek přidružených k danému objektu incidentu.

cURL
Python

curl --location GET 'https://<endpoint>/contentsafety/text/incidents/<text-incident-name>/incidentsamples?api-version=2024-02-15-preview' \
--header 'Ocp-Apim-Subscription-Key: <your-content-safety-key>'

import requests

url = "https://<endpoint>/contentsafety/text/incidents/<text-incident-name>/incidentsamples?api-version=2024-02-15-preview"

payload = {}
headers = {
  'Ocp-Apim-Subscription-Key': '<your-content-safety-key>'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Získání podrobností ukázky incidentu

Pomocí id ukázky incidentu vyhledejte podrobnosti o ukázce.

cURL
Python

curl --location GET 'https://<endpoint>/contentsafety/text/incidents/<text-incident-name>/incidentsamples/<your-incident-sample-id>?api-version=2024-02-15-preview' \
--header 'Ocp-Apim-Subscription-Key: <your-content-safety-key>'

import requests

url = "https://<endpoint>/contentsafety/text/incidents/<text-incident-name>/incidentsamples/<your-incident-sample-id>?api-version=2024-02-15-preview"

payload = {}
headers = {
  'Ocp-Apim-Subscription-Key': '<your-content-safety-key>'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Odstranění ukázky incidentu

K načtení a odstranění této ukázky použijte ukázkové ID incidentu.

cURL
Python

curl --location 'https://<endpoint>/contentsafety/text/incidents/<text-incident-name>:removeIncidentSamples?api-version=2024-02-15-preview' \
--header 'Ocp-Apim-Subscription-Key: <your-content-safety-key>' \
--header 'Content-Type: application/json' \
--data '{
  \"IncidentSampleIds\": [
    \"<your-incident-sample-id>\"
  ]
}'

import requests
import json

url = "https://<endpoint>/contentsafety/text/incidents/<text-incident-name>:removeIncidentSamples?api-version=2024-02-15-preview"

payload = json.dumps({
  "IncidentSampleIds": [
    "<your-incident-sample-id>"
  ]
})
headers = {
  'Ocp-Apim-Subscription-Key': '<your-content-safety-key>',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Rozhraní API pro incidenty obrázků

Získání seznamu incidentů

cURL
Python

curl --location GET 'https://<endpoint>/contentsafety/image/incidents?api-version=2024-02-15-preview' \
--header 'Ocp-Apim-Subscription-Key: <your-content-safety-key>'

import requests

url = "https://<endpoint>/contentsafety/image/incidents?api-version=2024-02-15-preview"

payload = {}
headers = {
  'Ocp-Apim-Subscription-Key': '<your-content-safety-key>'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Získání podrobností o incidentu

cURL
Python

curl --location GET 'https://<endpoint>/contentsafety/image/incidents/<image-incident-name>?api-version=2024-02-15-preview' \
--header 'Ocp-Apim-Subscription-Key: <your-content-safety-key>'

import requests

url = "https://<endpoint>/contentsafety/image/incidents/<image-incident-name>?api-version=2024-02-15-preview"

payload = {}
headers = {
  'Ocp-Apim-Subscription-Key': '<your-content-safety-key>'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Odstranění incidentu

cURL
Python

curl --location --request DELETE 'https://<endpoint>/contentsafety/image/incidents/<image-incident-name>?api-version=2024-02-15-preview' \
--header 'Ocp-Apim-Subscription-Key: <your-content-safety-key>'

import requests

url = "https://<endpoint>/contentsafety/image/incidents/<image-incident-name>?api-version=2024-02-15-preview"

payload = {}
headers = {
  'Ocp-Apim-Subscription-Key': '<your-content-safety-key>'
}

response = requests.request("DELETE", url, headers=headers, data=payload)

print(response.text)

Výpis všech ukázek v rámci incidentu

Tento příkaz načte jedinečná ID všech ukázek přidružených k danému objektu incidentu.

cURL
Python

curl --location GET 'https://<endpoint>/contentsafety/image/incidents/<image-incident-name>/incidentsamples?api-version=2024-02-15-preview' \
--header 'Ocp-Apim-Subscription-Key: <your-content-safety-key>'

import requests

url = "https://<endpoint>/contentsafety/image/incidents/<image-incident-name>/incidentsamples?api-version=2024-02-15-preview"

payload = {}
headers = {
  'Ocp-Apim-Subscription-Key': '<your-content-safety-key>'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Získání podrobností o ukázce incidentu

Pomocí id ukázky incidentu vyhledejte podrobnosti o ukázce.

cURL
Python

curl --location GET 'https://<endpoint>/contentsafety/image/incidents/<image-incident-name>/incidentsamples/<your-incident-sample-id>?api-version=2024-02-15-preview' \
--header 'Ocp-Apim-Subscription-Key: <your-content-safety-key>'

import requests

url = "https://<endpoint>/contentsafety/image/incidents/<image-incident-name>/incidentsamples/<your-incident-sample-id>?api-version=2024-02-15-preview"

payload = {}
headers = {
  'Ocp-Apim-Subscription-Key': '<your-content-safety-key>'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Odstranění ukázky incidentu

K načtení a odstranění této ukázky použijte ukázkové ID incidentu.

cURL
Python

curl --location 'https://<endpoint>/contentsafety/image/incidents/<image-incident-name>:removeIncidentSamples?api-version=2024-02-15-preview' \
--header 'Ocp-Apim-Subscription-Key: <your-content-safety-key>' \
--header 'Content-Type: application/json' \
--data '{
  \"IncidentSampleIds\": [
    \"<your-incident-sample-id>\"
  ]
}'

import requests
import json

url = "https://<endpoint>/contentsafety/image/incidents/<image-incident-name>:removeIncidentSamples?api-version=2024-02-15-preview"

payload = json.dumps({
  "IncidentSampleIds": [
    "<your-incident-sample-id>"
  ]
})
headers = {
  'Ocp-Apim-Subscription-Key': '<your-content-safety-key>',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Sdílet prostřednictvím

Použití vlastní kategorie (rychlé) rozhraní API (Preview)

Požadavky

Testování vlastních kategorií textu (rychlé) rozhraní API

Vytvoření objektu incidentu

Přidání ukázek k incidentu

Nasazení incidentu

Detekce textových incidentů

Testování vlastní kategorie imagí (rychlé) rozhraní API

Vytvoření incidentu

Přidání ukázek k incidentu

Nasazení incidentu

Detekce incidentů obrázků

Jiné operace incidentů

Rozhraní API pro incidenty textu

Výpis všech incidentů

Získání podrobností o incidentu

Odstranění incidentu

Výpis všech ukázek v rámci incidentu

Získání podrobností ukázky incidentu

Odstranění ukázky incidentu

Rozhraní API pro incidenty obrázků

Získání seznamu incidentů

Získání podrobností o incidentu

Odstranění incidentu

Výpis všech ukázek v rámci incidentu

Získání podrobností o ukázce incidentu

Odstranění ukázky incidentu

Váš názor

Další materiály

Sdílet prostřednictvím

Použití vlastní kategorie (rychlé) rozhraní API (Preview)

Požadavky

Testování vlastních kategorií textu (rychlé) rozhraní API

Vytvoření objektu incidentu

Přidání ukázek k incidentu

Nasazení incidentu

Detekce textových incidentů

Testování vlastní kategorie imagí (rychlé) rozhraní API

Vytvoření incidentu

Přidání ukázek k incidentu

Nasazení incidentu

Detekce incidentů obrázků

Jiné operace incidentů

Rozhraní API pro incidenty textu

Výpis všech incidentů

Získání podrobností o incidentu

Odstranění incidentu

Výpis všech ukázek v rámci incidentu

Získání podrobností ukázky incidentu

Odstranění ukázky incidentu

Rozhraní API pro incidenty obrázků

Získání seznamu incidentů

Získání podrobností o incidentu

Odstranění incidentu

Výpis všech ukázek v rámci incidentu

Získání podrobností o ukázce incidentu

Odstranění ukázky incidentu

Související obsah

Váš názor

Další materiály