Academic Search API

Interpret

The interpret REST API takes an end user query string (i.e., a query entered by a user of your application) and returns formatted interpretations of user intent based on the Academic Graph data and the Academic Grammar. To provide an interactive experience, you can call this method repeatedly after each character entered by the user. In that case, you should set the complete parameter to 1 to enable auto-complete suggestions. If your application does not want auto-completion, you should set the complete parameter to 0.

Open API testing console

Request URL

Request parameters

string

Query entered by user. If complete is set to 1, query will be interpreted as a prefix for generating query auto-completion suggestions.

(optional)
boolean

1 means that auto-completion suggestions are generated based on the grammar and graph data.

(optional)
number

Maximum number of interpretations to return.

(optional)
number

Index of the first interpretation to return. For example, count=2&offset=0 returns interpretations 0 and 1. count=2&offset=2 returns interpretations 2 and 3.

(optional)
number

Timeout in milliseconds. Only interpretations found before the timeout has elapsed are returned.

(optional)
string

Name of the model that you wish to query. Currently, the value defaults to "latest".

Request headers

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

Request body

Response 200

Response (JSON)

 
NameDescription
query The query parameter from the request.
interpretations An array of 0 or more different ways of matching user input against the grammar.
interpretations[x].prob The relative probability of the interpretation, on a scale from 0 to 1. A higher value means more likely.
interpretations[x].parse An XML string that shows how each part of the query was interpreted.
interpretations[x].rules An array of 1 or more rules defined in the grammar that were invoked during interpretation. For the Academic Knowledge API, there will always be 1 rule.
interpretations[x].rules[y].name Name of the rule.
interpretations[x].rules[y].output Output of the rule.
interpretations[x].rules[y].output.type The data type of the output of the rule. For the Academic Knowledge API, this will always be "query".
interpretations[x].rules[y].output.value The output of the rule. For the Academic Knowledge API, this is a query expression string that can be passed to the evaluate and calchistogram methods.
aborted True if the request timed out.

{
  "query": "papers by jaime",
  "interpretations": [
    {
      "prob": 2.429e-006,
      "parse": "<rule id=\"#GetPapers\">papers by <attr name=\"academic#AA.AuN\">jaime teevan</attr></rule>",
      "rules": [
        {
          "name": "#GetPapers",
          "output": {
            "type": "query",
            "value": "Composite(AA.AuN=='jaime teevan')"
          }
        }
      ]
    },
    {
      "prob": 1.416e-006,
      "parse": "<rule id=\"#GetPapers\">papers by <attr name=\"academic#AA.AuN\" canonical=\"j l green\">jaime green</attr></rule>",
      "rules": [
        {
          "name": "#GetPapers",
          "output": {
            "type": "query",
            "value": "Composite(AA.AuN=='j l green')"
          }
        }
      ]
    }
  ]
}

Response 400

{ "error": { "code": "Bad Argument", "message": "parameter is missing." } }

Response 401

{"error":{"code":"Unspecified","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 500

{ "error": { "code": "Unspecified", "message": "Internal server error." } }

Response 404

{ "error": { "code": "Unspecified", "message": "The requested resource is not found." } }

Response 403

{ "error": { "code": "QuotaExceeded", "message": "Out of call volume quota. Quota will be replenished later." } }

Code samples

@ECHO OFF

curl -v -X GET "https://westus.api.cognitive.microsoft.com/academic/v1.0/interpret?query={string}&complete=0&count=10&offset={number}&timeout={number}&model=latest"
-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["query"] = "{string}";
            queryString["complete"] = "0";
            queryString["count"] = "10";
            queryString["offset"] = "{number}";
            queryString["timeout"] = "{number}";
            queryString["model"] = "latest";
            var uri = "https://westus.api.cognitive.microsoft.com/academic/v1.0/interpret?" + 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://westus.api.cognitive.microsoft.com/academic/v1.0/interpret");

            builder.setParameter("query", "{string}");
            builder.setParameter("complete", "0");
            builder.setParameter("count", "10");
            builder.setParameter("offset", "{number}");
            builder.setParameter("timeout", "{number}");
            builder.setParameter("model", "latest");

            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
            "query": "{string}",
            "complete": "0",
            "count": "10",
            "offset": "{number}",
            "timeout": "{number}",
            "model": "latest",
        };
      
        $.ajax({
            url: "https://westus.api.cognitive.microsoft.com/academic/v1.0/interpret?" + $.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://westus.api.cognitive.microsoft.com/academic/v1.0/interpret";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"query={string}",
                         @"complete=0",
                         @"count=10",
                         @"offset={number}",
                         @"timeout={number}",
                         @"model=latest",
                      ];
    
    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://westus.api.cognitive.microsoft.com/academic/v1.0/interpret');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'query' => '{string}',
    'complete' => '0',
    'count' => '10',
    'offset' => '{number}',
    'timeout' => '{number}',
    'model' => 'latest',
);

$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
    'query': '{string}',
    'complete': '0',
    'count': '10',
    'offset': '{number}',
    'timeout': '{number}',
    'model': 'latest',
})

try:
    conn = httplib.HTTPSConnection('westus.api.cognitive.microsoft.com')
    conn.request("GET", "/academic/v1.0/interpret?%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
    'query': '{string}',
    'complete': '0',
    'count': '10',
    'offset': '{number}',
    'timeout': '{number}',
    'model': 'latest',
})

try:
    conn = http.client.HTTPSConnection('westus.api.cognitive.microsoft.com')
    conn.request("GET", "/academic/v1.0/interpret?%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/academic/v1.0/interpret')
uri.query = URI.encode_www_form({
    # Request parameters
    'query' => '{string}',
    'complete' => '0',
    'count' => '10',
    'offset' => '{number}',
    'timeout' => '{number}',
    'model' => 'latest'
})

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