API コンソールでカスタム用語リストを使用してモデレートする

[アーティクル]
01/18/2024

Azure Content Moderator の既定のグローバルな用語リストは、ほとんどのコンテンツモデレーションのニーズに十分対応できます。しかし、組織に固有の用語のスクリーニングが必要になる場合があります。たとえば、さらに詳しくレビューするために、競合他社名にタグを付けたい場合などです。

Text Moderation API で使用するカスタム用語リストを作成するには、List Management API を使用します。 [Text - Screen](テキスト - スクリーニング) 操作では、不適切な表現がないかテキストをスキャンし、テキストをカスタムブロックリストと共有ブロックリストに対して比較します。

Note

上限は用語の一覧が 5 つで、各一覧では用語が 10,000 個を超えてはいけません。

List Management API を使用して、次のタスクを実行できます。

リストを作成します。
リストに用語を追加する。
用語をリスト内の用語に照らしてスクリーニングする。
リストから用語を削除する。
リストを削除する。
リストの情報を編集する。
リストに加えた変更が今後のスキャンに含まれるように、インデックスを最新の情報に更新する。

API コンソールを使用する

オンラインコンソールで API を試すには、サブスクリプションキーが必要です。このキーは、[設定] タブの [Ocp-Apim-Subscription-Key] ボックス内にあります。詳細については、概要に関するページを参照してください。

検索インデックスを最新の情報に更新する

用語リストに変更を加えた後は、変更が今後のスキャンに含まれるように、用語リストのインデックスを最新の情報に更新する必要があります。この手順は、デスクトップ上の検索エンジン (有効になっている場合) や Web 検索エンジンが、新しいファイルやページが含まれるように絶えずインデックスを最新の情報に更新する方法と似ています。

Term List Management API リファレンスの左側のメニューで、[Term Lists](用語リスト) を選択し、[Refresh Search Index](検索インデックスを最新の情報に更新) を選択します。

[Term Lists - Refresh Search Index](用語リスト - 検索インデックスを最新の情報に更新) ページが開きます。
API テストコンソールを開く場合、実際の場所を最もよく表しているリージョンを選択します。

[Term Lists - Refresh Search Index](用語リスト - 検索インデックスを最新の情報に更新) API コンソールが開きます。
[listId] ボックスに、リスト ID を入力します。サブスクリプションキーを入力して、[送信] を選択します。

用語リストを作成する

Term List Management API リファレンスに移動します。

[Term Lists - Create](用語リスト - 作成) ページが開きます。
API テストコンソールを開く場合、実際の場所を最もよく表しているリージョンを選択します。

[Term Lists - Create](用語リスト - 作成) API コンソールが開きます。
[Ocp-Apim-Subscription-Key] ボックスにサブスクリプションキーを入力します。
[要求本文] ボックスで、[名前] (たとえば「MyList」) と [説明] の値を入力します。
よりわかりやすいメタデータをリストに割り当てるには、キーと値のペアのプレースホルダーを使用します。
```
{
    "Name": "MyExclusionList",
    "Description": "MyListDescription",
    "Metadata": 
    {
        "Category": "Competitors",
        "Type": "Exclude"
    }
}
```
リストのメタデータは、実際の用語ではなく、キーと値のペアとして追加します。
[Send] を選択します。リストが作成されました。新しいリストに関連付けられている ID の値をメモします。この ID は、他の用語リスト管理機能で必要になります。
MyList に用語を追加します。左側のメニューの [用語] で、[Add Term](用語の追加) を選択します。

[Term - Add Term](用語 - 用語の追加) ページが開きます。
API テストコンソールを開く場合、実際の場所を最もよく表しているリージョンを選択します。

[Term - Add Term](用語 - 用語の追加) API コンソールが開きます。
[listId] ボックスに生成されたリスト ID を入力し、[言語] の値を選択します。サブスクリプションキーを入力して、[送信] を選択します。
用語がリストに追加されたことを確認するには、左側のメニューで [用語] を選択し、[Get All Terms](すべての用語を取得) を選択します。

[Term - Get All Terms](用語 - すべての用語を取得) API コンソールが開きます。
[listId] ボックスで、リスト ID を入力し、サブスクリプションキーを入力します。 [Send] を選択します。
[応答のコンテンツ] ボックスで、入力した用語を確認します。
さらにいくつかの用語を追加します。これでカスタム用語リストを作成できたので、カスタム用語リストを使用していくつかのテキストをスキャンしてみましょう。

用語とリストを削除する

用語やリストを削除するのは簡単です。 API を使用して、次のタスクを実行できます。

用語を削除する。 ([Term - Delete](用語 - 削除))
リストを削除せずに、リスト内のすべての用語を削除する。 ([Term - Delete All Terms](用語 - すべての用語を削除))
リストと、そのコンテンツをすべて削除する。 ( [Term Lists - Delete](用語リスト - 削除) )

この例では、1 つの用語だけを削除します。

Term List Management API リファレンスの左側のメニューで、[用語] を選択し、[削除] を選択します。

[Term - Delete](用語 - 削除) が開きます。
API テストコンソールを開く場合、実際の場所を最もよく表しているリージョンを選択します。

[Term - Delete](用語 - 削除) API コンソールが開きます。
[listId] ボックスに、削除したい用語が含まれるリストの ID を入力します。この ID は、MyList の [Term Lists - Get Details](用語リスト - 詳細の取得) コンソールで返される数値 (この例では 122) です。用語を入力し、言語を選択します。
サブスクリプションキーを入力して、[送信] を選択します。
用語が削除されたことを確認するには、[Term Lists - Get All](用語リスト - すべて取得) コンソールを使用します。

リストの情報を変更する

リストの名前と説明を編集し、メタデータ項目を追加することができます。

Term List Management API リファレンスの左側のメニューで、[Term Lists](用語リスト) を選択し、[Update Details](詳細の更新) を選択します。

[Term Lists - Update Details](用語リスト - 詳細の更新) ページが開きます。
API テストコンソールを開く場合、実際の場所を最もよく表しているリージョンを選択します。

[Term Lists - Update Details](用語リスト - 詳細の更新) API コンソールが開きます。
[listId] ボックスで、リスト ID を入力し、サブスクリプションキーを入力します。
[要求本文] ボックスで編集を行い、[送信] を選択します。

次のステップ

コード内で REST API を使用するか、用語リストに関する .NET のクイックスタートから開始して、アプリケーションと統合します。