Describe Image - Describe Image

Layanan:

Azure AI Services

Versi API:

3.1

Operasi ini menghasilkan deskripsi gambar dalam bahasa yang dapat dibaca manusia dengan kalimat lengkap. Deskripsi didasarkan pada kumpulan tag konten, yang juga dikembalikan oleh operasi. Lebih dari satu deskripsi dapat dibuat untuk setiap gambar. Deskripsi diurutkan berdasarkan skor kepercayaan mereka. Deskripsi dapat mencakup hasil dari model domain selebriti dan landmark, jika berlaku. Dua metode input didukung -- (1) Mengunggah gambar atau (2) yang menentukan URL gambar. Respons yang berhasil akan dikembalikan di JSON. Jika permintaan gagal, respons akan berisi kode kesalahan dan pesan untuk membantu memahami apa yang salah.

POST {Endpoint}/vision/v3.1/describe

Dengan parameter opsional:

POST {Endpoint}/vision/v3.1/describe?maxCandidates={maxCandidates}&language={language}&descriptionExclude={descriptionExclude}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
Endpoint	path	True	string	Titik akhir Cognitive Services yang didukung.
descriptionExclude	query		DescriptionExclude[]	Nonaktifkan model domain tertentu saat membuat deskripsi.
language	query		string	Bahasa yang diinginkan untuk pembuatan output. Jika parameter ini tidak ditentukan, nilai defaultnya adalah "en". Bahasa yang didukung:en - Bahasa Inggris, Default. es - Spanyol, ja - Jepang, pt - Portugis, zh - Cina Sederhana.
maxCandidates	query		integer (int32)	Jumlah maksimum deskripsi kandidat yang akan dikembalikan. Defaultnya adalah 1.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
Ocp-Apim-Subscription-Key	True	string

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
url	True	string	URL gambar yang dapat dijangkau secara publik.

Respons

Nama	Jenis	Deskripsi
200 OK	ImageDescription	Objek deskripsi gambar.
Other Status Codes	ComputerVisionError	Respons kesalahan.

Keamanan

Ocp-Apim-Subscription-Key

Jenis: apiKey
Dalam: header

Contoh

Successful DescribeImage request

Permintaan sampel

HTTP

POST https://westus.api.cognitive.microsoft.com/vision/v3.1/describe?maxCandidates=1


{
  "url": "{url}"
}

Respon sampel

Kode status:

200

{
  "description": {
    "tags": [
      "person",
      "man",
      "outdoor",
      "window",
      "glasses"
    ],
    "captions": [
      {
        "text": "Satya Nadella sitting on a bench",
        "confidence": 0.48293603002174407
      },
      {
        "text": "Satya Nadella is sitting on a bench",
        "confidence": 0.4003700681542283
      },
      {
        "text": "Satya Nadella sitting in front of a building",
        "confidence": 0.38035155997373377
      }
    ]
  },
  "requestId": "ed2de1c6-fb55-4686-b0da-4da6e05d283f",
  "metadata": {
    "width": 1500,
    "height": 1000,
    "format": "Jpeg"
  }
}

Definisi

Nama	Deskripsi
ComputerVisionError	Detail tentang kesalahan permintaan API.
ComputerVisionErrorCodes	Kode kesalahan.
DescriptionExclude	Nonaktifkan model domain tertentu saat membuat deskripsi.
ImageCaption	Keterangan gambar, yaitu deskripsi singkat tentang apa yang digambarkan gambar.
ImageDescription	Kumpulan tag konten, bersama dengan daftar keterangan yang diurutkan berdasarkan tingkat keyakinan, dan metadata gambar.
ImageMetadata	Metadata gambar.
ImageUrl

ComputerVisionError

Objek

Detail tentang kesalahan permintaan API.

Nama	Jenis	Deskripsi
code	ComputerVisionErrorCodes	Kode kesalahan.
message	string	Pesan yang menjelaskan kesalahan yang dilaporkan oleh layanan.
requestId	string	Pengidentifikasi permintaan unik.

ComputerVisionErrorCodes

Enumeration

Kode kesalahan.

Nilai	Deskripsi
BadArgument
CancelledRequest
DetectFaceError
FailedToProcess
InternalServerError
InvalidDetails
InvalidImageFormat
InvalidImageSize
InvalidImageUrl
InvalidModel
InvalidThumbnailSize
NotSupportedFeature
NotSupportedImage
NotSupportedLanguage
NotSupportedVisualFeature
StorageException
Timeout
Unspecified
UnsupportedMediaType

DescriptionExclude

Enumeration

Nonaktifkan model domain tertentu saat membuat deskripsi.

Nilai	Deskripsi
Celebrities
Landmarks

ImageCaption

Objek

Keterangan gambar, yaitu deskripsi singkat tentang apa yang digambarkan gambar.

Nama	Jenis	Deskripsi
confidence	number (double)	Tingkat keyakinan yang dimiliki layanan dalam keterangan.
text	string	Teks keterangan.

ImageDescription

Objek

Kumpulan tag konten, bersama dengan daftar keterangan yang diurutkan berdasarkan tingkat keyakinan, dan metadata gambar.

Nama	Jenis	Deskripsi
description.captions	ImageCaption[]	Daftar keterangan, diurutkan menurut tingkat keyakinan.
description.tags	string[]	Kumpulan tag gambar.
metadata	ImageMetadata	Metadata gambar.
requestId	string	Id permintaan REST API.

ImageMetadata

Objek

Metadata gambar.

Nama	Jenis	Deskripsi
format	string	Format gambar.
height	integer (int32)	Tinggi gambar, dalam piksel.
width	integer (int32)	Lebar gambar, dalam piksel.

ImageUrl

Objek

Nama	Jenis	Deskripsi
url	string	URL gambar yang dapat dijangkau secara publik.