Training Jobs
Create Training Job
Create a new training job.
Requirements:
- Dataset must belong to tenant
- Annotation set must be published
- All audio files must have embeddings computed
- At least 5 minutes of total audio
POST
/
api
/
v1
/
training-jobs
Create Training Job
curl --request POST \
--url https://api.example.com/api/v1/training-jobs \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"annotation_set_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config": {
"artifact_types": [
"<string>"
],
"epochs": 20,
"validation_split": 0.2,
"learning_rate": 0.001,
"batch_size": 32,
"chunk_size_ms": 500,
"stride_ms": 250
}
}
'import requests
url = "https://api.example.com/api/v1/training-jobs"
payload = {
"dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"annotation_set_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config": {
"artifact_types": ["<string>"],
"epochs": 20,
"validation_split": 0.2,
"learning_rate": 0.001,
"batch_size": 32,
"chunk_size_ms": 500,
"stride_ms": 250
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
dataset_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
annotation_set_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
config: {
artifact_types: ['<string>'],
epochs: 20,
validation_split: 0.2,
learning_rate: 0.001,
batch_size: 32,
chunk_size_ms: 500,
stride_ms: 250
}
})
};
fetch('https://api.example.com/api/v1/training-jobs', 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/api/v1/training-jobs",
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([
'dataset_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'annotation_set_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'config' => [
'artifact_types' => [
'<string>'
],
'epochs' => 20,
'validation_split' => 0.2,
'learning_rate' => 0.001,
'batch_size' => 32,
'chunk_size_ms' => 500,
'stride_ms' => 250
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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/api/v1/training-jobs"
payload := strings.NewReader("{\n \"dataset_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"annotation_set_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {\n \"artifact_types\": [\n \"<string>\"\n ],\n \"epochs\": 20,\n \"validation_split\": 0.2,\n \"learning_rate\": 0.001,\n \"batch_size\": 32,\n \"chunk_size_ms\": 500,\n \"stride_ms\": 250\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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/api/v1/training-jobs")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"dataset_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"annotation_set_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {\n \"artifact_types\": [\n \"<string>\"\n ],\n \"epochs\": 20,\n \"validation_split\": 0.2,\n \"learning_rate\": 0.001,\n \"batch_size\": 32,\n \"chunk_size_ms\": 500,\n \"stride_ms\": 250\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/training-jobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dataset_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"annotation_set_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {\n \"artifact_types\": [\n \"<string>\"\n ],\n \"epochs\": 20,\n \"validation_split\": 0.2,\n \"learning_rate\": 0.001,\n \"batch_size\": 32,\n \"chunk_size_ms\": 500,\n \"stride_ms\": 250\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"annotation_set_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config": {},
"status": "<string>",
"status_message": "<string>",
"progress_percent": 123,
"metrics": {},
"error_message": "<string>",
"sagemaker_job_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"queued_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Body
application/json
Response
Successful Response
Training job response.
⌘I
Create Training Job
curl --request POST \
--url https://api.example.com/api/v1/training-jobs \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"annotation_set_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config": {
"artifact_types": [
"<string>"
],
"epochs": 20,
"validation_split": 0.2,
"learning_rate": 0.001,
"batch_size": 32,
"chunk_size_ms": 500,
"stride_ms": 250
}
}
'import requests
url = "https://api.example.com/api/v1/training-jobs"
payload = {
"dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"annotation_set_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config": {
"artifact_types": ["<string>"],
"epochs": 20,
"validation_split": 0.2,
"learning_rate": 0.001,
"batch_size": 32,
"chunk_size_ms": 500,
"stride_ms": 250
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
dataset_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
annotation_set_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
config: {
artifact_types: ['<string>'],
epochs: 20,
validation_split: 0.2,
learning_rate: 0.001,
batch_size: 32,
chunk_size_ms: 500,
stride_ms: 250
}
})
};
fetch('https://api.example.com/api/v1/training-jobs', 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/api/v1/training-jobs",
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([
'dataset_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'annotation_set_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'config' => [
'artifact_types' => [
'<string>'
],
'epochs' => 20,
'validation_split' => 0.2,
'learning_rate' => 0.001,
'batch_size' => 32,
'chunk_size_ms' => 500,
'stride_ms' => 250
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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/api/v1/training-jobs"
payload := strings.NewReader("{\n \"dataset_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"annotation_set_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {\n \"artifact_types\": [\n \"<string>\"\n ],\n \"epochs\": 20,\n \"validation_split\": 0.2,\n \"learning_rate\": 0.001,\n \"batch_size\": 32,\n \"chunk_size_ms\": 500,\n \"stride_ms\": 250\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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/api/v1/training-jobs")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"dataset_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"annotation_set_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {\n \"artifact_types\": [\n \"<string>\"\n ],\n \"epochs\": 20,\n \"validation_split\": 0.2,\n \"learning_rate\": 0.001,\n \"batch_size\": 32,\n \"chunk_size_ms\": 500,\n \"stride_ms\": 250\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/training-jobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dataset_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"annotation_set_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {\n \"artifact_types\": [\n \"<string>\"\n ],\n \"epochs\": 20,\n \"validation_split\": 0.2,\n \"learning_rate\": 0.001,\n \"batch_size\": 32,\n \"chunk_size_ms\": 500,\n \"stride_ms\": 250\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"annotation_set_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config": {},
"status": "<string>",
"status_message": "<string>",
"progress_percent": 123,
"metrics": {},
"error_message": "<string>",
"sagemaker_job_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"queued_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}