REST API-referens för webbsökning

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

Exempelbegäran:

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
query Yes string - En sökfrågesträng. Maximal längd är 1 000 tecken. Stöder operatorerna "site:" och "-site:" för att inkludera eller exkludera resultat från specifika platser (t.ex. "fråga site:example.com"). Använd endast dessa operatorer när det behövs, eftersom de i sig minskar resultatrelevansen.
maximalt antal resultat No integer 10 Maximalt antal resultat som ska returneras. Standardvärdet är 10 och maxvärdet är 50.
language No string "en" En iso 639-1-språkkod med två bokstäver för gränssnittsspråk i sökresultaten. Se Språk som stöds för den fullständiga listan.
region No string "US" En lands-/regionkod med två bokstäver för var resultaten ska komma från (t.ex. "US", "JP", "GB" osv.). Se Regioner som stöds för den fullständiga listan.
location No string - Platsinformation i formatet "lat:<float>; long:<float>", t.ex. "lat:40.753250; long:-74.003807". Om det inte anges kommer platsen i frågan att härledas.
contentFormat No string "passage" ("html" med fullständig dokumentåtkomst) passage returnerar de delar av varje resultat som är mest relevanta för frågan (rekommenderas för jordning). text, html och markdown returnera det fullständiga dokumentet och gäller endast för program med fullständig dokumentåtkomst, se Avsnitt och innehållsformat. Ställ in den på varje begäran. Obs! Webb-API:et returnerar inte något snippet fält.
maxlängd No integer 3000 (10000 med fullständig dokumentåtkomst) Maximalt antal tecken per content resultat, 1 till 500000. Utan fullständig dokumentåtkomst content är högst 3 000 tecken. Se Standardvärden och gränser. Ställ in den på varje begäran.
safeSearch No string "strikt" Nivå av säker sökfiltrering. Värden: "off", "strict". Standardvärdet är "strikt".

Innehållsformat

Ange contentFormat = passage för att få de delar av varje resultat som är mest relevanta för frågan, upp till maxLength tecken (3 000 är en bra utgångspunkt). Det är det rekommenderade formatet för jordning. se Vad är passage, och varför använda det? i vanliga frågor och svar. Program med fullständig dokumentåtkomst kan också begära det fullständiga dokumentet som text, html eller markdown; för andra program returnerar dessa format HTTP 403. Se Avsnitt och innehållsformat.

SafeSearch

Med SafeSearch-lägen kan du styra hur mycket känsligt webbinnehåll webb-API:et filtrerar ut innan resultaten returneras. Känsligt innehåll omfattar våld, självskadebeteende och andra kategorier. Standardvärdet är strict.

Value Description Rekommenderas för
strict Blockerar innehåll som rör vuxna, olämpliga ämnen, våld, hat och självskadebeteende. Barnsäker, utbildning, konsument-/konservativ distribution.
off Blockerar fortfarande olagligt innehåll. För annat potentiellt skadligt innehåll flyttar ansvaret för slutlig filtrering till användaren. Forskning, analys, opt-in enterprise, avancerade 3P-användningsfall.

Note

Om du använder site: frågeoperatorn kan svaret innehålla vuxet safeSearch innehåll oavsett värde. Använd site: endast om du är medveten om innehållet på webbplatsen och ditt scenario stöder möjligheten till vuxet innehåll.

Rubriker för begäran

Fält Type Description
host string Värd för Microsoft AI-API:er: api.microsoft.ai.
x-apikey eller auktorisering string Din API-nyckel eller Entra ID åtkomsttoken för autentisering.
innehållstyp string MIME-typ av begärandetext. Använd application/json.

Svar

Webbsvar

Fält Type Description
webResults matris med webResult Lista över webbsideresultat.
querySignals querySignals Rangordningssignaler på frågenivå för sökfrågan.
riskLevel string Säkerhetsrisknivån som utvärderas för frågan. Möjliga värden: low, moderate, high, veryHigh.
instrumentationClickBase string Bas-URL för att klicka på ping-begäranden. Lägg till ett instrumentationSuffix värde från ett resultatobjekt för att skapa den fullständiga ping-URL:en. Finns endast för program med profilflaggan EnableInstrumentationPing. Obs! Användarklick kan också loggas med url-omdirigering. När omdirigering har aktiverats krävs ingen åtgärd för att logga användarklickningar och instrumentationClickBase tas inte med i svaret. Se instrumenteringsguiden för installationsinstruktioner.
instrumentationCitationBase string Bas-URL för LLM-loggens pingbegäranden. Lägg till en DATA-nyttolast för att skapa den fullständiga ping-URL:en. Finns endast för program med profilflaggan EnableInstrumentationPing.
traceId string Spårnings-ID för felsökning.

querySignals

Fält Type Description
freshness boolean Anger om nya dokument ska prioriteras framför andra dokument för den här frågan.

webResult

Fält Type Description
title string Webbsidans rubrik.
url string Webbsidans käll-URL. För Kina-användare med URL-omdirigering aktiverat innehåller det här fältet i stället samma omdirigerings-URL som clickUrl.
domain string Målvärden för resultatet. Returneras endast för Kina-användare med URL-omdirigering aktiverat.
innehåll string Det detaljerade innehållet (även kallat grundläggning) på webbsidan.
crawledAt string Webbsidans senaste crawlade datum följer ISO8601 format.
lastUpdatedAt string Webbsidans senast uppdaterade datum följer ISO8601 format.
language string Språket på webbsidan använder språkkoden ISO 639-1.
isAdult boolean Anger om resultatet innehåller innehåll som är olämpligt för barn.
clickUrl string Omdirigerings-URL som proxyservrar klickar genom Bing. Visas endast när klickomdirigering är aktiverat.
instrumentationSuffix string Suffix som ska läggas till i instrumentations-ping-URL-basen för det här resultatobjektet. Används som K-värde för både instrumentations-ping-URL:en och clickUrl omdirigeringen. Presentera när instrumentations ping är aktiverat.
contentTier string Innehållsnivån för resultatet, som beskriver innehållskällans kommersiella åtkomstegenskaper. Möjliga värden: standard (standardinnehåll tillgängligt för alla kunder under standardtjänsterbjudandet), entitled (innehåll som är tillgängligt via befintliga kundlicensavtal, inklusive BYOL-innehåll (Bring Your Own License) som kunder har licensierat direkt från utgivare och åtkomst via sina egna avtalsarrangemang), premium (premiuminnehåll som ger ytterligare värde utöver standarderbjudandet och som är föremål för fakturering).

Note

crawledAt Värden för och lastUpdatedAt fält är valfria. Deras täckning är alltså inte 100%. Du kan se tomma värden för dessa fält.

Felkoder

Statuskod Felkategori Description Vanliga orsaker
200 Success Begäran lyckades. -
400 Felaktig förfrågan Ogiltiga parametrar för begäran. Obligatoriska fält saknas, ogiltiga parametervärden, felaktigt formaterad JSON
401 Behörighet saknas Autentiseringen misslyckades eller saknas. Ogiltig API-nyckel, x-apikey-huvud saknas
403 Ej tillåtet Giltiga autentiseringsuppgifter men otillräckliga behörigheter. API-nyckeln saknar nödvändiga behörigheter
410 Borta HTTPS krävs. Begäran som görs via HTTP i stället för HTTPS
415 Medietyp som inte stöds Innehållstypen stöds inte. Rubrik av innehållstyp saknas eller är felaktig
429 För många begäranden Hastighetsgränsen har överskridits. För många begäranden i tidsfönstret
500 Internt serverfel Oväntat serverfel. Problem med tillfällig server
503 Tjänsten är inte tillgänglig Tjänsten är inte tillgänglig för tillfället. Underhåll eller tillfälligt avbrott
504 Tidsgräns för gateway Tidsgränsen för begäran har överskridits. Timeout för överordnad tjänst

Detaljerad vägledning för felhantering finns i Felhantering.

Se även:Sök efter | videorBläddra bland | nyhetssökningsbilder | Sök MCP |

  • Uppdaterades senast