chore(internal): codegen related update

stainless-app[bot] · stainless-app[bot] · commit 1da125dba253 · 2026-03-05T18:35:20.000Z
diff --git a/src/client.ts b/src/client.ts
@@ -1028,24 +1028,54 @@ export class OpenAI {
 
   static toFile = Uploads.toFile;
 
+  /**
+   * Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position.
+   */
   completions: API.Completions = new API.Completions(this);
   chat: API.Chat = new API.Chat(this);
+  /**
+   * Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.
+   */
   embeddings: API.Embeddings = new API.Embeddings(this);
+  /**
+   * Files are used to upload documents that can be used with features like Assistants and Fine-tuning.
+   */
   files: API.Files = new API.Files(this);
+  /**
+   * Given a prompt and/or an input image, the model will generate a new image.
+   */
   images: API.Images = new API.Images(this);
   audio: API.Audio = new API.Audio(this);
+  /**
+   * Given text and/or image inputs, classifies if those inputs are potentially harmful.
+   */
   moderations: API.Moderations = new API.Moderations(this);
+  /**
+   * List and describe the various models available in the API.
+   */
   models: API.Models = new API.Models(this);
   fineTuning: API.FineTuning = new API.FineTuning(this);
   graders: API.Graders = new API.Graders(this);
   vectorStores: API.VectorStores = new API.VectorStores(this);
   webhooks: API.Webhooks = new API.Webhooks(this);
   beta: API.Beta = new API.Beta(this);
+  /**
+   * Create large batches of API requests to run asynchronously.
+   */
   batches: API.Batches = new API.Batches(this);
+  /**
+   * Use Uploads to upload large files in multiple parts.
+   */
   uploads: API.Uploads = new API.Uploads(this);
   responses: API.Responses = new API.Responses(this);
   realtime: API.Realtime = new API.Realtime(this);
+  /**
+   * Manage conversations and conversation items.
+   */
   conversations: API.Conversations = new API.Conversations(this);
+  /**
+   * Manage and run evals in the OpenAI platform.
+   */
   evals: API.Evals = new API.Evals(this);
   containers: API.Containers = new API.Containers(this);
   skills: API.Skills = new API.Skills(this);
diff --git a/src/resources/audio/speech.ts b/src/resources/audio/speech.ts
@@ -5,6 +5,9 @@ import { APIPromise } from '../../core/api-promise';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 
+/**
+ * Turn audio into text or text into audio.
+ */
 export class Speech extends APIResource {
   /**
    * Generates audio from the input text.
diff --git a/src/resources/audio/transcriptions.ts b/src/resources/audio/transcriptions.ts
@@ -9,6 +9,9 @@ import { type Uploadable } from '../../core/uploads';
 import { RequestOptions } from '../../internal/request-options';
 import { multipartFormRequestOptions } from '../../internal/uploads';
 
+/**
+ * Turn audio into text or text into audio.
+ */
 export class Transcriptions extends APIResource {
   /**
    * Transcribes audio into the input language.
diff --git a/src/resources/audio/translations.ts b/src/resources/audio/translations.ts
@@ -8,6 +8,9 @@ import { type Uploadable } from '../../core/uploads';
 import { RequestOptions } from '../../internal/request-options';
 import { multipartFormRequestOptions } from '../../internal/uploads';
 
+/**
+ * Turn audio into text or text into audio.
+ */
 export class Translations extends APIResource {
   /**
    * Translates audio into English.
diff --git a/src/resources/batches.ts b/src/resources/batches.ts
@@ -8,6 +8,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../core/paginati
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Create large batches of API requests to run asynchronously.
+ */
 export class Batches extends APIResource {
   /**
    * Creates and executes a batch from an uploaded file of requests
diff --git a/src/resources/beta/assistants.ts b/src/resources/beta/assistants.ts
@@ -13,6 +13,9 @@ import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 import { AssistantStream } from '../../lib/AssistantStream';
 
+/**
+ * Build Assistants that can call models and use tools.
+ */
 export class Assistants extends APIResource {
   /**
    * Create an assistant with a model and instructions.
diff --git a/src/resources/beta/threads/messages.ts b/src/resources/beta/threads/messages.ts
@@ -10,6 +10,8 @@ import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
 /**
+ * Build Assistants that can call models and use tools.
+ *
  * @deprecated The Assistants API is deprecated in favor of the Responses API
  */
 export class Messages extends APIResource {
diff --git a/src/resources/beta/threads/runs/runs.ts b/src/resources/beta/threads/runs/runs.ts
@@ -42,6 +42,8 @@ import { RunSubmitToolOutputsParamsStream } from '../../../../lib/AssistantStrea
 import { path } from '../../../../internal/utils/path';
 
 /**
+ * Build Assistants that can call models and use tools.
+ *
  * @deprecated The Assistants API is deprecated in favor of the Responses API
  */
 export class Runs extends APIResource {
diff --git a/src/resources/beta/threads/runs/steps.ts b/src/resources/beta/threads/runs/steps.ts
@@ -10,6 +10,8 @@ import { RequestOptions } from '../../../../internal/request-options';
 import { path } from '../../../../internal/utils/path';
 
 /**
+ * Build Assistants that can call models and use tools.
+ *
  * @deprecated The Assistants API is deprecated in favor of the Responses API
  */
 export class Steps extends APIResource {
diff --git a/src/resources/beta/threads/threads.ts b/src/resources/beta/threads/threads.ts
@@ -73,6 +73,8 @@ import { AssistantStream, ThreadCreateAndRunParamsBaseStream } from '../../../li
 import { path } from '../../../internal/utils/path';
 
 /**
+ * Build Assistants that can call models and use tools.
+ *
  * @deprecated The Assistants API is deprecated in favor of the Responses API
  */
 export class Threads extends APIResource {
diff --git a/src/resources/chat/completions/completions.ts b/src/resources/chat/completions/completions.ts
@@ -20,6 +20,9 @@ import { ChatCompletionStreamingToolRunnerParams } from '../../../lib/ChatComple
 import { ChatCompletionStream, type ChatCompletionStreamParams } from '../../../lib/ChatCompletionStream';
 import { ExtractParsedContentFromParams, parseChatCompletion, validateInputTools } from '../../../lib/parser';
 
+/**
+ * Given a list of messages comprising a conversation, the model will return a response.
+ */
 export class Completions extends APIResource {
   messages: MessagesAPI.Messages = new MessagesAPI.Messages(this._client);
 
diff --git a/src/resources/chat/completions/messages.ts b/src/resources/chat/completions/messages.ts
@@ -7,6 +7,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../../../core/pa
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Given a list of messages comprising a conversation, the model will return a response.
+ */
 export class Messages extends APIResource {
   /**
    * Get the messages in a stored chat completion. Only Chat Completions that have
diff --git a/src/resources/completions.ts b/src/resources/completions.ts
@@ -7,6 +7,9 @@ import { APIPromise } from '../core/api-promise';
 import { Stream } from '../core/streaming';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position.
+ */
 export class Completions extends APIResource {
   /**
    * Creates a completion for the provided prompt and parameters.
diff --git a/src/resources/conversations/conversations.ts b/src/resources/conversations/conversations.ts
@@ -18,6 +18,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Manage conversations and conversation items.
+ */
 export class Conversations extends APIResource {
   items: ItemsAPI.Items = new ItemsAPI.Items(this._client);
 
diff --git a/src/resources/conversations/items.ts b/src/resources/conversations/items.ts
@@ -12,6 +12,9 @@ import {
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Manage conversations and conversation items.
+ */
 export class Items extends APIResource {
   /**
    * Create items in a conversation with the given ID.
diff --git a/src/resources/embeddings.ts b/src/resources/embeddings.ts
@@ -5,6 +5,9 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { loggerFor, toFloat32Array } from '../internal/utils';
 
+/**
+ * Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.
+ */
 export class Embeddings extends APIResource {
   /**
    * Creates an embedding vector representing the input text.
diff --git a/src/resources/evals/evals.ts b/src/resources/evals/evals.ts
@@ -27,6 +27,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../../core/pagin
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Manage and run evals in the OpenAI platform.
+ */
 export class Evals extends APIResource {
   runs: RunsAPI.Runs = new RunsAPI.Runs(this._client);
 
diff --git a/src/resources/evals/runs/output-items.ts b/src/resources/evals/runs/output-items.ts
@@ -7,6 +7,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../../../core/pa
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Manage and run evals in the OpenAI platform.
+ */
 export class OutputItems extends APIResource {
   /**
    * Get an evaluation run output item by ID.
diff --git a/src/resources/evals/runs/runs.ts b/src/resources/evals/runs/runs.ts
@@ -19,6 +19,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../../../core/pa
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Manage and run evals in the OpenAI platform.
+ */
 export class Runs extends APIResource {
   outputItems: OutputItemsAPI.OutputItems = new OutputItemsAPI.OutputItems(this._client);
 
diff --git a/src/resources/files.ts b/src/resources/files.ts
@@ -11,6 +11,9 @@ import { APIConnectionTimeoutError } from '../error';
 import { multipartFormRequestOptions } from '../internal/uploads';
 import { path } from '../internal/utils/path';
 
+/**
+ * Files are used to upload documents that can be used with features like Assistants and Fine-tuning.
+ */
 export class Files extends APIResource {
   /**
    * Upload a file that can be used across various endpoints. Individual files can be
diff --git a/src/resources/fine-tuning/alpha/graders.ts b/src/resources/fine-tuning/alpha/graders.ts
@@ -5,6 +5,9 @@ import * as GraderModelsAPI from '../../graders/grader-models';
 import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 
+/**
+ * Manage fine-tuning jobs to tailor a model to your specific training data.
+ */
 export class Graders extends APIResource {
   /**
    * Run a grader.
diff --git a/src/resources/fine-tuning/checkpoints/permissions.ts b/src/resources/fine-tuning/checkpoints/permissions.ts
@@ -6,6 +6,9 @@ import { Page, PagePromise } from '../../../core/pagination';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Manage fine-tuning jobs to tailor a model to your specific training data.
+ */
 export class Permissions extends APIResource {
   /**
    * **NOTE:** Calling this endpoint requires an [admin API key](../admin-api-keys).
diff --git a/src/resources/fine-tuning/jobs/checkpoints.ts b/src/resources/fine-tuning/jobs/checkpoints.ts
@@ -5,6 +5,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../../../core/pa
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Manage fine-tuning jobs to tailor a model to your specific training data.
+ */
 export class Checkpoints extends APIResource {
   /**
    * List checkpoints for a fine-tuning job.
diff --git a/src/resources/fine-tuning/jobs/jobs.ts b/src/resources/fine-tuning/jobs/jobs.ts
@@ -15,6 +15,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../../../core/pa
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Manage fine-tuning jobs to tailor a model to your specific training data.
+ */
 export class Jobs extends APIResource {
   checkpoints: CheckpointsAPI.Checkpoints = new CheckpointsAPI.Checkpoints(this._client);
 
diff --git a/src/resources/images.ts b/src/resources/images.ts
@@ -8,6 +8,9 @@ import { type Uploadable } from '../core/uploads';
 import { RequestOptions } from '../internal/request-options';
 import { multipartFormRequestOptions } from '../internal/uploads';
 
+/**
+ * Given a prompt and/or an input image, the model will generate a new image.
+ */
 export class Images extends APIResource {
   /**
    * Creates a variation of a given image. This endpoint only supports `dall-e-2`.
diff --git a/src/resources/models.ts b/src/resources/models.ts
@@ -6,6 +6,9 @@ import { Page, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * List and describe the various models available in the API.
+ */
 export class Models extends APIResource {
   /**
    * Retrieves a model instance, providing basic information about the model such as
diff --git a/src/resources/moderations.ts b/src/resources/moderations.ts
@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Given text and/or image inputs, classifies if those inputs are potentially harmful.
+ */
 export class Moderations extends APIResource {
   /**
    * Classifies if text and/or image inputs are potentially harmful. Learn more in
diff --git a/src/resources/responses/internal-base.ts b/src/resources/responses/internal-base.ts
@@ -5,6 +5,7 @@ import { OpenAI } from '../../client';
 
 import { EventEmitter } from '../../core/EventEmitter';
 import { OpenAIError } from '../../core/error';
+import { stringifyQuery } from '../../internal/utils';
 
 export class WebSocketError extends OpenAIError {
   /**
@@ -72,10 +73,13 @@ export abstract class ResponsesEmitter extends EventEmitter<WebsocketEvents> {
   }
 }
 
-export function buildURL(client: OpenAI): URL {
+export function buildURL(client: OpenAI, query?: object | null): URL {
   const path = '/responses';
   const baseURL = client.baseURL;
   const url = new URL(baseURL + (baseURL.endsWith('/') ? path.slice(1) : path));
+  if (query) {
+    url.search = stringifyQuery(query);
+  }
   url.protocol = 'wss';
   return url;
 }
diff --git a/src/resources/responses/ws.ts b/src/resources/responses/ws.ts
@@ -10,10 +10,10 @@ export class ResponsesWS extends ResponsesEmitter {
   socket: WS.WebSocket;
   private client: OpenAI;
 
-  constructor(client: OpenAI, options?: WS.ClientOptions | undefined) {
+  constructor(client: OpenAI, options?: WS.ClientOptions | null | undefined) {
     super();
     this.client = client;
-    this.url = buildURL(client);
+    this.url = buildURL(client, {});
     this.socket = new WS.WebSocket(this.url, {
       ...options,
       headers: {
diff --git a/src/resources/uploads/parts.ts b/src/resources/uploads/parts.ts
@@ -7,6 +7,9 @@ import { RequestOptions } from '../../internal/request-options';
 import { multipartFormRequestOptions } from '../../internal/uploads';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Use Uploads to upload large files in multiple parts.
+ */
 export class Parts extends APIResource {
   /**
    * Adds a
diff --git a/src/resources/uploads/uploads.ts b/src/resources/uploads/uploads.ts
@@ -8,6 +8,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Use Uploads to upload large files in multiple parts.
+ */
 export class Uploads extends APIResource {
   parts: PartsAPI.Parts = new PartsAPI.Parts(this._client);
 
