Image Operations - Analyze Image

Služba:

Azure AI Services

Verze rozhraní API:

2024-09-01

Analýza obrázku
Synchronní rozhraní API pro analýzu potenciálně škodlivého obsahu obrázků. V současné době podporuje čtyři kategorie: Nenávist, SelfHarm, Sexuální a Násilí.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://.cognitiveservices.azure.com).
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
image	True	ImageData	Obrázek, který se má analyzovat.
categories		ImageCategory[]	Kategorie budou analyzovány. Pokud nejsou přiřazené, vrátí se výchozí sada výsledků analýzy pro kategorie.
outputType		AnalyzeImageOutputType	To se týká typu výstupu analýzy obrázků. Pokud není přiřazena žádná hodnota, výchozí hodnota bude FourSeverityLevels.

Odpovědi

Name	Typ	Description
200 OK	AnalyzeImageResult	Požadavek byl úspěšný.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: application
URL tokenu: https://login.microsoftonline.com/common/oauth2/v2.0/token

Rozsahy

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

Příklady

Analyze Image

Ukázkový požadavek

HTTP

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

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

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
AnalyzeImageOptions	Požadavek na analýzu obrázků.
AnalyzeImageOutputType	To se týká typu výstupu analýzy obrázků. Pokud není přiřazena žádná hodnota, výchozí hodnota bude FourSeverityLevels.
AnalyzeImageResult	Odpověď na analýzu obrázků.
Azure.Core.Foundations.Error	Objekt chyby.
Azure.Core.Foundations.ErrorResponse	Odpověď obsahující podrobnosti o chybě.
Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ImageCategoriesAnalysis	Výsledek analýzy obrázků
ImageCategory	Kategorie poškození podporovaná v analýze obsahu obrázku.
ImageData	Obrázek může mít kódování base64 bajtů nebo adresu URL objektu blob. Můžete zvolit jenom jednu z těchto možností. Pokud je k dispozici obojí, žádost bude odmítnuta. Maximální velikost obrázku je 2048 × 2048 pixelů a neměla by překročit 4 MB, zatímco minimální velikost obrázku je 50 × 50 pixelů.

AnalyzeImageOptions

Požadavek na analýzu obrázků.

Name	Typ	Default value	Description
categories	ImageCategory[]		Kategorie budou analyzovány. Pokud nejsou přiřazené, vrátí se výchozí sada výsledků analýzy pro kategorie.
image	ImageData		Obrázek, který se má analyzovat.
outputType	AnalyzeImageOutputType	FourSeverityLevels	To se týká typu výstupu analýzy obrázků. Pokud není přiřazena žádná hodnota, výchozí hodnota bude FourSeverityLevels.

AnalyzeImageOutputType

To se týká typu výstupu analýzy obrázků. Pokud není přiřazena žádná hodnota, výchozí hodnota bude FourSeverityLevels.

Name	Typ	Description
FourSeverityLevels	string	Závažnosti výstupu ve čtyřech úrovních můžou být 0,2,4,6.

AnalyzeImageResult

Odpověď na analýzu obrázků.

Name	Typ	Description
categoriesAnalysis	ImageCategoriesAnalysis[]	Výsledek analýzy pro kategorie

Azure.Core.Foundations.Error

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	Azure.Core.Foundations.Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

Azure.Core.Foundations.ErrorResponse

Odpověď obsahující podrobnosti o chybě.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Objekt chyby.

Azure.Core.Foundations.InnerError

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
innererror	Azure.Core.Foundations.InnerError	Vnitřní chyba.

ImageCategoriesAnalysis

Výsledek analýzy obrázků

Name	Typ	Description
category	ImageCategory	Kategorie analýzy obrázků.
severity	integer	Hodnota se zvyšuje závažností vstupního obsahu. Hodnota tohoto pole je určena výstupním typem zadaným v požadavku. Typ výstupu může být FourSeverityLevels a výstupní hodnota může být 0, 2, 4, 6.

ImageCategory

Kategorie poškození podporovaná v analýze obsahu obrázku.

Name	Typ	Description
Hate	string	Kategorie škod pro Image - Hate.
SelfHarm	string	Kategorie škod pro Image - SelfHarm.
Sexual	string	Kategorie poškození obrázku - sexuální.
Violence	string	Kategorie škod pro Obrázek - Násilí.

ImageData

Obrázek může mít kódování base64 bajtů nebo adresu URL objektu blob. Můžete zvolit jenom jednu z těchto možností. Pokud je k dispozici obojí, žádost bude odmítnuta. Maximální velikost obrázku je 2048 × 2048 pixelů a neměla by překročit 4 MB, zatímco minimální velikost obrázku je 50 × 50 pixelů.

Name	Typ	Description
blobUrl	string	Adresa URL objektu blob obrázku.
content	string	Kódování Base64 image.