Quickstart: Check spelling with the Bing Spell Check REST API and Ruby

Article
05/21/2020

Warning

On October 30, 2020, the Bing Search APIs moved from Azure AI services to Bing Search Services. This documentation is provided for reference only. For updated documentation, see the Bing search API documentation. For instructions on creating new Azure resources for Bing search, see Create a Bing Search resource through the Azure Marketplace.

Use this quickstart to make your first call to the Bing Spell Check REST API using Ruby. This simple application sends a request to the API and returns a list of suggested corrections.

Although this application is written in Ruby, the API is a RESTful Web service compatible with most programming languages. The source code for this application is available on GitHub

Prerequisites

Ruby 2.4 or later.

Create an Azure resource

Start using the Bing Spell Check API by creating one of the following Azure resources:

Bing Spell Check resource

Available through the Azure portal until you delete the resource.
Use the free pricing tier to try the service, and upgrade later to a paid tier for production.
The Bing Spell Check API is also offered in some tiers of the Bing Search v7 resource.

Multi-service resource

Available through the Azure portal until you delete the resource.
Use the same key and endpoint for your applications, across multiple Azure AI services.

Create and initialize the application

Create a new Ruby file in your favorite editor or IDE, and add the following requirements:
```
require 'net/http'
require 'uri'
require 'json'
```
Create variables for your subscription key, endpoint URI, and path. You can use the global endpoint in the following code, or use the custom subdomain endpoint displayed in the Azure portal for your resource. Create your request parameters:
1. Assign your market code to the mkt parameter with the = operator. The market code is the code of the country/region you make the request from.
2. Add the mode parameter with the & operator, and then assign the spell-check mode. The mode can be either proof (catches most spelling/grammar errors) or spell (catches most spelling errors, but not as many grammar errors).
```
key = 'ENTER YOUR KEY HERE'
uri = 'https://api.cognitive.microsoft.com'
path = '/bing/v7.0/spellcheck?'
params = 'mkt=en-us&mode=proof'
```

Send a spell check request

Create a URI from your host uri, path, and parameters string. Set its query to contain the text you want to spell check.
```
uri = URI(uri + path + params)
uri.query = URI.encode_www_form({
   # Request parameters
'text' => 'Hollo, wrld!'
})
```

Create a request using the URI constructed previously. Add your key to the Ocp-Apim-Subscription-Key header.

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

Send the request.

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

Get the JSON response, and print it to the console.

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

Run the application

Build and run your project. If you're using the command line, use the following command to run the application:

ruby <FILE_NAME>.rb

Example JSON response

A successful response is returned in JSON, as shown in the following example:

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

Next steps

Create a single-page web app