Web Language Model API

Break Into Words

Insert spaces into a string of words lacking spaces, like a hashtag or part of a URL. Punctuation or exotic characters can prevent a string from being broken, so it’s best to limit input strings to lower-case, alpha-numeric characters.

Open API testing console

Request URL

Request parameters

string

Which model to use, supported value: title/anchor/query/body

string

The line of text to break into words. If spaces are present, they will be interpreted as hard breaks and maintained, except for leading or trailing spaces, which will be trimmed.

(optional)
number

The order of N-gram. If not specified, use default value 5 .Supported value: 1, 2, 3, 4, 5.

(optional)
number

Max number of candidates would be returned. If not specified, use default value 5.

Request headers

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

Request body

empty post body

Response 200

A successful call returns an array of candidate words and their probabilities.

{
	"candidates" :
	[
		{
			"words" : "test for word break",
			"probability" :  -13.911
		},
		{
			"words" : "test for wordbreak",
			"probability" :  -14.574
		}
	]
}

Response 400

JSON Payload:
Example 1:
{ "code": BadArgument, "message": "The model is not supported." }

Example 2:
{ "code": BadArgument, "message": "The length of text is not in a valid range." }

Example 3:
{ "code": BadArgument, "message": "Invalid N-gram order." }

Example 4:
{ "code": BadArgument, "message": "Invalid max number of candidates returned." }

Response 401

{ "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

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

Response 429

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

Code samples

@ECHO OFF

curl -v -X POST "https://westus.api.cognitive.microsoft.com/text/weblm/v1.0/breakIntoWords?model={string}&text={string}&order={number}&maxNumOfCandidatesReturned={number}"
-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["model"] = "{string}";
            queryString["text"] = "{string}";
            queryString["order"] = "{number}";
            queryString["maxNumOfCandidatesReturned"] = "{number}";
            var uri = "https://westus.api.cognitive.microsoft.com/text/weblm/v1.0/breakIntoWords?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // 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://westus.api.cognitive.microsoft.com/text/weblm/v1.0/breakIntoWords");

            builder.setParameter("model", "{string}");
            builder.setParameter("text", "{string}");
            builder.setParameter("order", "{number}");
            builder.setParameter("maxNumOfCandidatesReturned", "{number}");

            URI uri = builder.build();
            HttpPost request = new HttpPost(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
            "model": "{string}",
            "text": "{string}",
            "order": "{number}",
            "maxNumOfCandidatesReturned": "{number}",
        };
      
        $.ajax({
            url: "https://westus.api.cognitive.microsoft.com/text/weblm/v1.0/breakIntoWords?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // 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://westus.api.cognitive.microsoft.com/text/weblm/v1.0/breakIntoWords";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"model={string}",
                         @"text={string}",
                         @"order={number}",
                         @"maxNumOfCandidatesReturned={number}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // 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://westus.api.cognitive.microsoft.com/text/weblm/v1.0/breakIntoWords');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'model' => '{string}',
    'text' => '{string}',
    'order' => '{number}',
    'maxNumOfCandidatesReturned' => '{number}',
);

$url->setQueryVariables($parameters);

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

// 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
    'model': '{string}',
    'text': '{string}',
    'order': '{number}',
    'maxNumOfCandidatesReturned': '{number}',
})

try:
    conn = httplib.HTTPSConnection('westus.api.cognitive.microsoft.com')
    conn.request("POST", "/text/weblm/v1.0/breakIntoWords?%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
    'model': '{string}',
    'text': '{string}',
    'order': '{number}',
    'maxNumOfCandidatesReturned': '{number}',
})

try:
    conn = http.client.HTTPSConnection('westus.api.cognitive.microsoft.com')
    conn.request("POST", "/text/weblm/v1.0/breakIntoWords?%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://westus.api.cognitive.microsoft.com/text/weblm/v1.0/breakIntoWords')
uri.query = URI.encode_www_form({
    # Request parameters
    'model' => '{string}',
    'text' => '{string}',
    'order' => '{number}',
    'maxNumOfCandidatesReturned' => '{number}'
})

request = Net::HTTP::Post.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