Rai Policies - Create Or Update

Servicio:: Azure AI Services

Versión de la API:: 2024-10-01

Actualice el estado de los filtros de contenido especificados asociados a la cuenta de Azure OpenAI.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
accountName	path	True	string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	Nombre de la cuenta de Cognitive Services.
raiPolicyName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	Nombre de RaiPolicy asociado a la cuenta de Cognitive Services
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties	RaiPolicyProperties	Propiedades de Cognitive Services RaiPolicy.
tags	object	Etiquetas de recursos.

Respuestas

Nombre	Tipo	Description
200 OK	RaiPolicy	Cree o actualice correctamente los filtros de contenido.
201 Created	RaiPolicy	Cree correctamente los filtros de contenido.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Ejemplos

PutRaiPolicy

Solicitud de ejemplo

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
      }
    ]
  }
}


import com.azure.resourcemanager.cognitiveservices.models.ContentLevel;
import com.azure.resourcemanager.cognitiveservices.models.RaiPolicyContentFilter;
import com.azure.resourcemanager.cognitiveservices.models.RaiPolicyContentSource;
import com.azure.resourcemanager.cognitiveservices.models.RaiPolicyMode;
import com.azure.resourcemanager.cognitiveservices.models.RaiPolicyProperties;
import java.util.Arrays;

/**
 * Samples for RaiPolicies CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/
     * PutRaiPolicy.json
     */
    /**
     * Sample code: PutRaiPolicy.
     * 
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void putRaiPolicy(com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager manager) {
        manager.raiPolicies().define("raiPolicyName").withExistingAccount("resourceGroupName", "accountName")
            .withProperties(new RaiPolicyProperties().withMode(RaiPolicyMode.ASYNCHRONOUS_FILTER)
                .withBasePolicyName("Microsoft.Default")
                .withContentFilters(Arrays.asList(
                    new RaiPolicyContentFilter().withName("Hate").withEnabled(false)
                        .withSeverityThreshold(ContentLevel.HIGH).withBlocking(false)
                        .withSource(RaiPolicyContentSource.PROMPT),
                    new RaiPolicyContentFilter().withName("Hate").withEnabled(true)
                        .withSeverityThreshold(ContentLevel.MEDIUM).withBlocking(true)
                        .withSource(RaiPolicyContentSource.COMPLETION),
                    new RaiPolicyContentFilter().withName("Sexual").withEnabled(true)
                        .withSeverityThreshold(ContentLevel.HIGH).withBlocking(true)
                        .withSource(RaiPolicyContentSource.PROMPT),
                    new RaiPolicyContentFilter().withName("Sexual").withEnabled(true)
                        .withSeverityThreshold(ContentLevel.MEDIUM).withBlocking(true)
                        .withSource(RaiPolicyContentSource.COMPLETION),
                    new RaiPolicyContentFilter().withName("Selfharm").withEnabled(true)
                        .withSeverityThreshold(ContentLevel.HIGH).withBlocking(true)
                        .withSource(RaiPolicyContentSource.PROMPT),
                    new RaiPolicyContentFilter().withName("Selfharm").withEnabled(true)
                        .withSeverityThreshold(ContentLevel.MEDIUM).withBlocking(true)
                        .withSource(RaiPolicyContentSource.COMPLETION),
                    new RaiPolicyContentFilter().withName("Violence").withEnabled(true)
                        .withSeverityThreshold(ContentLevel.MEDIUM).withBlocking(true)
                        .withSource(RaiPolicyContentSource.PROMPT),
                    new RaiPolicyContentFilter().withName("Violence").withEnabled(true)
                        .withSeverityThreshold(ContentLevel.MEDIUM).withBlocking(true)
                        .withSource(RaiPolicyContentSource.COMPLETION),
                    new RaiPolicyContentFilter().withName("Jailbreak").withEnabled(true).withBlocking(true)
                        .withSource(RaiPolicyContentSource.PROMPT),
                    new RaiPolicyContentFilter().withName("Protected Material Text").withEnabled(true)
                        .withBlocking(true).withSource(RaiPolicyContentSource.COMPLETION),
                    new RaiPolicyContentFilter().withName("Protected Material Code").withEnabled(true)
                        .withBlocking(true).withSource(RaiPolicyContentSource.COMPLETION),
                    new RaiPolicyContentFilter().withName("Profanity").withEnabled(true).withBlocking(true)
                        .withSource(RaiPolicyContentSource.PROMPT))))
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.cognitiveservices import CognitiveServicesManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cognitiveservices
# USAGE
    python put_rai_policy.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CognitiveServicesManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.rai_policies.create_or_update(
        resource_group_name="resourceGroupName",
        account_name="accountName",
        rai_policy_name="raiPolicyName",
        rai_policy={
            "properties": {
                "basePolicyName": "Microsoft.Default",
                "contentFilters": [
                    {
                        "blocking": False,
                        "enabled": False,
                        "name": "Hate",
                        "severityThreshold": "High",
                        "source": "Prompt",
                    },
                    {
                        "blocking": True,
                        "enabled": True,
                        "name": "Hate",
                        "severityThreshold": "Medium",
                        "source": "Completion",
                    },
                    {
                        "blocking": True,
                        "enabled": True,
                        "name": "Sexual",
                        "severityThreshold": "High",
                        "source": "Prompt",
                    },
                    {
                        "blocking": True,
                        "enabled": True,
                        "name": "Sexual",
                        "severityThreshold": "Medium",
                        "source": "Completion",
                    },
                    {
                        "blocking": True,
                        "enabled": True,
                        "name": "Selfharm",
                        "severityThreshold": "High",
                        "source": "Prompt",
                    },
                    {
                        "blocking": True,
                        "enabled": True,
                        "name": "Selfharm",
                        "severityThreshold": "Medium",
                        "source": "Completion",
                    },
                    {
                        "blocking": True,
                        "enabled": True,
                        "name": "Violence",
                        "severityThreshold": "Medium",
                        "source": "Prompt",
                    },
                    {
                        "blocking": True,
                        "enabled": True,
                        "name": "Violence",
                        "severityThreshold": "Medium",
                        "source": "Completion",
                    },
                    {"blocking": True, "enabled": True, "name": "Jailbreak", "source": "Prompt"},
                    {"blocking": True, "enabled": True, "name": "Protected Material Text", "source": "Completion"},
                    {"blocking": True, "enabled": True, "name": "Protected Material Code", "source": "Completion"},
                    {"blocking": True, "enabled": True, "name": "Profanity", "source": "Prompt"},
                ],
                "mode": "Asynchronous_filter",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutRaiPolicy.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcognitiveservices_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cognitiveservices/armcognitiveservices"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutRaiPolicy.json
func ExampleRaiPoliciesClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcognitiveservices.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewRaiPoliciesClient().CreateOrUpdate(ctx, "resourceGroupName", "accountName", "raiPolicyName", armcognitiveservices.RaiPolicy{
		Properties: &armcognitiveservices.RaiPolicyProperties{
			BasePolicyName: to.Ptr("Microsoft.Default"),
			ContentFilters: []*armcognitiveservices.RaiPolicyContentFilter{
				{
					Name:              to.Ptr("Hate"),
					Blocking:          to.Ptr(false),
					Enabled:           to.Ptr(false),
					SeverityThreshold: to.Ptr(armcognitiveservices.ContentLevelHigh),
					Source:            to.Ptr(armcognitiveservices.RaiPolicyContentSourcePrompt),
				},
				{
					Name:              to.Ptr("Hate"),
					Blocking:          to.Ptr(true),
					Enabled:           to.Ptr(true),
					SeverityThreshold: to.Ptr(armcognitiveservices.ContentLevelMedium),
					Source:            to.Ptr(armcognitiveservices.RaiPolicyContentSourceCompletion),
				},
				{
					Name:              to.Ptr("Sexual"),
					Blocking:          to.Ptr(true),
					Enabled:           to.Ptr(true),
					SeverityThreshold: to.Ptr(armcognitiveservices.ContentLevelHigh),
					Source:            to.Ptr(armcognitiveservices.RaiPolicyContentSourcePrompt),
				},
				{
					Name:              to.Ptr("Sexual"),
					Blocking:          to.Ptr(true),
					Enabled:           to.Ptr(true),
					SeverityThreshold: to.Ptr(armcognitiveservices.ContentLevelMedium),
					Source:            to.Ptr(armcognitiveservices.RaiPolicyContentSourceCompletion),
				},
				{
					Name:              to.Ptr("Selfharm"),
					Blocking:          to.Ptr(true),
					Enabled:           to.Ptr(true),
					SeverityThreshold: to.Ptr(armcognitiveservices.ContentLevelHigh),
					Source:            to.Ptr(armcognitiveservices.RaiPolicyContentSourcePrompt),
				},
				{
					Name:              to.Ptr("Selfharm"),
					Blocking:          to.Ptr(true),
					Enabled:           to.Ptr(true),
					SeverityThreshold: to.Ptr(armcognitiveservices.ContentLevelMedium),
					Source:            to.Ptr(armcognitiveservices.RaiPolicyContentSourceCompletion),
				},
				{
					Name:              to.Ptr("Violence"),
					Blocking:          to.Ptr(true),
					Enabled:           to.Ptr(true),
					SeverityThreshold: to.Ptr(armcognitiveservices.ContentLevelMedium),
					Source:            to.Ptr(armcognitiveservices.RaiPolicyContentSourcePrompt),
				},
				{
					Name:              to.Ptr("Violence"),
					Blocking:          to.Ptr(true),
					Enabled:           to.Ptr(true),
					SeverityThreshold: to.Ptr(armcognitiveservices.ContentLevelMedium),
					Source:            to.Ptr(armcognitiveservices.RaiPolicyContentSourceCompletion),
				},
				{
					Name:     to.Ptr("Jailbreak"),
					Blocking: to.Ptr(true),
					Enabled:  to.Ptr(true),
					Source:   to.Ptr(armcognitiveservices.RaiPolicyContentSourcePrompt),
				},
				{
					Name:     to.Ptr("Protected Material Text"),
					Blocking: to.Ptr(true),
					Enabled:  to.Ptr(true),
					Source:   to.Ptr(armcognitiveservices.RaiPolicyContentSourceCompletion),
				},
				{
					Name:     to.Ptr("Protected Material Code"),
					Blocking: to.Ptr(true),
					Enabled:  to.Ptr(true),
					Source:   to.Ptr(armcognitiveservices.RaiPolicyContentSourceCompletion),
				},
				{
					Name:     to.Ptr("Profanity"),
					Blocking: to.Ptr(true),
					Enabled:  to.Ptr(true),
					Source:   to.Ptr(armcognitiveservices.RaiPolicyContentSourcePrompt),
				}},
			Mode: to.Ptr(armcognitiveservices.RaiPolicyModeAsynchronousFilter),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.RaiPolicy = armcognitiveservices.RaiPolicy{
	// 	Name: to.Ptr("raiPolicyName"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName"),
	// 	Properties: &armcognitiveservices.RaiPolicyProperties{
	// 		BasePolicyName: to.Ptr("Microsoft.Default"),
	// 		ContentFilters: []*armcognitiveservices.RaiPolicyContentFilter{
	// 			{
	// 				Name: to.Ptr("Hate"),
	// 				Blocking: to.Ptr(false),
	// 				Enabled: to.Ptr(false),
	// 				SeverityThreshold: to.Ptr(armcognitiveservices.ContentLevelHigh),
	// 				Source: to.Ptr(armcognitiveservices.RaiPolicyContentSourcePrompt),
	// 			},
	// 			{
	// 				Name: to.Ptr("Hate"),
	// 				Blocking: to.Ptr(true),
	// 				Enabled: to.Ptr(true),
	// 				SeverityThreshold: to.Ptr(armcognitiveservices.ContentLevelMedium),
	// 				Source: to.Ptr(armcognitiveservices.RaiPolicyContentSourceCompletion),
	// 			},
	// 			{
	// 				Name: to.Ptr("Sexual"),
	// 				Blocking: to.Ptr(true),
	// 				Enabled: to.Ptr(true),
	// 				SeverityThreshold: to.Ptr(armcognitiveservices.ContentLevelHigh),
	// 				Source: to.Ptr(armcognitiveservices.RaiPolicyContentSourcePrompt),
	// 			},
	// 			{
	// 				Name: to.Ptr("Sexual"),
	// 				Blocking: to.Ptr(true),
	// 				Enabled: to.Ptr(true),
	// 				SeverityThreshold: to.Ptr(armcognitiveservices.ContentLevelMedium),
	// 				Source: to.Ptr(armcognitiveservices.RaiPolicyContentSourceCompletion),
	// 			},
	// 			{
	// 				Name: to.Ptr("Selfharm"),
	// 				Blocking: to.Ptr(true),
	// 				Enabled: to.Ptr(true),
	// 				SeverityThreshold: to.Ptr(armcognitiveservices.ContentLevelHigh),
	// 				Source: to.Ptr(armcognitiveservices.RaiPolicyContentSourcePrompt),
	// 			},
	// 			{
	// 				Name: to.Ptr("Selfharm"),
	// 				Blocking: to.Ptr(true),
	// 				Enabled: to.Ptr(true),
	// 				SeverityThreshold: to.Ptr(armcognitiveservices.ContentLevelMedium),
	// 				Source: to.Ptr(armcognitiveservices.RaiPolicyContentSourceCompletion),
	// 			},
	// 			{
	// 				Name: to.Ptr("Violence"),
	// 				Blocking: to.Ptr(true),
	// 				Enabled: to.Ptr(true),
	// 				SeverityThreshold: to.Ptr(armcognitiveservices.ContentLevelMedium),
	// 				Source: to.Ptr(armcognitiveservices.RaiPolicyContentSourcePrompt),
	// 			},
	// 			{
	// 				Name: to.Ptr("Violence"),
	// 				Blocking: to.Ptr(true),
	// 				Enabled: to.Ptr(true),
	// 				SeverityThreshold: to.Ptr(armcognitiveservices.ContentLevelMedium),
	// 				Source: to.Ptr(armcognitiveservices.RaiPolicyContentSourceCompletion),
	// 			},
	// 			{
	// 				Name: to.Ptr("Jailbreak"),
	// 				Blocking: to.Ptr(true),
	// 				Enabled: to.Ptr(true),
	// 				Source: to.Ptr(armcognitiveservices.RaiPolicyContentSourcePrompt),
	// 			},
	// 			{
	// 				Name: to.Ptr("Protected Material Text"),
	// 				Blocking: to.Ptr(true),
	// 				Enabled: to.Ptr(true),
	// 				Source: to.Ptr(armcognitiveservices.RaiPolicyContentSourceCompletion),
	// 			},
	// 			{
	// 				Name: to.Ptr("Protected Material Code"),
	// 				Blocking: to.Ptr(true),
	// 				Enabled: to.Ptr(true),
	// 				Source: to.Ptr(armcognitiveservices.RaiPolicyContentSourceCompletion),
	// 			},
	// 			{
	// 				Name: to.Ptr("Profanity"),
	// 				Blocking: to.Ptr(true),
	// 				Enabled: to.Ptr(true),
	// 				Source: to.Ptr(armcognitiveservices.RaiPolicyContentSourcePrompt),
	// 		}},
	// 		Mode: to.Ptr(armcognitiveservices.RaiPolicyModeAsynchronousFilter),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { CognitiveServicesManagementClient } = require("@azure/arm-cognitiveservices");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Update the state of specified Content Filters associated with the Azure OpenAI account.
 *
 * @summary Update the state of specified Content Filters associated with the Azure OpenAI account.
 * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutRaiPolicy.json
 */
async function putRaiPolicy() {
  const subscriptionId =
    process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["COGNITIVESERVICES_RESOURCE_GROUP"] || "resourceGroupName";
  const accountName = "accountName";
  const raiPolicyName = "raiPolicyName";
  const raiPolicy = {
    properties: {
      basePolicyName: "Microsoft.Default",
      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, enabled: true, source: "Prompt" },
        {
          name: "Protected Material Text",
          blocking: true,
          enabled: true,
          source: "Completion",
        },
        {
          name: "Protected Material Code",
          blocking: true,
          enabled: true,
          source: "Completion",
        },
        { name: "Profanity", blocking: true, enabled: true, source: "Prompt" },
      ],
      mode: "Asynchronous_filter",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new CognitiveServicesManagementClient(credential, subscriptionId);
  const result = await client.raiPolicies.createOrUpdate(
    resourceGroupName,
    accountName,
    raiPolicyName,
    raiPolicy,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.CognitiveServices.Models;
using Azure.ResourceManager.CognitiveServices;

// Generated from example definition: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutRaiPolicy.json
// this example is just showing the usage of "RaiPolicies_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this CognitiveServicesAccountResource created on azure
// for more information of creating CognitiveServicesAccountResource, please refer to the document of CognitiveServicesAccountResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "resourceGroupName";
string accountName = "accountName";
ResourceIdentifier cognitiveServicesAccountResourceId = CognitiveServicesAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
CognitiveServicesAccountResource cognitiveServicesAccount = client.GetCognitiveServicesAccountResource(cognitiveServicesAccountResourceId);

// get the collection of this RaiPolicyResource
RaiPolicyCollection collection = cognitiveServicesAccount.GetRaiPolicies();

// invoke the operation
string raiPolicyName = "raiPolicyName";
RaiPolicyData data = new RaiPolicyData()
{
    Properties = new RaiPolicyProperties()
    {
        Mode = RaiPolicyMode.AsynchronousFilter,
        BasePolicyName = "Microsoft.Default",
        ContentFilters =
        {
        new RaiPolicyContentFilter()
        {
        Name = "hate",
        Enabled = false,
        SeverityThreshold = RaiPolicyContentLevel.High,
        Blocking = false,
        Source = RaiPolicyContentSource.Prompt,
        },new RaiPolicyContentFilter()
        {
        Name = "hate",
        Enabled = true,
        SeverityThreshold = RaiPolicyContentLevel.Medium,
        Blocking = true,
        Source = RaiPolicyContentSource.Completion,
        },new RaiPolicyContentFilter()
        {
        Name = "sexual",
        Enabled = true,
        SeverityThreshold = RaiPolicyContentLevel.High,
        Blocking = true,
        Source = RaiPolicyContentSource.Prompt,
        },new RaiPolicyContentFilter()
        {
        Name = "sexual",
        Enabled = true,
        SeverityThreshold = RaiPolicyContentLevel.Medium,
        Blocking = true,
        Source = RaiPolicyContentSource.Completion,
        },new RaiPolicyContentFilter()
        {
        Name = "selfharm",
        Enabled = true,
        SeverityThreshold = RaiPolicyContentLevel.High,
        Blocking = true,
        Source = RaiPolicyContentSource.Prompt,
        },new RaiPolicyContentFilter()
        {
        Name = "selfharm",
        Enabled = true,
        SeverityThreshold = RaiPolicyContentLevel.Medium,
        Blocking = true,
        Source = RaiPolicyContentSource.Completion,
        },new RaiPolicyContentFilter()
        {
        Name = "violence",
        Enabled = true,
        SeverityThreshold = RaiPolicyContentLevel.Medium,
        Blocking = true,
        Source = RaiPolicyContentSource.Prompt,
        },new RaiPolicyContentFilter()
        {
        Name = "violence",
        Enabled = true,
        SeverityThreshold = RaiPolicyContentLevel.Medium,
        Blocking = true,
        Source = RaiPolicyContentSource.Completion,
        },new RaiPolicyContentFilter()
        {
        Name = "jailbreak",
        Enabled = true,
        Blocking = true,
        Source = RaiPolicyContentSource.Prompt,
        },new RaiPolicyContentFilter()
        {
        Name = "protected_material_text",
        Enabled = true,
        Blocking = true,
        Source = RaiPolicyContentSource.Completion,
        },new RaiPolicyContentFilter()
        {
        Name = "protected_material_code",
        Enabled = true,
        Blocking = true,
        Source = RaiPolicyContentSource.Completion,
        },new RaiPolicyContentFilter()
        {
        Name = "profanity",
        Enabled = true,
        Blocking = true,
        Source = RaiPolicyContentSource.Prompt,
        }
        },
    },
};
ArmOperation<RaiPolicyResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, raiPolicyName, data);
RaiPolicyResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
RaiPolicyData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:: 200

{
  "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
      }
    ]
  }
}

status code:: 201

{
  "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
      }
    ]
  }
}

Definiciones

Nombre	Description
ContentLevel	Nivel en el que se filtra el contenido.
createdByType	Tipo de identidad que creó el recurso.
CustomBlocklistConfig	Obtiene o establece el origen al que se aplica el filtro.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
RaiPolicy	RaiPolicy de Cognitive Services.
RaiPolicyContentFilter	Filtro de contenido de Azure OpenAI.
RaiPolicyContentSource	Origen de contenido para aplicar los filtros de contenido.
RaiPolicyMode	Modo de directiva Rai. La asignación de valores de enumeración es la siguiente: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Use "Asynchronous_filter" después del 2024-10-01. Es igual que "Diferido" en la versión anterior.
RaiPolicyProperties	Propiedades de filtros de contenido de Azure OpenAI.
RaiPolicyType	Tipo de directiva Filtros de contenido.
systemData	Metadatos relativos a la creación y última modificación del recurso.

ContentLevel

Enumeración

Nivel en el que se filtra el contenido.

Valor	Description
Low
Medium
High

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

CustomBlocklistConfig

Objeto

Obtiene o establece el origen al que se aplica el filtro.

Nombre	Tipo	Description
blocking	boolean	Si se produce un bloqueo.
blocklistName	string	Nombre de ContentFilter.
source	RaiPolicyContentSource	Origen de contenido para aplicar los filtros de contenido.

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

RaiPolicy

Objeto

RaiPolicy de Cognitive Services.

Nombre	Tipo	Description
etag	string	Etag de recursos.
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso
properties	RaiPolicyProperties	Propiedades de Cognitive Services RaiPolicy.
systemData	systemData	Metadatos relativos a la creación y última modificación del recurso.
tags	object	Etiquetas de recursos.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

RaiPolicyContentFilter

Objeto

Filtro de contenido de Azure OpenAI.

Nombre	Tipo	Description
blocking	boolean	Si se produce un bloqueo.
enabled	boolean	Si contentFilter está habilitado.
name	string	Nombre de ContentFilter.
severityThreshold	ContentLevel	Nivel en el que se filtra el contenido.
source	RaiPolicyContentSource	Origen de contenido para aplicar los filtros de contenido.

RaiPolicyContentSource

Enumeración

Origen de contenido para aplicar los filtros de contenido.

Valor	Description
Prompt
Completion

RaiPolicyMode

Enumeración

Modo de directiva Rai. La asignación de valores de enumeración es la siguiente: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Use "Asynchronous_filter" después del 2024-10-01. Es igual que "Diferido" en la versión anterior.

Valor	Description
Default
Deferred
Blocking
Asynchronous_filter

RaiPolicyProperties

Objeto

Propiedades de filtros de contenido de Azure OpenAI.

Nombre	Tipo	Description
basePolicyName	string	Nombre de la directiva Rai.
contentFilters	RaiPolicyContentFilter[]	Lista de filtros de contenido.
customBlocklists	CustomBlocklistConfig[]	La lista de listas de bloqueados personalizadas.
mode	RaiPolicyMode	Modo de directiva Rai. La asignación de valores de enumeración es la siguiente: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Use "Asynchronous_filter" después del 2024-10-01. Es igual que "Diferido" en la versión anterior.
type	RaiPolicyType	Tipo de directiva Filtros de contenido.

RaiPolicyType

Enumeración

Tipo de directiva Filtros de contenido.

Valor	Description
UserManaged
SystemManaged

systemData

Objeto

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.