Submit Classification Storage Object v2

POST /v2/classify/storage-object

Classify Storage V2

cURL

curl --request POST \
  --url https://eomer-api.onrender.com/v2/classify/storage-object \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "object_id": "<string>",
  "label_column": "target",
  "problem_type": "auto",
  "train_split_ratio": 0.8,
  "inference_mode": "train_evaluate",
  "validation_holdout_ratio": 0.2
}
'

import requests

url = "https://eomer-api.onrender.com/v2/classify/storage-object"

payload = {
    "object_id": "<string>",
    "label_column": "target",
    "problem_type": "auto",
    "train_split_ratio": 0.8,
    "inference_mode": "train_evaluate",
    "validation_holdout_ratio": 0.2
}
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({
    object_id: '<string>',
    label_column: 'target',
    problem_type: 'auto',
    train_split_ratio: 0.8,
    inference_mode: 'train_evaluate',
    validation_holdout_ratio: 0.2
  })
};

fetch('https://eomer-api.onrender.com/v2/classify/storage-object', 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://eomer-api.onrender.com/v2/classify/storage-object",
  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([
    'object_id' => '<string>',
    'label_column' => 'target',
    'problem_type' => 'auto',
    'train_split_ratio' => 0.8,
    'inference_mode' => 'train_evaluate',
    'validation_holdout_ratio' => 0.2
  ]),
  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://eomer-api.onrender.com/v2/classify/storage-object"

	payload := strings.NewReader("{\n  \"object_id\": \"<string>\",\n  \"label_column\": \"target\",\n  \"problem_type\": \"auto\",\n  \"train_split_ratio\": 0.8,\n  \"inference_mode\": \"train_evaluate\",\n  \"validation_holdout_ratio\": 0.2\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://eomer-api.onrender.com/v2/classify/storage-object")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"object_id\": \"<string>\",\n  \"label_column\": \"target\",\n  \"problem_type\": \"auto\",\n  \"train_split_ratio\": 0.8,\n  \"inference_mode\": \"train_evaluate\",\n  \"validation_holdout_ratio\": 0.2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eomer-api.onrender.com/v2/classify/storage-object")

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  \"object_id\": \"<string>\",\n  \"label_column\": \"target\",\n  \"problem_type\": \"auto\",\n  \"train_split_ratio\": 0.8,\n  \"inference_mode\": \"train_evaluate\",\n  \"validation_holdout_ratio\": 0.2\n}"

response = http.request(request)
puts response.read_body

202

{
  "job_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "elapsed_seconds": 123,
  "num_samples": 123,
  "error": "<string>",
  "download_url": "<string>",
  "problem_type": "<string>",
  "accuracy": 123,
  "feature_importance": {},
  "explainability": {
    "enabled": false,
    "overview_markdown": "",
    "selected_analyses": [
      "<string>"
    ],
    "completed_analyses": [
      "<string>"
    ],
    "skipped_analyses": {},
    "warnings": [
      "<string>"
    ],
    "artifacts": [
      {
        "artifact_id": "<string>",
        "analysis": "<string>",
        "label": "<string>",
        "format": "<string>",
        "output_path": "<string>",
        "download_url": "<string>",
        "embed_url": "<string>",
        "description": "",
        "render_inline": false,
        "preview_markdown": "",
        "highlights": [
          "<string>"
        ],
        "display_order": 0,
        "is_primary_visual": false,
        "is_thumbnail": false
      }
    ],
    "summary_path": "<string>"
  },
  "explainability_url": "<string>",
  "request_id": "<string>",
  "inference_mode": "<string>",
  "labeled_row_count": 123,
  "unlabeled_row_count": 123,
  "predicted_row_count": 123,
  "model_name": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Body

application/json

Stored-object request for one of the task-specific tabular v2 routes.

object_id · string · required

Required string length: 1 - 128

label_column · string · default: target

Required string length: 1 - 200

problem_type · string · default: auto

Required string length: 1 - 20

train_split_ratio · number · default: 0.8

Required range: 0.5 <= x <= 0.95

inference_mode · string · default: train_evaluate

Required string length: 1 - 20

validation_holdout_ratio · number · default: 0.2

Required range: 0.05 <= x <= 0.5

Response

202

application/json

Successful Response

Response model for tabular classification/regression job status.

job_id · string · required

status · enum<string> · required

Status values for async forecast jobs.

Available options: pending, running, completed, failed

created_at · string<date-time> · required

completed_at · string<date-time> | null

elapsed_seconds · number | null

num_samples · integer | null

error · string | null

error_code · enum<string> | null

Machine-readable error codes for agent-friendly error handling.

Available options: validation_error, invalid_preset, file_too_large, rate_limited, server_overloaded, job_not_found, job_not_completed, auth_failed, internal_error, timeout, pipeline_failed, storage_error, gpu_offload_unavailable, connection_not_found, connector_error, sandbox_domain_used, sandbox_captcha_failed, sandbox_dataset_too_large, sandbox_corporate_email_required

download_url · string | null

problem_type · string | null

accuracy · number | null

feature_importance · Feature Importance · object | null

Show child attributes

explainability · ExplainabilitySummaryResponse · object | null

Explainability execution status for a forecast job.

Show child attributes

explainability_url · string | null

request_id · string | null

inference_mode · string | null

labeled_row_count · integer | null

unlabeled_row_count · integer | null

predicted_row_count · integer | null

model_name · string | null