Text Operations - Analyze Text

Referens

Tjänst:: Azure AI Services

API-version:: 2024-09-01

Analysera text
Ett synkront API för analys av potentiellt skadligt textinnehåll. För närvarande stöder den fyra kategorier: Hate, SelfHarm, Sexual och Violence.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://.cognitiveservices.azure.com).
api-version	query	True	string	DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
text	True	string	Texten som ska analyseras. Vi stöder högst 10 000 Unicode-tecken (Unicode-kodpunkter) i texten i en begäran.
blocklistNames		string[]	Namnen på blocklistor.
categories		TextCategory[]	Kategorierna analyseras. Om de inte tilldelas returneras en standarduppsättning med analysresultat för kategorierna.
haltOnBlocklistHit		boolean	När värdet är true utförs inte ytterligare analyser av skadligt innehåll i de fall då blocklistor träffas. När värdet är falskt utförs alla analyser av skadligt innehåll, oavsett om blocklistor har nåtts eller inte.
outputType		AnalyzeTextOutputType	Detta refererar till typen av textanalysutdata. Om inget värde tilldelas blir standardvärdet "FourSeverityLevels".

Svar

Name	Typ	Description
200 OK	AnalyzeTextResult	Begäran har slutförts.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Name

Typ

Description

200 OK

AnalyzeTextResult

Begäran har slutförts.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Ett oväntat felsvar.

Sidhuvuden

x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

OAuth2Auth

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

Omfattningar

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

Exempel

Analyze Text

Exempelbegäran

HTTP

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

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

Exempelsvar

Statuskod:: 200

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

Definitioner

Name	Description
AnalyzeTextOptions	Begäran om textanalys.
AnalyzeTextOutputType	Detta refererar till typen av textanalysutdata. Om inget värde tilldelas blir standardvärdet "FourSeverityLevels".
AnalyzeTextResult	Textanalyssvaret.
Azure.Core.Foundations.Error	Felobjektet.
Azure.Core.Foundations.ErrorResponse	Ett svar som innehåller felinformation.
Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TextBlocklistMatch	Resultatet av blocklistmatchning.
TextCategoriesAnalysis	Textanalysresultat.
TextCategory	Skadekategorin som stöds i textinnehållsanalys.

AnalyzeTextOptions

Begäran om textanalys.

Name	Typ	Standardvärde	Description
blocklistNames	string[]		Namnen på blocklistor.
categories	TextCategory[]		Kategorierna analyseras. Om de inte tilldelas returneras en standarduppsättning med analysresultat för kategorierna.
haltOnBlocklistHit	boolean		När värdet är true utförs inte ytterligare analyser av skadligt innehåll i de fall då blocklistor träffas. När värdet är falskt utförs alla analyser av skadligt innehåll, oavsett om blocklistor har nåtts eller inte.
outputType	AnalyzeTextOutputType	FourSeverityLevels	Detta refererar till typen av textanalysutdata. Om inget värde tilldelas blir standardvärdet "FourSeverityLevels".
text	string		Texten som ska analyseras. Vi stöder högst 10 000 Unicode-tecken (Unicode-kodpunkter) i texten i en begäran.

AnalyzeTextOutputType

Detta refererar till typen av textanalysutdata. Om inget värde tilldelas blir standardvärdet "FourSeverityLevels".

Name	Typ	Description
EightSeverityLevels	string	Utdata allvarlighetsgrad i åtta nivåer, kan värdet vara 0,1,2,3,4,5,6,7.
FourSeverityLevels	string	Utdata allvarlighetsgrad i fyra nivåer, kan värdet vara 0,2,4,6.

AnalyzeTextResult

Textanalyssvaret.

Name	Typ	Description
blocklistsMatch	TextBlocklistMatch[]	Blocklisten matchar information.
categoriesAnalysis	TextCategoriesAnalysis[]	Analysresultat för kategorier.

Azure.Core.Foundations.Error

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	Azure.Core.Foundations.Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

Azure.Core.Foundations.ErrorResponse

Ett svar som innehåller felinformation.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Felobjektet.

Azure.Core.Foundations.InnerError

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	Azure.Core.Foundations.InnerError	Inre fel.

TextBlocklistMatch

Resultatet av blocklistmatchning.

Name	Typ	Description
blocklistItemId	string	ID för det matchade objektet.
blocklistItemText	string	Innehållet i det matchade objektet.
blocklistName	string	Namnet på den matchade blocklistan.

TextCategoriesAnalysis

Textanalysresultat.

Name	Typ	Description
category	TextCategory	Textanalyskategorin.
severity	integer	Värdet ökar med allvarlighetsgraden för indatainnehållet. Värdet för det här fältet bestäms av den utdatatyp som anges i begäran. Utdatatypen kan vara "FourSeverityLevels" eller "EightSeverity Levels", och utdatavärdet kan vara 0, 2, 4, 6 eller 0, 1, 2, 3, 4, 5, 6 eller 7.

TextCategory

Skadekategorin som stöds i textinnehållsanalys.

Name	Typ	Description
Hate	string	Skadekategorin för Text - Hate.
SelfHarm	string	Skadekategorin för Text – SelfHarm.
Sexual	string	Skadekategorin för Text - Sexuell.
Violence	string	Skadekategorin för Text - Våld.

Dela via

Text Operations - Analyze Text

URI-parametrar

Begärandetext

Svar

Säkerhet

Ocp-Apim-Subscription-Key

OAuth2Auth

Omfattningar

Exempel

Analyze Text

Exempelbegäran

Exempelsvar

Definitioner

AnalyzeTextOptions

AnalyzeTextOutputType

AnalyzeTextResult

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

TextBlocklistMatch

TextCategoriesAnalysis

TextCategory

Ytterligare resurser