POST
/
fine_tuning
/
jobs

Authorizations

x-portkey-api-key
string
headerrequired

Body

application/json
model
required

The name of the model to fine-tune. You can select one of the supported models.

training_file
string
required

The ID of an uploaded file that contains training data.

See upload file for how to upload a file.

Your dataset must be formatted as a JSONL file. Additionally, you must upload your file with the purpose fine-tune.

The contents of the file should differ depending on if the model uses the chat or completions format.

See the fine-tuning guide for more details.

hyperparameters
object

The hyperparameters used for the fine-tuning job.

suffix
string | null

A string of up to 18 characters that will be added to your fine-tuned model name.

For example, a suffix of "custom-model-name" would produce a model name like ft:gpt-3.5-turbo:openai:custom-model-name:7p4lURel.

validation_file
string | null

The ID of an uploaded file that contains validation data.

If you provide this file, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in the fine-tuning results file. The same data should not be present in both train and validation files.

Your dataset must be formatted as a JSONL file. You must upload your file with the purpose fine-tune.

See the fine-tuning guide for more details.

integrations
object[] | null

A list of integrations to enable for your fine-tuning job.

seed
integer | null

The seed controls the reproducibility of the job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases. If a seed is not specified, one will be generated for you.

Response

200 - application/json

The fine_tuning.job object represents a fine-tuning job that has been created through the API.

id
string
required

The object identifier, which can be referenced in the API endpoints.

created_at
integer
required

The Unix timestamp (in seconds) for when the fine-tuning job was created.

error
object | null
required

For fine-tuning jobs that have failed, this will contain more information on the cause of the failure.

fine_tuned_model
string | null
required

The name of the fine-tuned model that is being created. The value will be null if the fine-tuning job is still running.

finished_at
integer | null
required

The Unix timestamp (in seconds) for when the fine-tuning job was finished. The value will be null if the fine-tuning job is still running.

hyperparameters
object
required

The hyperparameters used for the fine-tuning job. See the fine-tuning guide for more details.

model
string
required

The base model that is being fine-tuned.

object
enum<string>
required

The object type, which is always "fine_tuning.job".

Available options:
fine_tuning.job
organization_id
string
required

The organization that owns the fine-tuning job.

result_files
string[]
required

The compiled results file ID(s) for the fine-tuning job. You can retrieve the results with the Files API.

status
enum<string>
required

The current status of the fine-tuning job, which can be either validating_files, queued, running, succeeded, failed, or cancelled.

Available options:
validating_files,
queued,
running,
succeeded,
failed,
cancelled
trained_tokens
integer | null
required

The total number of billable tokens processed by this fine-tuning job. The value will be null if the fine-tuning job is still running.

training_file
string
required

The file ID used for training. You can retrieve the training data with the Files API.

validation_file
string | null
required

The file ID used for validation. You can retrieve the validation results with the Files API.

integrations
object[] | null

A list of integrations to enable for this fine-tuning job.

seed
integer
required

The seed used for the fine-tuning job.

estimated_finish
integer | null

The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running.