Image Operations - Analyze Image

Tjänst:

Azure AI Services

API-versionen:

2024-09-01

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

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

URI-parametrar

Namn	I	Krävs	Typ	Beskrivning
endpoint	path	True	string (uri)	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://< resource-name.cognitiveservices.azure.com>).
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Begäranarorgan

Namn	Krävs	Typ	Beskrivning
image	True	ImageData	Bilden som ska analyseras.
categories		ImageCategory[]	Kategorierna analyseras. Om de inte tilldelas returneras en standarduppsättning med analysresultat för kategorierna.
outputType		AnalyzeImageOutputType	Detta refererar till typen av bildanalysutdata. Om inget värde tilldelas blir standardvärdet "FourSeverityLevels".

Svaren

Namn	Typ	Beskrivning
200 OK	AnalyzeImageResult	Begäran har slutförts.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Ett oväntat felsvar. Headers x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

OAuth2Auth

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

Scope

Namn	Beskrivning
https://cognitiveservices.azure.com/.default

Exempel

Analyze Image

Exempelförfrågan

HTTP

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

{
  "image": {
    "content": "Y29udGVudDE="
  }
}

Exempelsvar

Statuskod:

200

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

Definitioner

Namn	Beskrivning
AnalyzeImageOptions	Begäran om bildanalys.
AnalyzeImageOutputType	Detta refererar till typen av bildanalysutdata. Om inget värde tilldelas blir standardvärdet "FourSeverityLevels".
AnalyzeImageResult	Bildanalyssvaret.
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 Azure REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors.
ImageCategoriesAnalysis	Bildanalysresultat.
ImageCategory	Skadekategorin som stöds i bildinnehållsanalys.
ImageData	Avbildningen kan vara antingen base64-kodade byte eller en blob-URL. Du kan bara välja ett av dessa alternativ. Om båda tillhandahålls avvisas begäran. Den maximala bildstorleken är 2 048 x 2 048 bildpunkter och får inte överstiga 4 MB, medan den minsta bildstorleken är 50 x 50 bildpunkter.

AnalyzeImageOptions

Objekt

Begäran om bildanalys.

Namn	Typ	Standardvärde	Beskrivning
categories	ImageCategory[]		Kategorierna analyseras. Om de inte tilldelas returneras en standarduppsättning med analysresultat för kategorierna.
image	ImageData		Bilden som ska analyseras.
outputType	AnalyzeImageOutputType	FourSeverityLevels	Detta refererar till typen av bildanalysutdata. Om inget värde tilldelas blir standardvärdet "FourSeverityLevels".

AnalyzeImageOutputType

Uppräkning

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

Värde	Beskrivning
FourSeverityLevels	Utdata allvarlighetsgrad i fyra nivåer, kan värdet vara 0,2,4,6.

AnalyzeImageResult

Objekt

Bildanalyssvaret.

Namn	Typ	Beskrivning
categoriesAnalysis	ImageCategoriesAnalysis[]	Analysresultat för kategorier.

Azure.Core.Foundations.Error

Objekt

Felobjektet.

Namn	Typ	Beskrivning
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

Objekt

Ett svar som innehåller felinformation.

Namn	Typ	Beskrivning
error	Azure.Core.Foundations.Error	Felobjektet.

Azure.Core.Foundations.InnerError

Objekt

Ett objekt som innehåller mer specifik information om felet. Enligt riktlinjerna för Azure REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors.

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

ImageCategoriesAnalysis

Objekt

Bildanalysresultat.

Namn	Typ	Beskrivning
category	ImageCategory	Bildanalyskategorin.
severity	integer (int32)	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", och utdatavärdet kan vara 0, 2, 4, 6.

ImageCategory

Uppräkning

Skadekategorin som stöds i bildinnehållsanalys.

Värde	Beskrivning
Hate	Skadekategorin för Image - Hate.
SelfHarm	Skadekategorin för Image – SelfHarm.
Sexual	Skadekategorin för Image - Sexual.
Violence	Skadekategorin för Image - Violence.

ImageData

Objekt

Avbildningen kan vara antingen base64-kodade byte eller en blob-URL. Du kan bara välja ett av dessa alternativ. Om båda tillhandahålls avvisas begäran. Den maximala bildstorleken är 2 048 x 2 048 bildpunkter och får inte överstiga 4 MB, medan den minsta bildstorleken är 50 x 50 bildpunkter.

Namn	Typ	Beskrivning
blobUrl	string (uri)	Bildens blob-URL.
content	string (byte)	Base64-kodningen för avbildningen.