Retrieving a fine-tuning job

After creating a fine-tuning job, you can retrive the status of the job by calling the following API. When the status is succeeded you can use this model inside the agent.

request this GET endpoint to retrieve the status of the fine-tuning job.

/api/v1/finetunings/<finetuning_id>

Parameters

Name	Type	Description
finetuning_id	string	the finetuning_id, Required

Responses

HTTP 200 code response

{
    "id": "finetuing-job-id",
    "db_connection_id": "database_connection_id"
    "alias": "model name"
    "status": "finetuning_job_status" # queued is default other possible values are [queued, running, succeeded, failed, validating_files, or cancelled]
    "error": "The error message if the job failed" # optional default value is None
    "base_llm": {
        "model_provider": "model_provider_name" # right now openai is the only provider.
        "model_name": "model_name" # right now gpt-3.5-turbo and gpt-4 are suported.
        "model_parameters": {
            "n_epochs": int or string, #optional, default value 3
            "batch_size": int or string, #optional, default value 1
            "learning_rate_multiplier", int or string, #optional, default value "auto"
        }
    }
    "finetuning_file_id": "This is the file id that is assigned by model provider when uploading the finetuning file"
    "finetuning_job_id": "The is the finetuning job id that is assigned by model provider when creating the finetuning job"
    "model_id": "The is the model id that is assigned by model provider after finetuning job is done"
    "created_at": datetime,
    "golden_records": array[ids], # default value is none which means use all of the golden records
    "metadata": dict[str, str] | None} #optional, default value None
}

Request example

  curl -X 'GET' \
'http://localhost/api/v1/finetunings/{finetuning_id}?finetuning_job_id={finetuing-job-id}' \
-H 'accept: application/json'

Response example

{
"id": "finetuning-job-id",
"db_connection_id": "database_connection_id",
"alias": "my_model",
"status": "validating_files",
"error": null,
"base_llm": {
    "model_provider": "openai",
    "model_name": "gpt-3.5-turbo-1106",
    "model_parameters": {
    "n_epochs": "1"
    }
},
"finetuning_file_id": null,
"finetuning_job_id": null,
"model_id": null,
"created_at": "2023-12-13T17:35:53.263485",
"golden_records": [ # a list of golden record ids, keep in mind that at least 10 golden records are required for openai models finetuning
    "656777c9eb4e22533dc43fce",
    "656777ceeb4e22533dc43fcf",
    "656777ceeb4e22533dc43fd0",
    "656777ceeb4e22533dc43fd1",
    "656777ceeb4e22533dc43fd2",
    "656777ceeb4e22533dc43fd3",
    "656777ceeb4e22533dc43fd4",
    "656777ceeb4e22533dc43fd5",
    "656777ceeb4e22533dc43fd6",
    "656777ceeb4e22533dc43fd7",
    "656777ceeb4e22533dc43fd8",
    "656777ceeb4e22533dc43fd9",
    "656777ceeb4e22533dc43fda",
    "656777ceeb4e22533dc43fdb",
    "656777ceeb4e22533dc43fdc",
    "656777ceeb4e22533dc43fdd",
    "656777ceeb4e22533dc43fde"
],
"metadata": null
}