Create Fine-tuning Job

Creates a fine-tuning job which begins the process of creating a new model from a given dataset. Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete. [Learn more about fine-tuning](https://platform.openai.com/docs/guides/fine-tuning)

POSThttps://api.portkey.ai/v1/fine_tuning/jobs

Body

application/json

model*any of

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

Example: "gpt-3.5-turbo"

stringenum

training_file*string

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.

Example: "file-abc123"

hyperparametersobject

The hyperparameters used for the fine-tuning job.

suffixnullable string

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_filenullable string

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.

Example: "file-abc123"

integrationsnullable array of object

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

seednullable integer

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.

Example: 42

Response

200

OK

Body

application/json

id*string

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

created_at*integer

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

error*nullable object

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

fine_tuned_model*nullable string

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*nullable integer

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

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

model*string

The base model that is being fine-tuned.

object*enum

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

fine_tuning.job

organization_id*string

The organization that owns the fine-tuning job.

result_files*array of string

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

status*enum

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

validating_filesqueuedrunningsucceededfailedcancelled

trained_tokens*nullable integer

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

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

validation_file*nullable string

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

integrationsnullable array of one of

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

seed*integer

The seed used for the fine-tuning job.

estimated_finishnullable integer

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.

Response

{
  "id": "text",
  "error": {
    "code": "text",
    "message": "text",
    "param": "text"
  },
  "fine_tuned_model": "text",
  "hyperparameters": {
    "n_epochs": "auto"
  },
  "model": "text",
  "object": "fine_tuning.job",
  "organization_id": "text",
  "result_files": [
    "file-abc123"
  ],
  "status": "validating_files",
  "training_file": "text",
  "validation_file": "text",
  "integrations": [
    {
      "type": "wandb",
      "wandb": {
        "project": "my-wandb-project",
        "name": "text",
        "entity": "text",
        "tags": [
          "custom-tag"
        ]
      }
    }
  ]
}