Subscription Rai Policy - Get

Služba:: AI Foundry

Verze rozhraní API:: 2025-10-01-preview

Získává specifikované obsahové filtry spojené s odběrem.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
raiPolicyName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	Název zásad RaiPolicy přidružených k účtu služeb Cognitive Services
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	RaiPolicy	Operace Azure byla úspěšně dokončena.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

GetRaiPolicy

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
  }
}

Definice

Name	Description
ContentLevel	Úroveň, na které se obsah filtruje.
createdByType	Typ identity, která prostředek vytvořila.
CustomBlocklistConfig	Získá nebo nastaví zdroj, na který se použije filtr.
CustomTopicConfig	Získá nebo nastaví zdroj, na který se použije filtr.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
RaiActionType	Typy akcí, které se mají použít pro filtry obsahu
RaiPolicy	Kognitivní služby RaiPolicy.
RaiPolicyContentFilter	Azure OpenAI Content Filter.
RaiPolicyContentSource	Zdroj obsahu pro použití filtrů obsahu
RaiPolicyMode	Režim zásad Rai. Mapování hodnot výčtu je následující: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Po 2025-06-01 použijte 'Asynchronous_filter. Je to stejné jako Deferred v předchozí verzi.
RaiPolicyProperties	Vlastnosti Azure OpenAI Content Filters (vlastnosti filtrů obsahu).
RaiPolicyType	Typ zásad filtrů obsahu.
SafetyProviderConfig	Získává nebo nastavuje zdroj, na který se bezpečnostní poskytovatelé vztahují.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

ContentLevel

Výčet

Úroveň, na které se obsah filtruje.

Hodnota	Description
Low
Medium
High

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

CustomBlocklistConfig

Objekt

Získá nebo nastaví zdroj, na který se použije filtr.

Name	Typ	Description
blocking	boolean	Pokud dojde k blokování.
blocklistName	string	Název ContentFilteru.
source	RaiPolicyContentSource	Zdroj obsahu pro použití filtrů obsahu

CustomTopicConfig

Objekt

Získá nebo nastaví zdroj, na který se použije filtr.

Name	Typ	Description
blocking	boolean	Pokud dojde k blokování.
source	RaiPolicyContentSource	Zdroj obsahu pro použití filtrů obsahu
topicName	string	Název tématu RAI.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

RaiActionType

Výčet

Typy akcí, které se mají použít pro filtry obsahu

Hodnota	Description
None
BLOCKING
ANNOTATING
HITL
RETRY

RaiPolicy

Objekt

Kognitivní služby RaiPolicy.

Name	Typ	Description
etag	string	Značky Etag prostředku
id	string	Plně kvalifikované ID prostředku pro daný prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties	RaiPolicyProperties	Vlastnosti Služby Cognitive Services RaiPolicy
systemData	systemData	Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.
tags	object	Značky prostředků
type	string	Typ prostředku. Např. "Microsoft.Compute/virtualMachines" nebo "Microsoft.Storage/storageAccounts"

RaiPolicyContentFilter

Objekt

Azure OpenAI Content Filter.

Name	Typ	Description
action	RaiActionType	Typy akcí, které se mají použít pro filtry obsahu
blocking	boolean	Pokud dojde k blokování.
enabled	boolean	Pokud je povolená funkce ContentFilter.
name	string	Název ContentFilteru.
severityThreshold	ContentLevel	Úroveň, na které se obsah filtruje.
source	RaiPolicyContentSource	Zdroj obsahu pro použití filtrů obsahu

RaiPolicyContentSource

Výčet

Zdroj obsahu pro použití filtrů obsahu

Hodnota	Description
Prompt
Completion
PreToolCall
PostToolCall
PreRun
PostRun

RaiPolicyMode

Výčet

Režim zásad Rai. Mapování hodnot výčtu je následující: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Po 2025-06-01 použijte 'Asynchronous_filter. Je to stejné jako Deferred v předchozí verzi.

Hodnota	Description
Default
Deferred
Blocking
Asynchronous_filter

RaiPolicyProperties

Objekt

Vlastnosti Azure OpenAI Content Filters (vlastnosti filtrů obsahu).

Name	Typ	Description
basePolicyName	string	Název zásady Rai.
contentFilters	RaiPolicyContentFilter[]	Seznam filtrů obsahu.
customBlocklists	CustomBlocklistConfig[]	Seznam vlastních seznamů blokovaných položek.
customTopics	CustomTopicConfig[]	Seznam vlastních témat rai.
mode	RaiPolicyMode	Režim zásad Rai. Mapování hodnot výčtu je následující: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Po 2025-06-01 použijte 'Asynchronous_filter. Je to stejné jako Deferred v předchozí verzi.
safetyProviders	SafetyProviderConfig[]	Seznam poskytovatelů bezpečnosti.
type	RaiPolicyType	Typ zásad filtrů obsahu.

RaiPolicyType

Výčet

Typ zásad filtrů obsahu.

Hodnota	Description
UserManaged
SystemManaged

SafetyProviderConfig

Objekt

Získává nebo nastavuje zdroj, na který se bezpečnostní poskytovatelé vztahují.

Name	Typ	Description
blocking	boolean	Pokud dojde k blokování.
safetyProviderName	string	Název poskytovatele bezpečnosti RAI.
source	RaiPolicyContentSource	Zdroj obsahu pro použití filtrů obsahu

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Sdílet prostřednictvím

Subscription Rai Policy - Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

GetRaiPolicy

Ukázkový požadavek

Ukázková odpověď

Definice

ContentLevel

createdByType

CustomBlocklistConfig

CustomTopicConfig

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

RaiActionType

RaiPolicy

RaiPolicyContentFilter

RaiPolicyContentSource

RaiPolicyMode

RaiPolicyProperties

RaiPolicyType

SafetyProviderConfig

systemData