refactor(api): remove deprecated endpoints (#621)

The fine tunes and edits APIs are no longer
provided by OpenAI.
This is not a breaking change as attempting to
call these APIs, even on older versions, will
result in an error at runtime.

Author: stainless-bot

.stats.yml

@@ -1 +1 @@
-configured_endpoints: 57
+configured_endpoints: 51

README.md

@@ -272,8 +272,8 @@ a subclass of `APIError` will be thrown:
 <!-- prettier-ignore -->
 ```ts
 async function main() {
-  const fineTune = await openai.fineTunes
-    .create({ training_file: 'file-XGinujblHPwGLSztz8cPS8XY' })
+  const job = await openai.fineTuning.jobs
+    .create({ model: 'gpt-3.5-turbo', training_file: 'file-abc123' })
     .catch((err) => {
       if (err instanceof OpenAI.APIError) {
         console.log(err.status); // 400

api.md

@@ -48,16 +48,6 @@ Methods:
 
 - <code title="post /chat/completions">client.chat.completions.<a href="./src/resources/chat/completions.ts">create</a>({ ...params }) -> ChatCompletion</code>
 
-# Edits
-
-Types:
-
-- <code><a href="./src/resources/edits.ts">Edit</a></code>
-
-Methods:
-
-- <code title="post /edits">client.edits.<a href="./src/resources/edits.ts">create</a>({ ...params }) -> Edit</code>
-
 # Embeddings
 
 Types:
@@ -169,22 +159,6 @@ Methods:
 - <code title="post /fine_tuning/jobs/{fine_tuning_job_id}/cancel">client.fineTuning.jobs.<a href="./src/resources/fine-tuning/jobs.ts">cancel</a>(fineTuningJobId) -> FineTuningJob</code>
 - <code title="get /fine_tuning/jobs/{fine_tuning_job_id}/events">client.fineTuning.jobs.<a href="./src/resources/fine-tuning/jobs.ts">listEvents</a>(fineTuningJobId, { ...params }) -> FineTuningJobEventsPage</code>
 
-# FineTunes
-
-Types:
-
-- <code><a href="./src/resources/fine-tunes.ts">FineTune</a></code>
-- <code><a href="./src/resources/fine-tunes.ts">FineTuneEvent</a></code>
-- <code><a href="./src/resources/fine-tunes.ts">FineTuneEventsListResponse</a></code>
-
-Methods:
-
-- <code title="post /fine-tunes">client.fineTunes.<a href="./src/resources/fine-tunes.ts">create</a>({ ...params }) -> FineTune</code>
-- <code title="get /fine-tunes/{fine_tune_id}">client.fineTunes.<a href="./src/resources/fine-tunes.ts">retrieve</a>(fineTuneId) -> FineTune</code>
-- <code title="get /fine-tunes">client.fineTunes.<a href="./src/resources/fine-tunes.ts">list</a>() -> FineTunesPage</code>
-- <code title="post /fine-tunes/{fine_tune_id}/cancel">client.fineTunes.<a href="./src/resources/fine-tunes.ts">cancel</a>(fineTuneId) -> FineTune</code>
-- <code title="get /fine-tunes/{fine_tune_id}/events">client.fineTunes.<a href="./src/resources/fine-tunes.ts">listEvents</a>(fineTuneId, { ...params }) -> FineTuneEventsListResponse</code>
-
 # Beta
 
 ## Chat

src/index.ts

@@ -142,15 +142,13 @@ export class OpenAI extends Core.APIClient {
 
   completions: API.Completions = new API.Completions(this);
   chat: API.Chat = new API.Chat(this);
-  edits: API.Edits = new API.Edits(this);
   embeddings: API.Embeddings = new API.Embeddings(this);
   files: API.Files = new API.Files(this);
   images: API.Images = new API.Images(this);
   audio: API.Audio = new API.Audio(this);
   moderations: API.Moderations = new API.Moderations(this);
   models: API.Models = new API.Models(this);
   fineTuning: API.FineTuning = new API.FineTuning(this);
-  fineTunes: API.FineTunes = new API.FineTunes(this);
   beta: API.Beta = new API.Beta(this);
 
   protected override defaultQuery(): Core.DefaultQuery | undefined {
@@ -251,10 +249,6 @@ export namespace OpenAI {
   export import ChatCompletionCreateParamsNonStreaming = API.ChatCompletionCreateParamsNonStreaming;
   export import ChatCompletionCreateParamsStreaming = API.ChatCompletionCreateParamsStreaming;
 
-  export import Edits = API.Edits;
-  export import Edit = API.Edit;
-  export import EditCreateParams = API.EditCreateParams;
-
   export import Embeddings = API.Embeddings;
   export import CreateEmbeddingResponse = API.CreateEmbeddingResponse;
   export import Embedding = API.Embedding;
@@ -289,16 +283,6 @@ export namespace OpenAI {
 
   export import FineTuning = API.FineTuning;
 
-  export import FineTunes = API.FineTunes;
-  export import FineTune = API.FineTune;
-  export import FineTuneEvent = API.FineTuneEvent;
-  export import FineTuneEventsListResponse = API.FineTuneEventsListResponse;
-  export import FineTunesPage = API.FineTunesPage;
-  export import FineTuneCreateParams = API.FineTuneCreateParams;
-  export import FineTuneListEventsParams = API.FineTuneListEventsParams;
-  export import FineTuneListEventsParamsNonStreaming = API.FineTuneListEventsParamsNonStreaming;
-  export import FineTuneListEventsParamsStreaming = API.FineTuneListEventsParamsStreaming;
-
   export import Beta = API.Beta;
 
   export import FunctionDefinition = API.FunctionDefinition;

src/resources/chat/completions.ts

@@ -594,7 +594,7 @@ export interface ChatCompletionTool {
  * will not call a function and instead generates a message. `auto` means the model
  * can pick between generating a message or calling a function. Specifying a
  * particular function via
- * `{"type: "function", "function": {"name": "my_function"}}` forces the model to
+ * `{"type": "function", "function": {"name": "my_function"}}` forces the model to
  * call that function.
  *
  * `none` is the default when no functions are present. `auto` is the default if
@@ -807,7 +807,7 @@ export interface ChatCompletionCreateParamsBase {
    * will not call a function and instead generates a message. `auto` means the model
    * can pick between generating a message or calling a function. Specifying a
    * particular function via
-   * `{"type: "function", "function": {"name": "my_function"}}` forces the model to
+   * `{"type": "function", "function": {"name": "my_function"}}` forces the model to
    * call that function.
    *
    * `none` is the default when no functions are present. `auto` is the default if

src/resources/completions.ts

@@ -131,18 +131,7 @@ export interface CompletionCreateParamsBase {
    * [Model overview](https://platform.openai.com/docs/models/overview) for
    * descriptions of them.
    */
-  model:
-    | (string & {})
-    | 'babbage-002'
-    | 'davinci-002'
-    | 'gpt-3.5-turbo-instruct'
-    | 'text-davinci-003'
-    | 'text-davinci-002'
-    | 'text-davinci-001'
-    | 'code-davinci-002'
-    | 'text-curie-001'
-    | 'text-babbage-001'
-    | 'text-ada-001';
+  model: (string & {}) | 'gpt-3.5-turbo-instruct' | 'davinci-002' | 'babbage-002';
 
   /**
    * The prompt(s) to generate completions for, encoded as a string, array of
@@ -186,12 +175,11 @@ export interface CompletionCreateParamsBase {
    *
    * Accepts a JSON object that maps tokens (specified by their token ID in the GPT
    * tokenizer) to an associated bias value from -100 to 100. You can use this
-   * [tokenizer tool](/tokenizer?view=bpe) (which works for both GPT-2 and GPT-3) to
-   * convert text to token IDs. Mathematically, the bias is added to the logits
-   * generated by the model prior to sampling. The exact effect will vary per model,
-   * but values between -1 and 1 should decrease or increase likelihood of selection;
-   * values like -100 or 100 should result in a ban or exclusive selection of the
-   * relevant token.
+   * [tokenizer tool](/tokenizer?view=bpe) to convert text to token IDs.
+   * Mathematically, the bias is added to the logits generated by the model prior to
+   * sampling. The exact effect will vary per model, but values between -1 and 1
+   * should decrease or increase likelihood of selection; values like -100 or 100
+   * should result in a ban or exclusive selection of the relevant token.
    *
    * As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> token
    * from being generated.

src/resources/edits.ts

@@ -8,7 +8,8 @@ import { CursorPage, type CursorPageParams } from 'openai/pagination';
 
 export class Jobs extends APIResource {
   /**
-   * Creates a job that fine-tunes a specified model from a given dataset.
+   * 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.

src/resources/fine-tunes.ts

@@ -14,7 +14,6 @@ export {
   Completions,
 } from './completions';
 export { CreateEmbeddingResponse, Embedding, EmbeddingCreateParams, Embeddings } from './embeddings';
-export { Edit, EditCreateParams, Edits } from './edits';
 export {
   FileContent,
   FileDeleted,
@@ -24,17 +23,6 @@ export {
   FileObjectsPage,
   Files,
 } from './files';
-export {
-  FineTune,
-  FineTuneEvent,
-  FineTuneEventsListResponse,
-  FineTuneCreateParams,
-  FineTuneListEventsParams,
-  FineTuneListEventsParamsNonStreaming,
-  FineTuneListEventsParamsStreaming,
-  FineTunesPage,
-  FineTunes,
-} from './fine-tunes';
 export { FineTuning } from './fine-tuning/fine-tuning';
 export {
   Image,