Text Operations - Analyze Text

Referenz

Dienst:: Azure AI Services

API-Version:: 2023-10-01

Text analysieren
Eine synchrone API für die Analyse potenziell schädlicher Textinhalte. Derzeit unterstützt es vier Kategorien: Hass, SelfHarm, Sexual und Gewalt.

POST {endpoint}/contentsafety/text:analyze?api-version=2023-10-01

URI-Parameter

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

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
text	True	string	Der zu analysierende Text. Wir unterstützen maximal 10k Unicode-Zeichen (Unicode-Codepunkte) im Text einer Anforderung.
blocklistNames		string[]	Die Namen von Blocklisten.
categories		TextCategory[]	Die Kategorien werden analysiert. Wenn sie nicht zugewiesen sind, wird ein Standardsatz von Analyseergebnissen für die Kategorien zurückgegeben.
haltOnBlocklistHit		boolean	Bei Festlegung auf "true" werden in Fällen, in denen Blocklisten getroffen werden, keine weiteren Analysen schädlicher Inhalte durchgeführt. Bei Festlegung auf "false" werden alle Analysen schädlicher Inhalte ausgeführt, unabhängig davon, ob Blocklisten getroffen werden.
outputType		AnalyzeTextOutputType	Dies bezieht sich auf den Typ der Textanalyseausgabe. Wenn kein Wert zugewiesen ist, lautet der Standardwert "FourSeverityLevels".

Antworten

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

Name

Typ

Beschreibung

200 OK

AnalyzeTextResult

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

Analyze Text

Beispielanforderung

HTTP

POST {endpoint}/contentsafety/text:analyze?api-version=2023-10-01

{
  "text": "This is text example"
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "blocklistsMatch": [],
  "categoriesAnalysis": [
    {
      "category": "Hate",
      "severity": 0
    },
    {
      "category": "SelfHarm",
      "severity": 0
    },
    {
      "category": "Sexual",
      "severity": 0
    },
    {
      "category": "Violence",
      "severity": 0
    }
  ]
}

Definitionen

Name	Beschreibung
AnalyzeTextOptions	Die Textanalyseanforderung.
AnalyzeTextOutputType	Dies bezieht sich auf den Typ der Textanalyseausgabe. Wenn kein Wert zugewiesen ist, lautet der Standardwert "FourSeverityLevels".
AnalyzeTextResult	Die Textanalyseantwort.
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 Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TextBlocklistMatch	Das Ergebnis der Blocklistenzuordnung.
TextCategoriesAnalysis	Ergebnis der Textanalyse.
TextCategory	Die in der Textinhaltsanalyse unterstützte Schadenkategorie.

AnalyzeTextOptions

Die Textanalyseanforderung.

Name	Typ	Standardwert	Beschreibung
blocklistNames	string[]		Die Namen von Blocklisten.
categories	TextCategory[]		Die Kategorien werden analysiert. Wenn sie nicht zugewiesen sind, wird ein Standardsatz von Analyseergebnissen für die Kategorien zurückgegeben.
haltOnBlocklistHit	boolean		Bei Festlegung auf "true" werden in Fällen, in denen Blocklisten getroffen werden, keine weiteren Analysen schädlicher Inhalte durchgeführt. Bei Festlegung auf "false" werden alle Analysen schädlicher Inhalte ausgeführt, unabhängig davon, ob Blocklisten getroffen werden.
outputType	AnalyzeTextOutputType	FourSeverityLevels	Dies bezieht sich auf den Typ der Textanalyseausgabe. Wenn kein Wert zugewiesen ist, lautet der Standardwert "FourSeverityLevels".
text	string		Der zu analysierende Text. Wir unterstützen maximal 10k Unicode-Zeichen (Unicode-Codepunkte) im Text einer Anforderung.

AnalyzeTextOutputType

Dies bezieht sich auf den Typ der Textanalyseausgabe. Wenn kein Wert zugewiesen ist, lautet der Standardwert "FourSeverityLevels".

Name	Typ	Beschreibung
EightSeverityLevels	string	Ausgabeschweregrade in acht Ebenen, der Wert könnte 0,1,2,3,4,5,6,7 sein.
FourSeverityLevels	string	Ausgabeschweregrade in vier Ebenen, der Wert könnte 0,2,4,6 sein.

AnalyzeTextResult

Die Textanalyseantwort.

Name	Typ	Beschreibung
blocklistsMatch	TextBlocklistMatch[]	Die Blocklisten-Übereinstimmungsdetails.
categoriesAnalysis	TextCategoriesAnalysis[]	Analyseergebnis für Kategorien.

Azure.Core.Foundations.Error

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

Eine Antwort, die Fehlerdetails enthält.

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

Azure.Core.Foundations.InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

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

TextBlocklistMatch

Das Ergebnis der Blocklistenzuordnung.

Name	Typ	Beschreibung
blocklistItemId	string	Die ID des übereinstimmenen Elements.
blocklistItemText	string	Der Inhalt des übereinstimmenen Elements.
blocklistName	string	Der Name der übereinstimmenen Blockliste.

TextCategoriesAnalysis

Ergebnis der Textanalyse.

Name	Typ	Beschreibung
category	TextCategory	Die Textanalysekategorie.
severity	integer	Der Wert steigt mit dem Schweregrad des Eingabeinhalts. Der Wert dieses Felds wird durch den in der Anforderung angegebenen Ausgabetyp bestimmt. Der Ausgabetyp kann "FourSeverityLevels" oder "EightSeverity Levels" sein, und der Ausgabewert kann 0, 2, 4, 6 oder 0, 1, 2, 3, 4, 5, 6 oder 7 sein.

TextCategory

Die in der Textinhaltsanalyse unterstützte Schadenkategorie.

Name	Typ	Beschreibung
Hate	string	Die Schadenkategorie für Text - Hass.
SelfHarm	string	Die Schadenkategorie für Text - SelfHarm.
Sexual	string	Die Schadenkategorie für Text - Sexual.
Violence	string	Die Schadenkategorie für Text - Gewalt.

Freigeben über

Text Operations - Analyze Text

URI-Parameter

Anforderungstext

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

OAuth2Auth

Bereiche

Beispiele

Analyze Text

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AnalyzeTextOptions

AnalyzeTextOutputType

AnalyzeTextResult

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

TextBlocklistMatch

TextCategoriesAnalysis

TextCategory

Zusätzliche Ressourcen