Rychlý start: Hledání obrázků pomocí rozhraní REST API Bingu pro vyhledávání obrázků a jazyka C#

Článek
01/05/2022

Upozornění

30. října 2020 se rozhraní API Vyhledávání Bingu přesunula ze služeb Azure AI na Vyhledávání Bingu Services. Tato dokumentace je k dispozici pouze pro referenci. Aktualizovanou dokumentaci najdete v dokumentaci k rozhraní API bingu pro vyhledávání. Pokyny k vytváření nových prostředků Azure pro vyhledávání Bingem najdete v tématu Vytvoření prostředku Vyhledávání Bingu prostřednictvím Azure Marketplace.

V tomto rychlém startu se dozvíte, jak odesílat žádosti o hledání do rozhraní API Bingu pro vyhledávání obrázků. Tato aplikace jazyka C# odešle do rozhraní API vyhledávací dotaz a ve výsledcích zobrazí adresu URL prvního obrázku. I když je tato aplikace napsaná v jazyce C#, rozhraní API je webová služba RESTful kompatibilní s většinou programovacích jazyků.

Požadavky

Libovolná edice sady Visual Studio 2017 nebo novější.
Rozhraní Json.NET, k dispozici jako balíček NuGet.
Pokud používáte Linux nebo MacOS, můžete tuto aplikaci spustit pomocí Mono.

Vytvoření a inicializace projektu

Vytvořte nové konzolové řešení s názvem BingSearchApisQuickStart v sadě Visual Studio. Pak do hlavního souboru kódu přidejte následující obory názvů:
```
using System;
using System.Net;
using System.IO;
using System.Collections.Generic;
using Newtonsoft.Json.Linq;
```

Vytvořte proměnné pro koncový bod rozhraní API, klíč předplatného a hledaný výraz. Pro uriBasemůžete použít globální koncový bod v následujícím kódu nebo vlastní koncový bod subdomény zobrazený v Azure Portal pro váš prostředek.

//...
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";
//...

Vytvoření struktury pro formátování odpovědi vyhledávání obrázků Bingu

Definujte strukturu, SearchResult která bude obsahovat výsledky hledání obrázků a informace o hlavičce JSON.

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

Vytvoření metody k odesílání žádostí o vyhledávání

Vytvořte metodu s názvem BingImageSearch pro provedení volání rozhraní API a nastavte návratový typ na strukturu vytvořenou SearchResult dříve.

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

Vytvoření a zpracování žádostí o vyhledávání obrázků

BingImageSearch V metodě proveďte následující kroky:

Sestavte URI pro žádost o vyhledávání. Než ho SearchTerm přidáte do řetězce, naformátujte hledaný termín.

static SearchResult BingImageSearch(string SearchTerm){

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

Odešlete webový požadavek a získejte odpověď jako řetězec 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();

Vytvořte objekt výsledků hledání a extrahujte hlavičky HTTP Bingu. Pak vraťte 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;

Zpracování a zobrazení odpovědi

V hlavní metodě volejte BingImageSearch() a uložte vrácenou odpověď. Pak deserializujte JSON do objektu.

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

Získejte první vrácené obrázek z jsonObja vytiskněte název a adresu URL obrázku.

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");

Příklad odpovědi JSON

Odpovědi od rozhraní API Bingu pro vyhledávání obrázků se vrátí jako JSON. Ukázková odpověď je zkrácená, aby zobrazovala jenom jeden výsledek.

{
"_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"
    }]
}

Další kroky

Vyhledávání obrázků Bingu – kurz jednostránkové aplikace

Sdílet prostřednictvím