快速入門:使用 Node.js 將搜尋要求傳送至 Bing 實體搜尋 REST API

警告

在 2020 年 10 月 30 日,Bing 搜尋 API 已從 Azure AI 服務移至 Bing 搜尋 服務。 本文件僅供參考之用。 如需更新的文件,請參閱 Bing 搜尋 API 文件。 如需針對 Bing 搜尋建立新 Azure 資源的指示,請參閱透過 Azure Marketplace 建立 Bing 搜尋資源

使用本快速入門以第一次呼叫 Bing 實體搜尋 API,並檢視 JSON 回應。 這個簡單的 JavaScript 應用程式會將新聞搜尋查詢傳送給 API,並顯示回應。 GitHub 上有此範例的原始程式碼。

雖然此應用程式是以 JavaScript 撰寫的,但 API 是一種與大多數程式設計語言都相容的 RESTful Web 服務。

Prerequisites

建立 Azure 資源

藉由建立下列其中一項 Azure 資源,開始使用 Bing 實體搜尋 API。

Bing 實體搜尋資源

  • 您可以透過 Azure 入口網站取得該資源,直到將其刪除為止。
  • 使用免費定價層來試用服務,之後可升級至付費層以用於實際執行環境。
  • Bing 實體搜尋也會在 Bing 搜尋 v7 資源的付費層中提供。

多服務資源

  • 您可以透過 Azure 入口網站取得該資源,直到將其刪除為止。
  • 針對您的應用程式,跨多個 Azure AI 服務使用相同的金鑰和端點。

建立應用程式並將其初始化

  1. 在您最愛的 IDE 或編輯器中建立新的 JavaScript 檔案,並設定嚴謹度 和 HTTPS 需求。

    'use strict';
    let https = require ('https');
    
  2. 建立適用於 API 端點、您訂用帳戶金鑰及搜尋查詢的變數。 您可以使用下列程式碼中的全域端點,或使用 Azure 入口網站中針對您的資源所顯示的自訂子網域端點。

    let subscriptionKey = 'ENTER YOUR KEY HERE';
    let host = 'api.bing.microsoft.com';
    let path = '/v7.0/search';
    
    let mkt = 'en-US';
    let q = 'italian restaurant near me';
    
  3. 將您的市場和查詢參數附加至稱為 query 的字串。 請務必使用 encodeURI() 對您的查詢進行 url 編碼。

    let query = '?mkt=' + mkt + '&q=' + encodeURI(q);
    

處理及剖析回應

  1. 定義一個名為 response_handler() 的函式,此函式會接受 HTTP 呼叫 response 作為參數。

  2. 在此函式中,定義一個變數來包含 JSON 回應本文。

    let response_handler = function (response) {
        let body = '';
    };
    
  3. 在呼叫 data 旗標時,儲存回應本文。

    response.on('data', function (d) {
        body += d;
    });
    
  4. 出現 end 旗標的訊號時,剖析 JSON,然後將其列印出來。

    response.on ('end', function () {
    let json = JSON.stringify(JSON.parse(body), null, '  ');
    console.log (json);
    });
    

傳送要求

  1. 建立名為 Search() 的函式,以傳送搜尋要求。 在其中執行下列步驟:

  2. 在此函式中,建立包含所要求參數的 JSON 物件。 使用 Get 作為方法,並新增主機和路徑資訊。 將訂用帳戶金鑰新增至 Ocp-Apim-Subscription-Key 標頭。

  3. 使用 https.request() 傳送具有之前建立的回應處理常式和搜尋參數的要求。

    let Search = function () {
     let request_params = {
         method : 'GET',
         hostname : host,
         path : path + query,
         headers : {
             'Ocp-Apim-Subscription-Key' : subscriptionKey,
         }
     };
    
     let req = https.request (request_params, response_handler);
     req.end ();
    }
    
  4. 呼叫 Search() 函式。

範例 JSON 回應

如以下範例所示,成功的回應會以 JSON 格式來傳回:

{
  "_type": "SearchResponse",
  "queryContext": {
    "originalQuery": "italian restaurant near me",
    "askUserForLocation": true
  },
  "places": {
    "value": [
      {
        "_type": "LocalBusiness",
        "webSearchUrl": "https://www.bing.com/search?q=sinful+bakery&filters=local...",
        "name": "Liberty's Delightful Sinful Bakery & Cafe",
        "url": "https://www.contoso.com/",
        "entityPresentationInfo": {
          "entityScenario": "ListItem",
          "entityTypeHints": [
            "Place",
            "LocalBusiness"
          ]
        },
        "address": {
          "addressLocality": "Seattle",
          "addressRegion": "WA",
          "postalCode": "98112",
          "addressCountry": "US",
          "neighborhood": "Madison Park"
        },
        "telephone": "(800) 555-1212"
      },

      . . .
      {
        "_type": "Restaurant",
        "webSearchUrl": "https://www.bing.com/search?q=Pickles+and+Preserves...",
        "name": "Munson's Pickles and Preserves Farm",
        "url": "https://www.princi.com/",
        "entityPresentationInfo": {
          "entityScenario": "ListItem",
          "entityTypeHints": [
            "Place",
            "LocalBusiness",
            "Restaurant"
          ]
        },
        "address": {
          "addressLocality": "Seattle",
          "addressRegion": "WA",
          "postalCode": "98101",
          "addressCountry": "US",
          "neighborhood": "Capitol Hill"
        },
        "telephone": "(800) 555-1212"
      },
      
      . . .
    ]
  }
}

後續步驟