快速入門：使用 Ruby 將搜尋要求傳送至 Bing 實體搜尋 REST API

警告

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

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

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

Prerequisites

• Ruby 2.4 或更新版本 (英文)。

建立 Azure 資源

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

Bing 實體搜尋資源

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

多服務資源

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

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

1. 在您最愛的 IDE 或程式碼編輯器中，建立新聞 Ruby 檔案並匯入下列套件：

   require 'net/https'
   require 'cgi'
   require 'json'
   

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

   host = 'https://api.bing.microsoft.com'
   path = '/v7.0/search'
   
   mkt = 'en-US'
   query = 'italian restaurants near me'
   

製作 API 要求格式並提出 API 要求

1. 藉由將市場變數附加至 ?mkt= 參數來為要求建立參數字串。 對查詢進行編碼，並將其附加至 &q= 參數。 結合 API 主機、路徑和要求參數，並將其轉換為 URI 物件。

   params = '?mkt=' + mkt + '&q=' + CGI.escape(query)
   uri = URI (host + path + params)
   

2. 使用上一個步驟中的變數來建立要求。 將訂用帳戶金鑰新增至 Ocp-Apim-Subscription-Key 標頭。

   request = Net::HTTP::Get.new(uri)
   request['Ocp-Apim-Subscription-Key'] = subscriptionKey
   

3. 傳送要求並列印回應。

   response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
       http.request (request)
   end
   
   puts JSON::pretty_generate (JSON (response.body))
   

範例 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"
      },
      
      . . .
    ]
  }
}

後續步驟

建置單頁 Web 應用程式

• 什麼是 Bing 實體搜尋 API？
• Bing 實體搜尋 API 參考。