Text Operations - Analyze Text

Reference

Služba:: Azure AI Services

Verze rozhraní API:: 2024-09-01

Analýza textu
Synchronní rozhraní API pro analýzu potenciálně škodlivého textového obsahu. V současné době podporuje čtyři kategorie: Nenávist, SelfHarm, Sexuální a Násilí.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://.cognitiveservices.azure.com).
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
text	True	string	Text, který se má analyzovat. V textu jednoho požadavku podporujeme maximálně 10 tisíc znaků Unicode (body kódu Unicode).
blocklistNames		string[]	Názvy seznamů blokovaných položek.
categories		TextCategory[]	Kategorie budou analyzovány. Pokud nejsou přiřazené, vrátí se výchozí sada výsledků analýzy pro kategorie.
haltOnBlocklistHit		boolean	Pokud je nastavena hodnota true, nebudou další analýzy škodlivého obsahu provedeny v případech, kdy jsou nalezeny seznamy blokovaných položek. Pokud je nastavená hodnota false, budou provedeny všechny analýzy škodlivého obsahu bez ohledu na to, jestli jsou nalezeny seznamy blokovaných položek nebo ne.
outputType		AnalyzeTextOutputType	To se týká typu výstupu analýzy textu. Pokud není přiřazena žádná hodnota, výchozí hodnota bude FourSeverityLevels.

Odpovědi

Name	Typ	Description
200 OK	AnalyzeTextResult	Požadavek byl úspěšný.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Name

Typ

Description

200 OK

AnalyzeTextResult

Požadavek byl úspěšný.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Neočekávaná chybová odpověď

Hlavičky

x-ms-error-code: string

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

OAuth2Auth

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

Rozsahy

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

Příklady

Analyze Text

Ukázkový požadavek

HTTP

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

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

Ukázková odpověď

Stavový kód:: 200

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

Definice

Name	Description
AnalyzeTextOptions	Požadavek na analýzu textu.
AnalyzeTextOutputType	To se týká typu výstupu analýzy textu. Pokud není přiřazena žádná hodnota, výchozí hodnota bude FourSeverityLevels.
AnalyzeTextResult	Odpověď na analýzu textu.
Azure.Core.Foundations.Error	Objekt chyby.
Azure.Core.Foundations.ErrorResponse	Odpověď obsahující podrobnosti o chybě.
Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TextBlocklistMatch	Výsledek shody seznamu blokovaných položek.
TextCategoriesAnalysis	Výsledek analýzy textu
TextCategory	Kategorie škod podporovaná v analýze obsahu textu.

AnalyzeTextOptions

Požadavek na analýzu textu.

Name	Typ	Default value	Description
blocklistNames	string[]		Názvy seznamů blokovaných položek.
categories	TextCategory[]		Kategorie budou analyzovány. Pokud nejsou přiřazené, vrátí se výchozí sada výsledků analýzy pro kategorie.
haltOnBlocklistHit	boolean		Pokud je nastavena hodnota true, nebudou další analýzy škodlivého obsahu provedeny v případech, kdy jsou nalezeny seznamy blokovaných položek. Pokud je nastavená hodnota false, budou provedeny všechny analýzy škodlivého obsahu bez ohledu na to, jestli jsou nalezeny seznamy blokovaných položek nebo ne.
outputType	AnalyzeTextOutputType	FourSeverityLevels	To se týká typu výstupu analýzy textu. Pokud není přiřazena žádná hodnota, výchozí hodnota bude FourSeverityLevels.
text	string		Text, který se má analyzovat. V textu jednoho požadavku podporujeme maximálně 10 tisíc znaků Unicode (body kódu Unicode).

AnalyzeTextOutputType

To se týká typu výstupu analýzy textu. Pokud není přiřazena žádná hodnota, výchozí hodnota bude FourSeverityLevels.

Name	Typ	Description
EightSeverityLevels	string	Závažnosti výstupu v osmi úrovních můžou být 0,1,2,3,4,5,6,7.
FourSeverityLevels	string	Závažnosti výstupu ve čtyřech úrovních můžou být 0,2,4,6.

AnalyzeTextResult

Odpověď na analýzu textu.

Name	Typ	Description
blocklistsMatch	TextBlocklistMatch[]	Podrobnosti shody seznamu blokovaných položek.
categoriesAnalysis	TextCategoriesAnalysis[]	Výsledek analýzy pro kategorie

Azure.Core.Foundations.Error

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	Azure.Core.Foundations.Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

Azure.Core.Foundations.ErrorResponse

Odpověď obsahující podrobnosti o chybě.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Objekt chyby.

Azure.Core.Foundations.InnerError

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
innererror	Azure.Core.Foundations.InnerError	Vnitřní chyba.

TextBlocklistMatch

Výsledek shody seznamu blokovaných položek.

Name	Typ	Description
blocklistItemId	string	ID odpovídající položky.
blocklistItemText	string	Obsah odpovídající položky.
blocklistName	string	Název odpovídajícího seznamu blokovaných položek.

TextCategoriesAnalysis

Výsledek analýzy textu

Name	Typ	Description
category	TextCategory	Kategorie analýzy textu.
severity	integer	Hodnota se zvyšuje závažností vstupního obsahu. Hodnota tohoto pole je určena výstupním typem zadaným v požadavku. Výstupní typ může být FourSeverityLevels nebo EightSeverity Levels a výstupní hodnota může být 0, 2, 4, 6 nebo 0, 1, 2, 3, 4, 5, 6 nebo 7.

TextCategory

Kategorie škod podporovaná v analýze obsahu textu.

Name	Typ	Description
Hate	string	Kategorie škod pro Text - Nenávist.
SelfHarm	string	Kategorie škod pro Text - SelfHarm.
Sexual	string	Kategorie škod pro Text - Sexuální.
Violence	string	Kategorie škod pro text - Násilí.

Sdílet prostřednictvím

Text Operations - Analyze Text

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

Ocp-Apim-Subscription-Key

OAuth2Auth

Rozsahy

Příklady

Analyze Text

Ukázkový požadavek

Ukázková odpověď

Definice

AnalyzeTextOptions

AnalyzeTextOutputType

AnalyzeTextResult

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

TextBlocklistMatch

TextCategoriesAnalysis

TextCategory

Další materiály