Text Operations - Detect Text Protected Material

Dienst:

Azure AI Services

API-Version:

2024-09-01

Geschütztes Material für Text erkennen
Eine synchrone API zum Erkennen von geschütztem Material im angegebenen Text.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. https://< resource-name.cognitiveservices.azure.com>).
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
text	True	string	Der zu analysierende Text, der geschütztes Material enthalten kann. Die Zeichen werden in Unicode-Codepunkten gezählt.

Antworten

Name	Typ	Beschreibung
200 OK	DetectTextProtectedMaterialResult	Die Anforderung ist erfolgreich.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: application
Token-URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Bereiche

Name	Beschreibung
https://cognitiveservices.azure.com/.default

Beispiele

Detect Protected Material for Text

Beispielanforderung

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"
}

Beispiel für eine Antwort

Statuscode:

200

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

Definitionen

Name	Beschreibung
Azure.Core.Foundations.Error	Das Fehlerobjekt.
Azure.Core.Foundations.ErrorResponse	Eine Antwort, die Fehlerdetails enthält.
Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Richtlinien der Azure-REST-API: . https://aka.ms/AzureRestApiGuidelines#handling-errors
DetectTextProtectedMaterialOptions	Die Anforderung, potenzielle geschütztes Material zu erkennen, das im angegebenen Text vorhanden ist.
DetectTextProtectedMaterialResult	Die kombinierten Nachweisergebnisse potenzieller geschützter Materialien.
TextProtectedMaterialAnalysisResult	Das individuelle Erkennungsergebnis potenzieller geschützter Materialien.

Azure.Core.Foundations.Error

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	Azure.Core.Foundations.Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

Azure.Core.Foundations.ErrorResponse

Objekt

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	Azure.Core.Foundations.Error	Das Fehlerobjekt.

Azure.Core.Foundations.InnerError

Objekt

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Richtlinien der Azure-REST-API: . https://aka.ms/AzureRestApiGuidelines#handling-errors

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	Azure.Core.Foundations.InnerError	Innerer Fehler.

DetectTextProtectedMaterialOptions

Objekt

Die Anforderung, potenzielle geschütztes Material zu erkennen, das im angegebenen Text vorhanden ist.

Name	Typ	Beschreibung
text	string	Der zu analysierende Text, der geschütztes Material enthalten kann. Die Zeichen werden in Unicode-Codepunkten gezählt.

DetectTextProtectedMaterialResult

Objekt

Die kombinierten Nachweisergebnisse potenzieller geschützter Materialien.

Name	Typ	Beschreibung
protectedMaterialAnalysis	TextProtectedMaterialAnalysisResult	Analyseergebnis für den angegebenen Text.

TextProtectedMaterialAnalysisResult

Objekt

Das individuelle Erkennungsergebnis potenzieller geschützter Materialien.

Name	Typ	Beschreibung
detected	boolean	Ob potenzielles geschütztes Material erkannt wird oder nicht.