Subscription Rai Policy - Get

Служба:: AI Foundry

Версия API:: 2025-10-01-preview

Получает указанные фильтры контента, связанные с подпиской.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
raiPolicyName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	Имя политики RaiPolicy, связанной с учетной записью Cognitive Services
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	RaiPolicy	Операция Azure успешно завершена.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

GetRaiPolicy

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 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"
  }
}

Определения

Имя	Описание
ContentLevel	Уровень фильтрации содержимого.
createdByType	Тип удостоверения, создавшего ресурс.
CustomBlocklistConfig	Возвращает или задает источник, к которому применяется фильтр.
ErrorAdditionalInfo	Ошибка управления ресурсами дополнительная информация.
ErrorDetail	Детали ошибки.
ErrorResponse	Ответ на ошибку
RaiActionType	Типы действий, применяемые к фильтрам содержимого
RaiPolicy	Когнитивные сервисы RaiPolicy.
RaiPolicyContentFilter	Azure OpenAI Content Filter.
RaiPolicyContentSource	Источник содержимого для применения фильтров контента.
RaiPolicyMode	Режим политики Rai. Сопоставление значений перечисления имеет следующий вид: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Пожалуйста, используйте 'Asynchronous_filter' после 2025-06-01. Он совпадает с "Отложенным" в предыдущей версии.
RaiPolicyProperties	Azure OpenAI Content Filters свойства.
RaiPolicyType	Тип политики "Фильтры содержимого".
SafetyProviderConfig	Получает или устанавливает источник, к которому обращаются специалисты по безопасности.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

ContentLevel

Перечисление

Уровень фильтрации содержимого.

Значение	Описание
Low
Medium
High

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

CustomBlocklistConfig

Объект

Возвращает или задает источник, к которому применяется фильтр.

Имя	Тип	Описание
blocking	boolean	Если блокировка возникнет.
blocklistName	string	Имя ContentFilter.
source	RaiPolicyContentSource	Источник содержимого для применения фильтров контента.

ErrorAdditionalInfo

Объект

Ошибка управления ресурсами дополнительная информация.

Имя	Тип	Описание
info	object	Дополнительная информация.
type	string	Тип дополнительной информации.

ErrorDetail

Объект

Детали ошибки.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Ошибка дополнительная информация.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Цель ошибки.

ErrorResponse

Объект

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

RaiActionType

Перечисление

Типы действий, применяемые к фильтрам содержимого

Значение	Описание
None
BLOCKING
ANNOTATING
HITL
RETRY

RaiPolicy

Объект

Когнитивные сервисы RaiPolicy.

Имя	Тип	Описание
etag	string	Etag ресурса.
id	string	Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса
properties	RaiPolicyProperties	Свойства Cognitive Services RaiPolicy.
systemData	systemData	Azure Resource Manager метаданные, содержащие информацию createdBy и modifiedBy.
tags	object	Теги ресурсов.
type	string	Тип ресурса. Например, «Майкрософт. Compute/virtualMachines» или «Майкрософт. Аккаунты хранения/хранения»

RaiPolicyContentFilter

Объект

Azure OpenAI Content Filter.

Имя	Тип	Описание
action	RaiActionType	Типы действий, применяемые к фильтрам содержимого
blocking	boolean	Если блокировка возникнет.
enabled	boolean	Если ContentFilter включен.
name	string	Имя ContentFilter.
severityThreshold	ContentLevel	Уровень фильтрации содержимого.
source	RaiPolicyContentSource	Источник содержимого для применения фильтров контента.

RaiPolicyContentSource

Перечисление

Источник содержимого для применения фильтров контента.

Значение	Описание
Prompt
Completion
PreToolCall
PostToolCall
PreRun
PostRun

RaiPolicyMode

Перечисление

Режим политики Rai. Сопоставление значений перечисления имеет следующий вид: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Пожалуйста, используйте 'Asynchronous_filter' после 2025-06-01. Он совпадает с "Отложенным" в предыдущей версии.

Значение	Описание
Default
Deferred
Blocking
Asynchronous_filter

RaiPolicyProperties

Объект

Azure OpenAI Content Filters свойства.

Имя	Тип	Описание
basePolicyName	string	Имя политики Rai.
contentFilters	RaiPolicyContentFilter[]	Список фильтров содержимого.
customBlocklists	CustomBlocklistConfig[]	Список настраиваемых списков блокировок.
mode	RaiPolicyMode	Режим политики Rai. Сопоставление значений перечисления имеет следующий вид: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Пожалуйста, используйте 'Asynchronous_filter' после 2025-06-01. Он совпадает с "Отложенным" в предыдущей версии.
safetyProviders	SafetyProviderConfig[]	Список поставщиков услуг по обеспечению безопасности.
type	RaiPolicyType	Тип политики "Фильтры содержимого".

RaiPolicyType

Перечисление

Тип политики "Фильтры содержимого".

Значение	Описание
UserManaged
SystemManaged

SafetyProviderConfig

Объект

Получает или устанавливает источник, к которому обращаются специалисты по безопасности.

Имя	Тип	Описание
blocking	boolean	Если блокировка возникнет.
safetyProviderName	string	Наименование поставщика услуг безопасности RAI.
source	RaiPolicyContentSource	Источник содержимого для применения фильтров контента.

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Временная метка последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

Поделиться через

Subscription Rai Policy - Get

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

GetRaiPolicy

Образец запроса

Пример ответа

Определения

ContentLevel

createdByType

CustomBlocklistConfig

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

RaiActionType

RaiPolicy

RaiPolicyContentFilter

RaiPolicyContentSource

RaiPolicyMode

RaiPolicyProperties

RaiPolicyType

SafetyProviderConfig

systemData