Image Operations - Analyze Image

Referenz

Dienst:: Azure AI Services

API-Version:: 2023-10-01

Bild analysieren
Eine synchrone API für die Analyse potenziell schädlicher Bildinhalte. Derzeit unterstützt es vier Kategorien: Hass, SelfHarm, Sexual und Gewalt.

POST {endpoint}/contentsafety/image:analyze?api-version=2023-10-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B.: https://.cognitiveservices.azure.com).
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
image	True	ImageData	Das zu analysierende Bild.
categories		ImageCategory[]	Die Kategorien werden analysiert. Wenn sie nicht zugewiesen sind, wird ein Standardsatz von Analyseergebnissen für die Kategorien zurückgegeben.
outputType		AnalyzeImageOutputType	Dies bezieht sich auf den Typ der Bildanalyseausgabe. Wenn kein Wert zugewiesen ist, lautet der Standardwert "FourSeverityLevels".

Antworten

Name	Typ	Beschreibung
200 OK	AnalyzeImageResult	Die Anforderung ist erfolgreich.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

AnalyzeImageResult

Die Anforderung ist erfolgreich.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Unerwartete Fehlerantwort.

Header

x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

OAuth2Auth

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

Bereiche

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

Beispiele

Analyze Image

Beispielanforderung

HTTP

POST {endpoint}/contentsafety/image:analyze?api-version=2023-10-01

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

Beispiel für eine Antwort

Statuscode:: 200

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

Definitionen

Name	Beschreibung
AnalyzeImageOptions	Die Anforderung für die Bildanalyse.
AnalyzeImageOutputType	Dies bezieht sich auf den Typ der Bildanalyseausgabe. Wenn kein Wert zugewiesen ist, lautet der Standardwert "FourSeverityLevels".
AnalyzeImageResult	Die Antwort der Bildanalyse.
Azure.Core.Foundations.Error	Das Fehlerobjekt.
Azure.Core.Foundations.ErrorResponse	Eine Antwort, die Fehlerdetails enthält.
Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ImageCategoriesAnalysis	Ergebnis der Bildanalyse.
ImageCategory	Die in der Bildinhaltsanalyse unterstützte Schadenkategorie.
ImageData	Das Bild kann entweder base64-codierte Bytes oder eine BLOB-URL sein. Sie können nur eine dieser Optionen auswählen. Wenn beides angegeben wird, wird der Antrag abgelehnt. Die maximale Bildgröße beträgt 2048 x 2048 Pixel und darf 4 MB nicht überschreiten, während die Mindestbildgröße 50 x 50 Pixel beträgt.

AnalyzeImageOptions

Die Anforderung für die Bildanalyse.

Name	Typ	Standardwert	Beschreibung
categories	ImageCategory[]		Die Kategorien werden analysiert. Wenn sie nicht zugewiesen sind, wird ein Standardsatz von Analyseergebnissen für die Kategorien zurückgegeben.
image	ImageData		Das zu analysierende Bild.
outputType	AnalyzeImageOutputType	FourSeverityLevels	Dies bezieht sich auf den Typ der Bildanalyseausgabe. Wenn kein Wert zugewiesen ist, lautet der Standardwert "FourSeverityLevels".

AnalyzeImageOutputType

Dies bezieht sich auf den Typ der Bildanalyseausgabe. Wenn kein Wert zugewiesen ist, lautet der Standardwert "FourSeverityLevels".

Name	Typ	Beschreibung
FourSeverityLevels	string	Ausgabeschweregrade in vier Ebenen, der Wert könnte 0,2,4,6 sein.

AnalyzeImageResult

Die Antwort der Bildanalyse.

Name	Typ	Beschreibung
categoriesAnalysis	ImageCategoriesAnalysis[]	Analyseergebnis für Kategorien.

Azure.Core.Foundations.Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	Azure.Core.Foundations.Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

Azure.Core.Foundations.ErrorResponse

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	Azure.Core.Foundations.Error	Das Fehlerobjekt.

Azure.Core.Foundations.InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	Azure.Core.Foundations.InnerError	Innerer Fehler.

ImageCategoriesAnalysis

Ergebnis der Bildanalyse.

Name	Typ	Beschreibung
category	ImageCategory	Die Kategorie "Bildanalyse".
severity	integer	Der Wert steigt mit dem Schweregrad des Eingabeinhalts. Der Wert dieses Felds wird durch den in der Anforderung angegebenen Ausgabetyp bestimmt. Der Ausgabetyp kann "FourSeverityLevels" sein, und der Ausgabewert kann 0, 2, 4, 6 sein.

ImageCategory

Die in der Bildinhaltsanalyse unterstützte Schadenkategorie.

Name	Typ	Beschreibung
Hate	string	Die Kategorie "Schaden" für "Bild - Hass".
SelfHarm	string	Die Schadenkategorie für Bild - SelfHarm.
Sexual	string	Die Schadenskategorie für Bild - Sexual.
Violence	string	Die Schadenkategorie für Bild - Gewalt.

ImageData

Das Bild kann entweder base64-codierte Bytes oder eine BLOB-URL sein. Sie können nur eine dieser Optionen auswählen. Wenn beides angegeben wird, wird der Antrag abgelehnt. Die maximale Bildgröße beträgt 2048 x 2048 Pixel und darf 4 MB nicht überschreiten, während die Mindestbildgröße 50 x 50 Pixel beträgt.

Name	Typ	Beschreibung
blobUrl	string	Die BLOB-URL des Bilds.
content	string	Die Base64-Codierung des Bilds.

Freigeben über

Image Operations - Analyze Image

URI-Parameter

Anforderungstext

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

OAuth2Auth

Bereiche

Beispiele

Analyze Image

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AnalyzeImageOptions

AnalyzeImageOutputType

AnalyzeImageResult

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

ImageCategoriesAnalysis

ImageCategory

ImageData

Zusätzliche Ressourcen