OpenAI API

FineTunePreferenceRequestInput

object

The per-line training example of a fine-tuning input file for chat models using the dpo method.

inputobject
Show Child Parameters
preferred_completionOne Of
array

The preferred completion message for the output.

<= 1 items

Assistant messageobject

Messages sent by the model in response to user messages.

Show Child Parameters
non_preferred_completionOne Of
array

The non-preferred completion message for the output.

<= 1 items

Assistant messageobject

Messages sent by the model in response to user messages.

Show Child Parameters
Example

FineTuneSupervisedMethod

object

Configuration for the supervised fine-tuning method.

hyperparametersobject

The hyperparameters used for the fine-tuning job.

Show Child Parameters
Example

Fine-Tuning Job Integration

object
typestringrequired

The type of the integration being enabled for the fine-tuning job

Allowed values:wandb

wandbobjectrequired

The settings for your integration with Weights and Biases. This payload specifies the project that
metrics will be sent to. Optionally, you can set an explicit display name for your run, add tags
to your run, and set a default entity (team, username, etc) to be associated with your run.

Show Child Parameters
Example

FineTuningJob

object

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

idstringrequired

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

created_atintegerrequired

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

errorobjectrequired

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

Show Child Parameters
fine_tuned_modelstringrequired

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_atintegerrequired

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.

hyperparametersobjectrequired

The hyperparameters used for the fine-tuning job. This value will only be returned when running supervised jobs.

Show Child Parameters
modelstringrequired

The base model that is being fine-tuned.

objectstringrequired

The object type, which is always “fine_tuning.job”.

Allowed values:fine_tuning.job

organization_idstringrequired

The organization that owns the fine-tuning job.

result_filesarray[string]required

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

Example:file-abc123

statusstringrequired

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

Allowed values:validating_filesqueuedrunningsucceededfailedcancelled

trained_tokensintegerrequired

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_filestringrequired

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

validation_filestringrequired

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

integrationsOne Of
array

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

<= 5 items

Fine-Tuning Job Integrationobject
Show Child Parameters
seedintegerrequired

The seed used for the fine-tuning job.

estimated_finishinteger

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.

methodobject

The method used for fine-tuning.

Show Child Parameters
Example

FineTuningJobCheckpoint

object

The fine_tuning.job.checkpoint object represents a model checkpoint for a fine-tuning job that is ready to use.

idstringrequired

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

created_atintegerrequired

The Unix timestamp (in seconds) for when the checkpoint was created.

fine_tuned_model_checkpointstringrequired

The name of the fine-tuned checkpoint model that is created.

step_numberintegerrequired

The step number that the checkpoint was created at.

metricsobjectrequired

Metrics at the step number during the fine-tuning job.

Show Child Parameters
fine_tuning_job_idstringrequired

The name of the fine-tuning job that this checkpoint was created from.

objectstringrequired

The object type, which is always “fine_tuning.job.checkpoint”.

Allowed values:fine_tuning.job.checkpoint

Example