openai 4.0.1 → 4.2.0

package/src/resources/fine-tuning/jobs.ts

@@ -0,0 +1,293 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '../../core';
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as Files from '../files';
+import * as API from './index';
+import { Page } from '../../pagination';
+
+export class Jobs extends APIResource {
+  /**
+   * Creates a job that fine-tunes a specified 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](/docs/guides/fine-tuning)
+   */
+  create(body: JobCreateParams, options?: Core.RequestOptions): Core.APIPromise<FineTuningJob> {
+    return this.post('/fine_tuning/jobs', { body, ...options });
+  }
+
+  /**
+   * Get info about a fine-tuning job.
+   *
+   * [Learn more about fine-tuning](/docs/guides/fine-tuning)
+   */
+  retrieve(fineTuningJobId: string, options?: Core.RequestOptions): Core.APIPromise<FineTuningJob> {
+    return this.get(`/fine_tuning/jobs/${fineTuningJobId}`, options);
+  }
+
+  /**
+   * List your organization's fine-tuning jobs
+   */
+  list(
+    query?: JobListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<FineTuningJobsPage, FineTuningJob>;
+  list(options?: Core.RequestOptions): Core.PagePromise<FineTuningJobsPage, FineTuningJob>;
+  list(
+    query: JobListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<FineTuningJobsPage, FineTuningJob> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this.getAPIList('/fine_tuning/jobs', FineTuningJobsPage, { query, ...options });
+  }
+
+  /**
+   * Immediately cancel a fine-tune job.
+   */
+  cancel(fineTuningJobId: string, options?: Core.RequestOptions): Core.APIPromise<FineTuningJob> {
+    return this.post(`/fine_tuning/jobs/${fineTuningJobId}/cancel`, options);
+  }
+
+  /**
+   * Get status updates for a fine-tuning job.
+   */
+  listEvents(
+    fineTuningJobId: string,
+    query?: JobListEventsParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<FineTuningJobEventsPage, FineTuningJobEvent>;
+  listEvents(
+    fineTuningJobId: string,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<FineTuningJobEventsPage, FineTuningJobEvent>;
+  listEvents(
+    fineTuningJobId: string,
+    query: JobListEventsParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<FineTuningJobEventsPage, FineTuningJobEvent> {
+    if (isRequestOptions(query)) {
+      return this.listEvents(fineTuningJobId, {}, query);
+    }
+    return this.getAPIList(`/fine_tuning/jobs/${fineTuningJobId}/events`, FineTuningJobEventsPage, {
+      query,
+      ...options,
+    });
+  }
+}
+
+/**
+ * Note: no pagination actually occurs yet, this is for forwards-compatibility.
+ */
+export class FineTuningJobsPage extends Page<FineTuningJob> {}
+// alias so we can export it in the namespace
+type _FineTuningJobsPage = FineTuningJobsPage;
+
+/**
+ * Note: no pagination actually occurs yet, this is for forwards-compatibility.
+ */
+export class FineTuningJobEventsPage extends Page<FineTuningJobEvent> {}
+// alias so we can export it in the namespace
+type _FineTuningJobEventsPage = FineTuningJobEventsPage;
+
+/**
+ * The `fine_tuning.job` object represents a fine-tuning job that has been created
+ * through the API.
+ */
+export interface FineTuningJob {
+  /**
+   * The object identifier, which can be referenced in the API endpoints.
+   */
+  id: string;
+
+  /**
+   * The unix timestamp for when the fine-tuning job was created.
+   */
+  created_at: number;
+
+  /**
+   * The name of the fine-tuned model that is being created.
+   */
+  fine_tuned_model: string | null;
+
+  /**
+   * The hyperparameters used for the fine-tuning job. See the
+   * [fine-tuning guide](/docs/guides/fine-tuning) for more details.
+   */
+  hyperparameters: FineTuningJob.Hyperparameters;
+
+  /**
+   * The base model that is being fine-tuned.
+   */
+  model: string;
+
+  /**
+   * The object type, which is always "fine_tuning.job".
+   */
+  object: string;
+
+  /**
+   * The organization that owns the fine-tuning job.
+   */
+  organization_id: string;
+
+  /**
+   * The compiled results files for the fine-tuning job.
+   */
+  result_files: Array<Files.FileObject>;
+
+  /**
+   * The current status of the fine-tuning job, which can be either `created`,
+   * `pending`, `running`, `succeeded`, `failed`, or `cancelled`.
+   */
+  status: string;
+
+  /**
+   * The total number of billable tokens processed by this fine tuning job.
+   */
+  trained_tokens: number;
+
+  /**
+   * The file ID used for training.
+   */
+  training_file: string;
+
+  /**
+   * The file ID used for validation.
+   */
+  validation_file: string;
+
+  /**
+   * The unix timestamp for when the fine-tuning job was finished.
+   */
+  finished_at?: number;
+}
+
+export namespace FineTuningJob {
+  /**
+   * The hyperparameters used for the fine-tuning job. See the
+   * [fine-tuning guide](/docs/guides/fine-tuning) for more details.
+   */
+  export interface Hyperparameters {
+    /**
+     * The number of epochs to train the model for. An epoch refers to one full cycle
+     * through the training dataset. "Auto" decides the optimal number of epochs based
+     * on the size of the dataset. If setting the number manually, we support any
+     * number between 1 and 50 epochs.
+     */
+    n_epochs?: 'auto' | number;
+  }
+}
+
+export interface FineTuningJobEvent {
+  id: string;
+
+  created_at: number;
+
+  level: 'info' | 'warn' | 'error';
+
+  message: string;
+
+  object: string;
+}
+
+export interface JobCreateParams {
+  /**
+   * The name of the model to fine-tune. You can select one of the
+   * [supported models](/docs/guides/fine-tuning/what-models-can-be-fine-tuned).
+   */
+  model: (string & {}) | 'babbage-002' | 'davinci-002' | 'gpt-3.5-turbo';
+
+  /**
+   * The ID of an uploaded file that contains training data.
+   *
+   * See [upload file](/docs/api-reference/files/upload) 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`.
+   *
+   * See the [fine-tuning guide](/docs/guides/fine-tuning) for more details.
+   */
+  training_file: string;
+
+  /**
+   * The hyperparameters used for the fine-tuning job.
+   */
+  hyperparameters?: JobCreateParams.Hyperparameters;
+
+  /**
+   * A string of up to 40 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`.
+   */
+  suffix?: 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](/docs/guides/fine-tuning) for more details.
+   */
+  validation_file?: string | null;
+}
+
+export namespace JobCreateParams {
+  /**
+   * The hyperparameters used for the fine-tuning job.
+   */
+  export interface Hyperparameters {
+    /**
+     * The number of epochs to train the model for. An epoch refers to one full cycle
+     * through the training dataset.
+     */
+    n_epochs?: 'auto' | number;
+  }
+}
+
+export interface JobListParams {
+  /**
+   * Identifier for the last job from the previous pagination request.
+   */
+  after?: string;
+
+  /**
+   * Number of fine-tuning jobs to retrieve.
+   */
+  limit?: number;
+}
+
+export interface JobListEventsParams {
+  /**
+   * Identifier for the last event from the previous pagination request.
+   */
+  after?: string;
+
+  /**
+   * Number of events to retrieve.
+   */
+  limit?: number;
+}
+
+export namespace Jobs {
+  export import FineTuningJob = API.FineTuningJob;
+  export import FineTuningJobEvent = API.FineTuningJobEvent;
+  export type FineTuningJobsPage = _FineTuningJobsPage;
+  export type FineTuningJobEventsPage = _FineTuningJobEventsPage;
+  export import JobCreateParams = API.JobCreateParams;
+  export import JobListParams = API.JobListParams;
+  export import JobListEventsParams = API.JobListEventsParams;
+}

package/src/resources/index.ts

@@ -25,6 +25,7 @@ export {
   FineTunesPage,
   FineTunes,
 } from './fine-tunes';
+export { FineTuning } from './fine-tuning/fine-tuning';
 export {
   Image,
   ImagesResponse,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.0.1';
+export const VERSION = '4.2.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = '4.0.1';
+export declare const VERSION = '4.2.0';
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 'use strict';
 Object.defineProperty(exports, '__esModule', { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '4.0.1';
+exports.VERSION = '4.2.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '4.0.1';
+export const VERSION = '4.2.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map

package/version.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC"}
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}