Node Summarizer API

API change history

This API gives you RESTful access to our Node Summarizer NLP engine.

Node Summarizer is highly customizable and it combines the best of both Core and Coherent summarizers, generating summaries that are personalized based on clients' needs. The intention of this summarizer is to generate extractive summaries that are short, readable, focused on a single topic, and adhere to a set of rules provided by clients. For example, if a domain-expert client deems it valuable to pick out sentences with quantitative values such as cash amounts, percentages, and dates, we can customize Node Summarizer for this use case for this single client.

summarize

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 approximate words the output summary should contain>",
    "articles": [<Article objects>]

}

The Article objects must have one of the following two formats:

  • Web article URLs:

    { "url": "https://www.reuters.com/article/us-usa-immigration/white-house-softens-tone-after-threat-to-close-border-with-mexico-idUSKCN1RE1PE" }
    
  • Article title and body in plain text:

    {
      "title": "An unlikely contender, Sanders takes on ‘billionaire class’ in 2016 bid",
      "text": "The White House took a step back on Tuesday from a threat to close the U.S. border with Mexico, even as a redeployment of border officers in recent days has led to a slowdown of legal crossings and commerce at U.S. ports of entry there. White House spokeswoman Sarah Sanders said the..."
    }
    

Passing multiple input

You can perform multi-document summarization by passing multiple article URLs or text in the request body. The algorithm assumes the input articles are about the same topic or story.

If you pass two distinct stories, the summary for that cluster will not be very meaningful. For example, a story about a semiconductor company’s stock falling due to an earthquake and a story about the earthquake itself are related stories but are distinct stories.

Multiple input can be passed in this JSON format:

{
    "summary_length":"5",
    "articles":[
      {
        "url": "https://venturebeat.com/2017/05/03/microsoft-invests-in-agolo-a-startup-thats-fighting-information-overload-with-automated-summarizations/"}
      },
      {
        "url": "https://www.geekwire.com/2017/microsoft-ventures-doubles-ai-new-investments-agolo-bonsai/"}
      }
    ]
}

Example

Requests

{
 "summary_length":"5",
 "articles":[
    { 
        "url": "https://apnews.com/f79cc6f6223b489ab73eb32f1f7187e5"
    }
  ]
}

Responses

200 OK

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

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

  • photos: The photos from the article, if present.

  • sources: The name of the publisher, if applicable.

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

Representations

{
    "title": "Trump's threat to close border stirs fears of economic harm",
    "photos": [
        "https://storage.googleapis.com/afs-prod/media/media:9bd5b33247534157b904293deb6f0b49/3000.jpeg"
    ],
    "sources": [
        "AP NEWS"
    ],
    "sentences": [
        "President Donald Trump's threat to shut down the southern border raised fears Monday of dire economic consequences in the U. S. EL PASO, Texas — President Donald Trump’s threat to shut down the southern border raised fears Monday of dire economic consequences in the U. S. and an upheaval of daily life in a stretch of the country that relies on the international flow of not just goods and services but also students, families and workers.",
        "Trump brought up the possibility of closing ports of entry along the southern border Friday and revisited it in tweets over the weekend because of a surge of Central Americans migrants who are seeking asylum.",
        "Trump administration officials have said the influx is straining the immigration system to the breaking point.",
        "More than 60 percent of all Mexican winter produce consumed in the U. S. crosses into the country at Nogales, Arizona.",
        "Currently, about 750 inspectors are being reassigned."
    ]
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.agolo.com/node-summarizer/summarization"
-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/node-summarizer/summarization?" + 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/node-summarizer/summarization");


            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/node-summarizer/summarization?" + $.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/node-summarizer/summarization";
    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/node-summarizer/summarization');
$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", "/node-summarizer/summarization?%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", "/node-summarizer/summarization?%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/node-summarizer/summarization')

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