在 API 控制台中使用自定义术语列表进行审查

项目
01/29/2024

Azure 内容审查器中的默认全局术语列表足以满足大多数内容审查需求。但是，可能需要屏蔽特定于组织的术语。例如，可能需要标记竞争对手的名称作进一步审查。

使用列表管理 API来创建要供文本审查 API 使用的自定义术语列表。 “文本 - 筛选”操作扫描文本中是否存在侮辱性内容，并将文本与自定义阻止列表和共享阻止列表进行对比。

注意

最多只能使用 5 个术语列表，每个列表中的术语数不得超过 10,000 个。

可使用列表管理 API 执行以下任务：

创建列表。
向列表添加术语。
针对列表中的术语屏蔽术语。
从列表中删除术语。
删除列表。
编辑列表信息。
筛选索引，使新的扫描中包含列表更改项。

使用 API 控制台

必须有订阅密钥，才能在联机控制台中试用 API。此密钥位于“设置”选项卡的“Ocp-Apim-Subscription-Key”框中。有关详细信息，请参阅概述。

刷新搜索索引

更改术语列表后，必须筛选其索引，这样后续扫描才包含所作更改。此步骤类似于桌面上的搜索引擎（如果启用）或 Web 搜索引擎的操作，即不断刷新其索引以包含新文件或页面。

在术语列表管理 API 参考的左侧菜单中，选择“术语列表”，然后选择“刷新搜索索引”。

“术语列表 - 刷新搜索索引”页随即打开。
对于“开放 API 测试控制台” ，选择与所在位置最相关的区域。

“术语列表 - 刷新搜索索引”API 控制台随即打开。
在 listId 框中，输入列表 ID。输入订阅密钥，再选择“发送”。

创建术语列表

转到术语列表管理 API 参考。

“术语列表 - 创建”页随即打开。
对于“开放 API 测试控制台” ，选择与所在位置最相关的区域。

“术语列表 - 创建”API 控制台随即打开。
在“Ocp-Apim-Subscription-Key”框中，输入订阅密钥。
在“请求正文”框中，在“名称”中输入值（例如 MyList），在“说明”中输入相关说明。

使用键值对占位符向列表分配更具描述性的元数据。

{
    "Name": "MyExclusionList",
    "Description": "MyListDescription",
    "Metadata": 
    {
        "Category": "Competitors",
        "Type": "Exclude"
    }
}

添加列表元数据作为键/值对，而不是添加实际术语。

选择Send。列表已创建。请注意，ID 值与新的列表相关联。需在其他术语列表管理功能中使用此 ID。
向 MyList 添加术语。在左侧菜单的“术语”下，选择“添加术语”。

“术语 - 添加术语”页面随即打开。
对于“开放 API 测试控制台” ，选择与所在位置最相关的区域。

“术语 - 添加术语”API 控制台随即打开。
在 listId 框中，输入所生成的列表 ID，再选择语言的值。输入订阅密钥，再选择“发送”。
要验证确保已向列表添加术语，请在左侧菜单中选择“术语”，然后选择“获取所有术语”。

“术语 - 获取所有术语”API 控制台随即打开。
在 listId 框中，输入列表 ID，然后输入订阅密钥。选择Send。
在“响应内容”框中，验证所输入的术语。
再添加几条术语。现在，你已创建了自定义术语列表，接着请尝试使用自定义术语列表扫描一些文本。

删除术语和列表

删除术语或列表非常简单。使用 API 执行以下任务：

删除术语。（术语 - 删除）
删除列表中的所有术语而不删除列表。（术语 - 删除所有术语）
删除列表及其所有内容。（术语列表 - 删除）

下例删除一个术语。

在术语列表管理 API 参考的左侧菜单中，选择“术语”，然后选择“删除”。

“术语 - 删除”随即打开。
对于“开放 API 测试控制台” ，选择与所在位置最相关的区域。

“术语 - 删除”API 控制台随即打开。
在 listId 框中，输入要从中删除术语的列表的 ID。此 ID 是一个数字（本例中为 122），它是“术语列表 - 获取详细信息”控制台中针对 MyList 返回的内容。输入术语，再选择一种语言。
输入订阅密钥，再选择“发送”。
要验证术语是否已删除，请使用“术语列表 - 获取所有术语”控制台。

更改列表信息

可编辑列表的名称和说明，还可添加元数据项。

在术语列表管理 API 参考的左侧菜单中，选择“术语列表”，然后选择“更新详细信息”。

“术语列表 - 更新详细信息”页随即打开。
对于“开放 API 测试控制台” ，选择与所在位置最相关的区域。

“术语列表 - 更新详细信息”API 控制台随即打开。
在 listId 框中，输入列表 ID，然后输入订阅密钥。
在“请求正文”框中进行编辑，然后选择“发送”。

后续步骤

要与应用程序集成，请在代码中使用 REST API，或通过术语列表 .NET 快速入门开始。