Skip to main content
POST
/
v3
/
model-factory
Generate model from the given data sample
curl --request POST \
  --url https://api.example.com/v3/model-factory \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "spec": {
    "schema_version": 1,
    "inputs": [
      "<string>"
    ],
    "outputs": [
      "<string>"
    ],
    "targets": [
      "<string>"
    ],
    "decisions": [
      "<string>"
    ],
    "metadata": [
      "<string>"
    ],
    "custom_features": [
      {
        "name": "<string>",
        "columns": [
          "<string>"
        ],
        "centroids": [
          123
        ],
        "tf_idf": [
          {}
        ],
        "n_clusters": 123,
        "monitor_components": true
      }
    ]
  },
  "max_cardinality": 1000,
  "sample_size": 10000
}
'
import requests

url = "https://api.example.com/v3/model-factory"

payload = {
    "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "spec": {
        "schema_version": 1,
        "inputs": ["<string>"],
        "outputs": ["<string>"],
        "targets": ["<string>"],
        "decisions": ["<string>"],
        "metadata": ["<string>"],
        "custom_features": [
            {
                "name": "<string>",
                "columns": ["<string>"],
                "centroids": [123],
                "tf_idf": [{}],
                "n_clusters": 123,
                "monitor_components": True
            }
        ]
    },
    "max_cardinality": 1000,
    "sample_size": 10000
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    file_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    spec: {
      schema_version: 1,
      inputs: ['<string>'],
      outputs: ['<string>'],
      targets: ['<string>'],
      decisions: ['<string>'],
      metadata: ['<string>'],
      custom_features: [
        {
          name: '<string>',
          columns: ['<string>'],
          centroids: [123],
          tf_idf: [{}],
          n_clusters: 123,
          monitor_components: true
        }
      ]
    },
    max_cardinality: 1000,
    sample_size: 10000
  })
};

fetch('https://api.example.com/v3/model-factory', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v3/model-factory",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'file_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'spec' => [
        'schema_version' => 1,
        'inputs' => [
                '<string>'
        ],
        'outputs' => [
                '<string>'
        ],
        'targets' => [
                '<string>'
        ],
        'decisions' => [
                '<string>'
        ],
        'metadata' => [
                '<string>'
        ],
        'custom_features' => [
                [
                                'name' => '<string>',
                                'columns' => [
                                                                '<string>'
                                ],
                                'centroids' => [
                                                                123
                                ],
                                'tf_idf' => [
                                                                [
                                                                                                                                
                                                                ]
                                ],
                                'n_clusters' => 123,
                                'monitor_components' => true
                ]
        ]
    ],
    'max_cardinality' => 1000,
    'sample_size' => 10000
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v3/model-factory"

	payload := strings.NewReader("{\n  \"file_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"spec\": {\n    \"schema_version\": 1,\n    \"inputs\": [\n      \"<string>\"\n    ],\n    \"outputs\": [\n      \"<string>\"\n    ],\n    \"targets\": [\n      \"<string>\"\n    ],\n    \"decisions\": [\n      \"<string>\"\n    ],\n    \"metadata\": [\n      \"<string>\"\n    ],\n    \"custom_features\": [\n      {\n        \"name\": \"<string>\",\n        \"columns\": [\n          \"<string>\"\n        ],\n        \"centroids\": [\n          123\n        ],\n        \"tf_idf\": [\n          {}\n        ],\n        \"n_clusters\": 123,\n        \"monitor_components\": true\n      }\n    ]\n  },\n  \"max_cardinality\": 1000,\n  \"sample_size\": 10000\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/v3/model-factory")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"file_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"spec\": {\n    \"schema_version\": 1,\n    \"inputs\": [\n      \"<string>\"\n    ],\n    \"outputs\": [\n      \"<string>\"\n    ],\n    \"targets\": [\n      \"<string>\"\n    ],\n    \"decisions\": [\n      \"<string>\"\n    ],\n    \"metadata\": [\n      \"<string>\"\n    ],\n    \"custom_features\": [\n      {\n        \"name\": \"<string>\",\n        \"columns\": [\n          \"<string>\"\n        ],\n        \"centroids\": [\n          123\n        ],\n        \"tf_idf\": [\n          {}\n        ],\n        \"n_clusters\": 123,\n        \"monitor_components\": true\n      }\n    ]\n  },\n  \"max_cardinality\": 1000,\n  \"sample_size\": 10000\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v3/model-factory")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"file_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"spec\": {\n    \"schema_version\": 1,\n    \"inputs\": [\n      \"<string>\"\n    ],\n    \"outputs\": [\n      \"<string>\"\n    ],\n    \"targets\": [\n      \"<string>\"\n    ],\n    \"decisions\": [\n      \"<string>\"\n    ],\n    \"metadata\": [\n      \"<string>\"\n    ],\n    \"custom_features\": [\n      {\n        \"name\": \"<string>\",\n        \"columns\": [\n          \"<string>\"\n        ],\n        \"centroids\": [\n          123\n        ],\n        \"tf_idf\": [\n          {}\n        ],\n        \"n_clusters\": 123,\n        \"monitor_components\": true\n      }\n    ]\n  },\n  \"max_cardinality\": 1000,\n  \"sample_size\": 10000\n}"

response = http.request(request)
puts response.read_body
{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "schema": {
      "schema_version": 1,
      "columns": [
        {
          "name": "<string>",
          "id": "<string>",
          "min": 123,
          "max": 123,
          "categories": [
            "<string>"
          ],
          "bins": [
            123
          ],
          "replace_with_nulls": [
            "<string>"
          ],
          "n_dimensions": 123
        }
      ]
    },
    "spec": {
      "schema_version": 1,
      "inputs": [
        "<string>"
      ],
      "outputs": [
        "<string>"
      ],
      "targets": [
        "<string>"
      ],
      "decisions": [
        "<string>"
      ],
      "metadata": [
        "<string>"
      ],
      "custom_features": [
        {
          "name": "<string>",
          "columns": [
            "<string>"
          ],
          "centroids": [
            123
          ],
          "tf_idf": [
            {}
          ],
          "n_clusters": 123,
          "monitor_components": true
        }
      ]
    }
  }
}
{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}
{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
file_id
string<uuid>
required
​
spec
object
​
max_cardinality
integer
default:1000
Required range: 1 <= x <= 100000
​
sample_size
integer
default:10000
Required range: 10000 <= x <= 100000

Response

Generated model

Response object for standard API responses.

​
api_version
enum<string>
default:3.0

API version.

Available options:
2.0,
3.0
​
kind
enum<string>
default:NORMAL

Type of response, indicating a normal response.

Available options:
NORMAL
​
data
object