NLP API

API change history

The NLP API gives you RESTful access to our v2 Natural Language Processing engine.

Summarize

This API endpoint allows users to create an automatic summary of multiple documents.

Try it

Request

Request URL

Request headers

  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

The POST request body should be a JSON of the following format:

{
  "summary_length": <how many sentences the output summary should contain>,
  "articles": [<Article objects>],
  "coref": false,
  "sort_by_salience": false,
  "include_all_sentences": false
}

The Article objects must have one of the following formats:

  • Web article URLs:

    { "url": "http://www.nytimes.com/2015/05/19/us/politics/bernie-sanders-wants-to-be-president-but-hes-already-facebook-royalty.html" }
    
  • Article title and body in plain text:

    {
      "title": "An unlikely contender, Sanders takes on ‘billionaire class’ in 2016 bid",
      "text": "He seems an unlikely presidential candidate — an ex-hippie, septuagenarian socialist from the liberal reaches of Vermont who rails, in his thick Brooklyn accent, rumpled suit and frizzy pile of white hair, against the “billionaire class” taking over the country..."
    }
    
  • Optionally, metadata information about the article can be embedded in the metadata field of the article as a JSON object. This information will be transparently passed-through to the summary response::

    { "metadata": {"origin": "Azure portal"} }
    

There are several optional flags that can be set to true to modify the output of the summarizer API:

Flag Definition
sort_by_salience Flag to determine whether to order the sentences in the results by salience. If set to false, the sentences in the summary will be sorted by order of appearance. Defaults to false.
include_all_sentences Flag to determine whether all sentences in the input articles should be included in the summary. If set to true, the summary_length parameter is ignored. Defaults to false. Useful when combined with the sort_by_salience flag.
coref Flag to determine whether or not coreferences should be resolved. May cause a performance hit if set to true. Defaults to false.

{
  "summary_length": 5,
  "articles": [
    {
      "type": "article",
      "url": "http://www.nytimes.com/2015/07/09/business/dealbook/new-york-stock-exchange-suspends-trading.html",
      "metadata": {"origin": "Azure portal"}
    }
  ]
}

Responses

200 OK

A successful response will be a JSON object with the following attributes:

  • title: The title of the summary, if applicable.

  • photos: An array of photo URLs from the input items, if applicable.

  • summary: An array of summary sentences and item metadata, grouped by item. Each element is a Summary object.

Each Summary object contains the following fields:

  • metadata: An object that is a transparent pass-through of the metadata from the input Articles.

  • sentences: An array of sentences summarizing the input items.

  • ranks: Each element in this array corresponds to each sentence in the sentences array. The integer denotes where the sentence ranks in salience across all Articles. 1 is the most salient sentence in the entire collection of Articles.

Representations

{
  "summary": [
    {
      "metadata": {
        "origin": "Azure portal",
        "url": "http://www.nytimes.com/2015/07/09/business/dealbook/new-york-stock-exchange-suspends-trading.html",
        "source": "www.nytimes.com",
        "icon": "https://static01.nyt.com/favicon.ico"
      },
      "sentences": [
        "“When we traded physically we didn’t have these problems, but this is the world that we live in,” said Ted Weisberg, a trader with Seaport Securities who has been on the floor of the New York Stock Exchange for nearly 50 years.",
        "New powers have emerged, including the Intercontinental Exchange, or ICE, a commodities and derivatives trading platform based in Atlanta that acquired the New York Stock Exchange for $8.2 billion in 2013.",
        "Other exchanges owned by the New York Stock Exchange, like its options exchange, operated normally on Wednesday throughout the shutdown.",
        "In the silence that followed, traders on the floor, looking for information, flocked to a ramped area of the huge complex on Wall Street where employees of the exchange are located.",
        "Mary Jo White, the chairwoman of the Securities and Exchange Commission, which oversees the nation’s securities markets, said in a statement, “We are in contact with N.Y.S.E. and are closely monitoring the situation and trading in N.Y.S.E.-listed stocks.”"
      ],
      "ranks": [
        3,
        2,
        1,
        5,
        4
      ]
    }
  ],
  "title": "The Stock Market Bell Rings, Computers Fail, Wall Street Cringes",
  "photos": [
    "https://static01.nyt.com/images/2015/07/09/business/09DB-TRADE1/09DB-TRADE1-facebookJumbo.jpg"
  ]
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.agolo.com/nlp/v0.2/summarize"
-H "Content-Type: application/json"
-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}");

            var uri = "https://api.agolo.com/nlp/v0.2/summarize?" + 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://api.agolo.com/nlp/v0.2/summarize");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");
            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
        };
      
        $.ajax({
            url: "https://api.agolo.com/nlp/v0.2/summarize?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                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://api.agolo.com/nlp/v0.2/summarize";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_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://api.agolo.com/nlp/v0.2/summarize');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$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
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.agolo.com')
    conn.request("POST", "/nlp/v0.2/summarize?%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
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.agolo.com')
    conn.request("POST", "/nlp/v0.2/summarize?%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://api.agolo.com/nlp/v0.2/summarize')

request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# 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