Text Operations - Detect Text Protected Material

Usługa:

Azure AI Services

Wersja interfejsu API:

2024-09-01

Wykrywanie chronionego materiału dla tekstu
Synchroniczny interfejs API do wykrywania materiału chronionego w danym tekście.

POST {endpoint}/contentsafety/text:detectProtectedMaterial?api-version=2024-09-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://.cognitiveservices.azure.com).
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
text	True	string	Tekst do przeanalizowania, który może zawierać materiał chroniony. Znaki będą liczone w punktach kodu Unicode.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DetectTextProtectedMaterialResult	Żądanie zakończyło się pomyślnie.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

OAuth2Auth

Typ: oauth2
Flow: application
Adres URL tokenu: https://login.microsoftonline.com/common/oauth2/v2.0/token

Zakresy

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

Detect Protected Material for Text

Przykładowe żądanie

HTTP

POST {endpoint}/contentsafety/text:detectProtectedMaterial?api-version=2024-09-01

{
  "text": "to everyone, the best things in life are free. the stars belong to everyone, they gleam there for you and me. the flowers in spring, the robins that sing, the sunbeams that shine"
}

Przykładowa odpowiedź

Kod stanu:

200

{
  "protectedMaterialAnalysis": {
    "detected": true
  }
}

Definicje

Nazwa	Opis
Azure.Core.Foundations.Error	Obiekt błędu.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegóły błędu.
Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
DetectTextProtectedMaterialOptions	Żądanie wykrywania potencjalnego chronionego materiału obecnego w danym tekście.
DetectTextProtectedMaterialResult	Połączone wyniki wykrywania potencjalnego chronionego materiału.
TextProtectedMaterialAnalysisResult	Indywidualny wynik wykrywania potencjalnego chronionego materiału.

Azure.Core.Foundations.Error

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

Azure.Core.Foundations.ErrorResponse

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	Azure.Core.Foundations.Error	Obiekt błędu.

Azure.Core.Foundations.InnerError

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	Azure.Core.Foundations.InnerError	Błąd wewnętrzny.

DetectTextProtectedMaterialOptions

Żądanie wykrywania potencjalnego chronionego materiału obecnego w danym tekście.

Nazwa	Typ	Opis
text	string	Tekst do przeanalizowania, który może zawierać materiał chroniony. Znaki będą liczone w punktach kodu Unicode.

DetectTextProtectedMaterialResult

Połączone wyniki wykrywania potencjalnego chronionego materiału.

Nazwa	Typ	Opis
protectedMaterialAnalysis	TextProtectedMaterialAnalysisResult	Wynik analizy dla danego tekstu.

TextProtectedMaterialAnalysisResult

Indywidualny wynik wykrywania potencjalnego chronionego materiału.

Nazwa	Typ	Opis
detected	boolean	Niezależnie od tego, czy wykryto potencjalny materiał chroniony, czy nie.