Image Operations - Analyze Image

Layanan:

Azure AI Services

Versi API:

2024-09-01

Analisis Gambar
API sinkron untuk analisis konten gambar yang berpotensi berbahaya. Saat ini, mendukung empat kategori: Hate, SelfHarm, Sexual, dan Violence.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string	Titik akhir Cognitive Services yang didukung (protokol dan nama host, misalnya: https://.cognitiveservices.azure.com).
api-version	query	True	string	Versi API yang akan digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
image	True	ImageData	Gambar yang akan dianalisis.
categories		ImageCategory[]	Kategori akan dianalisis. Jika tidak ditetapkan, serangkaian hasil analisis default untuk kategori akan dikembalikan.
outputType		AnalyzeImageOutputType	Ini mengacu pada jenis output analisis gambar. Jika tidak ada nilai yang ditetapkan, nilai defaultnya adalah "FourSeverityLevels".

Respons

Nama	Jenis	Deskripsi
200 OK	AnalyzeImageResult	Permintaan telah berhasil.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Respons kesalahan tak terduga. Header x-ms-error-code: string

Keamanan

Ocp-Apim-Subscription-Key

Jenis: apiKey
Dalam: header

OAuth2Auth

Jenis: oauth2
Alur: application
URL token: https://login.microsoftonline.com/common/oauth2/v2.0/token

Cakupan

Nama	Deskripsi
https://cognitiveservices.azure.com/.default

Contoh

Analyze Image

Permintaan sampel

HTTP

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

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

Respon sampel

Kode status:

200

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

Definisi

Nama	Deskripsi
AnalyzeImageOptions	Permintaan analisis gambar.
AnalyzeImageOutputType	Ini mengacu pada jenis output analisis gambar. Jika tidak ada nilai yang ditetapkan, nilai defaultnya adalah "FourSeverityLevels".
AnalyzeImageResult	Respons analisis gambar.
Azure.Core.Foundations.Error	Objek kesalahan.
Azure.Core.Foundations.ErrorResponse	Respons yang berisi detail kesalahan.
Azure.Core.Foundations.InnerError	Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ImageCategoriesAnalysis	Hasil analisis gambar.
ImageCategory	Kategori bahaya yang didukung dalam Analisis konten gambar.
ImageData	Gambar dapat berupa byte yang dikodekan base64 atau URL blob. Anda hanya dapat memilih salah satu opsi ini. Jika keduanya disediakan, permintaan akan ditolak. Ukuran gambar maksimum adalah 2048 x 2048 piksel dan tidak boleh melebihi 4 MB, sedangkan ukuran gambar minimum adalah 50 x 50 piksel.

AnalyzeImageOptions

Permintaan analisis gambar.

Nama	Jenis	Nilai default	Deskripsi
categories	ImageCategory[]		Kategori akan dianalisis. Jika tidak ditetapkan, serangkaian hasil analisis default untuk kategori akan dikembalikan.
image	ImageData		Gambar yang akan dianalisis.
outputType	AnalyzeImageOutputType	FourSeverityLevels	Ini mengacu pada jenis output analisis gambar. Jika tidak ada nilai yang ditetapkan, nilai defaultnya adalah "FourSeverityLevels".

AnalyzeImageOutputType

Ini mengacu pada jenis output analisis gambar. Jika tidak ada nilai yang ditetapkan, nilai defaultnya adalah "FourSeverityLevels".

Nama	Jenis	Deskripsi
FourSeverityLevels	string	Tingkat keparahan output dalam empat tingkat, nilainya bisa 0,2,4,6.

AnalyzeImageResult

Respons analisis gambar.

Nama	Jenis	Deskripsi
categoriesAnalysis	ImageCategoriesAnalysis[]	Hasil analisis untuk kategori.

Azure.Core.Foundations.Error

Objek kesalahan.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
details	Azure.Core.Foundations.Error[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innererror	Azure.Core.Foundations.InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.
target	string	Target kesalahan.

Azure.Core.Foundations.ErrorResponse

Respons yang berisi detail kesalahan.

Nama	Jenis	Deskripsi
error	Azure.Core.Foundations.Error	Objek kesalahan.

Azure.Core.Foundations.InnerError

Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
innererror	Azure.Core.Foundations.InnerError	Kesalahan dalam.

ImageCategoriesAnalysis

Hasil analisis gambar.

Nama	Jenis	Deskripsi
category	ImageCategory	Kategori analisis gambar.
severity	integer	Nilai meningkat dengan tingkat keparahan konten input. Nilai bidang ini ditentukan oleh jenis output yang ditentukan dalam permintaan. Jenis output bisa menjadi 'FourSeverityLevels', dan nilai outputnya bisa 0, 2, 4, 6.

ImageCategory

Kategori bahaya yang didukung dalam Analisis konten gambar.

Nama	Jenis	Deskripsi
Hate	string	Kategori bahaya untuk Gambar - Kebencian.
SelfHarm	string	Kategori bahaya untuk Gambar - SelfHarm.
Sexual	string	Kategori bahaya untuk Gambar - Seksual.
Violence	string	Kategori bahaya untuk Gambar - Kekerasan.

ImageData

Gambar dapat berupa byte yang dikodekan base64 atau URL blob. Anda hanya dapat memilih salah satu opsi ini. Jika keduanya disediakan, permintaan akan ditolak. Ukuran gambar maksimum adalah 2048 x 2048 piksel dan tidak boleh melebihi 4 MB, sedangkan ukuran gambar minimum adalah 50 x 50 piksel.

Nama	Jenis	Deskripsi
blobUrl	string	Url blob gambar.
content	string	Pengodean gambar Base64.