カスタムカテゴリ (急速) API を使用する

[アーティクル]
09/03/2024

カスタムカテゴリ (急速) API を使用すると、新たに発生する有害なコンテンツインシデントに迅速に対応できます。特定のトピック内でいくつかの例を使用してインシデントを定義すると、このサービスによって同様のコンテンツの検出が開始されます。

次の手順に従って、いくつかのテキストコンテンツの例を含むインシデントを定義してから、新しいテキストコンテンツを分析して、それが当該インシデントと一致するかどうかを確認します。

重要

この新機能は、一部の Azure リージョンでのみ利用可能です。利用可能なリージョンに関するページを参照してください。

注意事項

このガイドのサンプルデータには、不快なコンテンツが含まれている可能性があります。ユーザーの裁量が推奨されます。

前提条件

Azure サブスクリプション - 無料アカウントを作成します
Azure サブスクリプションを入手したら、Azure portal で Content Safety リソースを作成し、キーとエンドポイントを取得します。リソースの一意の名前を入力し、サブスクリプションを選択して、リソースグループ、サポートされているリージョン (「利用可能なリージョン」を参照)、サポートされている価格レベルを選択します。 [作成] を選択します。
- リソースのデプロイには数分かかります。完了したら、[リソースに移動] を選びます。左ペインの [リソース管理] で、[サブスクリプションキーとエンドポイント] を選びます。エンドポイントといずれかのキーが、API の呼び出しに使われます。
また画像をアップロードしたい場合は、BLOB ストレージコンテナーを作成します。あるいは、画像を Base64 文字列としてエンコードし、それを API 呼び出し内で直接使用することもできます。
次のいずれかがインストールされていること。
- REST API 呼び出し用の cURL。
- Python 3.x がインストールされていること

テキストカスタムカテゴリ (急速) API をテストする

このセクションのサンプルコードを使用して、テキストインシデントの作成、インシデントへのサンプルの追加、インシデントのデプロイ、テキストインシデントの検出を行います。

次のコマンドでは、<your_api_key>、<your_endpoint>、およびその他の必要なパラメーターを独自の値に置き換えます。

次のコマンドを実行すると、名前と定義を使用してインシデントが作成されます。

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>\"}'

まず、必須の Python ライブラリをインストールする必要があります。

pip install requests

次に、独自の Azure リソースの詳細を使用して必要な変数を定義します。

import requests

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

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

次のコマンドを実行すると、名前と定義を使用してインシデントが作成されます。

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)

インシデントにサンプルを追加する

次のコマンドを使用して、インシデントにテキストの例を追加します。

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)

インシデントをデプロイする

次のコマンドを使用してインシデントをデプロイし、新しいコンテンツの分析に使用できるようにします。

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)

テキストインシデントを検出する

次のコマンドを実行して、デプロイしたばかりのインシデントのサンプルテキストコンテンツを分析します。

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)

画像のカスタムカテゴリ (急速) API をテストする

このセクションのサンプルコードを使用して、画像インシデントの作成、インシデントへのサンプルの追加、インシデントのデプロイ、画像インシデントの検出を行います。

インシデントを作成します

cURL
Python

次のコマンドでは、<your_api_key>、<your_endpoint>、およびその他の必要なパラメーターを独自の値に置き換えます。

次のコマンドを実行すると、画像インシデントが作成されます。

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>\"
}'

必須の Python ライブラリがインストールされていることを確認します。

pip install requests

独自の Azure リソースの詳細を使用して、必要な変数を定義します。

import requests

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

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

次のコマンドを実行すると、画像インシデントが作成されます。

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)

インシデントにサンプルを追加する

次のコマンドを使用して、インシデントに画像の例を追加します。画像サンプルは、Azure BLOB ストレージコンテナー内の画像を指す URL、または 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)

インシデントをデプロイする

次のコマンドを使用してインシデントをデプロイし、新しいコンテンツの分析に使用できるようにします。

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)

画像インシデントを検出する

次のコマンドを使用してサンプル画像をアップロードし、それを、デプロイしたインシデントと照らし合わせてテストします。 Azure BLOB ストレージコンテナー内の画像を指す URL を使用することも、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)

その他のインシデント操作

次の操作は、インシデントとインシデントサンプルの管理に役立ちます。

テキストインシデント API

すべてのインシデントを一覧表示する

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)

インシデントの詳細を取得する

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)

インシデントを削除する

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)

インシデントの下にあるすべてのサンプルを一覧表示する

このコマンドを実行すると、特定のインシデントオブジェクトに関連付けられたすべてのサンプルの一意の ID が取得されます。

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)

インシデントサンプルの詳細を取得する

インシデントサンプル ID を使用して、サンプルに関する詳細を検索します。

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)

インシデントサンプルを削除する

インシデントサンプル ID を使用して、そのサンプルを取得および削除します。

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)

画像インシデント API

インシデントの一覧を取得する

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)

インシデントの詳細を取得する

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)

インシデントを削除する

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)

インシデントの下にあるすべてのサンプルを一覧表示する

このコマンドを実行すると、特定のインシデントオブジェクトに関連付けられたすべてのサンプルの一意の ID が取得されます。

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)

インシデントサンプルの詳細を取得する

インシデントサンプル ID を使用して、サンプルに関する詳細を検索します。

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)

インシデントサンプルを削除する

インシデントサンプル ID を使用して、そのサンプルを取得および削除します。

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)

次の方法で共有

カスタムカテゴリ (急速) API を使用する

前提条件

テキストカスタムカテゴリ (急速) API をテストする

インシデントオブジェクトを作成する

インシデントにサンプルを追加する

インシデントをデプロイする

テキストインシデントを検出する

画像のカスタムカテゴリ (急速) API をテストする

インシデントを作成します

インシデントにサンプルを追加する

インシデントをデプロイする

画像インシデントを検出する

その他のインシデント操作

テキストインシデント API

すべてのインシデントを一覧表示する

インシデントの詳細を取得する

インシデントを削除する

インシデントの下にあるすべてのサンプルを一覧表示する

インシデントサンプルの詳細を取得する

インシデントサンプルを削除する

画像インシデント API

インシデントの一覧を取得する

インシデントの詳細を取得する

インシデントを削除する

インシデントの下にあるすべてのサンプルを一覧表示する

インシデントサンプルの詳細を取得する

インシデントサンプルを削除する

フィードバック

その他のリソース

次の方法で共有

カスタム カテゴリ (急速) API を使用する

前提条件

テキスト カスタム カテゴリ (急速) API をテストする

インシデント オブジェクトを作成する

インシデントにサンプルを追加する

インシデントをデプロイする

テキスト インシデントを検出する

画像のカスタム カテゴリ (急速) API をテストする

インシデントを作成します

インシデントにサンプルを追加する

インシデントをデプロイする

画像インシデントを検出する

その他のインシデント操作

テキスト インシデント API

すべてのインシデントを一覧表示する

インシデントの詳細を取得する

インシデントを削除する

インシデントの下にあるすべてのサンプルを一覧表示する

インシデント サンプルの詳細を取得する

インシデント サンプルを削除する

画像インシデント API

インシデントの一覧を取得する

インシデントの詳細を取得する

インシデントを削除する

インシデントの下にあるすべてのサンプルを一覧表示する

インシデント サンプルの詳細を取得する

インシデント サンプルを削除する

関連するコンテンツ

フィードバック

その他のリソース

カスタムカテゴリ (急速) API を使用する

テキストカスタムカテゴリ (急速) API をテストする

インシデントオブジェクトを作成する

テキストインシデントを検出する

画像のカスタムカテゴリ (急速) API をテストする

テキストインシデント API

インシデントサンプルの詳細を取得する

インシデントサンプルを削除する

インシデントサンプルの詳細を取得する

インシデントサンプルを削除する