Rai Policies - Create Or Update
Update the state of specified Content Filters associated with the Azure OpenAI account.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiPolicies/{raiPolicyName}?api-version=2024-10-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
account
|
path | True |
string |
The name of Cognitive Services account. Regex pattern: |
rai
|
path | True |
string |
The name of the RaiPolicy associated with the Cognitive Services Account Regex pattern: |
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
subscription
|
path | True |
string |
The ID of the target subscription. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Request Body
Name | Type | Description |
---|---|---|
properties |
Properties of Cognitive Services RaiPolicy. |
|
tags |
object |
Resource tags. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Create/Update the Content Filters successfully. |
|
201 Created |
Create the Content Filters successfully. |
|
Other Status Codes |
Error response describing why the operation failed. |
Examples
PutRaiPolicy
Sample request
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
}
]
}
}
Sample response
{
"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
}
]
}
}
Definitions
Name | Description |
---|---|
Content |
Level at which content is filtered. |
created |
The type of identity that created the resource. |
Custom |
Gets or sets the source to which filter applies. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Rai |
Cognitive Services RaiPolicy. |
Rai |
Azure OpenAI Content Filter. |
Rai |
Content source to apply the Content Filters. |
Rai |
Rai policy mode. The enum value mapping is as below: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Please use 'Asynchronous_filter' after 2024-10-01. It is the same as 'Deferred' in previous version. |
Rai |
Azure OpenAI Content Filters properties. |
Rai |
Content Filters policy type. |
system |
Metadata pertaining to creation and last modification of the resource. |
ContentLevel
Level at which content is filtered.
Value | Description |
---|---|
High | |
Low | |
Medium |
createdByType
The type of identity that created the resource.
Value | Description |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
CustomBlocklistConfig
Gets or sets the source to which filter applies.
Name | Type | Description |
---|---|---|
blocking |
boolean |
If blocking would occur. |
blocklistName |
string |
Name of ContentFilter. |
source |
Content source to apply the Content Filters. |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
RaiPolicy
Cognitive Services RaiPolicy.
Name | Type | Description |
---|---|---|
etag |
string |
Resource Etag. |
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
The name of the resource |
properties |
Properties of Cognitive Services RaiPolicy. |
|
systemData |
Metadata pertaining to creation and last modification of the resource. |
|
tags |
object |
Resource tags. |
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
RaiPolicyContentFilter
Azure OpenAI Content Filter.
Name | Type | Description |
---|---|---|
blocking |
boolean |
If blocking would occur. |
enabled |
boolean |
If the ContentFilter is enabled. |
name |
string |
Name of ContentFilter. |
severityThreshold |
Level at which content is filtered. |
|
source |
Content source to apply the Content Filters. |
RaiPolicyContentSource
Content source to apply the Content Filters.
Value | Description |
---|---|
Completion | |
Prompt |
RaiPolicyMode
Rai policy mode. The enum value mapping is as below: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Please use 'Asynchronous_filter' after 2024-10-01. It is the same as 'Deferred' in previous version.
Value | Description |
---|---|
Asynchronous_filter | |
Blocking | |
Default | |
Deferred |
RaiPolicyProperties
Azure OpenAI Content Filters properties.
Name | Type | Description |
---|---|---|
basePolicyName |
string |
Name of Rai policy. |
contentFilters |
The list of Content Filters. |
|
customBlocklists |
The list of custom Blocklist. |
|
mode |
Rai policy mode. The enum value mapping is as below: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Please use 'Asynchronous_filter' after 2024-10-01. It is the same as 'Deferred' in previous version. |
|
type |
Content Filters policy type. |
RaiPolicyType
Content Filters policy type.
Value | Description |
---|---|
SystemManaged | |
UserManaged |
systemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The timestamp of resource last modification (UTC) |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |