Rai Policies - List

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: 2024-04-01-preview

Pobiera filtry zawartości skojarzone z kontem usługi Azure OpenAI.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiPolicies?api-version=2024-04-01-preview

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
accountName	path	True	string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	Nazwa konta usług Cognitive Services.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
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	RaiPolicyListResult	Pomyślnie pobrano filtry zawartości.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Przykłady

ListRaiPolicies

Przykładowe żądanie

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies?api-version=2024-04-01-preview

Przykładowa odpowiedź

Kod stanu:: 200

{
  "value": [
    {
      "name": "raiPolicyName",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName",
      "properties": {
        "basePolicyName": "Microsoft.Default",
        "mode": "Deferred",
        "contentFilters": [
          {
            "name": "hate",
            "blocking": false,
            "enabled": false,
            "allowedContentLevel": "High",
            "source": "Prompt"
          },
          {
            "name": "hate",
            "blocking": true,
            "enabled": true,
            "allowedContentLevel": "Medium",
            "source": "Completion"
          },
          {
            "name": "sexual",
            "blocking": true,
            "enabled": true,
            "allowedContentLevel": "High",
            "source": "Prompt"
          },
          {
            "name": "sexual",
            "blocking": true,
            "enabled": true,
            "allowedContentLevel": "Medium",
            "source": "Completion"
          },
          {
            "name": "selfharm",
            "blocking": true,
            "enabled": true,
            "allowedContentLevel": "High",
            "source": "Prompt"
          },
          {
            "name": "selfharm",
            "blocking": true,
            "enabled": true,
            "allowedContentLevel": "Medium",
            "source": "Completion"
          },
          {
            "name": "violence",
            "blocking": true,
            "enabled": true,
            "allowedContentLevel": "Medium",
            "source": "Prompt"
          },
          {
            "name": "violence",
            "blocking": true,
            "enabled": true,
            "allowedContentLevel": "Medium",
            "source": "Completion"
          },
          {
            "name": "jailbreak",
            "blocking": true,
            "source": "Prompt",
            "enabled": true
          },
          {
            "name": "protected_material_text",
            "blocking": true,
            "source": "Completion",
            "enabled": true
          },
          {
            "name": "protected_material_code",
            "blocking": true,
            "source": "Completion",
            "enabled": true
          },
          {
            "name": "profanity",
            "blocking": true,
            "source": "Prompt",
            "enabled": true
          }
        ]
      }
    }
  ]
}

Definicje

Nazwa	Opis
allowedContentLevel	Poziom, na którym jest filtrowana zawartość.
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
RaiBlocklistConfig	Konfiguracja listy bloków usługi Azure OpenAI.
RaiPolicy	Cognitive Services RaiPolicy.
RaiPolicyContentFilter	Filtr zawartości interfejsu OpenAI platformy Azure.
RaiPolicyContentSource	Źródło zawartości w celu zastosowania filtrów zawartości.
RaiPolicyListResult	Lista usług cognitive services RaiPolicies.
RaiPolicyMode	Tryb filtrów zawartości.
RaiPolicyProperties	Właściwości filtrów zawartości interfejsu OpenAI platformy Azure.
RaiPolicyType	Typ zasad filtrów zawartości.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

allowedContentLevel

Wyliczanie

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

Wartość	Opis
High
Low
Medium

createdByType

Wyliczanie

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

Wartość	Opis
Application
Key
ManagedIdentity
User

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.

RaiBlocklistConfig

Objekt

Konfiguracja listy bloków usługi Azure OpenAI.

Nazwa	Typ	Opis
blocking	boolean	Jeśli wystąpi blokowanie.
blocklistName	string	Nazwa elementu ContentFilter.

RaiPolicy

Objekt

Cognitive Services RaiPolicy.

Nazwa	Typ	Opis
etag	string	Zasób Etag.
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /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 dotyczące tworzenia i ostatniej modyfikacji zasobu.
tags	object	Tagi zasobów.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

RaiPolicyContentFilter

Objekt

Filtr zawartości interfejsu OpenAI platformy Azure.

Nazwa	Typ	Opis
allowedContentLevel	allowedContentLevel	Poziom, na którym jest filtrowana zawartość.
blocking	boolean	Jeśli wystąpi blokowanie.
enabled	boolean	Jeśli właściwość ContentFilter jest włączona.
name	string	Nazwa elementu ContentFilter.
source	RaiPolicyContentSource	Źródło zawartości w celu zastosowania filtrów zawartości.

RaiPolicyContentSource

Wyliczanie

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

Wartość	Opis
Completion
Prompt

RaiPolicyListResult

Objekt

Lista usług cognitive services RaiPolicies.

Nazwa	Typ	Opis
nextLink	string	Link użyty do pobrania następnej strony RaiPolicy.
value	RaiPolicy[]	Lista RaiPolicy.

RaiPolicyMode

Wyliczanie

Tryb filtrów zawartości.

Wartość	Opis
Blocking
Default
Deferred

RaiPolicyProperties

Objekt

Właściwości filtrów zawartości interfejsu OpenAI platformy Azure.

Nazwa	Typ	Opis
basePolicyName	string	Nazwa podstawowych filtrów zawartości.
completionBlocklists	RaiBlocklistConfig[]	Lista list zablokowanych do ukończenia.
contentFilters	RaiPolicyContentFilter[]	Lista filtrów zawartości.
mode	RaiPolicyMode	Tryb filtrów zawartości.
policyType	RaiPolicyType	Typ zasad filtrów zawartości.
promptBlocklists	RaiBlocklistConfig[]	Lista list zablokowanych dla monitu.

RaiPolicyType

Wyliczanie

Typ zasad filtrów zawartości.

Wartość	Opis
SystemManaged
UserManaged

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

Rai Policies - List

Parametry identyfikatora URI

Odpowiedzi

Przykłady

ListRaiPolicies

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

allowedContentLevel

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

RaiBlocklistConfig

RaiPolicy

RaiPolicyContentFilter

RaiPolicyContentSource

RaiPolicyListResult

RaiPolicyMode

RaiPolicyProperties

RaiPolicyType

systemData