Informazioni di riferimento sulle API REST ricerca notizie

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

Richiesta di esempio:

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

Parametro Required Type Default Description
query Yes string - Query di ricerca per i risultati delle notizie. La lunghezza massima è di 1000 caratteri.
maxResults No integer 10 Numero massimo di risultati da restituire. Il valore predefinito è 10. Il valore massimo è 20.
language No string "en" Codice di lingua ISO 639-1 di 2 lettere per la lingua dell'interfaccia nei risultati della ricerca. Per l'elenco completo, vedere Lingue supportate .
region No string "US" Codice paese/area geografica a 2 lettere da cui devono provenire i risultati (ad esempio "US", "JP", "GB" e così via). Per l'elenco completo, vedere Aree supportate .
ubicazione No string - Informazioni sulla posizione nel formato "lat:<float>; long:<float>", ad esempio "lat:40.753250; long:-74.003807".
contentFormat No string "passaggio" ("text" con accesso completo al documento) passage restituisce le parti di ogni risultato più rilevante per la query (consigliata per il grounding). texte htmlmarkdown restituiscono il documento completo e si applicano solo alle applicazioni con accesso completo al documento. Vedere Passaggi e formati di contenuto. Impostarlo su ogni richiesta.
lunghezza massima No integer 3000 (10000 con accesso completo al documento) Numero massimo di caratteri per content risultato, da 1 a 500000. Senza accesso completo ai documenti, content è al massimo 3000 caratteri. Vedere Impostazioni predefinite e limiti. Impostarlo su ogni richiesta.

Formati di contenuto

Impostare contentFormat = passage per ottenere le parti di ogni risultato più rilevante per la query, fino a maxLength caratteri (3000 è un buon punto di partenza). È il formato consigliato per il grounding; vedere Che cos'è passagee perché usarlo? nelle domande frequenti. Le applicazioni con accesso completo ai documenti possono anche richiedere il documento completo come texto htmlmarkdown. per altre applicazioni, tali formati restituiscono HTTP 403. Vedi Passaggi e formati di contenuto.

Intestazioni della richiesta

Field Type Description
host string Host per le API di intelligenza artificiale Microsoft: api.microsoft.ai.
x-apikey o autorizzazione string La chiave API o Entra ID token di accesso per l'autenticazione.
tipo di contenuto string Tipo MIME del corpo della richiesta. Utilizzare il application/json.

Risposta

Risposta notizie

Field Type Description
newsResults matrice di newsResult Elenco dei risultati degli articoli di notizie.
instrumentationClickBase string URL di base per fare clic su richieste ping. Aggiungere un instrumentationSuffix valore da un elemento del risultato per formare l'URL ping completo. Presente solo per le applicazioni con il flag del profilo EnableInstrumentationPing. Nota: è anche possibile registrare i clic degli utenti usando il reindirizzamento URL. Quando il reindirizzamento è abilitato, non è necessaria alcuna azione per registrare i clic dell'utente e instrumentationClickBase non verrà inclusa nella risposta. Per istruzioni sull'installazione, vedere la guida alla strumentazione .
instrumentationCitationBase string URL di base per le richieste ping del log LLM. Aggiungere un payload DATA per formare l'URL ping completo. Presente solo per le applicazioni con il flag del profilo EnableInstrumentationPing.
traceId string ID traccia per il debug.

newsResult

Field Type Description
title string Titolo delle notizie.
url string URL di origine dell'articolo delle notizie. Per gli utenti della Cina con reindirizzamento URL abilitato, questo campo contiene invece lo stesso URL di reindirizzamento di clickUrl.
domain string Host di destinazione per il risultato. Restituito solo per gli utenti della Cina con reindirizzamento URL abilitato.
contenuto string Il contenuto dettagliato della pagina Web (noto anche come base) del risultato delle notizie.
anteprima oggetto thumbnail Anteprima dell'articolo di notizie.
ultimoAggiornatoAt string Data dell'ultimo aggiornamento delle notizie, in formato UTC ISO8601.
ricerca per indicizzazioneAt string L'ultima data sottoposta a ricerca per indicizzazione delle notizie segue ISO8601 formato.
language string Il linguaggio dell'articolo delle notizie usa il codice linguistico ISO 639-1.
source string Publisher nome, ad esempio "USA TODAY | MSN, "CNN", ecc.
isAdult boolean Indica se il contenuto è per adulti.
clickUrl string URL di reindirizzamento che esegue il proxy del clic tramite Bing. Presente solo quando il clic di reindirizzamento è abilitato.
instrumentationSuffix string Suffisso da aggiungere alla base dell'URL ping di strumentazione per questo elemento del risultato. Usato come valore K sia per l'URL ping di strumentazione che per il clickUrl reindirizzamento. Presente quando è abilitato il ping di strumentazione.

Note

lastUpdatedAt field è facoltativo, ovvero è possibile che venga visualizzato un valore vuoto per questo campo.

anteprima

Field Type Description
url string L'URL della miniatura.
width integer Larghezza dell'anteprima, in pixel.
height integer Altezza dell'anteprima, in pixel.

Note

thumbnail è anche un oggetto risposta facoltativo: potrebbe non essere disponibile per determinati risultati delle notizie.

Codici di errore

Codice di stato Categoria errore Description Cause comuni
200 Operazione completata La richiesta è stata accolta. -
400 Richiesta non valida Parametri di richiesta non validi. Campi obbligatori mancanti, valori di parametro non validi, JSON in formato non valido
401 Unauthorized Autenticazione non riuscita o mancante. Chiave API non valida, intestazione x-apikey mancante
403 Non consentito Credenziali valide ma autorizzazioni insufficienti. La chiave API non dispone delle autorizzazioni necessarie
410 Sparito HTTPS obbligatorio. Richiesta effettuata tramite HTTP invece di HTTPS
415 Tipo di supporto non supportato Tipo di contenuto non supportato. Intestazione di tipo contenuto mancante o non corretta
429 Troppe richieste Limite di velocità superato. Troppe richieste nell'intervallo di tempo
500 Errore interno del server Errore server imprevisto. Problema temporaneo del server
503 Servizio non disponibile Servizio temporaneamente non disponibile. Manutenzione o interruzione temporanea
504 Timeout gateway Tempo di attesa della richiesta scaduto. Timeout del servizio Upstream

Per indicazioni dettagliate sulla gestione degli errori, vedere Gestione degli errori.

Vedere anche:Ricercadi video di Ricerca | | WebCerca | immagini Ricerca | MCP

  • Ultimo aggiornamento: