Text Operations - Analyze Text

Service:

Azure AI Services

API-versie:

2024-09-01

Tekst analyseren
Een synchrone API voor de analyse van mogelijk schadelijke tekstinhoud. Momenteel ondersteunt het vier categorieën: Haat, SelfHarm, Seksueel en Geweld.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://.cognitiveservices.azure.com).
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
text	True	string	De te analyseren tekst. We ondersteunen maximaal 10.000 Unicode-tekens (Unicode-codepunten) in de tekst van één aanvraag.
blocklistNames		string[]	De namen van blokkeringen.
categories		TextCategory[]	De categorieën worden geanalyseerd. Als ze niet zijn toegewezen, wordt er een standaardset met analyseresultaten voor de categorieën geretourneerd.
haltOnBlocklistHit		boolean	Wanneer deze is ingesteld op waar, worden verdere analyses van schadelijke inhoud niet uitgevoerd in gevallen waarin bloklijsten worden bereikt. Als deze is ingesteld op onwaar, worden alle analyses van schadelijke inhoud uitgevoerd, ongeacht of er wel of geen bloklijsten worden bereikt.
outputType		AnalyzeTextOutputType	Dit verwijst naar het type uitvoer van tekstanalyse. Als er geen waarde is toegewezen, is de standaardwaarde 'FourSeverityLevels'.

Antwoorden

Name	Type	Description
200 OK	AnalyzeTextResult	De aanvraag is voltooid.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

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

Bereiken

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

Voorbeelden

Analyze Text

Voorbeeldaanvraag

HTTP

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

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

Voorbeeldrespons

Statuscode:

200

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

Definities

Name	Description
AnalyzeTextOptions	De aanvraag voor tekstanalyse.
AnalyzeTextOutputType	Dit verwijst naar het type uitvoer van tekstanalyse. Als er geen waarde is toegewezen, is de standaardwaarde 'FourSeverityLevels'.
AnalyzeTextResult	Het antwoord van de tekstanalyse.
Azure.Core.Foundations.Error	Het foutobject.
Azure.Core.Foundations.ErrorResponse	Een antwoord met foutdetails.
Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TextBlocklistMatch	Het resultaat van een bloklijstovereenkomst.
TextCategoriesAnalysis	Resultaat van tekstanalyse.
TextCategory	De schadecategorie die wordt ondersteund in tekstinhoudsanalyse.

AnalyzeTextOptions

De aanvraag voor tekstanalyse.

Name	Type	Default value	Description
blocklistNames	string[]		De namen van blokkeringen.
categories	TextCategory[]		De categorieën worden geanalyseerd. Als ze niet zijn toegewezen, wordt er een standaardset met analyseresultaten voor de categorieën geretourneerd.
haltOnBlocklistHit	boolean		Wanneer deze is ingesteld op waar, worden verdere analyses van schadelijke inhoud niet uitgevoerd in gevallen waarin bloklijsten worden bereikt. Als deze is ingesteld op onwaar, worden alle analyses van schadelijke inhoud uitgevoerd, ongeacht of er wel of geen bloklijsten worden bereikt.
outputType	AnalyzeTextOutputType	FourSeverityLevels	Dit verwijst naar het type uitvoer van tekstanalyse. Als er geen waarde is toegewezen, is de standaardwaarde 'FourSeverityLevels'.
text	string		De te analyseren tekst. We ondersteunen maximaal 10.000 Unicode-tekens (Unicode-codepunten) in de tekst van één aanvraag.

AnalyzeTextOutputType

Dit verwijst naar het type uitvoer van tekstanalyse. Als er geen waarde is toegewezen, is de standaardwaarde 'FourSeverityLevels'.

Name	Type	Description
EightSeverityLevels	string	De uitvoer ernst in acht niveaus kan de waarde 0,1,2,3,4,5,6,7 zijn.
FourSeverityLevels	string	De uitvoer ernst in vier niveaus kan 0,2,4,6 zijn.

AnalyzeTextResult

Het antwoord van de tekstanalyse.

Name	Type	Description
blocklistsMatch	TextBlocklistMatch[]	De details van de blokkeringslijst komen overeen.
categoriesAnalysis	TextCategoriesAnalysis[]	Analyseresultaat voor categorieën.

Azure.Core.Foundations.Error

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Azure.Core.Foundations.Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

Azure.Core.Foundations.ErrorResponse

Een antwoord met foutdetails.

Name	Type	Description
error	Azure.Core.Foundations.Error	Het foutobject.

Azure.Core.Foundations.InnerError

Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	Azure.Core.Foundations.InnerError	Interne fout.

TextBlocklistMatch

Het resultaat van een bloklijstovereenkomst.

Name	Type	Description
blocklistItemId	string	De id van het overeenkomende item.
blocklistItemText	string	De inhoud van het overeenkomende item.
blocklistName	string	De naam van de overeenkomende bloklijst.

TextCategoriesAnalysis

Resultaat van tekstanalyse.

Name	Type	Description
category	TextCategory	De categorie tekstanalyse.
severity	integer	De waarde neemt toe met de ernst van de invoerinhoud. De waarde van dit veld wordt bepaald door het uitvoertype dat is opgegeven in de aanvraag. Het uitvoertype kan 'FourSeverityLevels' of 'AchtSeveriteitsniveaus' zijn en de uitvoerwaarde kan 0, 2, 4, 6 of 0, 1, 2, 3, 4, 5, 6 of 7 zijn.

TextCategory

De schadecategorie die wordt ondersteund in tekstinhoudsanalyse.

Name	Type	Description
Hate	string	De schadecategorie voor Tekst - Haat.
SelfHarm	string	De categorie schade voor Tekst - SelfHarm.
Sexual	string	De schadecategorie voor Tekst - Seksueel.
Violence	string	De categorie schade voor Tekst - Geweld.