Rai Content Filters - List

Service:: Azure AI Services

API Version:: 2024-10-01

List Content Filters types.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/raiContentFilters?api-version=2024-10-01

URI Parameters

Name	In	Required	Type	Description
location	path	True	string	Resource location.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	RaiContentFilterListResult	OK.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Examples

ListRaiContentFilters

Sample request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters?api-version=2024-10-01


/**
 * Samples for RaiContentFilters List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/
     * ListRaiContentFilters.json
     */
    /**
     * Sample code: ListRaiContentFilters.
     * 
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void
        listRaiContentFilters(com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager manager) {
        manager.raiContentFilters().list("WestUS", 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

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_content_filters.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_content_filters.list(
        location="WestUS",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListRaiContentFilters.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/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/ListRaiContentFilters.json
func ExampleRaiContentFiltersClient_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.NewRaiContentFiltersClient().NewListPager("WestUS", 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.RaiContentFilterListResult = armcognitiveservices.RaiContentFilterListResult{
		// 	Value: []*armcognitiveservices.RaiContentFilter{
		// 		{
		// 			Name: to.Ptr("Hate"),
		// 			Type: to.Ptr("Microsoft.CognitiveServices/locations/raiContentFilters"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Hate"),
		// 			Properties: &armcognitiveservices.RaiContentFilterProperties{
		// 				Name: to.Ptr("Hate"),
		// 				IsMultiLevelFilter: to.Ptr(true),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Sexual"),
		// 			Type: to.Ptr("Microsoft.CognitiveServices/locations/raiContentFilters"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Sexual"),
		// 			Properties: &armcognitiveservices.RaiContentFilterProperties{
		// 				Name: to.Ptr("Sexual"),
		// 				IsMultiLevelFilter: to.Ptr(true),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Violence"),
		// 			Type: to.Ptr("Microsoft.CognitiveServices/locations/raiContentFilters"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Violence"),
		// 			Properties: &armcognitiveservices.RaiContentFilterProperties{
		// 				Name: to.Ptr("Violence"),
		// 				IsMultiLevelFilter: to.Ptr(true),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Selfharm"),
		// 			Type: to.Ptr("Microsoft.CognitiveServices/locations/raiContentFilters"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Selfharm"),
		// 			Properties: &armcognitiveservices.RaiContentFilterProperties{
		// 				Name: to.Ptr("Selfharm"),
		// 				IsMultiLevelFilter: to.Ptr(true),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Jailbreak"),
		// 			Type: to.Ptr("Microsoft.CognitiveServices/locations/raiContentFilters"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Jailbreak"),
		// 			Properties: &armcognitiveservices.RaiContentFilterProperties{
		// 				Name: to.Ptr("Jailbreak"),
		// 				IsMultiLevelFilter: to.Ptr(false),
		// 				Source: to.Ptr(armcognitiveservices.RaiPolicyContentSourcePrompt),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("ProtectedMaterialText"),
		// 			Type: to.Ptr("Microsoft.CognitiveServices/locations/raiContentFilters"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/ProtectedMaterialText"),
		// 			Properties: &armcognitiveservices.RaiContentFilterProperties{
		// 				Name: to.Ptr("Protected Material Text"),
		// 				IsMultiLevelFilter: to.Ptr(false),
		// 				Source: to.Ptr(armcognitiveservices.RaiPolicyContentSourceCompletion),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("ProtectedMaterialCode"),
		// 			Type: to.Ptr("Microsoft.CognitiveServices/locations/raiContentFilters"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/ProtectedMaterialCode"),
		// 			Properties: &armcognitiveservices.RaiContentFilterProperties{
		// 				Name: to.Ptr("Protected Material Code"),
		// 				IsMultiLevelFilter: to.Ptr(false),
		// 				Source: to.Ptr(armcognitiveservices.RaiPolicyContentSourceCompletion),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Profanity"),
		// 			Type: to.Ptr("Microsoft.CognitiveServices/locations/raiContentFilters"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Profanity"),
		// 			Properties: &armcognitiveservices.RaiContentFilterProperties{
		// 				Name: to.Ptr("Profanity"),
		// 				IsMultiLevelFilter: to.Ptr(false),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("IndirectAttack"),
		// 			Type: to.Ptr("Microsoft.CognitiveServices/locations/raiContentFilters"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/IndirectAttack"),
		// 			Properties: &armcognitiveservices.RaiContentFilterProperties{
		// 				Name: to.Ptr("Indirect Attack"),
		// 				IsMultiLevelFilter: to.Ptr(false),
		// 				Source: to.Ptr(armcognitiveservices.RaiPolicyContentSourcePrompt),
		// 			},
		// 	}},
		// }
	}
}

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 List Content Filters types.
 *
 * @summary List Content Filters types.
 * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListRaiContentFilters.json
 */
async function listRaiContentFilters() {
  const subscriptionId =
    process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const location = "WestUS";
  const credential = new DefaultAzureCredential();
  const client = new CognitiveServicesManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.raiContentFilters.list(location)) {
    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

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

// Generated from example definition: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListRaiContentFilters.json
// this example is just showing the usage of "RaiContentFilters_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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// get the collection of this RaiContentFilterResource
AzureLocation location = new AzureLocation("WestUS");
RaiContentFilterCollection collection = subscriptionResource.GetRaiContentFilters(location);

// invoke the operation and iterate over the result
await foreach (RaiContentFilterResource 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
    RaiContentFilterData 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

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Hate",
      "type": "Microsoft.CognitiveServices/locations/raiContentFilters",
      "name": "Hate",
      "properties": {
        "name": "Hate",
        "isMultiLevelFilter": true
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Sexual",
      "type": "Microsoft.CognitiveServices/locations/raiContentFilters",
      "name": "Sexual",
      "properties": {
        "name": "Sexual",
        "isMultiLevelFilter": true
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Violence",
      "type": "Microsoft.CognitiveServices/locations/raiContentFilters",
      "name": "Violence",
      "properties": {
        "name": "Violence",
        "isMultiLevelFilter": true
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Selfharm",
      "type": "Microsoft.CognitiveServices/locations/raiContentFilters",
      "name": "Selfharm",
      "properties": {
        "name": "Selfharm",
        "isMultiLevelFilter": true
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Jailbreak",
      "type": "Microsoft.CognitiveServices/locations/raiContentFilters",
      "name": "Jailbreak",
      "properties": {
        "name": "Jailbreak",
        "isMultiLevelFilter": false,
        "source": "Prompt"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/ProtectedMaterialText",
      "type": "Microsoft.CognitiveServices/locations/raiContentFilters",
      "name": "ProtectedMaterialText",
      "properties": {
        "name": "Protected Material Text",
        "isMultiLevelFilter": false,
        "source": "Completion"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/ProtectedMaterialCode",
      "type": "Microsoft.CognitiveServices/locations/raiContentFilters",
      "name": "ProtectedMaterialCode",
      "properties": {
        "name": "Protected Material Code",
        "isMultiLevelFilter": false,
        "source": "Completion"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Profanity",
      "type": "Microsoft.CognitiveServices/locations/raiContentFilters",
      "name": "Profanity",
      "properties": {
        "name": "Profanity",
        "isMultiLevelFilter": false
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/IndirectAttack",
      "type": "Microsoft.CognitiveServices/locations/raiContentFilters",
      "name": "IndirectAttack",
      "properties": {
        "name": "Indirect Attack",
        "isMultiLevelFilter": false,
        "source": "Prompt"
      }
    }
  ]
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
Properties	Azure OpenAI Content Filter Properties.
RaiContentFilter	Azure OpenAI Content Filter.
RaiContentFilterListResult	The list of Content Filters.
RaiPolicyContentSource	Content source to apply the Content Filters.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

Properties

Object

Azure OpenAI Content Filter Properties.

Name	Type	Description
isMultiLevelFilter	boolean	If the Content Filter has multi severity levels(Low, Medium, or High).
name	string	Name of Content Filter.
source	RaiPolicyContentSource	Content source to apply the Content Filters.

RaiContentFilter

Object

Azure OpenAI Content Filter.

Name	Type	Description
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	Azure OpenAI Content Filter Properties.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

RaiContentFilterListResult

Object

The list of Content Filters.

Name	Type	Description
nextLink	string	The link used to get the next page of Content Filters.
value	RaiContentFilter[]	The list of RaiContentFilter.

RaiPolicyContentSource

Enumeration

Content source to apply the Content Filters.

Value	Description
Prompt
Completion