Subscription Rai Policy - Get

Servicio:: AI Foundry

Versión de la API:: 2025-10-01-preview

Obtiene los filtros de contenido especificados asociados a la suscripción.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
raiPolicyName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	El nombre de RaiPolicy asociado a la cuenta de Cognitive Services
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	string minLength: 1	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	RaiPolicy	Operación de Azure completada con éxito.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

GetRaiPolicy

Solicitud de ejemplo

HTTP

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

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",
    "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"
  }
}

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.
CustomTopicConfig	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
RaiActionType	Los tipos de acción que se van a aplicar a los filtros de contenido
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. Por favor, utilice 'Asynchronous_filter' después de 2025-06-01. Es igual que "Diferido" en la versión anterior.
RaiPolicyProperties	Azure OpenAI Filtra contenido, propiedades.
RaiPolicyType	Tipo de directiva Filtros de contenido.
SafetyProviderConfig	Obtiene o establece la fuente a la que aplican los proveedores de seguridad.
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.

CustomTopicConfig

Objeto

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

Nombre	Tipo	Description
blocking	boolean	Si se produce un bloqueo.
source	RaiPolicyContentSource	Origen de contenido para aplicar los filtros de contenido.
topicName	string	Nombre del tema de RAI.

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	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

RaiActionType

Enumeración

Los tipos de acción que se van a aplicar a los filtros de contenido

Valor	Description
None
BLOCKING
ANNOTATING
HITL
RETRY

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	Azure Resource Manager metadatos que contienen información createdBy y modifiedBy.
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

RaiPolicyContentFilter

Objeto

Filtro de contenido de Azure OpenAI.

Nombre	Tipo	Description
action	RaiActionType	Los tipos de acción que se van a aplicar a los filtros de contenido
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
PreToolCall
PostToolCall
PreRun
PostRun

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. Por favor, utilice 'Asynchronous_filter' después de 2025-06-01. Es igual que "Diferido" en la versión anterior.

Valor	Description
Default
Deferred
Blocking
Asynchronous_filter

RaiPolicyProperties

Objeto

Azure OpenAI Filtra contenido, propiedades.

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.
customTopics	CustomTopicConfig[]	La lista de temas de rai personalizados.
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. Por favor, utilice 'Asynchronous_filter' después de 2025-06-01. Es igual que "Diferido" en la versión anterior.
safetyProviders	SafetyProviderConfig[]	La lista de proveedores de seguridad.
type	RaiPolicyType	Tipo de directiva Filtros de contenido.

RaiPolicyType

Enumeración

Tipo de directiva Filtros de contenido.

Valor	Description
UserManaged
SystemManaged

SafetyProviderConfig

Objeto

Obtiene o establece la fuente a la que aplican los proveedores de seguridad.

Nombre	Tipo	Description
blocking	boolean	Si se produce un bloqueo.
safetyProviderName	string	Nombre del proveedor de seguridad RAI.
source	RaiPolicyContentSource	Origen de contenido para aplicar los filtros de contenido.

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.

Compartir a través de

Subscription Rai Policy - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

GetRaiPolicy

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ContentLevel

createdByType

CustomBlocklistConfig

CustomTopicConfig

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

RaiActionType

RaiPolicy

RaiPolicyContentFilter

RaiPolicyContentSource

RaiPolicyMode

RaiPolicyProperties

RaiPolicyType

SafetyProviderConfig

systemData