Subscription Rai Policy - Get

Serviço:: AI Foundry

Versão da API:: 2025-10-01-preview

Recebe os Filtros de Conteúdo especificados associados à Assinatura.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/raiPolicy/{raiPolicyName}?api-version=2025-10-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
raiPolicyName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	O nome da RaiPolicy associada à Conta de Serviços Cognitivos
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	RaiPolicy	Operação do Azure concluída com sucesso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

GetRaiPolicy

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/raiPolicy/raiPolicyName?api-version=2025-10-01-preview

Resposta de exemplo

Código de status:: 200

{
  "name": "raiPolicyName",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName",
  "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"
  }
}

Definições

Nome	Description
ContentLevel	Nível no qual o conteúdo é filtrado.
createdByType	O tipo de identidade que criou o recurso.
CustomBlocklistConfig	Obtém ou define a origem à qual o filtro se aplica.
CustomTopicConfig	Obtém ou define a origem à qual o filtro se aplica.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
RaiActionType	Os tipos de ação a serem aplicados aos filtros de conteúdo
RaiPolicy	Serviços Cognitivos RaiPolicy.
RaiPolicyContentFilter	Filtro de Conteúdo do Azure OpenAI.
RaiPolicyContentSource	Fonte de conteúdo para aplicar os Filtros de Conteúdo.
RaiPolicyMode	Modo de política rai. O mapeamento de valor de enumeração é como abaixo: Padrão = 0, Adiado=1, Bloqueio=2, Asynchronous_filter =3. Por favor, use 'Asynchronous_filter' após 2025-06-01. É o mesmo que "Adiado" na versão anterior.
RaiPolicyProperties	Propriedades dos Filtros de Conteúdo do Azure OpenAI.
RaiPolicyType	Tipo de política filtros de conteúdo.
SafetyProviderConfig	Obtém ou definem a fonte à qual os provedores de segurança se aplicam.
systemData	Metadados relativos à criação e última modificação do recurso.

ContentLevel

Enumeração

Nível no qual o conteúdo é filtrado.

Valor	Description
Low
Medium
High

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

CustomBlocklistConfig

Objeto

Obtém ou define a origem à qual o filtro se aplica.

Nome	Tipo	Description
blocking	boolean	Se o bloqueio ocorrer.
blocklistName	string	Nome do ContentFilter.
source	RaiPolicyContentSource	Fonte de conteúdo para aplicar os Filtros de Conteúdo.

CustomTopicConfig

Objeto

Obtém ou define a origem à qual o filtro se aplica.

Nome	Tipo	Description
blocking	boolean	Se o bloqueio ocorrer.
source	RaiPolicyContentSource	Fonte de conteúdo para aplicar os Filtros de Conteúdo.
topicName	string	Nome do tópico RAI.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

RaiActionType

Enumeração

Os tipos de ação a serem aplicados aos filtros de conteúdo

Valor	Description
None
BLOCKING
ANNOTATING
HITL
RETRY

RaiPolicy

Objeto

Serviços Cognitivos RaiPolicy.

Nome	Tipo	Description
etag	string	Etag de recurso.
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties	RaiPolicyProperties	Propriedades dos Serviços Cognitivos RaiPolicy.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

RaiPolicyContentFilter

Objeto

Filtro de Conteúdo do Azure OpenAI.

Nome	Tipo	Description
action	RaiActionType	Os tipos de ação a serem aplicados aos filtros de conteúdo
blocking	boolean	Se o bloqueio ocorrer.
enabled	boolean	Se o ContentFilter estiver habilitado.
name	string	Nome do ContentFilter.
severityThreshold	ContentLevel	Nível no qual o conteúdo é filtrado.
source	RaiPolicyContentSource	Fonte de conteúdo para aplicar os Filtros de Conteúdo.

RaiPolicyContentSource

Enumeração

Fonte de conteúdo para aplicar os Filtros de Conteúdo.

Valor	Description
Prompt
Completion
PreToolCall
PostToolCall
PreRun
PostRun

RaiPolicyMode

Enumeração

Modo de política rai. O mapeamento de valor de enumeração é como abaixo: Padrão = 0, Adiado=1, Bloqueio=2, Asynchronous_filter =3. Por favor, use 'Asynchronous_filter' após 2025-06-01. É o mesmo que "Adiado" na versão anterior.

Valor	Description
Default
Deferred
Blocking
Asynchronous_filter

RaiPolicyProperties

Objeto

Propriedades dos Filtros de Conteúdo do Azure OpenAI.

Nome	Tipo	Description
basePolicyName	string	Nome da política Rai.
contentFilters	RaiPolicyContentFilter[]	A lista de Filtros de Conteúdo.
customBlocklists	CustomBlocklistConfig[]	A lista de blocklist personalizados.
customTopics	CustomTopicConfig[]	A lista de tópicos rai personalizados.
mode	RaiPolicyMode	Modo de política rai. O mapeamento de valor de enumeração é como abaixo: Padrão = 0, Adiado=1, Bloqueio=2, Asynchronous_filter =3. Por favor, use 'Asynchronous_filter' após 2025-06-01. É o mesmo que "Adiado" na versão anterior.
safetyProviders	SafetyProviderConfig[]	A lista de provedores de segurança.
type	RaiPolicyType	Tipo de política filtros de conteúdo.

RaiPolicyType

Enumeração

Tipo de política filtros de conteúdo.

Valor	Description
UserManaged
SystemManaged

SafetyProviderConfig

Objeto

Obtém ou definem a fonte à qual os provedores de segurança se aplicam.

Nome	Tipo	Description
blocking	boolean	Se o bloqueio ocorrer.
safetyProviderName	string	Nome do Provedor de Segurança RAI.
source	RaiPolicyContentSource	Fonte de conteúdo para aplicar os Filtros de Conteúdo.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Compartilhar via

Subscription Rai Policy - Get

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

GetRaiPolicy

Solicitação de exemplo

Resposta de exemplo

Definições

ContentLevel

createdByType

CustomBlocklistConfig

CustomTopicConfig

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

RaiActionType

RaiPolicy

RaiPolicyContentFilter

RaiPolicyContentSource

RaiPolicyMode

RaiPolicyProperties

RaiPolicyType

SafetyProviderConfig

systemData