Class Jobs

constructor

• new Jobs(client): Jobs

• Parameters

  • client: OpenAIClient

  Returns Jobs

checkpoints

cancel

• cancel(fineTuningJobID, options?): APIPromise<FineTuningJob>

• Immediately cancel a fine-tune job.

  Parameters

  • fineTuningJobID: string
  • Optionaloptions: RequestOptions

  Returns APIPromise<FineTuningJob>

  Example

  const fineTuningJob = await client.fineTuning.jobs.cancel(
    'ft-AF1WoRqd3aJAHsqc9NY7iL8F',
  );
  Copy

create

• create(body, options?): APIPromise<FineTuningJob>

• 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

  Parameters

  • body: JobCreateParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<FineTuningJob>

  Example

  const fineTuningJob = await client.fineTuning.jobs.create({
    model: 'gpt-4o-mini',
    training_file: 'file-abc123',
  });
  Copy

list

• list(query?, options?): PagePromise<FineTuningJobsPage, FineTuningJob>

• List your organization's fine-tuning jobs

  Parameters

  • Optionalquery: null | JobListParams
  • Optionaloptions: RequestOptions

  Returns PagePromise<FineTuningJobsPage, FineTuningJob>

  Example

  // Automatically fetches more pages as needed.
  for await (const fineTuningJob of client.fineTuning.jobs.list()) {
    // ...
  }
  Copy

listEvents

• listEvents(fineTuningJobID, query?, options?): PagePromise<FineTuningJobEventsPage, FineTuningJobEvent>

• Get status updates for a fine-tuning job.

  Parameters

  • fineTuningJobID: string
  • Optionalquery: null | JobListEventsParams
  • Optionaloptions: RequestOptions

  Returns PagePromise<FineTuningJobEventsPage, FineTuningJobEvent>

  Example

  // Automatically fetches more pages as needed.
  for await (const fineTuningJobEvent of client.fineTuning.jobs.listEvents(
    'ft-AF1WoRqd3aJAHsqc9NY7iL8F',
  )) {
    // ...
  }
  Copy

pause

• pause(fineTuningJobID, options?): APIPromise<FineTuningJob>

• Pause a fine-tune job.

  Parameters

  • fineTuningJobID: string
  • Optionaloptions: RequestOptions

  Returns APIPromise<FineTuningJob>

  Example

  const fineTuningJob = await client.fineTuning.jobs.pause(
    'ft-AF1WoRqd3aJAHsqc9NY7iL8F',
  );
  Copy

resume

• resume(fineTuningJobID, options?): APIPromise<FineTuningJob>

• Resume a fine-tune job.

  Parameters

  • fineTuningJobID: string
  • Optionaloptions: RequestOptions

  Returns APIPromise<FineTuningJob>

  Example

  const fineTuningJob = await client.fineTuning.jobs.resume(
    'ft-AF1WoRqd3aJAHsqc9NY7iL8F',
  );
  Copy

retrieve

• retrieve(fineTuningJobID, options?): APIPromise<FineTuningJob>

• Get info about a fine-tuning job.

  Learn more about fine-tuning

  Parameters

  • fineTuningJobID: string
  • Optionaloptions: RequestOptions

  Returns APIPromise<FineTuningJob>

  Example

  const fineTuningJob = await client.fineTuning.jobs.retrieve(
    'ft-AF1WoRqd3aJAHsqc9NY7iL8F',
  );
  Copy