Spell Check API - v7

Spell Check

Select the testing console in the region where you created your resource:

Global West US West US 2 East US East US 2 West Central US South Central US West Europe North Europe Southeast Asia East Asia Australia East Brazil South Canada Central Central India UK South Japan East Central US France Central Korea Central Japan West North Central US South Africa North

Request URL

Request parameters

string

The text string to check for spelling and grammar errors.

(optional)
string

Mode of spellcheck:

  • Proof - Meant to provide Office Word like spelling corrections. It can correct long queries, provide casing corrections and suppresses aggressive corrections.
  • Spell - Meant to provide Search engine like spelling corrections. It will correct small queries(up to length 9 tokens) without any casing changes and will be more optimized (perf and relevance) towards search like queries.
(optional)
string

A string that gives context to the text string. For example, the text string petal is valid; however, if you set preContextText to bike, the context changes and the text string becomes not valid. In this case, the API will suggest that you change petal to pedal (as in bike pedal).

(optional)
string

A string that gives context to the text string. For example, the text string read is valid; however, if you set postContextText to carpet, the context changes and the text string becomes not valid. In this case, the API will suggest that you change read to red (as in red carpet).

(optional)
string

For proof mode, only support en-us, es-es, pt-br, For spell mode, support all language codes.

Request headers

string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.

Request body

Response 200

{
  "_type": "SpellCheck",
  "flaggedTokens": [
    {
      "offset": 5,
      "token": "Gatas",
      "type": "UnknownToken",
      "suggestions": [
        {
          "suggestion": "Gates",
          "score": 1
        }
      ]
    }
  ]
}

Response 400

{
    "_type": "ErrorResponse",
    "instrumentation": {},
    "errors": [
        {
            "code": "InvalidRequest",
            "subCode": "ParameterMissing",
            "message": "Required parameter is missing.",
            "parameter": "text"
        }
    ]
}

Response 401

{
    "error":{
        "statusCode": 401,
        "message": "Access denied due to invalid subscription key. Make sure you are subscribed to an API you are trying to call and provide the right key." 
    }
}

Response 403

{
    "error":{
        "statusCode": 403,
        "message": "Out of call volume quota. Quota will be replenished in 2.12 days." 
    }
}

Response 429

{
    "error":{
        "statusCode": 429,
        "message": "Rate limit is exceeded. Try again in 26 seconds." 
    }
}

Code samples

@ECHO OFF

curl -v -X GET "https://eastasia.api.cognitive.microsoft.com/bing/v7.0/spellcheck/?text=Bill Gatas&mode={string}&preContextText={string}&postContextText={string}&mkt={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["text"] = "Bill Gatas";
            queryString["mode"] = "{string}";
            queryString["preContextText"] = "{string}";
            queryString["postContextText"] = "{string}";
            queryString["mkt"] = "{string}";
            var uri = "https://eastasia.api.cognitive.microsoft.com/bing/v7.0/spellcheck/?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://eastasia.api.cognitive.microsoft.com/bing/v7.0/spellcheck/");

            builder.setParameter("text", "Bill Gatas");
            builder.setParameter("mode", "{string}");
            builder.setParameter("preContextText", "{string}");
            builder.setParameter("postContextText", "{string}");
            builder.setParameter("mkt", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "text": "Bill Gatas",
            "mode": "{string}",
            "preContextText": "{string}",
            "postContextText": "{string}",
            "mkt": "{string}",
        };
      
        $.ajax({
            url: "https://eastasia.api.cognitive.microsoft.com/bing/v7.0/spellcheck/?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://eastasia.api.cognitive.microsoft.com/bing/v7.0/spellcheck/";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"text=Bill Gatas",
                         @"mode={string}",
                         @"preContextText={string}",
                         @"postContextText={string}",
                         @"mkt={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://eastasia.api.cognitive.microsoft.com/bing/v7.0/spellcheck/');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'text' => 'Bill Gatas',
    'mode' => '{string}',
    'preContextText' => '{string}',
    'postContextText' => '{string}',
    'mkt' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'text': 'Bill Gatas',
    'mode': '{string}',
    'preContextText': '{string}',
    'postContextText': '{string}',
    'mkt': '{string}',
})

try:
    conn = httplib.HTTPSConnection('eastasia.api.cognitive.microsoft.com')
    conn.request("GET", "/bing/v7.0/spellcheck/?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'text': 'Bill Gatas',
    'mode': '{string}',
    'preContextText': '{string}',
    'postContextText': '{string}',
    'mkt': '{string}',
})

try:
    conn = http.client.HTTPSConnection('eastasia.api.cognitive.microsoft.com')
    conn.request("GET", "/bing/v7.0/spellcheck/?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://eastasia.api.cognitive.microsoft.com/bing/v7.0/spellcheck/')
uri.query = URI.encode_www_form({
    # Request parameters
    'text' => 'Bill Gatas',
    'mode' => '{string}',
    'preContextText' => '{string}',
    'postContextText' => '{string}',
    'mkt' => '{string}'
})

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

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

puts response.body