News Search REST API-Referenz

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

Beispielanforderung:

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 Vorgabe Description
query Yes string - Eine Suchabfrage für die Nachrichtenergebnisse. Die maximale Länge beträgt 1000 Zeichen.
maxResults No integer 10 Maximale Anzahl der zurückzugebenden Ergebnisse. Der Standardwert ist 10. Der Maximalwert ist 20.
language No string „de“ Ein 2-Buchstaben-ISO 639-1-Sprachcode für die Schnittstellensprache in den Suchergebnissen. Die vollständige Liste finden Sie unter "Unterstützte Sprachen ".
region No string "US" Ein 2-Buchstaben-Länder-/Regionscode für den Ort, aus dem die Ergebnisse stammen sollen (z. B. "US", "JP", "GB" usw.). Die vollständige Liste finden Sie unter "Unterstützte Regionen ".
location No string - Standortinformationen im Format "lat:<float>; long:<float>", z. B. "lat:40.753250; long:-74.003807".
contentFormat No string "Passage" ("Text" mit Volldokumentzugriff) passage gibt die Teile jedes Ergebnisses zurück, die für die Abfrage am relevantesten sind (empfohlen für die Erdung). text, html und geben Sie das vollständige Dokument zurück und markdown gelten nur für Anwendungen mit vollständigem Dokumentzugriff; siehe Passagen und Inhaltsformate. Legen Sie sie für jede Anforderung fest.
Maximale Länge No integer 3000 (10000 mit Volldokumentzugriff) Maximale Anzahl von Zeichen content pro Ergebnis, 1 bis 500000. Ohne vollständigen Dokumentzugriff content beträgt dies höchstens 3000 Zeichen. Siehe "Standardwerte und Grenzwerte". Legen Sie sie für jede Anforderung fest.

Inhaltsformate

Legen Sie fest contentFormat = passage , dass die Teile jedes Ergebnisses, die für die Abfrage am relevantesten sind, bis zu maxLength Zeichen (3000 ist ein guter Ausgangspunkt). Es ist das empfohlene Format für die Erdung; siehe Was ist passage, und warum verwenden Sie sie in den häufig gestellten Fragen. Anwendungen mit vollständigem Dokumentzugriff können auch das vollständige Dokument anfordern als text, html oder markdown; für andere Anwendungen geben diese Formate HTTP 403 zurück. Siehe Passagen und Inhaltsformate.

Anforderungsheader

Feld Typ Description
host string Host für Microsoft AI-APIs: api.microsoft.ai.
x-apikey oder Autorisierung string Ihr API-Schlüssel oder Entra ID Zugriffstoken für die Authentifizierung.
Inhaltstyp string MIME-Typ des Anforderungstexts. Verwenden Sie application/json.

Antwort

Nachrichtenantwort

Feld Typ Description
newsResults Array von newsResult Liste der Newsartikelergebnisse.
instrumentationClickBase string Basis-URL zum Klicken auf Pinganforderungen. Fügen Sie einen instrumentationSuffix Wert aus einem Ergebniselement an, um die vollständige Ping-URL zu bilden. Nur für Anwendungen mit dem EnableInstrumentationPing-Profilflagge vorhanden. Hinweis: Benutzerklicks können auch mithilfe der URL-Umleitung protokolliert werden. Wenn die Umleitung aktiviert ist, ist keine Aktion erforderlich, um Benutzerklicks zu protokollieren und instrumentationClickBase nicht in die Antwort eingeschlossen. Anweisungen zum Einrichten finden Sie im Handbuch zur Instrumentierung .
instrumentationCitationBase string Basis-URL für LLM-Protokollpinganforderungen. Fügen Sie eine DATA-Nutzlast an, um die vollständige Ping-URL zu bilden. Nur für Anwendungen mit dem EnableInstrumentationPing-Profilflagge vorhanden.
traceId string Ablaufverfolgungs-ID für das Debuggen.

newsResult

Feld Typ Description
title string Der Titel der Nachrichten.
url string Die Quell-URL des Newsartikels. Für China-Benutzer mit aktivierter URL-Umleitung enthält dieses Feld stattdessen dieselbe Umleitungs-URL wie clickUrl.
domain string Der Zielhost für das Ergebnis. Wird nur für China-Benutzer mit aktivierter URL-Umleitung zurückgegeben.
Inhalt string Die detaillierten Webseiteninhalte (auch als Grundlage bezeichnet) des Newsergebnisses.
Vorschaubild Miniaturansichtsobjekt Die Miniaturansicht des Newsartikels.
lastUpdatedAt string Das datum der letzten Aktualisierung der Nachrichten im UTC-ISO8601-Format.
crawledAt string Das letzte durchforstete Datum der Nachrichten folgt ISO8601 Format.
language string Die Sprache des Newsartikels verwendet ISO 639-1-Sprachcode.
source string Publisher Name, z. B. "USA TODAY | MSN", "CNN" usw.
isAdult boolean Gibt an, ob der Inhalt erwachsener Ist.
clickUrl string Umleitungs-URL, die den Klick durch Bing proxiest. Nur vorhanden, wenn die Klickumleitung aktiviert ist.
instrumentationSuffix string Suffix, das an die URL-Basis der Instrumentierung für dieses Ergebniselement angefügt werden soll. Wird als K-Wert sowohl für die Ping-URL der Instrumentation als auch für die clickUrl Umleitung verwendet. Vorhanden, wenn die Instrumentierungs-Ping aktiviert ist.

Note

lastUpdatedAt das Feld optional ist, d. h. es wird möglicherweise ein leerer Wert für dieses Feld angezeigt.

Vorschaubild

Feld Typ Description
url string Die URL des Thumbnails.
width integer Breite der Miniaturansicht in Pixel.
height integer Höhe der Miniaturansicht in Pixel.

Note

thumbnail ist auch ein optionales Antwortobjekt – es ist möglicherweise nicht für bestimmte Nachrichtenergebnisse verfügbar.

Fehlercodes

Statuscode Fehlerkategorie Description Häufige Ursachen
200 Success Die Anfrage war erfolgreich. -
400 Ungültige Anforderung Ungültige Anforderungsparameter. Fehlende erforderliche Felder, ungültige Parameterwerte, falsch formatierter JSON-Code
401 Unauthorized Fehler bei der Authentifizierung oder fehlender Authentifizierung. Ungültiger API-Schlüssel, fehlender x-apikey-Header
403 Verboten Gültige Anmeldeinformationen, aber unzureichende Berechtigungen. API-Schlüssel verfügt nicht über erforderliche Berechtigungen
410 Nicht vorhanden (Gone) HTTPS erforderlich. Anforderung über HTTP anstelle von HTTPS
415 Nicht unterstützter Medientyp Der Inhaltstyp wird nicht unterstützt. Fehlender oder falscher Inhaltstypheader
429 Zu viele Anforderungen Das Ratenlimit wurde überschritten. Zu viele Anforderungen im Zeitfenster
500 Interner Serverfehler Unerwarteter Serverfehler. Temporäres Serverproblem
503 Dienst nicht verfügbar Der Dienst ist vorübergehend nicht verfügbar. Wartung oder vorübergehender Ausfall
504 Gateway-Zeitüberschreitung Zeitüberschreitung bei der Anforderung. Timeout des Upstream-Diensts

Ausführliche Anleitungen zur Fehlerbehandlung finden Sie unter "Fehlerbehandlung".

Siehe auch:Web search | Videos Search | | Images Search | MCP

  • Zuletzt aktualisiert um