Informations de référence sur l’API REST Recherche d’actualités

Point de terminaison :POST https://api.microsoft.ai/v3/search/news

Exemple de demande :

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

Paramètre Required Type Default Description
query Yes string - Requête de recherche pour les résultats des actualités. La longueur maximale est de 1 000 caractères.
maxResults Non integer 10 Nombre maximal de résultats à retourner. La valeur par défaut est 10. La valeur maximale est 20.
langue Non string « en » Code de langue ISO 639-1 de 2 lettres pour la langue de l’interface dans les résultats de recherche. Consultez les langues prises en charge pour obtenir la liste complète.
region Non string "US" Code pays/région de 2 lettres pour lequel les résultats doivent provenir (par exemple, « US », « JP », « GB », etc.). Consultez les régions prises en charge pour obtenir la liste complète.
location Non string - Informations d’emplacement au format « lat :<float> ; long :<float> », par exemple « lat :40.753250 ; long :-74.003807".
contentFormat Non string « passage » (« texte » avec accès complet au document) passage retourne les parties de chaque résultat le plus pertinent pour la requête (recommandé pour la mise au point). text, html et renvoyer le document complet et markdown s’appliquer uniquement aux applications disposant d’un accès complet aux documents ; consultez Passages et formats de contenu. Définissez-le sur chaque requête.
longueur maximale Non integer 3000 (10000 avec accès complet aux documents) Nombre maximal de caractères par content résultat, 1 à 5 0000. Sans accès complet aux documents, content il y a au maximum 3 000 caractères. Consultez les valeurs par défaut et les limites. Définissez-le sur chaque requête.

Formats de contenu

Définissez contentFormat = passage pour obtenir les parties de chaque résultat le plus pertinent pour la requête, jusqu’à maxLength caractères (3000 est un bon point de départ). Il s’agit du format recommandé pour la mise à l’terre ; voir Qu’est-ce que c’est passageet pourquoi l’utiliser ? dans le FAQ. Les applications disposant d’un accès complet au document peuvent également demander le document complet en tant que text, html ou markdown; pour d’autres applications, ces formats retournent HTTP 403. Consultez passages et formats de contenu.

En-têtes de requête

Champ Type Description
host string Hôte pour Microsoft API IA : api.microsoft.ai.
x-apikey ou autorisation string Votre clé API ou votre jeton d’accès Entra ID pour l’authentification.
type de contenu string Type MIME du corps de la requête. Utilisez application/json.

Response

Réponse aux actualités

Champ Type Description
newsResults tableau de newsResult Liste des résultats de l’article d’actualités.
instrumentationClickBase string URL de base pour cliquer sur les requêtes ping. Ajoutez une instrumentationSuffix valeur à partir d’un élément de résultat pour former l’URL ping complète. Présente uniquement pour les applications avec l’indicateur de profil EnableInstrumentationPing. Remarque : les clics utilisateur peuvent également être enregistrés à l’aide de la redirection d’URL. Lorsque la redirection est activée, aucune action n’est nécessaire pour journaliser les clics utilisateur et instrumentationClickBase ne sera pas incluse dans la réponse. Consultez le guide d’instrumentation pour obtenir des instructions de configuration.
instrumentationCitationBase string URL de base pour les requêtes ping du journal LLM. Ajoutez une charge utile DATA pour former l’URL ping complète. Présente uniquement pour les applications avec l’indicateur de profil EnableInstrumentationPing.
traceId string ID de trace pour le débogage.

newsResult

Champ Type Description
title string Titre de la nouvelle.
url string URL source de l’article d’actualité. Pour les utilisateurs chinois avec la redirection d’URL activée, ce champ contient plutôt la même URL de redirection que clickUrl.
domain string Hôte de destination pour le résultat. Retourné uniquement pour les utilisateurs chinois avec redirection d’URL activée.
contenu string Contenu détaillé de la page web (par exemple, base) du résultat de l’actualité.
miniature objet miniature Miniature de l’article d’actualité.
lastUpdatedAt string Date de la dernière mise à jour des actualités, au format UTC ISO8601.
crawledAt string La dernière date analysée des actualités suit ISO8601 format.
langue string La langue de l’article d’actualités utilise le code de langue ISO 639-1.
source string Publisher nom, tel que « USA TODAY | » MSN », « CNN », etc.
isAdult boolean Indique si le contenu est adulte.
clickUrl string URL de redirection qui proxie le clic via Bing. Présente uniquement lorsque la redirection en un clic est activée.
instrumentationSuffix string Suffixe à ajouter à la base d’URL ping d’instrumentation pour cet élément de résultat. Utilisé comme valeur K pour l’URL ping d’instrumentation et la clickUrl redirection. Présent lorsque le test ping d’instrumentation est activé.

Note

lastUpdatedAt champ facultatif : autrement dit, vous pouvez voir une valeur vide pour ce champ.

miniature

Champ Type Description
url string L’URL de la vignette.
width integer Largeur de la miniature, en pixels.
height integer Hauteur de la miniature, en pixels.

Note

thumbnail est également un objet de réponse facultatif : il peut ne pas être disponible pour certains résultats d’actualités.

Codes d’erreur

Code de statut Catégorie d’erreur Description Causes courantes
200 Success La demande a abouti. -
400 Demande incorrecte Paramètres de requête non valides. Champs obligatoires manquants, valeurs de paramètre non valides, JSON mal formé
401 Unauthorized Échec ou absence de l’authentification. Clé API non valide, en-tête x-apikey manquant
403 Interdit Informations d’identification valides, mais autorisations insuffisantes. La clé API ne dispose pas des autorisations requises
410 Non disponible (Gone) HTTPS requis. Requête effectuée sur HTTP au lieu de HTTPS
415 Type de média non pris en charge Type de contenu non pris en charge. En-tête de type de contenu manquant ou incorrect
429 Trop de demandes Limite de débit dépassée. Trop de requêtes dans la fenêtre de temps
500 Erreur interne du serveur Erreur de serveur inattendue. Problème de serveur temporaire
503 Service indisponible Service temporairement indisponible. Pannes de maintenance ou temporaires
504 Délai d’expiration de la passerelle La requête a expiré. Délai d’expiration du service en amont

Pour obtenir des instructions détaillées sur la gestion des erreurs, consultez Gestion des erreurs.

Voir aussi :Recherche devidéos de recherche | webrecherche d’imagesrecherche | d’images | MCP |

  • Dernière mise à jour :