Image Operations - Analyze Image

Tjänst:

Azure AI Services

API-version:

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

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 minLength: 1	DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
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".

Svar

Name	Typ	Description
200 OK	AnalyzeImageResult	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 Image

Exempelbegäran

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

Name	Description
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 Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
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.

Name	Typ	Standardvärde	Description
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	Description
FourSeverityLevels	Utdata allvarlighetsgrad i fyra nivåer, kan värdet vara 0,2,4,6.

AnalyzeImageResult

Objekt

Bildanalyssvaret.

Name	Typ	Description
categoriesAnalysis	ImageCategoriesAnalysis[]	Analysresultat för kategorier.

Azure.Core.Foundations.Error

Objekt

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

Objekt

Ett svar som innehåller felinformation.

Name	Typ	Description
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 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.

ImageCategoriesAnalysis

Objekt

Bildanalysresultat.

Name	Typ	Description
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	Description
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.

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