openai 4.4.0 → 4.5.0

package/src/core.ts

@@ -1,8 +1,8 @@
-import { VERSION } from './version';
-import { Stream } from './streaming';
-import { APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError } from './error';
-import type { Readable } from './_shims/node-readable';
-import { getDefaultAgent, type Agent } from './_shims/agent';
+import { VERSION } from './version.js';
+import { Stream } from './streaming.js';
+import { APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError } from './error.js';
+import type { Readable } from './_shims/node-readable.js';
+import { getDefaultAgent, type Agent } from './_shims/agent.js';
 import {
   fetch,
   isPolyfilled as fetchIsPolyfilled,
@@ -12,13 +12,13 @@ import {
   type HeadersInit,
 } from './_shims/fetch.js';
 export { type Response };
-import { isMultipartBody } from './uploads';
+import { isMultipartBody } from './uploads.js';
 export {
   maybeMultipartFormRequestOptions,
   multipartFormRequestOptions,
   createForm,
   type Uploadable,
-} from './uploads';
+} from './uploads.js';
 
 const MAX_RETRIES = 2;
 
@@ -52,7 +52,7 @@ async function defaultParseResponse<T>(props: APIResponseProps): Promise<T> {
   // TODO handle blob, arraybuffer, other content types, etc.
   const text = await response.text();
   debug('response', response.status, response.url, response.headers, text);
-  return text as T;
+  return text as any as T;
 }
 
 /**
@@ -313,7 +313,8 @@ export abstract class APIClient {
   protected parseHeaders(headers: HeadersInit | null | undefined): Record<string, string> {
     return (
       !headers ? {}
-      : Symbol.iterator in headers ? Object.fromEntries(Array.from(headers).map((header) => [...header]))
+      : Symbol.iterator in headers ?
+        Object.fromEntries(Array.from(headers as Iterable<string[]>).map((header) => [...header]))
       : { ...headers }
     );
   }
@@ -397,7 +398,7 @@ export abstract class APIClient {
     return new PagePromise<PageClass, Item>(this, request, Page);
   }
 
-  buildURL<Req>(path: string, query: Req | undefined): string {
+  buildURL<Req extends Record<string, unknown>>(path: string, query: Req | null | undefined): string {
     const url =
       isAbsoluteURL(path) ?
         new URL(path)
@@ -900,7 +901,7 @@ const isAbsoluteURL = (url: string): boolean => {
   return startsWithSchemeRegexp.test(url);
 };
 
-const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));
+export const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));
 
 const validatePositiveInteger = (name: string, n: unknown): number => {
   if (typeof n !== 'number' || !Number.isInteger(n)) {

package/src/error.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import { castToError, Headers } from './core';
+import { castToError, Headers } from './core.js';
 
 export class APIError extends Error {
   readonly status: number | undefined;
@@ -106,8 +106,8 @@ export class APIConnectionError extends APIError {
 }
 
 export class APIConnectionTimeoutError extends APIConnectionError {
-  constructor() {
-    super({ message: 'Request timed out.' });
+  constructor({ message }: { message?: string } = {}) {
+    super({ message: message ?? 'Request timed out.' });
   }
 }
 

package/src/index.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from './core';
-import * as Pagination from './pagination';
-import * as API from './resources/index';
-import * as Errors from './error';
-import type { Agent } from './_shims/agent';
-import * as Uploads from './uploads';
+import * as Core from './core.js';
+import * as Pagination from './pagination.js';
+import * as API from './resources/index.js';
+import * as Errors from './error.js';
+import type { Agent } from './_shims/agent.js';
+import * as Uploads from './uploads.js';
 
 export interface ClientOptions {
   /**
@@ -111,8 +111,8 @@ export class OpenAI extends Core.APIClient {
     const options: ClientOptions = {
       apiKey,
       organization,
-      baseURL: `https://api.openai.com/v1`,
       ...opts,
+      baseURL: opts.baseURL ?? `https://api.openai.com/v1`,
     };
 
     if (!options.dangerouslyAllowBrowser && Core.isRunningInBrowser()) {

package/src/pagination.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import { AbstractPage, Response, APIClient, FinalRequestOptions, PageInfo } from './core';
+import { AbstractPage, Response, APIClient, FinalRequestOptions, PageInfo } from './core.js';
 
 export interface PageResponse<Item> {
   data: Array<Item>;

package/src/resource.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import type { OpenAI } from './index';
+import type { OpenAI } from './index.js';
 
 export class APIResource {
   protected client: OpenAI;

package/src/resources/audio/audio.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import { APIResource } from '../../resource';
-import { Transcriptions } from './transcriptions';
-import { Translations } from './translations';
-import * as API from './index';
+import { APIResource } from '../../resource.js';
+import { Transcriptions } from './transcriptions.js';
+import { Translations } from './translations.js';
+import * as API from './index.js';
 
 export class Audio extends APIResource {
   transcriptions: Transcriptions = new Transcriptions(this.client);

package/src/resources/audio/index.ts

@@ -1,5 +1,5 @@
 // File generated from our OpenAPI spec by Stainless.
 
-export { Audio } from './audio';
-export { Transcription, TranscriptionCreateParams, Transcriptions } from './transcriptions';
-export { Translation, TranslationCreateParams, Translations } from './translations';
+export { Audio } from './audio.js';
+export { Transcription, TranscriptionCreateParams, Transcriptions } from './transcriptions.js';
+export { Translation, TranslationCreateParams, Translations } from './translations.js';

package/src/resources/audio/transcriptions.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../../core';
-import { APIResource } from '../../resource';
-import * as API from './index';
-import { type Uploadable, multipartFormRequestOptions } from '../../core';
+import * as Core from '../../core.js';
+import { APIResource } from '../../resource.js';
+import * as API from './index.js';
+import { type Uploadable, multipartFormRequestOptions } from '../../core.js';
 
 export class Transcriptions extends APIResource {
   /**

package/src/resources/audio/translations.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../../core';
-import { APIResource } from '../../resource';
-import * as API from './index';
-import { type Uploadable, multipartFormRequestOptions } from '../../core';
+import * as Core from '../../core.js';
+import { APIResource } from '../../resource.js';
+import * as API from './index.js';
+import { type Uploadable, multipartFormRequestOptions } from '../../core.js';
 
 export class Translations extends APIResource {
   /**

package/src/resources/chat/chat.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import { APIResource } from '../../resource';
-import { Completions } from './completions';
-import * as API from './index';
+import { APIResource } from '../../resource.js';
+import { Completions } from './completions.js';
+import * as API from './index.js';
 
 export class Chat extends APIResource {
   completions: Completions = new Completions(this.client);

package/src/resources/chat/completions.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../../core';
-import { APIPromise } from '../../core';
-import { APIResource } from '../../resource';
-import * as Completions_ from '../completions';
-import * as API from './index';
-import { Stream } from '../../streaming';
+import * as Core from '../../core.js';
+import { APIPromise } from '../../core.js';
+import { APIResource } from '../../resource.js';
+import * as Completions_ from '../completions.js';
+import * as API from './index.js';
+import { Stream } from '../../streaming.js';
 
 export class Completions extends APIResource {
   /**
@@ -50,7 +50,7 @@ export interface ChatCompletion {
   choices: Array<ChatCompletion.Choice>;
 
   /**
-   * A unix timestamp of when the chat completion was created.
+   * The Unix timestamp (in seconds) of when the chat completion was created.
    */
   created: number;
 
@@ -109,7 +109,7 @@ export interface ChatCompletionChunk {
   choices: Array<ChatCompletionChunk.Choice>;
 
   /**
-   * A unix timestamp of when the chat completion chunk was created.
+   * The Unix timestamp (in seconds) of when the chat completion chunk was created.
    */
   created: number;
 
@@ -321,7 +321,7 @@ export interface ChatCompletionCreateParamsBase {
    * existing frequency in the text so far, decreasing the model's likelihood to
    * repeat the same line verbatim.
    *
-   * [See more information about frequency and presence penalties.](/docs/api-reference/parameter-details)
+   * [See more information about frequency and presence penalties.](/docs/guides/gpt/parameter-details)
    */
   frequency_penalty?: number | null;
 
@@ -329,7 +329,7 @@ export interface ChatCompletionCreateParamsBase {
    * Controls how the model responds to function calls. "none" means the model does
    * not call a function, and responds to the end-user. "auto" means the model can
    * pick between an end-user or calling a function. Specifying a particular function
-   * via `{"name":\ "my_function"}` forces the model to call that function. "none" is
+   * via `{"name": "my_function"}` forces the model to call that function. "none" is
    * the default when no functions are present. "auto" is the default if functions
    * are present.
    */
@@ -372,7 +372,7 @@ export interface ChatCompletionCreateParamsBase {
    * whether they appear in the text so far, increasing the model's likelihood to
    * talk about new topics.
    *
-   * [See more information about frequency and presence penalties.](/docs/api-reference/parameter-details)
+   * [See more information about frequency and presence penalties.](/docs/guides/gpt/parameter-details)
    */
   presence_penalty?: number | null;
 

package/src/resources/chat/index.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless.
 
-export { Chat } from './chat';
+export { Chat } from './chat.js';
 export {
   ChatCompletion,
   ChatCompletionChunk,
@@ -14,4 +14,4 @@ export {
   ChatCompletionCreateParamsStreaming,
   CompletionCreateParamsStreaming,
   Completions,
-} from './completions';
+} from './completions.js';

package/src/resources/completions.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core';
-import { APIPromise } from '../core';
-import { APIResource } from '../resource';
-import * as API from './index';
-import { Stream } from '../streaming';
+import * as Core from '../core.js';
+import { APIPromise } from '../core.js';
+import { APIResource } from '../resource.js';
+import * as API from './index.js';
+import { Stream } from '../streaming.js';
 
 export class Completions extends APIResource {
   /**
@@ -45,7 +45,7 @@ export interface Completion {
   choices: Array<CompletionChoice>;
 
   /**
-   * The Unix timestamp of when the completion was created.
+   * The Unix timestamp (in seconds) of when the completion was created.
    */
   created: number;
 
@@ -166,7 +166,7 @@ export interface CompletionCreateParamsBase {
    * existing frequency in the text so far, decreasing the model's likelihood to
    * repeat the same line verbatim.
    *
-   * [See more information about frequency and presence penalties.](/docs/api-reference/parameter-details)
+   * [See more information about frequency and presence penalties.](/docs/guides/gpt/parameter-details)
    */
   frequency_penalty?: number | null;
 
@@ -221,7 +221,7 @@ export interface CompletionCreateParamsBase {
    * whether they appear in the text so far, increasing the model's likelihood to
    * talk about new topics.
    *
-   * [See more information about frequency and presence penalties.](/docs/api-reference/parameter-details)
+   * [See more information about frequency and presence penalties.](/docs/guides/gpt/parameter-details)
    */
   presence_penalty?: number | null;
 

package/src/resources/edits.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core';
-import { APIResource } from '../resource';
-import * as Completions from './completions';
-import * as API from './index';
+import * as Core from '../core.js';
+import { APIResource } from '../resource.js';
+import * as Completions from './completions.js';
+import * as API from './index.js';
 
 export class Edits extends APIResource {
   /**
@@ -25,7 +25,7 @@ export interface Edit {
   choices: Array<Edit.Choice>;
 
   /**
-   * A unix timestamp of when the edit was created.
+   * The Unix timestamp (in seconds) of when the edit was created.
    */
   created: number;
 

package/src/resources/embeddings.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core';
-import { APIResource } from '../resource';
-import * as API from './index';
+import * as Core from '../core.js';
+import { APIResource } from '../resource.js';
+import * as API from './index.js';
 
 export class Embeddings extends APIResource {
   /**

package/src/resources/files.ts

@@ -1,10 +1,12 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core';
-import { APIResource } from '../resource';
-import * as API from './index';
-import { type Uploadable, multipartFormRequestOptions } from '../core';
-import { Page } from '../pagination';
+import * as Core from '../core.js';
+import { APIResource } from '../resource.js';
+import { sleep } from '../core.js';
+import { APIConnectionTimeoutError } from '../error.js';
+import * as API from './index.js';
+import { type Uploadable, multipartFormRequestOptions } from '../core.js';
+import { Page } from '../pagination.js';
 
 export class Files extends APIResource {
   /**
@@ -47,6 +49,32 @@ export class Files extends APIResource {
       headers: { Accept: 'application/json', ...options?.headers },
     });
   }
+
+  /**
+   * Waits for the given file to be processed, default timeout is 30 mins.
+   */
+  async waitForProcessing(
+    id: string,
+    { pollInterval = 5000, maxWait = 30 * 60 * 1000 }: { pollInterval?: number; maxWait?: number } = {},
+  ): Promise<FileObject> {
+    const TERMINAL_STATES = new Set(['processed', 'error', 'deleted']);
+
+    const start = Date.now();
+    let file = await this.retrieve(id);
+
+    while (!file.status || !TERMINAL_STATES.has(file.status)) {
+      await sleep(pollInterval);
+
+      file = await this.retrieve(id);
+      if (Date.now() - start > maxWait) {
+        throw new APIConnectionTimeoutError({
+          message: `Giving up on waiting for file ${id} to finish processing after ${maxWait} milliseconds.`,
+        });
+      }
+    }
+
+    return file;
+  }
 }
 
 /**
@@ -81,7 +109,7 @@ export interface FileObject {
   bytes: number;
 
   /**
-   * The unix timestamp for when the file was created.
+   * The Unix timestamp (in seconds) for when the file was created.
    */
   created_at: number;
 

package/src/resources/fine-tunes.ts

@@ -1,12 +1,12 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core';
-import { APIPromise } from '../core';
-import { APIResource } from '../resource';
-import * as Files from './files';
-import * as API from './index';
-import { Page } from '../pagination';
-import { Stream } from '../streaming';
+import * as Core from '../core.js';
+import { APIPromise } from '../core.js';
+import { APIResource } from '../resource.js';
+import * as Files from './files.js';
+import * as API from './index.js';
+import { Page } from '../pagination.js';
+import { Stream } from '../streaming.js';
 
 export class FineTunes extends APIResource {
   /**
@@ -94,7 +94,7 @@ export interface FineTune {
   id: string;
 
   /**
-   * The unix timestamp for when the fine-tuning job was created.
+   * The Unix timestamp (in seconds) for when the fine-tuning job was created.
    */
   created_at: number;
 
@@ -142,7 +142,7 @@ export interface FineTune {
   training_files: Array<Files.FileObject>;
 
   /**
-   * The unix timestamp for when the fine-tuning job was last updated.
+   * The Unix timestamp (in seconds) for when the fine-tuning job was last updated.
    */
   updated_at: number;
 

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

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import { APIResource } from '../../resource';
-import { Jobs } from './jobs';
-import * as API from './index';
+import { APIResource } from '../../resource.js';
+import { Jobs } from './jobs.js';
+import * as API from './index.js';
 
 export class FineTuning extends APIResource {
   jobs: Jobs = new Jobs(this.client);

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

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless.
 
-export { FineTuning } from './fine-tuning';
+export { FineTuning } from './fine-tuning.js';
 export {
   FineTuningJob,
   FineTuningJobEvent,
@@ -10,4 +10,4 @@ export {
   FineTuningJobsPage,
   FineTuningJobEventsPage,
   Jobs,
-} from './jobs';
+} from './jobs.js';

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

@@ -1,11 +1,11 @@
 // 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 { CursorPage, CursorPageParams } from '../../pagination';
+import * as Core from '../../core.js';
+import { APIResource } from '../../resource.js';
+import { isRequestOptions } from '../../core.js';
+import * as Files from '../files.js';
+import * as API from './index.js';
+import { CursorPage, CursorPageParams } from '../../pagination.js';
 
 export class Jobs extends APIResource {
   /**
@@ -100,7 +100,7 @@ export interface FineTuningJob {
   id: string;
 
   /**
-   * The unix timestamp for when the fine-tuning job was created.
+   * The Unix timestamp (in seconds) for when the fine-tuning job was created.
    */
   created_at: number;
 
@@ -154,10 +154,10 @@ export interface FineTuningJob {
   /**
    * The file ID used for validation.
    */
-  validation_file: string;
+  validation_file: string | null;
 
   /**
-   * The unix timestamp for when the fine-tuning job was finished.
+   * The Unix timestamp (in seconds) for when the fine-tuning job was finished.
    */
   finished_at?: number;
 }

package/src/resources/images.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core';
-import { APIResource } from '../resource';
-import * as API from './index';
-import { type Uploadable, multipartFormRequestOptions } from '../core';
+import * as Core from '../core.js';
+import { APIResource } from '../resource.js';
+import * as API from './index.js';
+import { type Uploadable, multipartFormRequestOptions } from '../core.js';
 
 export class Images extends APIResource {
   /**

package/src/resources/index.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless.
 
-export { Audio } from './audio/audio';
-export { Chat } from './chat/chat';
+export { Audio } from './audio/audio.js';
+export { Chat } from './chat/chat.js';
 export {
   Completion,
   CompletionChoice,
@@ -10,10 +10,10 @@ export {
   CompletionCreateParamsNonStreaming,
   CompletionCreateParamsStreaming,
   Completions,
-} from './completions';
-export { CreateEmbeddingResponse, Embedding, EmbeddingCreateParams, Embeddings } from './embeddings';
-export { Edit, EditCreateParams, Edits } from './edits';
-export { FileContent, FileDeleted, FileObject, FileCreateParams, FileObjectsPage, Files } from './files';
+} from './completions.js';
+export { CreateEmbeddingResponse, Embedding, EmbeddingCreateParams, Embeddings } from './embeddings.js';
+export { Edit, EditCreateParams, Edits } from './edits.js';
+export { FileContent, FileDeleted, FileObject, FileCreateParams, FileObjectsPage, Files } from './files.js';
 export {
   FineTune,
   FineTuneEvent,
@@ -24,8 +24,8 @@ export {
   FineTuneListEventsParamsStreaming,
   FineTunesPage,
   FineTunes,
-} from './fine-tunes';
-export { FineTuning } from './fine-tuning/fine-tuning';
+} from './fine-tunes.js';
+export { FineTuning } from './fine-tuning/fine-tuning.js';
 export {
   Image,
   ImagesResponse,
@@ -33,6 +33,6 @@ export {
   ImageEditParams,
   ImageGenerateParams,
   Images,
-} from './images';
-export { Model, ModelDeleted, ModelsPage, Models } from './models';
-export { Moderation, ModerationCreateResponse, ModerationCreateParams, Moderations } from './moderations';
+} from './images.js';
+export { Model, ModelDeleted, ModelsPage, Models } from './models.js';
+export { Moderation, ModerationCreateResponse, ModerationCreateParams, Moderations } from './moderations.js';

package/src/resources/models.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core';
-import { APIResource } from '../resource';
-import * as API from './index';
-import { Page } from '../pagination';
+import * as Core from '../core.js';
+import { APIResource } from '../resource.js';
+import * as API from './index.js';
+import { Page } from '../pagination.js';
 
 export class Models extends APIResource {
   /**
@@ -23,7 +23,8 @@ export class Models extends APIResource {
   }
 
   /**
-   * Delete a fine-tuned model. You must have the Owner role in your organization.
+   * Delete a fine-tuned model. You must have the Owner role in your organization to
+   * delete a model.
    */
   del(model: string, options?: Core.RequestOptions): Core.APIPromise<ModelDeleted> {
     return this.delete(`/models/${model}`, options);
@@ -47,7 +48,7 @@ export interface Model {
   id: string;
 
   /**
-   * The date and time when the model was created.
+   * The Unix timestamp (in seconds) when the model was created.
    */
   created: number;
 

package/src/resources/moderations.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core';
-import { APIResource } from '../resource';
-import * as API from './index';
+import * as Core from '../core.js';
+import { APIResource } from '../resource.js';
+import * as API from './index.js';
 
 export class Moderations extends APIResource {
   /**

package/src/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  // this config is included in the published src directory to prevent TS errors
+  // from appearing when users go to source, and VSCode opens the source .ts file
+  // via declaration maps
+  "include": ["index.ts"],
+  "compilerOptions": {
+    "target": "es2015",
+    "lib": ["DOM"],
+    "moduleResolution": "node"
+  }
+}