Image Operations - Analyze Image

Szolgáltatás:: Azure AI Services

API verzió:: 2024-09-01

Analyze Image
Szinkron API a potenciálisan káros képtartalmak elemzéséhez. Jelenleg négy kategóriát támogat: a gyűlöletet, az önkontrasztot, a szexuális és az erőszakot.

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

URI paraméterek

Név	Ban	Szükséges	Típus	Leírás
endpoint	path	True	string (uri)	Támogatott Cognitive Services-végpontok (protokoll és állomásnév, például: https://< resource-name.cognitiveservices.azure.com>).
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Kérő Testület

Név	Szükséges	Típus	Leírás
image	True	ImageData	Az elemezni kívánt kép.
categories		ImageCategory[]	A rendszer elemzi a kategóriákat. Ha nincsenek hozzárendelve, a rendszer a kategóriák alapértelmezett elemzési eredményeit adja vissza.
outputType		AnalyzeImageOutputType	Ez a képelemzési kimenet típusára vonatkozik. Ha nincs hozzárendelve érték, az alapértelmezett érték a "FourSeverityLevels" lesz.

Válaszok

Név	Típus	Leírás
200 OK	AnalyzeImageResult	A kérés sikeres volt.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Váratlan hibaválasz. Fejlécek x-ms-error-code: string

Név

Típus

Leírás

200 OK

AnalyzeImageResult

A kérés sikeres volt.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Váratlan hibaválasz.

Fejlécek

x-ms-error-code: string

Biztonság

Ocp-Apim-Subscription-Key

Típus: apiKey
Ban: header

OAuth2Auth

Típus: oauth2
Flow: application
Token URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Hatókörök

Név	Leírás
https://cognitiveservices.azure.com/.default

Példák

Analyze Image

Mintakérés

HTTP

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

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

Mintaválasz

Állapotkód:: 200

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

Meghatározások

Név	Leírás
AnalyzeImageOptions	A képelemzési kérelem.
AnalyzeImageOutputType	Ez a képelemzési kimenet típusára vonatkozik. Ha nincs hozzárendelve érték, az alapértelmezett érték a "FourSeverityLevels" lesz.
AnalyzeImageResult	A képelemzési válasz.
Azure.Core.Foundations.Error	A hibaobjektum.
Azure.Core.Foundations.ErrorResponse	Hibaadatokat tartalmazó válasz.
Azure.Core.Foundations.InnerError	Egy objektum, amely részletesebb információkat tartalmaz a hibáról. Az Azure REST API irányelvei szerint – https://aka.ms/AzureRestApiGuidelines#handling-errors.
ImageCategoriesAnalysis	Képelemzés eredménye.
ImageCategory	A képtartalom-elemzésben támogatott kárkategória.
ImageData	A kép lehet base64 kódolású bájt vagy blob URL-cím. Ezek közül csak egyet választhat. Ha mindkettő meg van adva, a kérelem elutasításra kerül. A maximális képméret 2048 x 2048 képpont, és nem haladhatja meg a 4 MB-ot, míg a minimális képméret 50 x 50 képpont.

AnalyzeImageOptions

Tárgy

A képelemzési kérelem.

Név	Típus	Alapértelmezett érték	Leírás
categories	ImageCategory[]		A rendszer elemzi a kategóriákat. Ha nincsenek hozzárendelve, a rendszer a kategóriák alapértelmezett elemzési eredményeit adja vissza.
image	ImageData		Az elemezni kívánt kép.
outputType	AnalyzeImageOutputType	FourSeverityLevels	Ez a képelemzési kimenet típusára vonatkozik. Ha nincs hozzárendelve érték, az alapértelmezett érték a "FourSeverityLevels" lesz.

AnalyzeImageOutputType

Felsorolás

Ez a képelemzési kimenet típusára vonatkozik. Ha nincs hozzárendelve érték, az alapértelmezett érték a "FourSeverityLevels" lesz.

Érték	Leírás
FourSeverityLevels	A kimenet súlyossága négy szinten 0,2,4,6 lehet.

AnalyzeImageResult

Tárgy

A képelemzési válasz.

Név	Típus	Leírás
categoriesAnalysis	ImageCategoriesAnalysis[]	Kategóriák elemzési eredménye.

Azure.Core.Foundations.Error

Tárgy

A hibaobjektum.

Név	Típus	Leírás
code	string	A kiszolgáló által definiált hibakódok egyike.
details	Azure.Core.Foundations.Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	Azure.Core.Foundations.InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba ember által olvasható ábrázolása.
target	string	A hiba célja.

Azure.Core.Foundations.ErrorResponse

Tárgy

Hibaadatokat tartalmazó válasz.

Név	Típus	Leírás
error	Azure.Core.Foundations.Error	A hibaobjektum.

Azure.Core.Foundations.InnerError

Tárgy

Egy objektum, amely részletesebb információkat tartalmaz a hibáról. Az Azure REST API irányelvei szerint – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Név	Típus	Leírás
code	string	A kiszolgáló által definiált hibakódok egyike.
innererror	Azure.Core.Foundations.InnerError	Belső hiba.

ImageCategoriesAnalysis

Tárgy

Képelemzés eredménye.

Név	Típus	Leírás
category	ImageCategory	A képelemzési kategória.
severity	integer (int32)	Az érték a bemeneti tartalom súlyosságával nő. A mező értékét a kérelemben megadott kimeneti típus határozza meg. A kimeneti típus lehet "FourSeverityLevels", a kimeneti érték pedig 0, 2, 4, 6 lehet.

ImageCategory

Felsorolás

A képtartalom-elemzésben támogatott kárkategória.

Érték	Leírás
Hate	A kép ártalom kategóriája – Gyűlölet.
SelfHarm	A Kép – SelfHarm kárkategória.
Sexual	A kép ártalmak kategóriája - Szexuális.
Violence	A kép ártalom kategóriája – Erőszak.

ImageData

Tárgy

A kép lehet base64 kódolású bájt vagy blob URL-cím. Ezek közül csak egyet választhat. Ha mindkettő meg van adva, a kérelem elutasításra kerül. A maximális képméret 2048 x 2048 képpont, és nem haladhatja meg a 4 MB-ot, míg a minimális képméret 50 x 50 képpont.

Név	Típus	Leírás
blobUrl	string (uri)	A kép blob URL-címe.
content	string (byte)	A kép Base64-kódolása.