Naslaginformatie over REST API voor Nieuws zoeken

Eindpunt:POST https://api.microsoft.ai/v3/search/news

Voorbeeldaanvraag:

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 Type Default Description
zoekopdracht Yes string - Een zoekquery voor de nieuwsresultaten. De maximale lengte is 1000 tekens.
maxResults No integer 10 Maximum aantal resultaten dat moet worden geretourneerd. De standaardwaarde is 10. De maximumwaarde is 20.
taal No string "en" Een ISO 639-1-taalcode van 2 letters voor interfacetaal in de zoekresultaten. Zie Ondersteunde talen voor de volledige lijst.
region No string "US" Een land-/regiocode van 2 letters voor waar de resultaten vandaan moeten komen (bijvoorbeeld 'VS', 'JP', 'GB', enzovoort). Zie Ondersteunde regio's voor de volledige lijst.
location No string - Locatiegegevens in indeling "lat:<float>; long:<float>", bijvoorbeeld "lat:40,753250; long:-74.003807".
inhoudOpmaak No string 'passage' ('tekst' met volledige documenttoegang) passage retourneert de onderdelen van elk resultaat dat het meest relevant is voor de query (aanbevolen voor aarding). texten htmlmarkdown retourneer het volledige document en pas van toepassing op toepassingen met volledige documenttoegang. Zie Passages en inhoudsindelingen. Stel deze in op elke aanvraag.
maximale lengte No integer 3000 (10000 met volledige documenttoegang) Maximum aantal tekens per content resultaat, 1 tot 500000. Zonder volledige documenttoegang content zijn maximaal 3000 tekens. Zie De standaardinstellingen en limieten. Stel deze in op elke aanvraag.

Inhoudsindelingen

Ingesteld contentFormat = passage om de onderdelen van elk resultaat op te halen die het meest relevant zijn voor de query, tot maxLength tekens (3000 is een goed uitgangspunt). Het is de aanbevolen indeling voor aarding; zie Wat is passageen waarom deze gebruiken? in de veelgestelde vragen. Toepassingen met volledige documenttoegang kunnen ook het volledige document aanvragen als text, html of markdown; voor andere toepassingen, die indelingen HTTP 403 retourneren. Zie Passages en inhoudsindelingen.

Aanvraagheaders

Veld Type Description
host string Host voor Microsoft AI-API's: api.microsoft.ai.
x-apikey of autorisatie string Uw API-sleutel of Entra ID toegangstoken voor verificatie.
inhoudstype string MIME-type van de aanvraagbody. Gebruik application/json.

Antwoord

Nieuwsantwoord

Veld Type Description
newsResults matrix van newsResult Lijst met nieuwsartikelresultaten.
instrumentationClickBase string Basis-URL voor ping-aanvragen voor klikken. Voeg een instrumentationSuffix waarde van een resultaatitem toe om de volledige ping-URL te vormen. Alleen aanwezig voor toepassingen met de vlag EnableInstrumentationPing-profiel. Opmerking: Gebruikersklikken kunnen ook worden geregistreerd met behulp van URL-omleiding. Wanneer omleiding is ingeschakeld, is er geen actie vereist voor het vastleggen van klikken van gebruikers en instrumentationClickBase wordt deze niet opgenomen in het antwoord. Zie de instrumentatiehandleiding voor installatie-instructies.
instrumentationCitationBase string Basis-URL voor PING-aanvragen voor LLM-logboeken. Voeg een DATA-nettolading toe om de volledige ping-URL te vormen. Alleen aanwezig voor toepassingen met de vlag EnableInstrumentationPing-profiel.
traceId string Tracerings-id voor foutopsporing.

newsResult

Veld Type Description
title string De titel van het nieuws.
url string De bron-URL van het nieuwsartikel. Voor China-gebruikers waarvoor URL-omleiding is ingeschakeld, bevat dit veld in plaats daarvan dezelfde omleidings-URL als clickUrl.
domain string De doelhost voor het resultaat. Alleen geretourneerd voor China-gebruikers waarvoor URL-omleiding is ingeschakeld.
inhoud string De gedetailleerde webpagina-inhoud (ook wel grounding genoemd) van het nieuwsresultaat.
thumbnail miniatuurobject De miniatuur van het nieuwsartikel.
laatsteBijgewerktOp string De laatst bijgewerkte datum van het nieuws, in UTC ISO8601 indeling.
crawledAt string De laatste verkende datum van het nieuws volgt ISO8601 indeling.
taal string De taal van het nieuwsartikel maakt gebruik van ISO 639-1-taalcode.
source string Publisher naam, zoals 'USA TODAY | MSN, CNN, enzovoort.
isAdult boolean Geeft aan of de inhoud volwassen is.
clickUrl string Omleidings-URL die de klik via Bing proxyt. Alleen aanwezig wanneer klikken op omleiding is ingeschakeld.
instrumentationSuffix string Achtervoegsel dat moet worden toegevoegd aan de URL-basis voor instrumentatie-ping voor dit resultaatitem. Wordt gebruikt als de K-waarde voor zowel de ping-URL voor instrumentatie als de clickUrl omleiding. Aanwezig wanneer instrumentatie ping is ingeschakeld.

Note

lastUpdatedAt het veld is optioneel, dat wil gezegd dat er een lege waarde voor dit veld wordt weergegeven.

thumbnail

Veld Type Description
url string De URL van de thumbnail.
width integer Breedte van de miniatuur, in pixels.
height integer Hoogte van de miniatuur, in pixels.

Note

thumbnail is ook een optioneel antwoordobject. Het is mogelijk niet beschikbaar voor bepaalde nieuwsresultaten.

Foutcodes

Statuscode Foutcategorie Description Veelvoorkomende oorzaken
200 Success Het verzoek slaagde. -
400 Onjuiste aanvraag Ongeldige aanvraagparameters. Ontbrekende vereiste velden, ongeldige parameterwaarden, ongeldige JSON
401 Niet geautoriseerd Verificatie is mislukt of ontbreekt. Ongeldige API-sleutel, ontbrekende x-apikey-header
403 Verboden Geldige referenties, maar onvoldoende machtigingen. API-sleutel heeft geen vereiste machtigingen
410 Weg HTTPS vereist. Aanvraag via HTTP in plaats van HTTPS
415 Niet-ondersteund mediatype Inhoudstype wordt niet ondersteund. Ontbrekende of onjuiste header van inhoudstype
429 Te veel aanvragen De snelheidslimiet is overschreden. Te veel aanvragen in tijdvenster
500 Interne serverfout Onverwachte serverfout. Probleem met tijdelijke server
503 Service niet beschikbaar Service is tijdelijk niet beschikbaar. Onderhoud of tijdelijke storing
504 Gateway-time-out Er is een time-out opgetreden voor het verzoek. Time-out van upstream-service

Zie Foutafhandeling voor gedetailleerde richtlijnen voor foutafhandeling.

Zie ook:Zoeken invideo's zoeken | in video's zoeken | in | afbeeldingen zoeken | MCP

  • Laatst bijgewerkt om