Resim Arama REST API başvurusu

Bitiş noktası:POST https://api.microsoft.ai/v3/search/images

Örnek İstek:

curl -X POST "https://api.microsoft.ai/v3/search/images" \
  -H "host: api.microsoft.ai" \
  -H "x-apikey: <Your key>" \
  -H 'content-type: application/json' \
  -d '{
    "query": "cats",
    "maxResults": 2,
    "language": "en",
    "region": "US"
  }'

Parameters

Parametre Required Tür Default Description
query Yes string - Arama sorgusu dizesi. Uzunluk üst sınırı 1000 karakterdir.
maxResults No integer 30 Döndürülecek en fazla sonuç sayısı. Varsayılan değer 30, maksimum değer ise 30'dur.
language No string "en" Arama sonuçlarında arabirim dili için 2 harfli ISO 639-1 dil kodu. Tam liste için bkz . Desteklenen Diller .
region No string "US" Sonuçların nereden gelmesi gerektiği için 2 harfli bir ülke/bölge kodu (ör. "ABD", "JP", "CN"). Tam liste için bkz . Desteklenen Bölgeler .
aspectRatio No string(enum) - Görüntüleri en boy oranına göre filtreleyin. Değerler: "kare" (kabaca 1:1), "geniş" (genişlik > yüksekliği), "uzun" (yükseklik > genişliği). Ayarlanmadığında, filtreleme uygulanmaz.
color No string(enum) - Görüntüleri görüntü rengine göre filtreleyin. Değerler: "colorOnly" (yalnızca renkli görüntüler döndür), "tek renkli" (yalnızca siyah beyaz görüntüler döndürür). Ayarlanmadığında, filtreleme uygulanmaz.
safeSearch No string(enum) "katı" Güvenli arama filtreleme düzeyi. Değerler: "off", "strict". Varsayılan değer "katı"dır.
imageSize No string(enum) - Resimleri boyut kategorisine göre filtreleyin. Değerler: "small" (<200x200px), "medium" (width or height 200-500px), "large" (width or height >=500px), "extraLarge" (>1024x768px). Ayrıca özel sınırlar için piksel kısıtlamalarını (maxHeight, minHeight, maxWidth, minWidth) kullanabilir; piksel kısıtlamaları çakıştığında imageSize'a göre önceliklidir. Ayarlanmadığında, filtreleme uygulanmaz.
watermarkFree No boolean yanlış Filigranlı görüntüleri dışlama. Varsayılan değer false'tur.
maxHeight No integer - Piksel cinsinden en yüksek görüntü yüksekliği. Özel sınırlar için imageSize ile kullanılır.
minHeight No integer - Piksel cinsinden en düşük görüntü yüksekliği.
maxWidth No integer - Piksel cinsinden en fazla görüntü genişliği.
minWidth No integer - Piksel cinsinden en düşük görüntü genişliği.

İstek Üst Bilgileri

Field Tür Description
host string Microsoft AI API'leri için konak: api.microsoft.ai.
x-apikey veya Yetkilendirme string Kimlik doğrulaması için API anahtarınız veya Entra ID erişim belirteciniz.
içerik türü string İstek gövdesinin MIME türü. application/json adresini kullanın.

Response

ImagesResponse

Field Tür Description
imageResults ImageResult dizisi Görüntü sonuçlarının listesi.
instrumentationClickBase string Tıklama ping istekleri için temel URL. instrumentationSuffix Tam ping URL'sini oluşturmak için sonuç öğesinden bir değer ekleyin. Yalnızca EnableInstrumentationPing profil bayrağına sahip uygulamalar için sunulur. Not: Kullanıcı tıklamaları URL yeniden yönlendirmesi kullanılarak da günlüğe kaydedilebilir. Yeniden yönlendirme etkinleştirildiğinde, Kullanıcı tıklamalarını günlüğe kaydetmek için hiçbir eylem gerekmez ve instrumentationClickBase yanıta dahil edilmeyecektir. Kurulum yönergeleri için İzleme kılavuzuna bakın.
instrumentationCitationBase string LLM günlük ping istekleri için temel URL. Tam ping URL'sini oluşturmak için bir VERİ yükü ekleyin. Yalnızca EnableInstrumentationPing profil bayrağına sahip uygulamalar için sunulur.
traceId string Hata ayıklama ve izleme için izleme kimliği.

ImageResult

Field Tür Description
title string Resmin başlığı.
url string Görüntünün kaynak URL'si. URL yeniden yönlendirmesi etkinleştirilmiş Çin kullanıcıları için, bu alan bunun yerine ile aynı yeniden yönlendirme URL'sini clickUrliçerir.
domain string Sonucun hedef ana bilgisayarı. Yalnızca URL yeniden yönlendirmesi etkinleştirilmiş Çin kullanıcıları için döndürülür.
hostPageUrl string Görüntüyü barındıran web sayfasının URL'si.
caption string Görüntünün oluşturulan açıklaması.
width integer Görüntünün piksel cinsinden genişliği.
height integer Görüntünün piksel cinsinden yüksekliği.
thumbnailUrl string Görüntünün küçük resim kaynak URL'si.
lastUpdatedAt string Görüntünün son güncelleştirme tarihi, ISO8601 biçimi izler.
isAdult boolean İçeriğin yetişkinlere özgü içerik olup olmadığını gösterir.
clickUrl string Tıklamayı Bing'e yönlendiren URL'yi yeniden yönlendirin. Yalnızca tıklama yeniden yönlendirme etkinleştirildiğinde bulunur.
instrumentationSuffix string Bu sonuç öğesi için izleme ping URL'si tabanına eklenecek son ek. Hem izleme ping URL'si clickUrl hem de yeniden yönlendirme için K değeri olarak kullanılır. İzleme ping'i etkinleştirildiğinde bulunur.

Hata Kodları

Durum Kodu Hata Kategorisi Description Olası Nedenler
200 Success İstek başarılı oldu. -
400 Hatalı İstek Geçersiz istek parametreleri. Eksik gerekli alanlar, geçersiz parametre değerleri, hatalı biçimlendirilmiş JSON
401 Yetkisiz Kimlik doğrulaması başarısız oldu veya eksik. Geçersiz API anahtarı, eksik x-apikey üst bilgisi
403 Yasak Geçerli kimlik bilgileri ancak izinler yetersiz. API anahtarında gerekli izinler yok
410 Gitti HTTPS gereklidir. İSTEK HTTPS yerine HTTP üzerinden yapıldı
415 Desteklenmeyen Medya Türü İçerik türü desteklenmiyor. Eksik veya yanlış içerik türü üst bilgisi
429 Çok Fazla İstek Var Hız sınırı aşıldı. Zaman penceresinde çok fazla istek var
500 İç Sunucu Hatası Beklenmeyen sunucu hatası. Geçici sunucu sorunu
503 Hizmet Kullanılamıyor Hizmet geçici olarak kullanılamıyor. Bakım veya geçici kesinti
504 Ağ Geçidi Zaman Aşımı İstek zaman aşımına uğradı. Yukarı akış hizmeti zaman aşımı

Ayrıntılı hata işleme kılavuzu için bkz. Hata İşleme.

Ayrıca bkz:Web AramasıVideoları Arama | | Haber Arama | MCP'ye Gözat |

  • Son güncelleştirme: