Image Operations - Analyze Image

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: 2023-10-01

Analizowanie obrazu
Synchroniczny interfejs API do analizy potencjalnie szkodliwej zawartości obrazu. Obecnie obsługuje cztery kategorie: Nienawiść, SelfHarm, Seks i Przemoc.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://.cognitiveservices.azure.com).
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
image	True	ImageData	Obraz do przeanalizowania.
categories		ImageCategory[]	Kategorie zostaną przeanalizowane. Jeśli nie zostaną przypisane, zostanie zwrócony domyślny zestaw wyników analizy dla kategorii.
outputType		AnalyzeImageOutputType	Odnosi się to do typu danych wyjściowych analizy obrazów. Jeśli żadna wartość nie zostanie przypisana, wartość domyślna będzie mieć wartość "FourSeverityLevels".

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AnalyzeImageResult	Żądanie zakończyło się pomyślnie.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Nazwa

Typ

Opis

200 OK

AnalyzeImageResult

Żądanie zakończyło się pomyślnie.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Nagłówki

x-ms-error-code: string

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

OAuth2Auth

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

Zakresy

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

Analyze Image

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:: 200

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

Definicje

Nazwa	Opis
AnalyzeImageOptions	Żądanie analizy obrazu.
AnalyzeImageOutputType	Odnosi się to do typu danych wyjściowych analizy obrazów. Jeśli żadna wartość nie zostanie przypisana, wartość domyślna będzie mieć wartość "FourSeverityLevels".
AnalyzeImageResult	Odpowiedź na analizę obrazu.
Azure.Core.Foundations.Error	Obiekt błędu.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegóły błędu.
Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ImageCategoriesAnalysis	Wynik analizy obrazu.
ImageCategory	Kategoria szkody obsługiwana w analizie zawartości obrazu.
ImageData	Obraz może być zakodowany w formacie base64 bajtami lub adresem URL obiektu blob. Możesz wybrać tylko jedną z tych opcji. Jeśli oba te elementy zostaną podane, żądanie zostanie odrzucone. Maksymalny rozmiar obrazu to 2048 x 2048 pikseli i nie powinien przekraczać 4 MB, podczas gdy minimalny rozmiar obrazu to 50 x 50 pikseli.

AnalyzeImageOptions

Żądanie analizy obrazu.

Nazwa	Typ	Domyślna wartość	Opis
categories	ImageCategory[]		Kategorie zostaną przeanalizowane. Jeśli nie zostaną przypisane, zostanie zwrócony domyślny zestaw wyników analizy dla kategorii.
image	ImageData		Obraz do przeanalizowania.
outputType	AnalyzeImageOutputType	FourSeverityLevels	Odnosi się to do typu danych wyjściowych analizy obrazów. Jeśli żadna wartość nie zostanie przypisana, wartość domyślna będzie mieć wartość "FourSeverityLevels".

AnalyzeImageOutputType

Odnosi się to do typu danych wyjściowych analizy obrazów. Jeśli żadna wartość nie zostanie przypisana, wartość domyślna będzie mieć wartość "FourSeverityLevels".

Nazwa	Typ	Opis
FourSeverityLevels	string	Ważność danych wyjściowych na czterech poziomach, wartość może wynosić 0,2,4,6.

AnalyzeImageResult

Odpowiedź na analizę obrazu.

Nazwa	Typ	Opis
categoriesAnalysis	ImageCategoriesAnalysis[]	Wynik analizy dla kategorii.

Azure.Core.Foundations.Error

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

Azure.Core.Foundations.ErrorResponse

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	Azure.Core.Foundations.Error	Obiekt błędu.

Azure.Core.Foundations.InnerError

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	Azure.Core.Foundations.InnerError	Błąd wewnętrzny.

ImageCategoriesAnalysis

Wynik analizy obrazu.

Nazwa	Typ	Opis
category	ImageCategory	Kategoria analiza obrazów.
severity	integer	Wartość zwiększa się wraz z ważnością zawartości wejściowej. Wartość tego pola jest określana przez typ danych wyjściowych określony w żądaniu. Typ danych wyjściowych może mieć wartość "FourSeverityLevels", a wartość wyjściowa może wynosić 0, 2, 4, 6.

ImageCategory

Kategoria szkody obsługiwana w analizie zawartości obrazu.

Nazwa	Typ	Opis
Hate	string	Kategoria szkody dla Obrazu - Nienawiść.
SelfHarm	string	Kategoria szkody dla obrazu — SelfHarm.
Sexual	string	Kategoria szkody dla Obrazu - Seksualne.
Violence	string	Kategoria szkody dla Obrazu - Przemoc.

ImageData

Obraz może być zakodowany w formacie base64 bajtami lub adresem URL obiektu blob. Możesz wybrać tylko jedną z tych opcji. Jeśli oba te elementy zostaną podane, żądanie zostanie odrzucone. Maksymalny rozmiar obrazu to 2048 x 2048 pikseli i nie powinien przekraczać 4 MB, podczas gdy minimalny rozmiar obrazu to 50 x 50 pikseli.

Nazwa	Typ	Opis
blobUrl	string	Adres URL obiektu blob obrazu.
content	string	Kodowanie obrazu Base64.

Udostępnij za pośrednictwem

Image Operations - Analyze Image

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

Ocp-Apim-Subscription-Key

OAuth2Auth

Zakresy

Przykłady

Analyze Image

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AnalyzeImageOptions

AnalyzeImageOutputType

AnalyzeImageResult

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

ImageCategoriesAnalysis

ImageCategory

ImageData

Dodatkowe zasoby