Nexosis Api
Vocabulary: Query Vocabularies
Gets summary information about the Vocabulary built from the Text columns in a session
Nexosis will automatically engineer features based on Feature columsn of type Text This endpoint describes the vocabularies that we built from the text columns in your Session
Try itRequest URL
Request parameters
(optional)
string
List Vocabularies from data sources matching this string
(optional)
string
Format - uuid. The Session Id used to create the vocabulary
(optional)
integer
Format - int32. The page number
(optional)
integer
Format - int32. The number of records in each page
Request headers
Request body
Response 200
success
{
"items": [
{
"id": "60f1e0b1-c1c4-4f9e-a7b6-c766b7c5a789",
"dataSourceName": "my_data_source",
"columnName": "column",
"dataSourceType": "dataSet",
"createdOnDate": "2018-06-01T19:14:41.6481506+00:00",
"createdBySessionId": "00000000-0000-0000-0000-000000000000",
"links": []
}
],
"pageNumber": 0,
"totalPages": 0,
"pageSize": 0,
"totalCount": 0,
"links": []
}
{
"items": [
{
"id": "60f1e0b1-c1c4-4f9e-a7b6-c766b7c5a789",
"dataSourceName": "my_data_source",
"columnName": "column",
"dataSourceType": "dataSet",
"createdOnDate": "2018-06-01T19:14:41.6481506+00:00",
"createdBySessionId": "00000000-0000-0000-0000-000000000000",
"links": []
}
],
"pageNumber": 0,
"totalPages": 0,
"pageSize": 0,
"totalCount": 0,
"links": []
}
Response 400
One or more parameters are invalid
{
"statusCode": 0,
"message": "string",
"errorType": "string",
"errorDetails": {}
}
{
"type": "object",
"properties": {
"statusCode": {
"format": "int32",
"type": "integer"
},
"message": {
"type": "string"
},
"errorType": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
{
"statusCode": 0,
"message": "string",
"errorType": "string",
"errorDetails": {}
}
{
"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/vocabulary?dataSource=my-data-source&createdFromSession=efff353c-34ec-4244-a531-a26e87cc372c&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["dataSource"] = "my-data-source";
queryString["createdFromSession"] = "efff353c-34ec-4244-a531-a26e87cc372c";
queryString["page"] = "{integer}";
queryString["pageSize"] = "{integer}";
var uri = "https://ml.nexosis.com/v1/vocabulary?" + 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/vocabulary");
builder.setParameter("dataSource", "my-data-source");
builder.setParameter("createdFromSession", "efff353c-34ec-4244-a531-a26e87cc372c");
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
"dataSource": "my-data-source",
"createdFromSession": "efff353c-34ec-4244-a531-a26e87cc372c",
"page": "{integer}",
"pageSize": "{integer}",
};
$.ajax({
url: "https://ml.nexosis.com/v1/vocabulary?" + $.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/vocabulary";
NSArray* array = @[
// Request parameters
@"entities=true",
@"dataSource=my-data-source",
@"createdFromSession=efff353c-34ec-4244-a531-a26e87cc372c",
@"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/vocabulary');
$url = $request->getUrl();
$headers = array(
// Request headers
'api-key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'dataSource' => 'my-data-source',
'createdFromSession' => 'efff353c-34ec-4244-a531-a26e87cc372c',
'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
'dataSource': 'my-data-source',
'createdFromSession': 'efff353c-34ec-4244-a531-a26e87cc372c',
'page': '{integer}',
'pageSize': '{integer}',
})
try:
conn = httplib.HTTPSConnection('ml.nexosis.com')
conn.request("GET", "/v1/vocabulary?%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
'dataSource': 'my-data-source',
'createdFromSession': 'efff353c-34ec-4244-a531-a26e87cc372c',
'page': '{integer}',
'pageSize': '{integer}',
})
try:
conn = http.client.HTTPSConnection('ml.nexosis.com')
conn.request("GET", "/v1/vocabulary?%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/vocabulary')
query = URI.encode_www_form({
# Request parameters
'dataSource' => 'my-data-source',
'createdFromSession' => 'efff353c-34ec-4244-a531-a26e87cc372c',
'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