Image Operations - Analyze Image

Service:

Azure AI Services

API-versie:

2024-09-01

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

POST {endpoint}/contentsafety/image: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
image	True	ImageData	De afbeelding die moet worden geanalyseerd.
categories		ImageCategory[]	De categorieën worden geanalyseerd. Als ze niet zijn toegewezen, wordt er een standaardset met analyseresultaten voor de categorieën geretourneerd.
outputType		AnalyzeImageOutputType	Dit verwijst naar het type uitvoer van een afbeeldingsanalyse. Als er geen waarde is toegewezen, is de standaardwaarde 'FourSeverityLevels'.

Antwoorden

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

Voorbeeldaanvraag

HTTP

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

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

Voorbeeldrespons

Statuscode:

200

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

Definities

Name	Description
AnalyzeImageOptions	De aanvraag voor afbeeldingsanalyse.
AnalyzeImageOutputType	Dit verwijst naar het type uitvoer van een afbeeldingsanalyse. Als er geen waarde is toegewezen, is de standaardwaarde 'FourSeverityLevels'.
AnalyzeImageResult	Het antwoord van de afbeeldingsanalyse.
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.
ImageCategoriesAnalysis	Resultaat van afbeeldingsanalyse.
ImageCategory	De categorie schade die wordt ondersteund in afbeeldingsinhoudsanalyse.
ImageData	De afbeelding kan base64 gecodeerde bytes of een blob-URL zijn. U kunt slechts één van deze opties kiezen. Als beide worden verstrekt, wordt het verzoek geweigerd. De maximale afbeeldingsgrootte is 2048 x 2048 pixels en mag niet groter zijn dan 4 MB, terwijl de minimale afbeeldingsgrootte 50 x 50 pixels is.

AnalyzeImageOptions

De aanvraag voor afbeeldingsanalyse.

Name	Type	Default value	Description
categories	ImageCategory[]		De categorieën worden geanalyseerd. Als ze niet zijn toegewezen, wordt er een standaardset met analyseresultaten voor de categorieën geretourneerd.
image	ImageData		De afbeelding die moet worden geanalyseerd.
outputType	AnalyzeImageOutputType	FourSeverityLevels	Dit verwijst naar het type uitvoer van een afbeeldingsanalyse. Als er geen waarde is toegewezen, is de standaardwaarde 'FourSeverityLevels'.

AnalyzeImageOutputType

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

Name	Type	Description
FourSeverityLevels	string	De uitvoer ernst in vier niveaus kan 0,2,4,6 zijn.

AnalyzeImageResult

Het antwoord van de afbeeldingsanalyse.

Name	Type	Description
categoriesAnalysis	ImageCategoriesAnalysis[]	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.

ImageCategoriesAnalysis

Resultaat van afbeeldingsanalyse.

Name	Type	Description
category	ImageCategory	De categorie afbeeldingsanalyse.
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 zijn en de uitvoerwaarde kan 0, 2, 4, 6 zijn.

ImageCategory

De categorie schade die wordt ondersteund in afbeeldingsinhoudsanalyse.

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

ImageData

De afbeelding kan base64 gecodeerde bytes of een blob-URL zijn. U kunt slechts één van deze opties kiezen. Als beide worden verstrekt, wordt het verzoek geweigerd. De maximale afbeeldingsgrootte is 2048 x 2048 pixels en mag niet groter zijn dan 4 MB, terwijl de minimale afbeeldingsgrootte 50 x 50 pixels is.

Name	Type	Description
blobUrl	string	De blob-URL van de afbeelding.
content	string	De Base64-codering van de installatiekopieën.