你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
从 Azure AI 内容安全公共预览版迁移到 GA
本指南展示了如何将现有代码从 Azure AI 内容安全的公共预览版升级到 GA 版本。
REST API 调用
在所有 API 调用中,请务必在代码中更改api 版本参数:
old | new |
---|---|
api-version=2023-04-30-preview |
api-version=2023-10-01 (或更高版本) |
请注意预览版 API 中的以下 REST 终结点名称更改:
公共预览版术语 | GA 术语 |
---|---|
addBlockItems | addOrUpdateBlocklistItems |
blockItems | blocklistItems |
removeBlockItems | removeBlocklistItems |
JSON 字段
已重命名以下 JSON 字段。 在将数据发送到 REST 调用时,请务必更改它们:
公共预览版术语 | GA 术语 |
---|---|
blockItems |
blocklistItems |
BlockItemId |
blocklistItemId |
blockItemIds |
blocklistItemIds |
blocklistMatchResults |
blocklistsMatch |
breakByBlocklists |
haltOnBlocklistHit |
返回格式
一些 JSON 返回格式已更改。 请参阅以下更新的 JSON 返回示例。
具有类别分析的text:analyze API 调用:
{
"categoriesAnalysis": [
{
"category": "Hate",
"severity": 2
},
{
"category": "SelfHarm",
"severity": 0
},
{
"category": "Sexual",
"severity": 0
},
{
"category": "Violence",
"severity": 0
}
]
}
具有阻止列表的text:analyze API 调用:
{
"blocklistsMatch": [
{
"blocklistName": "string",
"blocklistItemId": "string",
"blocklistItemText": "bleed"
}
],
"categoriesAnalysis": [
{
"category": "Hate",
"severity": 0
}
]
}
addOrUpdateBlocklistItems API 调用:
{
"blocklistItems:"[
{
"blocklistItemId": "string",
"description": "string",
"text": "bleed"
}
]
}
blocklistItems API 调用(列出所有阻止列表项):
{
"values": [
{
"blocklistItemId": "string",
"description": "string",
"text": "bleed",
}
]
}
具有项 ID(检索单个项)的blocklistItems API 调用:
{
"blocklistItemId": "string",
"description": "string",
"text": "string"
}