Rai Content Filters - List

Service:

Azure AI Services

API Version:

2023-10-01-preview

List Content Filters types.

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

URI Parameters

Name	In	Required	Type	Description
location	path	True	string	Resource location.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	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

HTTP

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

Sample Response

Status code:

200

{
  "value": [
    {
      "policyName": "Hate",
      "description": "Multi-level filter for hate speech.",
      "filterType": "MultiLevel"
    },
    {
      "policyName": "Sexual",
      "description": "Multi-level filter for sexual content.",
      "filterType": "MultiLevel"
    },
    {
      "policyName": "HateSpeechPatterns",
      "description": "Global blocklist for hate speech.",
      "filterType": "Switch"
    }
  ]
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
RaiContentFilter	Azure OpenAI Content Filter.
RaiContentFilterListResult	The list of Content Filters.
RaiContentFilterType	Content Filter type.

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

Error response

Name	Type	Description
error	ErrorDetail	The error object.

RaiContentFilter

Azure OpenAI Content Filter.

Name	Type	Description
description	string	Description of Content Filter.
filterType	RaiContentFilterType	Content Filter type.
policyName	string	Name of Content Filter.

RaiContentFilterListResult

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.

RaiContentFilterType

Content Filter type.

Name	Type	Description
MultiLevel	string
Switch	string