快速入門：使用 Bing 影像搜尋 REST API 和 C# 來搜尋影像

使用本快速入門，了解如何將搜尋要求傳送至 Bing 影像搜尋 API。 這個 C# 應用程式會將搜尋查詢傳送至 API，並顯示結果中第一個影像的 URL。 雖然此應用程式是以 C# 撰寫的，但 API 是一種與大多數程式設計語言都相容的 RESTful Web 服務。

必要條件

• Visual Studio 2017 或更新版本的任何版本。
• Json.NET 架構 (以 NuGet 套件形式提供)。
• 如果您使用 Linux/MacOS，則可以使用 Mono 來執行此應用程式。

建立專案並將其初始化

1. 在 Visual Studio 中建立一個名為 BingSearchApisQuickStart 的新主控台解決方案。 接著，將下列命名空間新增至主要程式碼檔案：

   using System;
   using System.Net;
   using System.IO;
   using System.Collections.Generic;
   using Newtonsoft.Json.Linq;
   

2. 建立適用於 API 端點、您訂用帳戶金鑰及搜尋字詞的變數。 針對 uriBase，您可以使用下列程式碼中的全域端點，或使用 Azure 入口網站中針對您的資源顯示的自訂子網域端點。

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

建立結構來製作 Bing 影像搜尋回應的格式

定義 SearchResult 結構以包含影像搜尋結果及 JSON 標頭資訊。

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

建立方法來傳送搜尋要求

建立一個名為 BingImageSearch 的方法來執行對 API 的呼叫，並將傳回類型設定為之前建立的 SearchResult 結構。

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

建立及處理影像搜尋要求

在 BingImageSearch 方法中，執行下列步驟：

1. 建構搜尋要求的 URI。 將搜尋字詞 SearchTerm 格式化，然後再附加至字串。

   static SearchResult BingImageSearch(string SearchTerm){
   
       var uriQuery = uriBase + "?q=" + Uri.EscapeDataString(SearchTerm);
   //...
   

2. 傳送 Web 要求並取得 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();
   

3. 建立搜尋結果物件並擷取 Bing HTTP 標頭。 然後傳回 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;
   

處理及檢視回應

1. 在主要方法中，呼叫 BingImageSearch() 並儲存傳回的回應。 接著，將 JSON 還原序列化為物件。

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

2. 從 jsonObj 取得第一個傳回的影像，並列印出影像的標題和 URL。

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

範例 JSON 回應

來自「Bing 影像搜尋 API」的回應會以 JSON 形式傳回。 本範例回應已截斷而只顯示單一結果。

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

後續步驟

另請參閱

• 什麼是 Bing 影像搜尋 API？
• 試用線上互動式示範
• Bing 搜尋 API 的定價詳細資料
• Azure AI 服務文件
• Bing 影像搜尋 API 參考