Avvio rapido: Cercare immagini con l'API REST Ricerca immagini Bing e C#

Articolo
01/05/2022

Avviso

Il 30 ottobre 2020 le API di Ricerca Bing spostate dai servizi di intelligenza artificiale di Azure ai servizi Ricerca Bing. Questa documentazione viene fornita solo per informazioni di riferimento. Per la documentazione aggiornata, vedere la documentazione dell'API di ricerca Bing. Per istruzioni sulla creazione di nuove risorse di Azure per la ricerca Bing, vedere Creare una risorsa Ricerca Bing tramite la Azure Marketplace.

Seguire questo argomento di avvio rapido per informazioni su come inviare richieste di ricerca all'API Ricerca immagini Bing. Questa applicazione C# invia una query di ricerca all'API e visualizza l'URL della prima immagine inclusa nei risultati. Anche se l'applicazione è scritta in C#, l'API è un servizio Web RESTful compatibile con la maggior parte dei linguaggi di programmazione.

Prerequisiti

Qualsiasi edizione di Visual Studio 2017 o versioni successive.
Il framework Json.NET, disponibile come pacchetto NuGet.
Se si usa Linux/MacOS, questa applicazione può essere eseguita tramite Mono.

Creare e inizializzare un progetto

Creare una nuova soluzione console denominata BingSearchApisQuickStart in Visual Studio. Aggiungere quindi gli spazi dei nomi seguenti al file di codice principale:
```
using System;
using System.Net;
using System.IO;
using System.Collections.Generic;
using Newtonsoft.Json.Linq;
```

Creare variabili per l'endpoint dell'API, la chiave di sottoscrizione e il termine di ricerca. Per uriBase è possibile usare l'endpoint globale nel codice seguente o l'endpoint di sottodominio personalizzato visualizzato nel portale di Azure per la risorsa.

//...
namespace BingSearchApisQuickstart
{
    class Program
    {
    // Replace the this string with your valid access key.
    const string subscriptionKey = "enter your key here";
    const string uriBase = "https://api.cognitive.microsoft.com/bing/v7.0/images/search";
    const string searchTerm = "tropical ocean";
//...

Creare uno struct per formattare la risposta di Ricerca immagini Bing

Definire uno struct SearchResult in cui saranno contenuti i risultati della ricerca di immagini e le informazioni dell'intestazione JSON.

    namespace BingSearchApisQuickstart
    {
        class Program
        {
        //...
            struct SearchResult
            {
                public String jsonResult;
                public Dictionary<String, String> relevantHeaders;
            }
//...

Creare un metodo per l'invio di richieste di ricerca

Creare un metodo denominato BingImageSearch per effettuare la chiamata all'API e impostare il tipo restituito sullo struct SearchResult creato in precedenza.

//...
namespace BingSearchApisQuickstart
{
    //...
    class Program
    {
        //...
        static SearchResult BingImageSearch(string searchTerm)
        {
        }
//...

Creare e gestire una richiesta di ricerca di immagini

Nel metodo BingImageSearch eseguire i passaggi seguenti:

Costruire l'URI per la richiesta di ricerca. Formattare il termine di ricerca SearchTerm prima di aggiungerlo alla stringa.

static SearchResult BingImageSearch(string SearchTerm){

    var uriQuery = uriBase + "?q=" + Uri.EscapeDataString(SearchTerm);
//...

Inviare la richiesta Web e ottenere la risposta come stringa JSON.

WebRequest request = WebRequest.Create(uriQuery);
request.Headers["Ocp-Apim-Subscription-Key"] = subscriptionKey;
HttpWebResponse response = (HttpWebResponse)request.GetResponseAsync().Result;
string json = new StreamReader(response.GetResponseStream()).ReadToEnd();

Creare l'oggetto risultato della ricerca ed estrarre le intestazioni HTTP di Bing. Restituire quindi searchResult.

// Create the result object for return
var searchResult = new SearchResult()
{
    jsonResult = json,
    relevantHeaders = new Dictionary<String, String>()
};

// Extract Bing HTTP headers
foreach (String header in response.Headers)
{
    if (header.StartsWith("BingAPIs-") || header.StartsWith("X-MSEdge-"))
        searchResult.relevantHeaders[header] = response.Headers[header];
}
return searchResult;

Elaborare e visualizzare la risposta

Nel metodo principale chiamare BingImageSearch() e memorizzare la risposta restituita. Deserializzare quindi la risposta JSON in un oggetto.

SearchResult result = BingImageSearch(searchTerm);
//deserialize the JSON response from the Bing Image Search API
dynamic jsonObj = Newtonsoft.Json.JsonConvert.DeserializeObject(result.jsonResult);

Ottenere la prima immagine restituita da jsonObj e stampare il titolo e un URL nell'immagine.

var firstJsonObj = jsonObj["value"][0];
Console.WriteLine("Title for the first image result: " + firstJsonObj["name"]+"\n");
//After running the application, copy the output URL into a browser to see the image.
Console.WriteLine("URL for the first image result: " + firstJsonObj["webSearchUrl"]+"\n");

Risposta JSON di esempio

Le risposte dell'API Ricerca immagini Bing vengono restituite in formato JSON. Questa risposta di esempio è stata troncata in modo da visualizzare un singolo risultato.

{
"_type":"Images",
"instrumentation":{
    "_type":"ResponseInstrumentation"
},
"readLink":"images\/search?q=tropical ocean",
"webSearchUrl":"https:\/\/www.bing.com\/images\/search?q=tropical ocean&FORM=OIIARP",
"totalEstimatedMatches":842,
"nextOffset":47,
"value":[
    {
        "webSearchUrl":"https:\/\/www.bing.com\/images\/search?view=detailv2&FORM=OIIRPO&q=tropical+ocean&id=8607ACDACB243BDEA7E1EF78127DA931E680E3A5&simid=608027248313960152",
        "name":"My Life in the Ocean | The greatest WordPress.com site in ...",
        "thumbnailUrl":"https:\/\/tse3.mm.bing.net\/th?id=OIP.fmwSKKmKpmZtJiBDps1kLAHaEo&pid=Api",
        "datePublished":"2017-11-03T08:51:00.0000000Z",
        "contentUrl":"https:\/\/mylifeintheocean.files.wordpress.com\/2012\/11\/tropical-ocean-wallpaper-1920x12003.jpg",
        "hostPageUrl":"https:\/\/mylifeintheocean.wordpress.com\/",
        "contentSize":"897388 B",
        "encodingFormat":"jpeg",
        "hostPageDisplayUrl":"https:\/\/mylifeintheocean.wordpress.com",
        "width":1920,
        "height":1200,
        "thumbnail":{
        "width":474,
        "height":296
        },
        "imageInsightsToken":"ccid_fmwSKKmK*mid_8607ACDACB243BDEA7E1EF78127DA931E680E3A5*simid_608027248313960152*thid_OIP.fmwSKKmKpmZtJiBDps1kLAHaEo",
        "insightsMetadata":{
        "recipeSourcesCount":0,
        "bestRepresentativeQuery":{
            "text":"Tropical Beaches Desktop Wallpaper",
            "displayText":"Tropical Beaches Desktop Wallpaper",
            "webSearchUrl":"https:\/\/www.bing.com\/images\/search?q=Tropical+Beaches+Desktop+Wallpaper&id=8607ACDACB243BDEA7E1EF78127DA931E680E3A5&FORM=IDBQDM"
        },
        "pagesIncludingCount":115,
        "availableSizesCount":44
        },
        "imageId":"8607ACDACB243BDEA7E1EF78127DA931E680E3A5",
        "accentColor":"0050B2"
    }]
}

Passaggi successivi

Esercitazione sull'app a singola pagina di Ricerca immagini Bing

Condividi tramite