快速入門:使用 Bing 拼字檢查 REST API 和 Ruby 進行檢查拼字

警告

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

使用本快速入門,透過 Ruby 第一次呼叫 Bing 拼字檢查 REST API。 此簡單應用程式會將要求傳送至 API 並傳回建議的修正清單。

雖然此應用程式是以 Ruby 撰寫的,但 API 是一種與大多數程式設計語言都相容的 RESTful Web 服務。 您可以在 GitHub 上找到此應用程式的原始程式碼

Prerequisites

建立 Azure 資源

藉由建立下列其中一項 Azure 資源,開始使用 Bing 拼字檢查 API:

Bing 拼字檢查資源

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

多服務資源

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

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

  1. 在您最愛的編輯器或 IDE 中建立新的 Ruby 檔案,然後新增下列需求:

    require 'net/http'
    require 'uri'
    require 'json'
    
  2. 針對您的訂用帳戶金鑰、端點 URI 和路徑建立變數。 您可以使用下列程式碼中的全域端點,或使用 Azure 入口網站中針對您的資源所顯示的自訂子網域端點。 建立要求參數:

    1. 使用 = 運算子,將您的市場代碼指派給 mkt 參數。 市場代碼是您提出要求的國家/區域。

    2. 使用 & 運算子新增 mode 參數,然後指派拼字檢查模式。 模式可以是 proof (攔截大部分的拼字/文法錯誤) 或 spell (攔截大部分的拼字檢查錯誤,但沒有多少文法錯誤)。

    key = 'ENTER YOUR KEY HERE'
    uri = 'https://api.cognitive.microsoft.com'
    path = '/bing/v7.0/spellcheck?'
    params = 'mkt=en-us&mode=proof'
    

傳送拼字檢查要求

  1. 從您的主機 URI、路徑和參數字串建立 URL。 設定其查詢,以包含您想要拼字檢查的文字。

    uri = URI(uri + path + params)
    uri.query = URI.encode_www_form({
       # Request parameters
    'text' => 'Hollo, wrld!'
    })
    
  2. 使用先前建構的 URI 來建立要求。 將您的金鑰新增至 Ocp-Apim-Subscription-Key 標頭。

    request = Net::HTTP::Post.new(uri)
    request['Content-Type'] = "application/x-www-form-urlencoded"
    request['Ocp-Apim-Subscription-Key'] = key
    
  3. 傳送要求。

    response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
        http.request(request)
    end
    
  4. 取得 JSON 回應,並將它列印到主控台。

    result = JSON.pretty_generate(JSON.parse(response.body))
    puts result
    

執行應用程式

建置並執行專案。 如果您使用命令列,請使用下列命令來執行應用程式:

ruby <FILE_NAME>.rb

範例 JSON 回應

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

{
   "_type": "SpellCheck",
   "flaggedTokens": [
      {
         "offset": 0,
         "token": "Hollo",
         "type": "UnknownToken",
         "suggestions": [
            {
               "suggestion": "Hello",
               "score": 0.9115257530801
            },
            {
               "suggestion": "Hollow",
               "score": 0.858039839213461
            },
            {
               "suggestion": "Hallo",
               "score": 0.597385084464481
            }
         ]
      },
      {
         "offset": 7,
         "token": "wrld",
         "type": "UnknownToken",
         "suggestions": [
            {
               "suggestion": "world",
               "score": 0.9115257530801
            }
         ]
      }
   ]
}

後續步驟