你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Rai Policies - Create Or Update

更新与 Azure OpenAI 帐户关联的指定内容筛选器的状态。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiPolicies/{raiPolicyName}?api-version=2024-10-01

URI 参数

名称 必需 类型 说明
accountName
path True

string

minLength: 2
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$

认知服务帐户的名称。

raiPolicyName
path True

string

pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$

与认知服务帐户关联的 RaiPolicy 的名称

resourceGroupName
path True

string

minLength: 1
maxLength: 90

资源组的名称。 名称不区分大小写。

subscriptionId
path True

string

minLength: 1

目标订阅的 ID。

api-version
query True

string

minLength: 1

用于此作的 API 版本。

请求正文

名称 类型 说明
properties

RaiPolicyProperties

认知服务 RaiPolicy 的属性。

tags

object

资源标记。

响应

名称 类型 说明
200 OK

RaiPolicy

成功创建/更新内容筛选器。

201 Created

RaiPolicy

成功创建内容筛选器。

Other Status Codes

ErrorResponse

描述作失败的原因的错误响应。

示例

PutRaiPolicy

示例请求

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName?api-version=2024-10-01

{
  "properties": {
    "basePolicyName": "Microsoft.Default",
    "mode": "Asynchronous_filter",
    "contentFilters": [
      {
        "name": "Hate",
        "blocking": false,
        "enabled": false,
        "severityThreshold": "High",
        "source": "Prompt"
      },
      {
        "name": "Hate",
        "blocking": true,
        "enabled": true,
        "severityThreshold": "Medium",
        "source": "Completion"
      },
      {
        "name": "Sexual",
        "blocking": true,
        "enabled": true,
        "severityThreshold": "High",
        "source": "Prompt"
      },
      {
        "name": "Sexual",
        "blocking": true,
        "enabled": true,
        "severityThreshold": "Medium",
        "source": "Completion"
      },
      {
        "name": "Selfharm",
        "blocking": true,
        "enabled": true,
        "severityThreshold": "High",
        "source": "Prompt"
      },
      {
        "name": "Selfharm",
        "blocking": true,
        "enabled": true,
        "severityThreshold": "Medium",
        "source": "Completion"
      },
      {
        "name": "Violence",
        "blocking": true,
        "enabled": true,
        "severityThreshold": "Medium",
        "source": "Prompt"
      },
      {
        "name": "Violence",
        "blocking": true,
        "enabled": true,
        "severityThreshold": "Medium",
        "source": "Completion"
      },
      {
        "name": "Jailbreak",
        "blocking": true,
        "source": "Prompt",
        "enabled": true
      },
      {
        "name": "Protected Material Text",
        "blocking": true,
        "source": "Completion",
        "enabled": true
      },
      {
        "name": "Protected Material Code",
        "blocking": true,
        "source": "Completion",
        "enabled": true
      },
      {
        "name": "Profanity",
        "blocking": true,
        "source": "Prompt",
        "enabled": true
      }
    ]
  }
}

示例响应

{
  "name": "raiPolicyName",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName",
  "properties": {
    "basePolicyName": "Microsoft.Default",
    "mode": "Asynchronous_filter",
    "contentFilters": [
      {
        "name": "Hate",
        "blocking": false,
        "enabled": false,
        "severityThreshold": "High",
        "source": "Prompt"
      },
      {
        "name": "Hate",
        "blocking": true,
        "enabled": true,
        "severityThreshold": "Medium",
        "source": "Completion"
      },
      {
        "name": "Sexual",
        "blocking": true,
        "enabled": true,
        "severityThreshold": "High",
        "source": "Prompt"
      },
      {
        "name": "Sexual",
        "blocking": true,
        "enabled": true,
        "severityThreshold": "Medium",
        "source": "Completion"
      },
      {
        "name": "Selfharm",
        "blocking": true,
        "enabled": true,
        "severityThreshold": "High",
        "source": "Prompt"
      },
      {
        "name": "Selfharm",
        "blocking": true,
        "enabled": true,
        "severityThreshold": "Medium",
        "source": "Completion"
      },
      {
        "name": "Violence",
        "blocking": true,
        "enabled": true,
        "severityThreshold": "Medium",
        "source": "Prompt"
      },
      {
        "name": "Violence",
        "blocking": true,
        "enabled": true,
        "severityThreshold": "Medium",
        "source": "Completion"
      },
      {
        "name": "Jailbreak",
        "blocking": true,
        "source": "Prompt",
        "enabled": true
      },
      {
        "name": "Protected Material Text",
        "blocking": true,
        "source": "Completion",
        "enabled": true
      },
      {
        "name": "Protected Material Code",
        "blocking": true,
        "source": "Completion",
        "enabled": true
      },
      {
        "name": "Profanity",
        "blocking": true,
        "source": "Prompt",
        "enabled": true
      }
    ]
  }
}
{
  "name": "raiPolicyName",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName",
  "properties": {
    "basePolicyName": "Microsoft.Default",
    "mode": "Asynchronous_filter",
    "contentFilters": [
      {
        "name": "Hate",
        "blocking": false,
        "enabled": false,
        "severityThreshold": "High",
        "source": "Prompt"
      },
      {
        "name": "Hate",
        "blocking": true,
        "enabled": true,
        "severityThreshold": "Medium",
        "source": "Completion"
      },
      {
        "name": "Sexual",
        "blocking": true,
        "enabled": true,
        "severityThreshold": "High",
        "source": "Prompt"
      },
      {
        "name": "Sexual",
        "blocking": true,
        "enabled": true,
        "severityThreshold": "Medium",
        "source": "Completion"
      },
      {
        "name": "Selfharm",
        "blocking": true,
        "enabled": true,
        "severityThreshold": "High",
        "source": "Prompt"
      },
      {
        "name": "Selfharm",
        "blocking": true,
        "enabled": true,
        "severityThreshold": "Medium",
        "source": "Completion"
      },
      {
        "name": "Violence",
        "blocking": true,
        "enabled": true,
        "severityThreshold": "Medium",
        "source": "Prompt"
      },
      {
        "name": "Violence",
        "blocking": true,
        "enabled": true,
        "severityThreshold": "Medium",
        "source": "Completion"
      },
      {
        "name": "Jailbreak",
        "blocking": true,
        "source": "Prompt",
        "enabled": true
      },
      {
        "name": "Protected Material Text",
        "blocking": true,
        "source": "Completion",
        "enabled": true
      },
      {
        "name": "Protected Material Code",
        "blocking": true,
        "source": "Completion",
        "enabled": true
      },
      {
        "name": "Profanity",
        "blocking": true,
        "source": "Prompt",
        "enabled": true
      }
    ]
  }
}

定义

名称 说明
ContentLevel

筛选内容的级别。

createdByType

创建资源的标识的类型。

CustomBlocklistConfig

获取或设置应用筛选器的源。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

RaiPolicy

认知服务 RaiPolicy。

RaiPolicyContentFilter

Azure OpenAI 内容筛选器。

RaiPolicyContentSource

要应用内容筛选器的内容源。

RaiPolicyMode

Rai 策略模式。 枚举值映射如下所示:默认值 = 0,Deferred=1,Blocking=2,Asynchronous_filter =3。 请在 2024-10-01 之后使用“Asynchronous_filter”。 它与以前版本中的“延迟”相同。

RaiPolicyProperties

Azure OpenAI 内容筛选器属性。

RaiPolicyType

内容筛选器策略类型。

systemData

与创建和上次修改资源相关的元数据。

ContentLevel

筛选内容的级别。

说明
High
Low
Medium

createdByType

创建资源的标识的类型。

说明
Application
Key
ManagedIdentity
User

CustomBlocklistConfig

获取或设置应用筛选器的源。

名称 类型 说明
blocking

boolean

如果发生阻塞,

blocklistName

string

ContentFilter 的名称。

source

RaiPolicyContentSource

要应用内容筛选器的内容源。

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

RaiPolicy

认知服务 RaiPolicy。

名称 类型 说明
etag

string

资源 Etag。

id

string

资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

资源的名称

properties

RaiPolicyProperties

认知服务 RaiPolicy 的属性。

systemData

systemData

与创建和上次修改资源相关的元数据。

tags

object

资源标记。

type

string

资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

RaiPolicyContentFilter

Azure OpenAI 内容筛选器。

名称 类型 说明
blocking

boolean

如果发生阻塞,

enabled

boolean

如果已启用 ContentFilter。

name

string

ContentFilter 的名称。

severityThreshold

ContentLevel

筛选内容的级别。

source

RaiPolicyContentSource

要应用内容筛选器的内容源。

RaiPolicyContentSource

要应用内容筛选器的内容源。

说明
Completion
Prompt

RaiPolicyMode

Rai 策略模式。 枚举值映射如下所示:默认值 = 0,Deferred=1,Blocking=2,Asynchronous_filter =3。 请在 2024-10-01 之后使用“Asynchronous_filter”。 它与以前版本中的“延迟”相同。

说明
Asynchronous_filter
Blocking
Default
Deferred

RaiPolicyProperties

Azure OpenAI 内容筛选器属性。

名称 类型 说明
basePolicyName

string

Rai 策略的名称。

contentFilters

RaiPolicyContentFilter[]

内容筛选器的列表。

customBlocklists

CustomBlocklistConfig[]

自定义阻止列表的列表。

mode

RaiPolicyMode

Rai 策略模式。 枚举值映射如下所示:默认值 = 0,Deferred=1,Blocking=2,Asynchronous_filter =3。 请在 2024-10-01 之后使用“Asynchronous_filter”。 它与以前版本中的“延迟”相同。

type

RaiPolicyType

内容筛选器策略类型。

RaiPolicyType

内容筛选器策略类型。

说明
SystemManaged
UserManaged

systemData

与创建和上次修改资源相关的元数据。

名称 类型 说明
createdAt

string (date-time)

资源创建时间戳(UTC)。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识的类型。

lastModifiedAt

string (date-time)

上次修改的资源时间戳(UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识的类型。