Skip to main content
POST
/
api
/
playground
/
sessions
/
{session_id}
/
splits
Generate Splits
curl --request POST \
  --url https://api.example.com/api/playground/sessions/{session_id}/splits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "target_column": "<string>",
  "target_label_column": "target_label",
  "split_column": "split",
  "include_train": true,
  "include_val": true,
  "include_test": true,
  "train_ratio": 0.7,
  "val_ratio": 0.15,
  "test_ratio": 0.15,
  "random_state": 42
}
'
{
  "session_id": "<string>",
  "row_count": 123,
  "target_column": "<string>",
  "target_label_column": "<string>",
  "split_column": "<string>",
  "splits": [
    "<string>"
  ],
  "split_counts": {},
  "split_ratios": {},
  "overall_target_distribution": {},
  "target_distribution_by_split": {},
  "split_balance": {},
  "balance_quality": "<string>",
  "balance_score": 123,
  "balance_feedback": "<string>",
  "stratified": true,
  "worst_split": "<string>",
  "worst_split_tvd": 123,
  "worst_split_gap": 123,
  "warning": "<string>"
}

Authorizations

Authorization
string
header
required

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

Headers

X-API-Key
string | null

Path Parameters

session_id
string
required

Cookies

antidote_session
string | null

Body

application/json
target_column
string
required
Minimum string length: 1
target_label_column
string | null
default:target_label
split_column
string
default:split
Minimum string length: 1
include_train
boolean
default:true
include_val
boolean
default:true
include_test
boolean
default:true
train_ratio
number
default:0.7
val_ratio
number
default:0.15
test_ratio
number
default:0.15
random_state
integer
default:42

Response

Successful Response

session_id
string
required
row_count
integer
required
target_column
string
required
target_label_column
string
required
split_column
string
required
splits
string[]
required
split_counts
Split Counts · object
required
split_ratios
Split Ratios · object
required
overall_target_distribution
Overall Target Distribution · object
required
target_distribution_by_split
Target Distribution By Split · object
required
split_balance
Split Balance · object
required
balance_quality
string
required
balance_score
number
required
balance_feedback
string
required
stratified
boolean
required
worst_split
string | null
worst_split_tvd
number | null
worst_split_gap
number | null
warning
string | null