Haber Arama REST API başvurusu

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

Örnek İstek:

curl -X POST "https://api.microsoft.ai/v3/search/news" \
  -H "host: api.microsoft.ai" \
  -H "x-apikey: <Your key>" \
  -H "content-type: application/json" \
  -d '{
    "query": "latest VC funding in tech",
    "maxResults": 10,
    "language": "en",
    "region": "US",
    "maxLength": 3000,
    "contentFormat": "passage"
  }'

Parameters

Parametre Required Tür Default Description
query Yes string - Haber sonuçları için bir arama sorgusu. Uzunluk üst sınırı 1000 karakterdir.
maxResults No integer 10 Döndürülecek en fazla sonuç sayısı. Varsayılan değer 10'dur. En yüksek değer 20'dir.
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 ülke/bölge kodu (ör. "ABD", "JP", "GB", vb.). Tam liste için bkz . Desteklenen Bölgeler .
location No string - "lat:<float>; long:<float>", örn. "lat:40.753250; long:-74.003807".
contentFormat No string "passage" ("text" with full document access) passage her sonucun sorguyla en ilgili bölümlerini döndürür (topraklama için önerilir). text markdown ve html tam belgeyi döndürerek yalnızca tam belge erişimine sahip uygulamalara uygulayın; bkz. Geçişler ve içerik biçimleri. Her istekte ayarlayın.
maksimumUzunluk No integer 3000 (tam belge erişimine sahip 10000) Sonuç başına en fazla karakter content sayısı 1 ile 500000 arasıdır. Tam belge erişimi olmadan en content fazla 3000 karakterdir. Bkz. Varsayılanlar ve sınırlar. Her istekte ayarlayın.

İçerik biçimleri

Her sonucun sorguyla en ilgili bölümlerini en çok maxLength karakter olacak şekilde ayarlayınpassagecontentFormat = (3000 iyi bir başlangıç noktasıdır). Topraklama için önerilen biçimdir; SSS bölümünde , nedir passageve neden kullanılır? bölümüne bakın. Tam belge erişimine sahip uygulamalar, belgenin tamamını textolarak html da isteyebilir veya markdowndiğer uygulamalar için bu biçimler HTTP 403 döndürür. Bkz . Geçişler ve içerik biçimleri.

İ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

Haber Yanıtı

Field Tür Description
newsResults newsResult dizisi Haber makalesi 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 için izleme kimliği.

newsResult

Field Tür Description
title string Haberlerin başlığı.
url string Haber makalesinin 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.
içerik string Haber sonucunun ayrıntılı web sayfası içeriği (yani temel oluşturma).
küçük resim küçük resim nesnesi Haber makalesinin küçük resmi.
lastUpdatedAt string Haberlerin utc ISO8601 biçimindeki son güncelleştirme tarihi.
crawledAt string Haberlerin son gezinme tarihi, ISO8601 biçimi izler.
language string Haber makalesinin dili, ISO 639-1 dil kodunu kullanır.
source string "USA TODAY | gibi Publisher adı MSN", "CNN" vb.
isAdult boolean İçeriğin yetişkin 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.

Note

lastUpdatedAt alanı isteğe bağlıdır; yani bu alan için boş değer görebilirsiniz.

küçük resim

Field Tür Description
url string Küçük resmin URL'si.
width integer Küçük resmin piksel cinsinden genişliği.
height integer Küçük resmin piksel cinsinden yüksekliği.

Note

thumbnail aynı zamanda isteğe bağlı bir yanıt nesnesidir; belirli haber sonuçları için kullanılamayabilir.

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 Arama | Videoları Arama | Göz Atma | Resimleri ARAMA | MCP