Text Operations - Analyze Text

Szolgáltatás:: Azure AI Services

API verzió:: 2024-09-01

Szöveg elemzése
Szinkron API a potenciálisan káros szöveges tartalom elemzéséhez. Jelenleg négy kategóriát támogat: a gyűlöletet, az önkontrasztot, a szexuális és az erőszakot.

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

URI paraméterek

Név	Ban	Szükséges	Típus	Leírás
endpoint	path	True	string (uri)	Támogatott Cognitive Services-végpontok (protokoll és állomásnév, például: https://< resource-name.cognitiveservices.azure.com>).
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Kérő Testület

Név	Szükséges	Típus	Leírás
text	True	string maxLength: 10000	Az elemezni kívánt szöveg. Egy kérés szövegében legfeljebb 10 ezer Unicode-karaktert (Unicode-kódpontot) támogatunk.
blocklistNames		string[]	A blokklisták nevei.
categories		TextCategory[]	A rendszer elemzi a kategóriákat. Ha nincsenek hozzárendelve, a rendszer a kategóriák alapértelmezett elemzési eredményeit adja vissza.
haltOnBlocklistHit		boolean	Ha igaz értékre van állítva, a káros tartalmak további elemzése nem történik meg olyan esetekben, amikor a tiltólistákat találatok érik. Ha hamis értékre van állítva, a rendszer elvégzi a káros tartalmak elemzését, függetlenül attól, hogy a tiltólistákat találatok érik-e el.
outputType		AnalyzeTextOutputType	Ez a szövegelemzési kimenet típusára vonatkozik. Ha nincs hozzárendelve érték, az alapértelmezett érték a "FourSeverityLevels" lesz.

Válaszok

Név	Típus	Leírás
200 OK	AnalyzeTextResult	A kérés sikeres volt.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Váratlan hibaválasz. Fejlécek x-ms-error-code: string

Név

Típus

Leírás

200 OK

AnalyzeTextResult

A kérés sikeres volt.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Váratlan hibaválasz.

Fejlécek

x-ms-error-code: string

Biztonság

Ocp-Apim-Subscription-Key

Típus: apiKey
Ban: header

OAuth2Auth

Típus: oauth2
Flow: application
Token URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Hatókörök

Név	Leírás
https://cognitiveservices.azure.com/.default

Példák

Analyze Text

Mintakérés

HTTP

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

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

Mintaválasz

Állapotkód:: 200

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

Meghatározások

Név	Leírás
AnalyzeTextOptions	A szövegelemzési kérelem.
AnalyzeTextOutputType	Ez a szövegelemzési kimenet típusára vonatkozik. Ha nincs hozzárendelve érték, az alapértelmezett érték a "FourSeverityLevels" lesz.
AnalyzeTextResult	A szövegelemzési válasz.
Azure.Core.Foundations.Error	A hibaobjektum.
Azure.Core.Foundations.ErrorResponse	Hibaadatokat tartalmazó válasz.
Azure.Core.Foundations.InnerError	Egy objektum, amely részletesebb információkat tartalmaz a hibáról. Az Azure REST API irányelvei szerint – https://aka.ms/AzureRestApiGuidelines#handling-errors.
TextBlocklistMatch	A tiltólista-egyezés eredménye.
TextCategoriesAnalysis	Szövegelemzés eredménye.
TextCategory	A szövegtartalom-elemzésben támogatott kárkategória.

AnalyzeTextOptions

Tárgy

A szövegelemzési kérelem.

Név	Típus	Alapértelmezett érték	Leírás
blocklistNames	string[]		A blokklisták nevei.
categories	TextCategory[]		A rendszer elemzi a kategóriákat. Ha nincsenek hozzárendelve, a rendszer a kategóriák alapértelmezett elemzési eredményeit adja vissza.
haltOnBlocklistHit	boolean		Ha igaz értékre van állítva, a káros tartalmak további elemzése nem történik meg olyan esetekben, amikor a tiltólistákat találatok érik. Ha hamis értékre van állítva, a rendszer elvégzi a káros tartalmak elemzését, függetlenül attól, hogy a tiltólistákat találatok érik-e el.
outputType	AnalyzeTextOutputType	FourSeverityLevels	Ez a szövegelemzési kimenet típusára vonatkozik. Ha nincs hozzárendelve érték, az alapértelmezett érték a "FourSeverityLevels" lesz.
text	string maxLength: 10000		Az elemezni kívánt szöveg. Egy kérés szövegében legfeljebb 10 ezer Unicode-karaktert (Unicode-kódpontot) támogatunk.

AnalyzeTextOutputType

Felsorolás

Ez a szövegelemzési kimenet típusára vonatkozik. Ha nincs hozzárendelve érték, az alapértelmezett érték a "FourSeverityLevels" lesz.

Érték	Leírás
FourSeverityLevels	A kimenet súlyossága négy szinten 0,2,4,6 lehet.
EightSeverityLevels	A kimenet súlyossága nyolc szinten 0,1,2,3,4,5,6,7 lehet.

AnalyzeTextResult

Tárgy

A szövegelemzési válasz.

Név	Típus	Leírás
blocklistsMatch	TextBlocklistMatch[]	A tiltólista megegyezik a részletekkel.
categoriesAnalysis	TextCategoriesAnalysis[]	Kategóriák elemzési eredménye.

Azure.Core.Foundations.Error

Tárgy

A hibaobjektum.

Név	Típus	Leírás
code	string	A kiszolgáló által definiált hibakódok egyike.
details	Azure.Core.Foundations.Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	Azure.Core.Foundations.InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba ember által olvasható ábrázolása.
target	string	A hiba célja.

Azure.Core.Foundations.ErrorResponse

Tárgy

Hibaadatokat tartalmazó válasz.

Név	Típus	Leírás
error	Azure.Core.Foundations.Error	A hibaobjektum.

Azure.Core.Foundations.InnerError

Tárgy

Egy objektum, amely részletesebb információkat tartalmaz a hibáról. Az Azure REST API irányelvei szerint – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Név	Típus	Leírás
code	string	A kiszolgáló által definiált hibakódok egyike.
innererror	Azure.Core.Foundations.InnerError	Belső hiba.

TextBlocklistMatch

Tárgy

A tiltólista-egyezés eredménye.

Név	Típus	Leírás
blocklistItemId	string maxLength: 64	A egyeztetett elem azonosítója.
blocklistItemText	string maxLength: 128	A egyeztetett elem tartalma.
blocklistName	string maxLength: 64	A egyeztetett tiltólista neve.

TextCategoriesAnalysis

Tárgy

Szövegelemzés eredménye.

Név	Típus	Leírás
category	TextCategory	A szövegelemzési kategória.
severity	integer (int32)	Az érték a bemeneti tartalom súlyosságával nő. A mező értékét a kérelemben megadott kimeneti típus határozza meg. A kimeneti típus lehet "FourSeverityLevels" vagy "EightSeverity Levels", és a kimeneti érték lehet 0, 2, 4, 6 vagy 0, 1, 2, 3, 4, 5, 6 vagy 7.

TextCategory

Felsorolás

A szövegtartalom-elemzésben támogatott kárkategória.

Érték	Leírás
Hate	A szöveg kárkategóriája – Gyűlölet.
SelfHarm	A szöveg kárkategóriája – SelfHarm.
Sexual	A szöveg kárkategóriája - Szexuális.
Violence	A szöveg kárkategóriája – Erőszak.