Nexosis Api
Sessions: Retrieve class scores
Gets the class scores for each result of a particular completed classification model session
Whereas classification session results indicate the class chosen for each row in the test set, this endpoint returns the scores for each possible class for ech row in the test set. Higher scores indicate that the model is more confident that the row fits into the specified class, but the scores are not strict probabilities, and they are not comparable across sessions or data sources.
Try itRequest URL
Request parameters
string
Format - uuid. Session identifier for which to retrieve scores
(optional)
integer
Format - int32. Zero-based page number of class scores to retrieve
(optional)
integer
Format - int32. Count of class scores to retrieve in each page (max 1000)
Request headers
Request body
Response 200
success
{
"data": [
{
"species:setosa": "0.9",
"species:veriscolour": "0.1",
"species:virginica": "0.1",
"species": "setosa"
},
{
"species:setosa": "0.8",
"species:veriscolour": "0.3",
"species:virginica": "0.1",
"species": "setosa"
},
{
"species:setosa": "0",
"species:veriscolour": "0.99",
"species:virginica": "0.01",
"species": "veriscolour"
},
{
"species:setosa": "0.2",
"species:veriscolour": "1.1",
"species:virginica": "0.1",
"species": "veriscolour"
},
{
"species:setosa": "0.3",
"species:veriscolour": "0.55",
"species:virginica": "0.7",
"species": "virginica"
}
],
"approximateCompletionPercentage": 0,
"pageNumber": 0,
"totalPages": 0,
"pageSize": 0,
"totalCount": 0,
"classes": [
"setosa",
"veriscolour",
"virginica"
],
"sessionId": "5172cf33-1172-486e-9d31-fd98cff08f90",
"type": "model",
"status": "completed",
"predictionDomain": "classification",
"supportsFeatureImportance": false,
"requestedDate": "0001-01-01T00:00:00+00:00",
"statusHistory": [],
"extraParameters": {},
"messages": [],
"dataSourceName": "iris",
"dataSetName": "iris",
"targetColumn": "species",
"callbackUrl": "",
"isEstimate": false,
"links": []
}
{
"type": "object",
"properties": {
"featureImportance": {
"type": "object",
"additionalProperties": {
"format": "double",
"type": "number"
}
},
"metrics": {
"type": "object",
"additionalProperties": {
"format": "double",
"type": "number"
}
},
"data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"approximateCompletionPercentage": {
"format": "int32",
"type": "integer"
},
"pageNumber": {
"format": "int32",
"type": "integer"
},
"totalPages": {
"format": "int32",
"type": "integer"
},
"pageSize": {
"format": "int32",
"type": "integer"
},
"totalCount": {
"format": "int32",
"type": "integer"
},
"classes": {
"type": "array",
"items": {
"type": "string"
}
},
"confusionMatrix": {
"type": "array",
"items": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
}
},
"sessionId": {
"format": "uuid",
"type": "string"
},
"type": {
"enum": [
"import",
"forecast",
"impact",
"model"
],
"type": "string"
},
"status": {
"enum": [
"requested",
"started",
"completed",
"cancelled",
"failed",
"estimated",
"cancellationPending"
],
"type": "string"
},
"eventName": {
"type": "string"
},
"predictionDomain": {
"type": "string"
},
"supportsFeatureImportance": {
"type": "boolean"
},
"availablePredictionIntervals": {
"type": "array",
"items": {
"type": "string"
}
},
"modelId": {
"format": "uuid",
"type": "string"
},
"startDate": {
"format": "date-time",
"type": "string"
},
"endDate": {
"format": "date-time",
"type": "string"
},
"resultInterval": {
"enum": [
"hour",
"day",
"week",
"month",
"year"
],
"type": "string"
},
"requestedDate": {
"format": "date-time",
"type": "string"
},
"statusHistory": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"format": "date-time",
"type": "string"
},
"status": {
"enum": [
"requested",
"started",
"completed",
"cancelled",
"failed",
"estimated",
"cancellationPending"
],
"type": "string"
}
}
}
},
"extraParameters": {
"type": "object",
"properties": {
"event": {
"type": "string"
},
"balance": {
"type": "boolean"
},
"containsAnomalies": {
"type": "boolean"
}
}
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"severity": {
"enum": [
"informational",
"warning",
"error",
"status",
"debug"
],
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"name": {
"type": "string"
},
"dataSourceName": {
"type": "string"
},
"targetColumn": {
"type": "string"
},
"algorithm": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"key": {
"type": "string"
}
}
},
"callbackUrl": {
"type": "string"
},
"missingValues": {
"type": "array",
"items": {
"type": "string"
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string",
"readOnly": true
},
"href": {
"type": "string",
"readOnly": true
}
}
},
"readOnly": true
}
}
}
{
"data": [
{
"species:setosa": "0.9",
"species:veriscolour": "0.1",
"species:virginica": "0.1",
"species": "setosa"
},
{
"species:setosa": "0.8",
"species:veriscolour": "0.3",
"species:virginica": "0.1",
"species": "setosa"
},
{
"species:setosa": "0",
"species:veriscolour": "0.99",
"species:virginica": "0.01",
"species": "veriscolour"
},
{
"species:setosa": "0.2",
"species:veriscolour": "1.1",
"species:virginica": "0.1",
"species": "veriscolour"
},
{
"species:setosa": "0.3",
"species:veriscolour": "0.55",
"species:virginica": "0.7",
"species": "virginica"
}
],
"approximateCompletionPercentage": 0,
"pageNumber": 0,
"totalPages": 0,
"pageSize": 0,
"totalCount": 0,
"classes": [
"setosa",
"veriscolour",
"virginica"
],
"sessionId": "5172cf33-1172-486e-9d31-fd98cff08f90",
"type": "model",
"status": "completed",
"predictionDomain": "classification",
"supportsFeatureImportance": false,
"requestedDate": "0001-01-01T00:00:00+00:00",
"statusHistory": [],
"extraParameters": {},
"messages": [],
"dataSourceName": "iris",
"dataSetName": "iris",
"targetColumn": "species",
"callbackUrl": "",
"isEstimate": false,
"links": []
}
{
"type": "object",
"properties": {
"featureImportance": {
"type": "object",
"additionalProperties": {
"format": "double",
"type": "number"
}
},
"metrics": {
"type": "object",
"additionalProperties": {
"format": "double",
"type": "number"
}
},
"data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"approximateCompletionPercentage": {
"format": "int32",
"type": "integer"
},
"pageNumber": {
"format": "int32",
"type": "integer"
},
"totalPages": {
"format": "int32",
"type": "integer"
},
"pageSize": {
"format": "int32",
"type": "integer"
},
"totalCount": {
"format": "int32",
"type": "integer"
},
"classes": {
"type": "array",
"items": {
"type": "string"
}
},
"confusionMatrix": {
"type": "array",
"items": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
}
},
"sessionId": {
"format": "uuid",
"type": "string"
},
"type": {
"enum": [
"import",
"forecast",
"impact",
"model"
],
"type": "string"
},
"status": {
"enum": [
"requested",
"started",
"completed",
"cancelled",
"failed",
"estimated",
"cancellationPending"
],
"type": "string"
},
"eventName": {
"type": "string"
},
"predictionDomain": {
"type": "string"
},
"supportsFeatureImportance": {
"type": "boolean"
},
"availablePredictionIntervals": {
"type": "array",
"items": {
"type": "string"
}
},
"modelId": {
"format": "uuid",
"type": "string"
},
"startDate": {
"format": "date-time",
"type": "string"
},
"endDate": {
"format": "date-time",
"type": "string"
},
"resultInterval": {
"enum": [
"hour",
"day",
"week",
"month",
"year"
],
"type": "string"
},
"requestedDate": {
"format": "date-time",
"type": "string"
},
"statusHistory": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"format": "date-time",
"type": "string"
},
"status": {
"enum": [
"requested",
"started",
"completed",
"cancelled",
"failed",
"estimated",
"cancellationPending"
],
"type": "string"
}
}
}
},
"extraParameters": {
"type": "object",
"properties": {
"event": {
"type": "string"
},
"balance": {
"type": "boolean"
},
"containsAnomalies": {
"type": "boolean"
}
}
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"severity": {
"enum": [
"informational",
"warning",
"error",
"status",
"debug"
],
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"name": {
"type": "string"
},
"dataSourceName": {
"type": "string"
},
"targetColumn": {
"type": "string"
},
"algorithm": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"key": {
"type": "string"
}
}
},
"callbackUrl": {
"type": "string"
},
"missingValues": {
"type": "array",
"items": {
"type": "string"
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string",
"readOnly": true
},
"href": {
"type": "string",
"readOnly": true
}
}
},
"readOnly": true
}
}
}
Response 400
One or more parameters are invalid
{
"statusCode": 400,
"message": "Request is invalid",
"errorType": "RequestValidation",
"errorDetails": {
"sessionId": [
"Value for sessionId must be a valid GUID"
]
}
}
{
"type": "object",
"properties": {
"statusCode": {
"format": "int32",
"type": "integer"
},
"message": {
"type": "string"
},
"errorType": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
{
"statusCode": 400,
"message": "Request is invalid",
"errorType": "RequestValidation",
"errorDetails": {
"sessionId": [
"Value for sessionId must be a valid GUID"
]
}
}
{
"type": "object",
"properties": {
"statusCode": {
"format": "int32",
"type": "integer"
},
"message": {
"type": "string"
},
"errorType": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
Response 404
notfound
{
"statusCode": 404,
"message": "Item of type session with identifier 5172cf33-1172-486e-9d31-fd98cff08f90 was not found",
"errorType": "NotFound",
"errorDetails": {
"itemType": "session",
"itemId": "5172cf33-1172-486e-9d31-fd98cff08f90"
}
}
{
"type": "object",
"properties": {
"statusCode": {
"format": "int32",
"type": "integer"
},
"message": {
"type": "string"
},
"errorType": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
{
"statusCode": 404,
"message": "Item of type session with identifier 5172cf33-1172-486e-9d31-fd98cff08f90 was not found",
"errorType": "NotFound",
"errorDetails": {
"itemType": "session",
"itemId": "5172cf33-1172-486e-9d31-fd98cff08f90"
}
}
{
"type": "object",
"properties": {
"statusCode": {
"format": "int32",
"type": "integer"
},
"message": {
"type": "string"
},
"errorType": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
Code samples
@ECHO OFF
curl -v -X GET "https://ml.nexosis.com/v1/sessions/{sessionId}/results/classScores?page={integer}&pageSize={integer}"
-H "api-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("api-key", "{subscription key}");
// Request parameters
queryString["page"] = "{integer}";
queryString["pageSize"] = "{integer}";
var uri = "https://ml.nexosis.com/v1/sessions/{sessionId}/results/classScores?" + 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://ml.nexosis.com/v1/sessions/{sessionId}/results/classScores");
builder.setParameter("page", "{integer}");
builder.setParameter("pageSize", "{integer}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("api-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
"page": "{integer}",
"pageSize": "{integer}",
};
$.ajax({
url: "https://ml.nexosis.com/v1/sessions/{sessionId}/results/classScores?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("api-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://ml.nexosis.com/v1/sessions/{sessionId}/results/classScores";
NSArray* array = @[
// Request parameters
@"entities=true",
@"page={integer}",
@"pageSize={integer}",
];
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:@"api-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://ml.nexosis.com/v1/sessions/{sessionId}/results/classScores');
$url = $request->getUrl();
$headers = array(
// Request headers
'api-key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'page' => '{integer}',
'pageSize' => '{integer}',
);
$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
'api-key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'page': '{integer}',
'pageSize': '{integer}',
})
try:
conn = httplib.HTTPSConnection('ml.nexosis.com')
conn.request("GET", "/v1/sessions/{sessionId}/results/classScores?%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
'api-key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'page': '{integer}',
'pageSize': '{integer}',
})
try:
conn = http.client.HTTPSConnection('ml.nexosis.com')
conn.request("GET", "/v1/sessions/{sessionId}/results/classScores?%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://ml.nexosis.com/v1/sessions/{sessionId}/results/classScores')
query = URI.encode_www_form({
# Request parameters
'page' => '{integer}',
'pageSize' => '{integer}'
})
if query.length > 0
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['api-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