Image Operations - Analyze Image

Service:

Cognitive Services

API Version:

2023-04-30-preview

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

POST {endpoint}/contentsafety/image:analyze?api-version=2023-04-30-preview

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.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Text požadavku

Name	Vyžadováno	Typ	Description
image	True	ImageData	Obrázek je potřeba analyzovat.
categories		ImageCategory[]	Kategorie budou analyzovány. Pokud není přiřazeno, vrátí se výchozí sada výsledků analýzy kategorií.

Odpovědi

Name	Typ	Description
200 OK	AnalyzeImageResult	Žádost byla úspěšná.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Neočekávaná chybová odpověď. Headers x-ms-error-code: string

Zabezpečení

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Příklady

Analyze Image

Sample Request

HTTP

POST {endpoint}/contentsafety/image:analyze?api-version=2023-04-30-preview

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

Sample Response

Status code:

200

{
  "hateResult": {
    "category": "Hate",
    "severity": 0
  },
  "selfHarmResult": {
    "category": "Hate",
    "severity": 0
  },
  "sexualResult": {
    "category": "Hate",
    "severity": 0
  },
  "violenceResult": {
    "category": "Hate",
    "severity": 2
  }
}

Definice

Name	Description
AnalyzeImageOptions	Požadavek na analýzu obrázku.
AnalyzeImageResult	Odpověď obrázku na analýzu.
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í MICROSOFT One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ImageAnalyzeSeverityResult	Výsledek analýzy obrázků.
ImageCategory	Kategorie analýzy obrázků
ImageData	Obsah nebo adresa URL objektu blob obrázku můžou být bajty kódování Base64 nebo adresa URL objektu blob. Pokud jsou zadány obě, bude žádost odmítnuta. Maximální velikost obrázku je 2048 pixelů × 2048 pixelů, ne větší než 4 MB najednou. Minimální velikost obrázku je 50 pixelů × 50 pixelů.

AnalyzeImageOptions

Požadavek na analýzu obrázku.

Name	Typ	Description
categories	ImageCategory[]	Kategorie budou analyzovány. Pokud není přiřazeno, vrátí se výchozí sada výsledků analýzy kategorií.
image	ImageData	Obrázek je potřeba analyzovat.

AnalyzeImageResult

Odpověď obrázku na analýzu.

Name	Typ	Description
hateResult	ImageAnalyzeSeverityResult	Výsledek analýzy pro kategorii Nenávist.
selfHarmResult	ImageAnalyzeSeverityResult	Výsledek analýzy pro kategorii SelfHarm
sexualResult	ImageAnalyzeSeverityResult	Výsledek analýzy pro kategorii Sexuální.
violenceResult	ImageAnalyzeSeverityResult	Výsledek analýzy pro kategorii Násilí

Azure.Core.Foundations.Error

Objekt chyby.

Name	Typ	Description
code	string	Jeden ze serverem definovaných chybových kódů.
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 o chybě než aktuální objekt.
message	string	Lidsky čitelná reprezentace chyby.
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í MICROSOFT One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	string	Jeden ze serverem definovaných chybových kódů.
innererror	Azure.Core.Foundations.InnerError	Vnitřní chyba.

ImageAnalyzeSeverityResult

Výsledek analýzy obrázků.

Name	Typ	Description
category	ImageCategory	Kategorie image.
severity	integer	Čím vyšší je závažnost vstupního obsahu, tím větší je tato hodnota, v současné době může být její hodnota: 0,2,4,6.

ImageCategory

Kategorie analýzy obrázků

Name	Typ	Description
Hate	string
SelfHarm	string
Sexual	string
Violence	string

ImageData

Obsah nebo adresa URL objektu blob obrázku můžou být bajty kódování Base64 nebo adresa URL objektu blob. Pokud jsou zadány obě, bude žádost odmítnuta. Maximální velikost obrázku je 2048 pixelů × 2048 pixelů, ne větší než 4 MB najednou. Minimální velikost obrázku je 50 pixelů × 50 pixelů.

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