Subscription Rai Policy - Get

Usługa:: AI Foundry

Wersja interfejsu API:: 2025-10-01-preview

Otrzymuje określone filtry treści powiązane z subskrypcją.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
raiPolicyName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	Nazwa zasady RaiPolicy skojarzonej z kontem usług Cognitive Services
subscriptionId	path	True	string minLength: 1	Identyfikator subskrypcji docelowej.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	RaiPolicy	Operacja Azure zakończyła się pomyślnie.
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

GetRaiPolicy

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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"
  }
}

Definicje

Nazwa	Opis
ContentLevel	Poziom, na którym jest filtrowana zawartość.
createdByType	Typ tożsamości, która utworzyła zasób.
CustomBlocklistConfig	Pobiera lub ustawia źródło, do którego ma zastosowanie filtr.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
RaiActionType	Typy akcji, które mają być stosowane do filtrów zawartości
RaiPolicy	Usługi poznawcze RaiPolicy.
RaiPolicyContentFilter	Azure OpenAI Content Filter.
RaiPolicyContentSource	Źródło zawartości w celu zastosowania filtrów zawartości.
RaiPolicyMode	Tryb zasad Rai. Mapowanie wartości wyliczenia jest następujące: Default = 0, Odroczone=1, Blocking=2, Asynchronous_filter =3. Użyj "Asynchronous_filter" po 2025-06-01. Jest ona taka sama jak "Odroczona" w poprzedniej wersji.
RaiPolicyProperties	Właściwości filtrów treści Azure OpenAI.
RaiPolicyType	Typ zasad filtrów zawartości.
SafetyProviderConfig	Ustala lub ustala źródło, do którego stosuje się ubezpieczenie bezpieczeństwa.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

ContentLevel

Wyliczenie

Poziom, na którym jest filtrowana zawartość.

Wartość	Opis
Low
Medium
High

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

CustomBlocklistConfig

Objekt

Pobiera lub ustawia źródło, do którego ma zastosowanie filtr.

Nazwa	Typ	Opis
blocking	boolean	Jeśli wystąpi blokowanie.
blocklistName	string	Nazwa elementu ContentFilter.
source	RaiPolicyContentSource	Źródło zawartości w celu zastosowania filtrów zawartości.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

RaiActionType

Wyliczenie

Typy akcji, które mają być stosowane do filtrów zawartości

Wartość	Opis
None
BLOCKING
ANNOTATING
HITL
RETRY

RaiPolicy

Objekt

Usługi poznawcze RaiPolicy.

Nazwa	Typ	Opis
etag	string	Zasób Etag.
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties	RaiPolicyProperties	Właściwości usług Cognitive Services RaiPolicy.
systemData	systemData	Metadane Azure Resource Manager zawierające informacje createdBy i modifiedBy.
tags	object	Tagi zasobów.
type	string	Typ zasobu. Np. "Microsoft. Compute/virtualMachines" lub "Microsoft. Storage/storageAccounts"

RaiPolicyContentFilter

Objekt

Azure OpenAI Content Filter.

Nazwa	Typ	Opis
action	RaiActionType	Typy akcji, które mają być stosowane do filtrów zawartości
blocking	boolean	Jeśli wystąpi blokowanie.
enabled	boolean	Jeśli właściwość ContentFilter jest włączona.
name	string	Nazwa elementu ContentFilter.
severityThreshold	ContentLevel	Poziom, na którym jest filtrowana zawartość.
source	RaiPolicyContentSource	Źródło zawartości w celu zastosowania filtrów zawartości.

RaiPolicyContentSource

Wyliczenie

Źródło zawartości w celu zastosowania filtrów zawartości.

Wartość	Opis
Prompt
Completion
PreToolCall
PostToolCall
PreRun
PostRun

RaiPolicyMode

Wyliczenie

Tryb zasad Rai. Mapowanie wartości wyliczenia jest następujące: Default = 0, Odroczone=1, Blocking=2, Asynchronous_filter =3. Użyj "Asynchronous_filter" po 2025-06-01. Jest ona taka sama jak "Odroczona" w poprzedniej wersji.

Wartość	Opis
Default
Deferred
Blocking
Asynchronous_filter

RaiPolicyProperties

Objekt

Właściwości filtrów treści Azure OpenAI.

Nazwa	Typ	Opis
basePolicyName	string	Nazwa zasad Rai.
contentFilters	RaiPolicyContentFilter[]	Lista filtrów zawartości.
customBlocklists	CustomBlocklistConfig[]	Lista niestandardowych list zablokowanych.
mode	RaiPolicyMode	Tryb zasad Rai. Mapowanie wartości wyliczenia jest następujące: Default = 0, Odroczone=1, Blocking=2, Asynchronous_filter =3. Użyj "Asynchronous_filter" po 2025-06-01. Jest ona taka sama jak "Odroczona" w poprzedniej wersji.
safetyProviders	SafetyProviderConfig[]	Lista dostawców usług bezpieczeństwa.
type	RaiPolicyType	Typ zasad filtrów zawartości.

RaiPolicyType

Wyliczenie

Typ zasad filtrów zawartości.

Wartość	Opis
UserManaged
SystemManaged

SafetyProviderConfig

Objekt

Ustala lub ustala źródło, do którego stosuje się ubezpieczenie bezpieczeństwa.

Nazwa	Typ	Opis
blocking	boolean	Jeśli wystąpi blokowanie.
safetyProviderName	string	Nazwa dostawcy usług bezpieczeństwa RAI.
source	RaiPolicyContentSource	Źródło zawartości w celu zastosowania filtrów zawartości.

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Udostępnij za pośrednictwem

Subscription Rai Policy - Get

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

GetRaiPolicy

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ContentLevel

createdByType

CustomBlocklistConfig

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

RaiActionType

RaiPolicy

RaiPolicyContentFilter

RaiPolicyContentSource

RaiPolicyMode

RaiPolicyProperties

RaiPolicyType

SafetyProviderConfig

systemData