Rest API-referens för nyhetssökning

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

Exempelbegäran:

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
query Yes string - En sökfråga för nyhetsresultatet. Maximal längd är 1 000 tecken.
maximalt antal resultat No integer 10 Maximalt antal resultat som ska returneras. Standardvärdet är 10. Maximalt värde är 20.
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".
contentFormat No string "passage" ("text" 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.
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.

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.

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

Nyhetssvar

Fält Type Description
newsResults matris med newsResult Lista över nyhetsartikelresultat.
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.

newsResult

Fält Type Description
title string Nyhetsrubriken.
url string Käll-URL:en för nyhetsartikeln. 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 webbplatsinnehållet (även kallat grundläggning) för nyhetsresultatet.
miniatyr miniatyrobjekt Miniatyrbilden av nyhetsartikeln.
lastUpdatedAt string Senaste uppdateringsdatum för nyheterna i UTC-ISO8601 format.
crawledAt string Det senaste crawlade datumet för nyheterna följer ISO8601 format.
language string Språket i nyhetsartikeln använder språkkoden ISO 639-1.
source string Publisher namn, till exempel "USA TODAY | MSN, CNN osv.
isAdult boolean Anger om innehållet är vuxet.
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.

Note

lastUpdatedAt fältet är valfritt, det vill sa att du kan se ett tomt värde för det här fältet.

miniatyr

Fält Type Description
url string URL:en till miniatyrbilden.
width integer Miniatyrbildens bredd i bildpunkter.
height integer Miniatyrbildens höjd i bildpunkter.

Note

thumbnail är också ett valfritt svarsobjekt – det kanske inte är tillgängligt för vissa nyhetsresultat.

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 webbsökningsvideor | | Sök efter | bilder Sök MCP |

  • Uppdaterades senast