Referenční informace k rozhraní REST API pro vyhledávání zpráv

Koncový bod:POST https://api.microsoft.ai/v3/search/news

Ukázkový požadavek:

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

Parameter Required Typ Výchozí Description
dotaz Ano řetězec - Vyhledávací dotaz pro výsledky zpráv. Maximální délka je 1000 znaků.
maxResults No integer 10 Maximální počet výsledků, které se mají vrátit. Výchozí hodnota je 10. Maximální hodnota je 20.
jazyk No řetězec "en" Dvoumísmenný kód jazyka ISO 639-1 pro jazyk rozhraní ve výsledcích hledání. Úplný seznam najdete v části Podporované jazyky .
oblast No řetězec "US" 2písmenný kód země/oblasti, odkud mají výsledky pocházet (např. "US", "JP", "GB" atd.). Úplný seznam najdete v části Podporované oblasti .
poloha No řetězec - Informace o poloze ve formátu "lat:<float>; long:<float>", např. lat:40.753250; long:-74.003807".
Formát obsahu No řetězec "passage" ("text" s úplným přístupem k dokumentu) passage vrátí části každého výsledku, které jsou pro dotaz nejrelevantní (doporučeno pro uzemnění). text html a vrátit celý dokument a markdown použít pouze pro aplikace s úplným přístupem k dokumentu; viz Pasáže a formáty obsahu. Nastavte ho pro každý požadavek.
maximální délka No integer 3000 (1 0000 s úplným přístupem k dokumentům) Maximální počet znaků na content výsledek, 1 až 5 00000. Bez úplného přístupu k content dokumentu je maximálně 3000 znaků. Viz Výchozí hodnoty a limity. Nastavte ho pro každý požadavek.

Formáty obsahu

Nastaví contentFormat = passage se pro získání částí každého výsledku, který je pro dotaz nejrelevavantnější, až maxLength znaky (3000 je dobrým výchozím bodem). Je to doporučený formát pro uzemnění; Podívejte se na článek Co je passagea proč ho používat? v nejčastějších dotazech. Aplikace s úplným přístupem k dokumentům mohou také požadovat celý dokument jako text, html nebo markdown; pro jiné aplikace, tyto formáty vrací HTTP 403. Viz pasáže a formáty obsahu.

Hlavičky požadavku

Field Typ Description
hostitel řetězec Hostitel pro rozhraní API Microsoft AI: api.microsoft.ai.
x-apikey nebo authorization řetězec Váš klíč rozhraní API nebo Entra ID přístupový token pro ověřování.
typ obsahu řetězec Typ MIME textu požadavku. Použijte application/json.

Response

Odpověď na zprávy

Field Typ Description
newsResults array of newsResult Seznam výsledků příspěvku
instrumentationClickBase řetězec Základní adresa URL pro kliknutí na požadavky ping instrumentationSuffix Připojte hodnotu z položky výsledku, která vytvoří úplnou adresu URL příkazu Ping. K dispozici pouze pro aplikace s příznakem profilu EnableInstrumentationPing. Poznámka: Kliknutím uživatele lze také protokolovat pomocí přesměrování adresy URL. Pokud je přesměrování povolené, nevyžaduje se žádná akce pro protokolování kliknutí uživatele a instrumentationClickBase nebude zahrnuta do odpovědi. Pokyny k nastavení najdete v průvodci instrumentací .
instrumentationCitationBase řetězec Základní adresa URL pro požadavky ping protokolu LLM Připojte datovou část k vytvoření úplné adresy URL příkazu Ping. K dispozici pouze pro aplikace s příznakem profilu EnableInstrumentationPing.
traceId řetězec ID trasování pro ladění

newsResult

Field Typ Description
title řetězec Název zprávy.
url řetězec Zdrojová adresa URL příspěvku. Pro uživatele v Číně s povoleným přesměrováním adresy URL místo toho toto pole obsahuje stejnou adresu URL přesměrování jako clickUrl.
doména řetězec Cílový hostitel výsledku. Vráceno pouze pro uživatele v Číně s povoleným přesměrováním adresy URL.
obsah řetězec Podrobný obsah webové stránky (neboli uzemnění) výsledku zprávy.
miniatura thumbnail object Miniatura příspěvku.
lastUpdatedAt řetězec Datum poslední aktualizace novinek ve formátu UTC ISO8601.
crawledAt řetězec Datum posledního procházení zpráv se řídí formátem ISO8601.
jazyk řetězec Jazyk novinového článku používá kód jazyka ISO 639-1.
odeslat k provedení řetězec Publisher název, například "USA TODAY | MSN, CNN atd.
isAdult boolean Označuje, jestli je obsah pro dospělé.
clickUrl řetězec Přesměrujte adresu URL, která přesMěruje proxy přes Bing. Je k dispozici pouze v době, kdy je povoleno kliknutí na přesměrování.
instrumentationSuffix řetězec Přípona pro připojení k základu adresy URL příkazu ping instrumentace pro tuto položku výsledku. Používá se jako hodnota K pro adresu URL příkazu ping instrumentace i pro clickUrl přesměrování. Je k dispozici, když je povolený příkaz ping instrumentace.

Note

lastUpdatedAt pole je volitelné – to znamená, že pro toto pole se může zobrazit prázdná hodnota.

miniatura

Field Typ Description
url řetězec URL náhledu.
width integer Šířka miniatury v pixelech
height integer Výška miniatury v pixelech

Note

thumbnail je také volitelný objekt odpovědi – nemusí být k dispozici pro určité výsledky zpráv.

Kódy chyb

Kód stavu Kategorie chyb Description Běžné příčiny
200 Success Žádost byla úspěšná. -
400 Nesprávná žádost Neplatné parametry požadavku. Chybí požadovaná pole, neplatné hodnoty parametrů, chybně formátovaný JSON.
401 Neautorizováno Ověřování se nezdařilo nebo chybí. Neplatný klíč rozhraní API, chybějící hlavička x-apikey
403 Zakázáno Platné přihlašovací údaje, ale nedostatečná oprávnění Klíč rozhraní API nemá požadovaná oprávnění
410 Pryč Vyžaduje se HTTPS. Požadavek provedený přes PROTOKOL HTTP místo HTTPS
415 Nepodporovaný typ média Typ obsahu není podporován. Chybějící nebo nesprávná hlavička typu obsahu
429 Příliš mnoho požadavků Byl překročen limit rychlosti. Příliš mnoho požadavků v časovém intervalu
500 Vnitřní chyba serveru Neočekávaná chyba serveru Dočasný problém se serverem
503 Služba není k dispozici Služba je dočasně nedostupná. Údržba nebo dočasný výpadek
504 Časový limit brány Vypršel časový limit požadavku. Upstreamový časový limit služby

Podrobné pokyny pro zpracování chyb najdete v tématu Zpracování chyb.

Viz také:Web SearchVideos Search | | SearchSearch | Images Search MCP |

  • Poslední aktualizace v