Rai Policies - List

Service:

Azure AI Services

API-versie:

2024-10-01

Hiermee haalt u de inhoudsfilters op die zijn gekoppeld aan het Azure OpenAI-account.

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

URI-parameters

Name	In	Vereist	Type	Description
accountName	path	True	string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	De naam van het Cognitive Services-account.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string minLength: 1	De id van het doelabonnement.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	RaiPolicyListResult	Inhoudsfilters zijn opgehaald.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

ListRaiPolicies

Voorbeeldaanvraag

HTTP

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

Java

/**
 * Samples for RaiPolicies List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/
     * ListRaiPolicies.json
     */
    /**
     * Sample code: ListRaiPolicies.
     * 
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void listRaiPolicies(com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager manager) {
        manager.raiPolicies().list("resourceGroupName", "accountName", com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.cognitiveservices import CognitiveServicesManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cognitiveservices
# USAGE
    python list_rai_policies.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.list(
        resource_group_name="resourceGroupName",
        account_name="accountName",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListRaiPolicies.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

Go

package armcognitiveservices_test

import (
	"context"
	"log"

	"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/ListRaiPolicies.json
func ExampleRaiPoliciesClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewRaiPoliciesClient().NewListPager("resourceGroupName", "accountName", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.RaiPolicyListResult = armcognitiveservices.RaiPolicyListResult{
		// 	Value: []*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

JavaScript

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

/**
 * This sample demonstrates how to Gets the content filters associated with the Azure OpenAI account.
 *
 * @summary Gets the content filters associated with the Azure OpenAI account.
 * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListRaiPolicies.json
 */
async function listRaiPolicies() {
  const subscriptionId =
    process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["COGNITIVESERVICES_RESOURCE_GROUP"] || "resourceGroupName";
  const accountName = "accountName";
  const credential = new DefaultAzureCredential();
  const client = new CognitiveServicesManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.raiPolicies.list(resourceGroupName, accountName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

dotnet

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/ListRaiPolicies.json
// this example is just showing the usage of "RaiPolicies_List" 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 and iterate over the result
await foreach (RaiPolicyResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

Voorbeeldrespons

Statuscode:

200

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

Definities

Name	Description
ContentLevel	Niveau waarop inhoud wordt gefilterd.
createdByType	Het type identiteit waarmee de resource is gemaakt.
CustomBlocklistConfig	Hiermee haalt u de bron op waarop het filter van toepassing is of stelt u deze in.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
RaiPolicy	Cognitive Services RaiPolicy.
RaiPolicyContentFilter	Azure OpenAI-inhoudsfilter.
RaiPolicyContentSource	Inhoudsbron om de inhoudsfilters toe te passen.
RaiPolicyListResult	De lijst met cognitive services RaiPolicies.
RaiPolicyMode	Rai beleidsmodus. De enum-waardetoewijzing is zoals hieronder: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Gebruik 'Asynchronous_filter' na 2024-10-01. Het is hetzelfde als 'Deferred' in de vorige versie.
RaiPolicyProperties	Eigenschappen van Azure OpenAI-inhoudsfilters.
RaiPolicyType	Beleidstype Inhoudsfilters.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

ContentLevel

Inventarisatie

Niveau waarop inhoud wordt gefilterd.

Waarde	Description
High
Low
Medium

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
Application
Key
ManagedIdentity
User

CustomBlocklistConfig

Object

Hiermee haalt u de bron op waarop het filter van toepassing is of stelt u deze in.

Name	Type	Description
blocking	boolean	Als er blokkering zou optreden.
blocklistName	string	Naam van ContentFilter.
source	RaiPolicyContentSource	Inhoudsbron om de inhoudsfilters toe te passen.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

RaiPolicy

Object

Cognitive Services RaiPolicy.

Name	Type	Description
etag	string	Resource-Etag.
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties	RaiPolicyProperties	Eigenschappen van Cognitive Services RaiPolicy.
systemData	systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
tags	object	Resourcetags.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

RaiPolicyContentFilter

Object

Azure OpenAI-inhoudsfilter.

Name	Type	Description
blocking	boolean	Als er blokkering zou optreden.
enabled	boolean	Als het ContentFilter is ingeschakeld.
name	string	Naam van ContentFilter.
severityThreshold	ContentLevel	Niveau waarop inhoud wordt gefilterd.
source	RaiPolicyContentSource	Inhoudsbron om de inhoudsfilters toe te passen.

RaiPolicyContentSource

Inventarisatie

Inhoudsbron om de inhoudsfilters toe te passen.

Waarde	Description
Completion
Prompt

RaiPolicyListResult

Object

De lijst met cognitive services RaiPolicies.

Name	Type	Description
nextLink	string	De koppeling is gebruikt om de volgende pagina van RaiPolicy op te halen.
value	RaiPolicy[]	De lijst met RaiPolicy.

RaiPolicyMode

Inventarisatie

Rai beleidsmodus. De enum-waardetoewijzing is zoals hieronder: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Gebruik 'Asynchronous_filter' na 2024-10-01. Het is hetzelfde als 'Deferred' in de vorige versie.

Waarde	Description
Asynchronous_filter
Blocking
Default
Deferred

RaiPolicyProperties

Object

Eigenschappen van Azure OpenAI-inhoudsfilters.

Name	Type	Description
basePolicyName	string	Naam van Rai-beleid.
contentFilters	RaiPolicyContentFilter[]	De lijst met inhoudsfilters.
customBlocklists	CustomBlocklistConfig[]	De lijst met aangepaste blokkeringen.
mode	RaiPolicyMode	Rai beleidsmodus. De enum-waardetoewijzing is zoals hieronder: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Gebruik 'Asynchronous_filter' na 2024-10-01. Het is hetzelfde als 'Deferred' in de vorige versie.
type	RaiPolicyType	Beleidstype Inhoudsfilters.

RaiPolicyType

Inventarisatie

Beleidstype Inhoudsfilters.

Waarde	Description
SystemManaged
UserManaged

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.