Get a fine-tuning dataset proposal
curl --request GET \
--url https://api.example.com/api/finetune/datasets/{job_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/finetune/datasets/{job_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/finetune/datasets/{job_id}', 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/finetune/datasets/{job_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/finetune/datasets/{job_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/finetune/datasets/{job_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/finetune/datasets/{job_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "running",
"name": "<string>",
"domain": "<string>",
"base_model": "<string>",
"owner": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"example_count": 0,
"coverage": {
"glossary_terms": 0,
"documents": 0,
"datasets": 0,
"tags": 0,
"data_products": 0,
"total_examples": 0
},
"sample_examples": [
{
"messages": [
{
"role": "system",
"content": "<string>"
}
],
"provenance": "<string>",
"category": "<string>"
}
],
"notes": "<string>",
"proposed_dataset_s3": "<string>",
"approved_dataset_s3": "<string>",
"mlflow_dataset_uri": "<string>",
"error": "<string>"
}{
"error": "<string>",
"code": 500
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Training
Get a fine-tuning dataset proposal
Return the latest proposal for a job (sample, counts, coverage).
GET
/
api
/
finetune
/
datasets
/
{job_id}
Get a fine-tuning dataset proposal
curl --request GET \
--url https://api.example.com/api/finetune/datasets/{job_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/finetune/datasets/{job_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/finetune/datasets/{job_id}', 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/finetune/datasets/{job_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/finetune/datasets/{job_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/finetune/datasets/{job_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/finetune/datasets/{job_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "running",
"name": "<string>",
"domain": "<string>",
"base_model": "<string>",
"owner": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"example_count": 0,
"coverage": {
"glossary_terms": 0,
"documents": 0,
"datasets": 0,
"tags": 0,
"data_products": 0,
"total_examples": 0
},
"sample_examples": [
{
"messages": [
{
"role": "system",
"content": "<string>"
}
],
"provenance": "<string>",
"category": "<string>"
}
],
"notes": "<string>",
"proposed_dataset_s3": "<string>",
"approved_dataset_s3": "<string>",
"mlflow_dataset_uri": "<string>",
"error": "<string>"
}{
"error": "<string>",
"code": 500
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
OAuth2AuthorizationCodeBearerAPIKeyHeader
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Dataset job ID.
Response
Successful Response
The crew's proposed dataset, returned for review.
The full example set lives in S3 (proposed_dataset_s3 / after approval,
approved_dataset_s3). sample_examples is a bounded preview.
Lifecycle of a fine-tuning dataset job.
Available options:
running, pending_approval, failed, approved, materializing, complete How much of the domain the crew drew on.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?

