Merge pull request #814 from openai/release-please--branches--master-…

…-changes--next--components--openai

release: 4.40.1

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "4.40.0"
+  ".": "4.40.1"
 }

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 4.40.1 (2024-05-02)
+
+Full Changelog: [v4.40.0...v4.40.1](https://github.com/openai/openai-node/compare/v4.40.0...v4.40.1)
+
+### Chores
+
+* **internal:** bump prism version ([#813](https://github.com/openai/openai-node/issues/813)) ([81a6c28](https://github.com/openai/openai-node/commit/81a6c28c4773a0245ce9c505fc5b98d43df21beb))
+* **internal:** move client class to separate file ([#815](https://github.com/openai/openai-node/issues/815)) ([d0b915a](https://github.com/openai/openai-node/commit/d0b915a7514eda5b23d7d1e4420d1d1485ed8d0f))
+
 ## 4.40.0 (2024-05-01)
 
 Full Changelog: [v4.39.1...v4.40.0](https://github.com/openai/openai-node/compare/v4.39.1...v4.40.0)

README.md

@@ -19,7 +19,7 @@ You can import in Deno via:
 <!-- x-release-please-start-version -->
 
 ```ts
-import OpenAI from 'https://deno.land/x/openai@v4.40.0/mod.ts';
+import OpenAI from 'https://deno.land/x/openai@v4.40.1/mod.ts';
 ```
 
 <!-- x-release-please-end -->

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openai",
-  "version": "4.40.0",
+  "version": "4.40.1",
   "description": "The official TypeScript library for the OpenAI API",
   "author": "OpenAI <support@openai.com>",
   "types": "dist/index.d.ts",

scripts/build-deno

@@ -16,7 +16,7 @@ This is a build produced from https://github.com/openai/openai-node – please g
 Usage:
 
 \`\`\`ts
-import OpenAI from "https://deno.land/x/openai@v4.40.0/mod.ts";
+import OpenAI from "https://deno.land/x/openai@v4.40.1/mod.ts";
 
 const client = new OpenAI();
 \`\`\`

scripts/mock

@@ -21,7 +21,7 @@ echo "==> Starting mock server with URL ${URL}"
 
 # Run prism mock on the given spec
 if [ "$1" == "--daemon" ]; then
-  npm exec --package=@stoplight/prism-cli@~5.3.2 -- prism mock "$URL" &> .prism.log &
+  npm exec --package=@stoplight/prism-cli@~5.8 -- prism mock "$URL" &> .prism.log &
 
   # Wait for server to come online
   echo -n "Waiting for server"
@@ -37,5 +37,5 @@ if [ "$1" == "--daemon" ]; then
 
   echo
 else
-  npm exec  --package=@stoplight/prism-cli@~5.3.2 -- prism mock "$URL"
+  npm exec  --package=@stoplight/prism-cli@~5.8 -- prism mock "$URL"
 fi

scripts/test

@@ -54,4 +54,4 @@ fi
 
 # Run tests
 echo "==> Running tests"
-./node_modules/.bin/jest
+./node_modules/.bin/jest "$@"

src/client.ts

@@ -0,0 +1,292 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as Core from './core';
+import * as Errors from './error';
+import { type Agent } from './_shims/index';
+import * as Uploads from './uploads';
+import * as Pagination from 'openai/pagination';
+import * as API from 'openai/resources/index';
+
+export interface ClientOptions {
+  /**
+   * Defaults to process.env['OPENAI_API_KEY'].
+   */
+  apiKey?: string | undefined;
+
+  /**
+   * Defaults to process.env['OPENAI_ORG_ID'].
+   */
+  organization?: string | null | undefined;
+
+  /**
+   * Defaults to process.env['OPENAI_PROJECT_ID'].
+   */
+  project?: string | null | undefined;
+
+  /**
+   * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
+   *
+   * Defaults to process.env['OPENAI_BASE_URL'].
+   */
+  baseURL?: string | null | undefined;
+
+  /**
+   * The maximum amount of time (in milliseconds) that the client should wait for a response
+   * from the server before timing out a single request.
+   *
+   * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
+   * much longer than this timeout before the promise succeeds or fails.
+   */
+  timeout?: number;
+
+  /**
+   * An HTTP agent used to manage HTTP(S) connections.
+   *
+   * If not provided, an agent will be constructed by default in the Node.js environment,
+   * otherwise no agent is used.
+   */
+  httpAgent?: Agent;
+
+  /**
+   * Specify a custom `fetch` function implementation.
+   *
+   * If not provided, we use `node-fetch` on Node.js and otherwise expect that `fetch` is
+   * defined globally.
+   */
+  fetch?: Core.Fetch | undefined;
+
+  /**
+   * The maximum number of times that the client will retry a request in case of a
+   * temporary failure, like a network error or a 5XX error from the server.
+   *
+   * @default 2
+   */
+  maxRetries?: number;
+
+  /**
+   * Default headers to include with every request to the API.
+   *
+   * These can be removed in individual requests by explicitly setting the
+   * header to `undefined` or `null` in request options.
+   */
+  defaultHeaders?: Core.Headers;
+
+  /**
+   * Default query parameters to include with every request to the API.
+   *
+   * These can be removed in individual requests by explicitly setting the
+   * param to `undefined` in request options.
+   */
+  defaultQuery?: Core.DefaultQuery;
+
+  /**
+   * By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers.
+   * Only set this option to `true` if you understand the risks and have appropriate mitigations in place.
+   */
+  dangerouslyAllowBrowser?: boolean;
+}
+
+/** API Client for interfacing with the OpenAI API. */
+export class OpenAI extends Core.APIClient {
+  apiKey: string;
+  organization: string | null;
+  project: string | null;
+
+  private _options: ClientOptions;
+
+  /**
+   * API Client for interfacing with the OpenAI API.
+   *
+   * @param {string | undefined} [opts.apiKey=process.env['OPENAI_API_KEY'] ?? undefined]
+   * @param {string | null | undefined} [opts.organization=process.env['OPENAI_ORG_ID'] ?? null]
+   * @param {string | null | undefined} [opts.project=process.env['OPENAI_PROJECT_ID'] ?? null]
+   * @param {string} [opts.baseURL=process.env['OPENAI_BASE_URL'] ?? https://api.openai.com/v1] - Override the default base URL for the API.
+   * @param {number} [opts.timeout=10 minutes] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
+   * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
+   * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
+   * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
+   * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
+   * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
+   * @param {boolean} [opts.dangerouslyAllowBrowser=false] - By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers.
+   */
+  constructor({
+    baseURL = Core.readEnv('OPENAI_BASE_URL'),
+    apiKey = Core.readEnv('OPENAI_API_KEY'),
+    organization = Core.readEnv('OPENAI_ORG_ID') ?? null,
+    project = Core.readEnv('OPENAI_PROJECT_ID') ?? null,
+    ...opts
+  }: ClientOptions = {}) {
+    if (apiKey === undefined) {
+      throw new Errors.OpenAIError(
+        "The OPENAI_API_KEY environment variable is missing or empty; either provide it, or instantiate the OpenAI client with an apiKey option, like new OpenAI({ apiKey: 'My API Key' }).",
+      );
+    }
+
+    const options: ClientOptions = {
+      apiKey,
+      organization,
+      project,
+      ...opts,
+      baseURL: baseURL || `https://api.openai.com/v1`,
+    };
+
+    if (!options.dangerouslyAllowBrowser && Core.isRunningInBrowser()) {
+      throw new Errors.OpenAIError(
+        "It looks like you're running in a browser-like environment.\n\nThis is disabled by default, as it risks exposing your secret API credentials to attackers.\nIf you understand the risks and have appropriate mitigations in place,\nyou can set the `dangerouslyAllowBrowser` option to `true`, e.g.,\n\nnew OpenAI({ apiKey, dangerouslyAllowBrowser: true });\n\nhttps://help.openai.com/en/articles/5112595-best-practices-for-api-key-safety\n",
+      );
+    }
+
+    super({
+      baseURL: options.baseURL!,
+      timeout: options.timeout ?? 600000 /* 10 minutes */,
+      httpAgent: options.httpAgent,
+      maxRetries: options.maxRetries,
+      fetch: options.fetch,
+    });
+    this._options = options;
+
+    this.apiKey = apiKey;
+    this.organization = organization;
+    this.project = project;
+  }
+
+  completions: API.Completions = new API.Completions(this);
+  chat: API.Chat = new API.Chat(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);
+  beta: API.Beta = new API.Beta(this);
+  batches: API.Batches = new API.Batches(this);
+
+  protected override defaultQuery(): Core.DefaultQuery | undefined {
+    return this._options.defaultQuery;
+  }
+
+  protected override defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers {
+    return {
+      ...super.defaultHeaders(opts),
+      'OpenAI-Organization': this.organization,
+      'OpenAI-Project': this.project,
+      ...this._options.defaultHeaders,
+    };
+  }
+
+  protected override authHeaders(opts: Core.FinalRequestOptions): Core.Headers {
+    return { Authorization: `Bearer ${this.apiKey}` };
+  }
+
+  static OpenAI = this;
+
+  static OpenAIError = Errors.OpenAIError;
+  static APIError = Errors.APIError;
+  static APIConnectionError = Errors.APIConnectionError;
+  static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
+  static APIUserAbortError = Errors.APIUserAbortError;
+  static NotFoundError = Errors.NotFoundError;
+  static ConflictError = Errors.ConflictError;
+  static RateLimitError = Errors.RateLimitError;
+  static BadRequestError = Errors.BadRequestError;
+  static AuthenticationError = Errors.AuthenticationError;
+  static InternalServerError = Errors.InternalServerError;
+  static PermissionDeniedError = Errors.PermissionDeniedError;
+  static UnprocessableEntityError = Errors.UnprocessableEntityError;
+
+  static toFile = Uploads.toFile;
+  static fileFromPath = Uploads.fileFromPath;
+}
+
+export namespace OpenAI {
+  export import RequestOptions = Core.RequestOptions;
+
+  export import Page = Pagination.Page;
+  export import PageResponse = Pagination.PageResponse;
+
+  export import CursorPage = Pagination.CursorPage;
+  export import CursorPageParams = Pagination.CursorPageParams;
+  export import CursorPageResponse = Pagination.CursorPageResponse;
+
+  export import Completions = API.Completions;
+  export import Completion = API.Completion;
+  export import CompletionChoice = API.CompletionChoice;
+  export import CompletionUsage = API.CompletionUsage;
+  export import CompletionCreateParams = API.CompletionCreateParams;
+  export import CompletionCreateParamsNonStreaming = API.CompletionCreateParamsNonStreaming;
+  export import CompletionCreateParamsStreaming = API.CompletionCreateParamsStreaming;
+
+  export import Chat = API.Chat;
+  export import ChatModel = API.ChatModel;
+  export import ChatCompletion = API.ChatCompletion;
+  export import ChatCompletionAssistantMessageParam = API.ChatCompletionAssistantMessageParam;
+  export import ChatCompletionChunk = API.ChatCompletionChunk;
+  export import ChatCompletionContentPart = API.ChatCompletionContentPart;
+  export import ChatCompletionContentPartImage = API.ChatCompletionContentPartImage;
+  export import ChatCompletionContentPartText = API.ChatCompletionContentPartText;
+  export import ChatCompletionFunctionCallOption = API.ChatCompletionFunctionCallOption;
+  export import ChatCompletionFunctionMessageParam = API.ChatCompletionFunctionMessageParam;
+  export import ChatCompletionMessage = API.ChatCompletionMessage;
+  export import ChatCompletionMessageParam = API.ChatCompletionMessageParam;
+  export import ChatCompletionMessageToolCall = API.ChatCompletionMessageToolCall;
+  export import ChatCompletionNamedToolChoice = API.ChatCompletionNamedToolChoice;
+  export import ChatCompletionRole = API.ChatCompletionRole;
+  export import ChatCompletionSystemMessageParam = API.ChatCompletionSystemMessageParam;
+  export import ChatCompletionTokenLogprob = API.ChatCompletionTokenLogprob;
+  export import ChatCompletionTool = API.ChatCompletionTool;
+  export import ChatCompletionToolChoiceOption = API.ChatCompletionToolChoiceOption;
+  export import ChatCompletionToolMessageParam = API.ChatCompletionToolMessageParam;
+  export import ChatCompletionUserMessageParam = API.ChatCompletionUserMessageParam;
+  export import ChatCompletionCreateParams = API.ChatCompletionCreateParams;
+  export import ChatCompletionCreateParamsNonStreaming = API.ChatCompletionCreateParamsNonStreaming;
+  export import ChatCompletionCreateParamsStreaming = API.ChatCompletionCreateParamsStreaming;
+
+  export import Embeddings = API.Embeddings;
+  export import CreateEmbeddingResponse = API.CreateEmbeddingResponse;
+  export import Embedding = API.Embedding;
+  export import EmbeddingCreateParams = API.EmbeddingCreateParams;
+
+  export import Files = API.Files;
+  export import FileContent = API.FileContent;
+  export import FileDeleted = API.FileDeleted;
+  export import FileObject = API.FileObject;
+  export import FileObjectsPage = API.FileObjectsPage;
+  export import FileCreateParams = API.FileCreateParams;
+  export import FileListParams = API.FileListParams;
+
+  export import Images = API.Images;
+  export import Image = API.Image;
+  export import ImagesResponse = API.ImagesResponse;
+  export import ImageCreateVariationParams = API.ImageCreateVariationParams;
+  export import ImageEditParams = API.ImageEditParams;
+  export import ImageGenerateParams = API.ImageGenerateParams;
+
+  export import Audio = API.Audio;
+
+  export import Moderations = API.Moderations;
+  export import Moderation = API.Moderation;
+  export import ModerationCreateResponse = API.ModerationCreateResponse;
+  export import ModerationCreateParams = API.ModerationCreateParams;
+
+  export import Models = API.Models;
+  export import Model = API.Model;
+  export import ModelDeleted = API.ModelDeleted;
+  export import ModelsPage = API.ModelsPage;
+
+  export import FineTuning = API.FineTuning;
+
+  export import Beta = API.Beta;
+
+  export import Batches = API.Batches;
+  export import Batch = API.Batch;
+  export import BatchError = API.BatchError;
+  export import BatchRequestCounts = API.BatchRequestCounts;
+  export import BatchesPage = API.BatchesPage;
+  export import BatchCreateParams = API.BatchCreateParams;
+  export import BatchListParams = API.BatchListParams;
+
+  export import ErrorObject = API.ErrorObject;
+  export import FunctionDefinition = API.FunctionDefinition;
+  export import FunctionParameters = API.FunctionParameters;
+}