Naslaginformatie over REST API voor webzoekopdrachten

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

Voorbeeldaanvraag:

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

Parameters

Parameter Required Type Default Description
zoekopdracht Yes string - Een zoekquerytekenreeks. De maximale lengte is 1000 tekens. Ondersteunt de operators 'site:' en '-site:' om resultaten van specifieke sites op te nemen of uit te sluiten (bijvoorbeeld 'query's site:example.com'). Gebruik deze operators alleen wanneer dat nodig is, omdat ze inherent de relevantie van resultaten verminderen.
maxResults No integer 10 Het maximum aantal resultaten dat moet worden teruggegeven. De standaardwaarde is 10 en de maximumwaarde is 50.
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". Als dit niet is opgegeven, wordt de locatie in de query afgeleid.
inhoudOpmaak No string 'passage' ('html' 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. Opmerking: de web-API retourneert snippet geen veld.
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.
safeSearch No string "strikt" Niveau van veilig zoeken filteren. Waarden: "uit", "strikt". De standaardwaarde is 'strikt'.

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.

SafeSearch

Met safeSearch-modi kunt u bepalen hoeveel gevoelige webinhoud de web-API filtert voordat de resultaten worden geretourneerd. Gevoelige inhoud omvat geweld, zelfbeschadiging en andere categorieën. De standaardwaarde is strict.

Value Description Aanbevolen voor
strict Blokkeert inhoud met betrekking tot onderwerpen voor volwassenen, ongepaste, geweld, haat en zelfverschadiging. Kindveilig, onderwijs, consumenten/conservatieve implementaties.
off Blokkeert nog steeds illegale inhoud. Voor andere mogelijk schadelijke inhoud verschuift de verantwoordelijkheid voor het uiteindelijke filteren naar de gebruiker. Onderzoek, analyse, opt-in enterprise, geavanceerde 3P-gebruiksscenario's.

Note

Als u de site: queryoperator gebruikt, kan het antwoord inhoud voor volwassenen bevatten, ongeacht de safeSearch waarde. Gebruik site: alleen als u op de hoogte bent van de inhoud op de site en uw scenario de mogelijkheid van inhoud voor volwassenen ondersteunt.

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

Webantwoord

Veld Type Description
webResults matrix van webResult Lijst met resultaten van webpagina's.
querySignals querySignals Classificatiesignalen op queryniveau voor de zoekquery.
riskLevel string Het veiligheidsrisiconiveau dat wordt beoordeeld voor de query. Mogelijke waarden: low, moderate, high, . veryHigh
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.

querySignals

Veld Type Description
freshness boolean Hiermee wordt aangegeven of nieuwe documenten prioriteit moeten krijgen boven andere documenten voor deze query.

webResult

Veld Type Description
title string De titel van de webpagina.
url string De bron-URL van de webpagina. 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 inhoud (ook wel grounding genoemd) van de webpagina.
crawledAt string De laatste verkende datum van de webpagina volgt ISO8601 indeling.
laatsteBijgewerktOp string De laatst bijgewerkte datum van de webpagina volgt ISO8601 indeling.
taal string De taal van de webpagina maakt gebruik van ISO 639-1-taalcode.
isAdult boolean Geeft aan of het resultaat inhoud voor volwassenen bevat.
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.
contentTier string De inhoudslaag van het resultaat, waarin de commerciële toegangskenmerken van de inhoudsbron worden beschreven. Mogelijke waarden: standard (standaardinhoud die beschikbaar is voor alle klanten onder het standaardserviceaanbod), entitled (inhoud die beschikbaar is via bestaande klantlicentieovereenkomsten, inclusief BYOL-inhoud (Bring Your Own License) die klanten rechtstreeks hebben gelicentieerd bij uitgevers en toegang via hun eigen contractuele regelingen), premium (Premium-inhoud die extra waarde biedt buiten het standaardaanbod en waarvoor facturering is vereist).

Note

Waarden van crawledAt en lastUpdatedAt velden zijn optioneel. Dat wil gezegd, hun dekking is niet 100%. Mogelijk ziet u lege waarden voor deze velden.

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:Video's zoekendoor | nieuws zoeken | | afbeeldingen zoeken | MCP

  • Laatst bijgewerkt om