Générer un client de recherche d’application console en C#

Article
06/24/2020

Avertissement

Le 30 octobre 2020, les API de recherche Bing sont passées des services Azure AI aux services de recherche Bing. Cette documentation est fournie à des fins de référence uniquement. Pour accéder à la documentation mise à jour, consultez la documentation de l’API Recherche Bing. Pour obtenir des instructions sur la création de nouvelles ressources Azure pour Recherche Bing, consultez Créer une ressource Recherche Bing à l’aide de Place de marché Azure.

Ce tutoriel montre comment générer une application console .NET Core simple qui permet aux utilisateurs d’interroger l’API Recherche web Bing et d’afficher les résultats classés.

Ce tutoriel montre comment :

Effectuer une requête simple auprès de l’API Recherche web Bing
Afficher les résultats de la requête dans un ordre de classement

Prérequis

Pour suivre le tutoriel, vous avez besoin des éléments suivants :

Un abonnement Azure - En créer un gratuitement
Une fois que vous avez votre abonnement Azure, créez une ressource Recherche Bing dans le portail Azure pour obtenir votre clé et votre point de terminaison. Une fois le déploiement effectué, cliquez sur Accéder à la ressource.
IDE Visual Studio.

Créer un projet d’application console

Dans Visual Studio, créez un projet avec Ctrl+Shift+N.

Dans la boîte de dialogue Nouveau projet, cliquez sur Visual C# > Bureau classique Windows > Application console (.NET Framework).

Nommez l’application MyConsoleSearchApp, puis cliquez sur OK.

Ajouter le package NuGet JSON.net au projet

Json.NET vous permet d’utiliser les réponses JSON retournées par l’API. Ajoutez son package NuGet à votre projet :

Dans l’Explorateur de solutions, cliquez avec le bouton droit sur le projet, puis sélectionnez Gérer les packages NuGet... .
Sous l’onglet Parcourir, recherchez Newtonsoft.Json. Sélectionnez la version la plus récente, puis cliquez sur Installer.
Cliquez sur le bouton OK dans la fenêtre Examiner les modifications.
Fermez l’onglet de Visual Studio intitulé NuGet : MyConsoleSearchApp.

Ajouter une référence à System.Web

Ce tutoriel s’appuie sur l’assembly System.Web. Ajoutez une référence à cet assembly à votre projet :

Dans l’Explorateur de solutions, cliquez avec le bouton droit sur Références, puis sélectionnez Ajouter une référence...
Sélectionnez Assemblies > Framework, puis faites défiler vers le bas et cochez System.Web
Sélectionnez OK.

Ajouter quelques instructions using nécessaires

Le code de ce tutoriel requiert trois instructions using supplémentaires. Ajoutez ces instructions sous les instructions using existantes en haut de Program.cs :

using System.Web;
using System.Net.Http;

Demander une requête à l’utilisateur

Dans l’Explorateur de solutions, ouvrez Program.cs. Mettez à jour la méthode Main() :

static void Main()
{
    // Get the user's query
    Console.Write("Enter Bing query: ");
    string userQuery = Console.ReadLine();
    Console.WriteLine();

    // Run the query and display the results
    RunQueryAndDisplayResults(userQuery);

    // Prevent the console window from closing immediately
    Console.WriteLine("\nHit ENTER to exit...");
    Console.ReadLine();
}

Cette méthode :

Demande une requête à l’utilisateur
Appelle RunQueryAndDisplayResults(userQuery) pour exécuter la requête et afficher les résultats
Attend une entrée d’utilisateur pour empêcher la fermeture immédiate de la fenêtre de console.

Rechercher les résultats de la requête à l’aide de l’API Recherche web Bing

Ajoutez ensuite une méthode qui interroge l’API et affiche les résultats :

static void RunQueryAndDisplayResults(string userQuery)
{
    try
    {
        // Create a query
        var client = new HttpClient();
        client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "<YOUR_SUBSCRIPTION_KEY_GOES_HERE>");
        var queryString = HttpUtility.ParseQueryString(string.Empty);
        queryString["q"] = userQuery;
        var query = "https://api.cognitive.microsoft.com/bing/v7.0/search?" + queryString;

        // Run the query
        HttpResponseMessage httpResponseMessage = client.GetAsync(query).Result;

        // Deserialize the response content
        var responseContentString = httpResponseMessage.Content.ReadAsStringAsync().Result;
        Newtonsoft.Json.Linq.JObject responseObjects = Newtonsoft.Json.Linq.JObject.Parse(responseContentString);

        // Handle success and error codes
        if (httpResponseMessage.IsSuccessStatusCode)
        {
            DisplayAllRankedResults(responseObjects);
        }
        else
        {
            Console.WriteLine($"HTTP error status code: {httpResponseMessage.StatusCode.ToString()}");
        }
    }
    catch (Exception e)
    {
        Console.WriteLine(e.Message);
    }
}

Cette méthode :

Crée un HttpClient pour interroger l’API Recherche web
Définit l’en-tête HTTP Ocp-Apim-Subscription-Key que Bing utilise pour authentifier la requête
Exécute la requête et utilise Json.NET pour désérialiser les résultats
Appelle DisplayAllRankedResults(responseObjects) pour afficher tous les résultats dans un ordre de classement

Veillez à définir la valeur de Ocp-Apim-Subscription-Key sur votre clé d’abonnement.

Afficher les résultats classés

Avant de voir comment afficher les résultats dans un ordre de classement, examinons un exemple de réponse de recherche web :

{
    "_type" : "SearchResponse",
    "webPages" : {
        "webSearchUrl" : "https:\/\/www.bing.com\/cr?IG=70BE289346...",
        "totalEstimatedMatches" : 982000,
        "value" : [{
            "id" : "https:\/\/api.cognitive.microsoft.com\/api\/v7\/#WebPages.0",
            "name" : "Contoso Sailing Club - Seattle",
            "url" : "https:\/\/www.bing.com\/cr?IG=70BE289346ED4594874FE...",
            "displayUrl" : "https:\/\/contososailingsea...",
            "snippet" : "Come sail with Contoso in Seattle...",
            "dateLastCrawled" : "2017-04-07T02:25:00"
        },
        {
            "id" : "https:\/\/api.cognitive.microsoft.com\/api\/7\/#WebPages.6",
            "name" : "Contoso Sailing Lessons - Official Site",
            "url" : "http:\/\/www.bing.com\/cr?IG=70BE289346ED4594874FE...",
            "displayUrl" : "https:\/\/www.constososailinglessonsseat...",
            "snippet" : "Contoso sailing lessons in Seattle...",
            "dateLastCrawled" : "2017-04-09T14:30:00"
        },

        ...

        ],
        "someResultsRemoved" : true
    },
    "relatedSearches" : {
        "id" : "https:\/\/api.cognitive.microsoft.com\/api\/7\/#RelatedSearches",
        "value" : [{
            "text" : "sailing lessons",
            "displayText" : "sailing lessons",
            "webSearchUrl" : "https:\/\/www.bing.com\/cr?IG=70BE289346E..."
        }

        ...

        ]
    },
    "rankingResponse" : {
        "mainline" : {
            "items" : [{
                "answerType" : "WebPages",
                "resultIndex" : 0,
                "value" : {
                    "id" : "https:\/\/api.cognitive.microsoft.com\/api\/v7\/#WebPages.0"
                }
            },
            {
                "answerType" : "WebPages",
                "resultIndex" : 1,
                "value" : {
                    "id" : "https:\/\/api.cognitive.microsoft.com\/api\/v7\/#WebPages.1"
                }
            }

            ...

            ]
        },
        "sidebar" : {
            "items" : [{
                "answerType" : "RelatedSearches",
                "value" : {
                    "id" : "https:\/\/api.cognitive.microsoft.com\/api\/v7\/#RelatedSearches"
                }
            }]
        }
    }
}

L’objet JSON rankingResponse (documentation) décrit l’ordre d’affichage approprié pour les résultats de la recherche. Il contient un ou plusieurs des groupes suivants, classés par ordre de priorité :

pole: Résultats de la recherche qui doivent être les plus visibles (par exemple, affichés au-dessus de la partie principale et de l’encadré).
mainline: Résultats de la recherche à afficher dans la partie principale.
sidebar: Résultats de la recherche à afficher dans l’encadré. En l’absence d’encadré, affichez les résultats sous la partie principale.

La réponse de classement JSON peut inclure un ou plusieurs des groupes.

Dans Program.cs, ajoutez la méthode suivante pour afficher les résultats dans un ordre de classement correct :

static void DisplayAllRankedResults(Newtonsoft.Json.Linq.JObject responseObjects)
{
    string[] rankingGroups = new string[] { "pole", "mainline", "sidebar" };

    // Loop through the ranking groups in priority order
    foreach (string rankingName in rankingGroups)
    {
        Newtonsoft.Json.Linq.JToken rankingResponseItems = responseObjects.SelectToken($"rankingResponse.{rankingName}.items");
        if (rankingResponseItems != null)
        {
            foreach (Newtonsoft.Json.Linq.JObject rankingResponseItem in rankingResponseItems)
            {
                Newtonsoft.Json.Linq.JToken resultIndex;
                rankingResponseItem.TryGetValue("resultIndex", out resultIndex);
                var answerType = rankingResponseItem.Value<string>("answerType");
                switch (answerType)
                {
                    case "WebPages":
                        DisplaySpecificResults(resultIndex, responseObjects.SelectToken("webPages.value"), "WebPage", "name", "url", "displayUrl", "snippet");
                        break;
                    case "News":
                        DisplaySpecificResults(resultIndex, responseObjects.SelectToken("news.value"), "News", "name", "url", "description");
                        break;
                    case "Images":
                        DisplaySpecificResults(resultIndex, responseObjects.SelectToken("images.value"), "Image", "thumbnailUrl");
                        break;
                    case "Videos":
                        DisplaySpecificResults(resultIndex, responseObjects.SelectToken("videos.value"), "Video", "embedHtml");
                        break;
                    case "RelatedSearches":
                        DisplaySpecificResults(resultIndex, responseObjects.SelectToken("relatedSearches.value"), "RelatedSearch", "displayText", "webSearchUrl");
                        break;
                }
            }
        }
    }
}

Cette méthode :

Effectue une boucle sur les groupes rankingResponse contenus dans la réponse
Affiche les éléments dans chaque groupe en appelant DisplaySpecificResults(...)

Dans Program.cs, ajoutez les deux méthodes suivantes :

static void DisplaySpecificResults(Newtonsoft.Json.Linq.JToken resultIndex, Newtonsoft.Json.Linq.JToken items, string title, params string[] fields)
{
    if (resultIndex == null)
    {
        foreach (Newtonsoft.Json.Linq.JToken item in items)
        {
            DisplayItem(item, title, fields);
        }
    }
    else
    {
        DisplayItem(items.ElementAt((int)resultIndex), title, fields);
    }
}

static void DisplayItem(Newtonsoft.Json.Linq.JToken item, string title, string[] fields)
{
    Console.WriteLine($"{title}: ");
    foreach( string field in fields )
    {
        Console.WriteLine($"- {field}: {item[field]}");
    }
    Console.WriteLine();
}

Ces méthodes fonctionnent ensemble pour générer les résultats de la recherche dans la console.

Exécution de l'application

Exécutez l'application. Le résultat doit être semblable à ce qui suit :

Enter Bing query: sailing lessons seattle

WebPage:
- name: Contoso Sailing Club - Seattle
- url: https://www.bing.com/cr?IG=70BE289346ED4594874FE...
- displayUrl: https://contososailingsea....
- snippet: Come sail with Contoso in Seattle...

WebPage:
- name: Contoso Sailing Lessons Seattle - Official Site
- url: http://www.bing.com/cr?IG=70BE289346ED4594874FE...
- displayUrl: https://www.constososailinglessonsseat...
- snippet: Contoso sailing lessons in Seattle...

...

Étapes suivantes

En savoir plus sur l’utilisation du classement pour afficher les résultats.

Générer un client de recherche d’application console en C#

Prérequis

Créer un projet d’application console

Ajouter le package NuGet JSON.net au projet

Ajouter une référence à System.Web

Ajouter quelques instructions using nécessaires

Demander une requête à l’utilisateur

Rechercher les résultats de la requête à l’aide de l’API Recherche web Bing

Afficher les résultats classés

Exécution de l'application

Étapes suivantes

Ressources supplémentaires