chore(internal): codegen related update

Author: stainless-app[bot]

src/resources/audio/speech.ts

@@ -8,6 +8,18 @@ import { RequestOptions } from '../../internal/request-options';
 export class Speech extends APIResource {
   /**
    * Generates audio from the input text.
+   *
+   * @example
+   * ```ts
+   * const speech = await client.audio.speech.create({
+   *   input: 'input',
+   *   model: 'string',
+   *   voice: 'ash',
+   * });
+   *
+   * const content = await speech.blob();
+   * console.log(content);
+   * ```
    */
   create(body: SpeechCreateParams, options?: RequestOptions): APIPromise<Response> {
     return this._client.post('/audio/speech', {

src/resources/audio/transcriptions.ts

@@ -12,6 +12,15 @@ import { multipartFormRequestOptions } from '../../internal/uploads';
 export class Transcriptions extends APIResource {
   /**
    * Transcribes audio into the input language.
+   *
+   * @example
+   * ```ts
+   * const transcription =
+   *   await client.audio.transcriptions.create({
+   *     file: fs.createReadStream('speech.mp3'),
+   *     model: 'gpt-4o-transcribe',
+   *   });
+   * ```
    */
   create(
     body: TranscriptionCreateParamsNonStreaming,

src/resources/audio/translations.ts

@@ -11,6 +11,14 @@ import { multipartFormRequestOptions } from '../../internal/uploads';
 export class Translations extends APIResource {
   /**
    * Translates audio into English.
+   *
+   * @example
+   * ```ts
+   * const translation = await client.audio.translations.create({
+   *   file: fs.createReadStream('speech.mp3'),
+   *   model: 'whisper-1',
+   * });
+   * ```
    */
   create(body: TranslationCreateParams, options?: RequestOptions): APIPromise<TranslationCreateResponse> {
     return this._client.post(

src/resources/beta/assistants.ts

@@ -15,6 +15,13 @@ import { path } from '../../internal/utils/path';
 export class Assistants extends APIResource {
   /**
    * Create an assistant with a model and instructions.
+   *
+   * @example
+   * ```ts
+   * const assistant = await client.beta.assistants.create({
+   *   model: 'gpt-4o',
+   * });
+   * ```
    */
   create(body: AssistantCreateParams, options?: RequestOptions): APIPromise<Assistant> {
     return this._client.post('/assistants', {
@@ -26,6 +33,13 @@ export class Assistants extends APIResource {
 
   /**
    * Retrieves an assistant.
+   *
+   * @example
+   * ```ts
+   * const assistant = await client.beta.assistants.retrieve(
+   *   'assistant_id',
+   * );
+   * ```
    */
   retrieve(assistantID: string, options?: RequestOptions): APIPromise<Assistant> {
     return this._client.get(path`/assistants/${assistantID}`, {
@@ -36,6 +50,13 @@ export class Assistants extends APIResource {
 
   /**
    * Modifies an assistant.
+   *
+   * @example
+   * ```ts
+   * const assistant = await client.beta.assistants.update(
+   *   'assistant_id',
+   * );
+   * ```
    */
   update(assistantID: string, body: AssistantUpdateParams, options?: RequestOptions): APIPromise<Assistant> {
     return this._client.post(path`/assistants/${assistantID}`, {
@@ -47,6 +68,14 @@ export class Assistants extends APIResource {
 
   /**
    * Returns a list of assistants.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const assistant of client.beta.assistants.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query: AssistantListParams | null | undefined = {},
@@ -61,6 +90,12 @@ export class Assistants extends APIResource {
 
   /**
    * Delete an assistant.
+   *
+   * @example
+   * ```ts
+   * const assistantDeleted =
+   *   await client.beta.assistants.delete('assistant_id');
+   * ```
    */
   delete(assistantID: string, options?: RequestOptions): APIPromise<AssistantDeleted> {
     return this._client.delete(path`/assistants/${assistantID}`, {

src/resources/beta/realtime/sessions.ts

@@ -14,6 +14,12 @@ export class Sessions extends APIResource {
    * It responds with a session object, plus a `client_secret` key which contains a
    * usable ephemeral API token that can be used to authenticate browser clients for
    * the Realtime API.
+   *
+   * @example
+   * ```ts
+   * const session =
+   *   await client.beta.realtime.sessions.create();
+   * ```
    */
   create(body: SessionCreateParams, options?: RequestOptions): APIPromise<SessionCreateResponse> {
     return this._client.post('/realtime/sessions', {

src/resources/beta/realtime/transcription-sessions.ts

@@ -14,6 +14,12 @@ export class TranscriptionSessions extends APIResource {
    * It responds with a session object, plus a `client_secret` key which contains a
    * usable ephemeral API token that can be used to authenticate browser clients for
    * the Realtime API.
+   *
+   * @example
+   * ```ts
+   * const transcriptionSession =
+   *   await client.beta.realtime.transcriptionSessions.create();
+   * ```
    */
   create(body: TranscriptionSessionCreateParams, options?: RequestOptions): APIPromise<TranscriptionSession> {
     return this._client.post('/realtime/transcription_sessions', {

src/resources/beta/threads/messages.ts

@@ -12,6 +12,14 @@ import { path } from '../../../internal/utils/path';
 export class Messages extends APIResource {
   /**
    * Create a message.
+   *
+   * @example
+   * ```ts
+   * const message = await client.beta.threads.messages.create(
+   *   'thread_id',
+   *   { content: 'string', role: 'user' },
+   * );
+   * ```
    */
   create(threadID: string, body: MessageCreateParams, options?: RequestOptions): APIPromise<Message> {
     return this._client.post(path`/threads/${threadID}/messages`, {
@@ -23,6 +31,14 @@ export class Messages extends APIResource {
 
   /**
    * Retrieve a message.
+   *
+   * @example
+   * ```ts
+   * const message = await client.beta.threads.messages.retrieve(
+   *   'message_id',
+   *   { thread_id: 'thread_id' },
+   * );
+   * ```
    */
   retrieve(messageID: string, params: MessageRetrieveParams, options?: RequestOptions): APIPromise<Message> {
     const { thread_id } = params;
@@ -34,6 +50,14 @@ export class Messages extends APIResource {
 
   /**
    * Modifies a message.
+   *
+   * @example
+   * ```ts
+   * const message = await client.beta.threads.messages.update(
+   *   'message_id',
+   *   { thread_id: 'thread_id' },
+   * );
+   * ```
    */
   update(messageID: string, params: MessageUpdateParams, options?: RequestOptions): APIPromise<Message> {
     const { thread_id, ...body } = params;
@@ -46,6 +70,16 @@ export class Messages extends APIResource {
 
   /**
    * Returns a list of messages for a given thread.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const message of client.beta.threads.messages.list(
+   *   'thread_id',
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     threadID: string,
@@ -61,6 +95,14 @@ export class Messages extends APIResource {
 
   /**
    * Deletes a message.
+   *
+   * @example
+   * ```ts
+   * const messageDeleted =
+   *   await client.beta.threads.messages.delete('message_id', {
+   *     thread_id: 'thread_id',
+   *   });
+   * ```
    */
   delete(
     messageID: string,

src/resources/beta/threads/runs/runs.ts

@@ -50,6 +50,14 @@ export class Runs extends APIResource {
 
   /**
    * Create a run.
+   *
+   * @example
+   * ```ts
+   * const run = await client.beta.threads.runs.create(
+   *   'thread_id',
+   *   { assistant_id: 'assistant_id' },
+   * );
+   * ```
    */
   create(threadID: string, params: RunCreateParamsNonStreaming, options?: RequestOptions): APIPromise<Run>;
   create(
@@ -79,6 +87,14 @@ export class Runs extends APIResource {
 
   /**
    * Retrieves a run.
+   *
+   * @example
+   * ```ts
+   * const run = await client.beta.threads.runs.retrieve(
+   *   'run_id',
+   *   { thread_id: 'thread_id' },
+   * );
+   * ```
    */
   retrieve(runID: string, params: RunRetrieveParams, options?: RequestOptions): APIPromise<Run> {
     const { thread_id } = params;
@@ -90,6 +106,14 @@ export class Runs extends APIResource {
 
   /**
    * Modifies a run.
+   *
+   * @example
+   * ```ts
+   * const run = await client.beta.threads.runs.update(
+   *   'run_id',
+   *   { thread_id: 'thread_id' },
+   * );
+   * ```
    */
   update(runID: string, params: RunUpdateParams, options?: RequestOptions): APIPromise<Run> {
     const { thread_id, ...body } = params;
@@ -102,6 +126,16 @@ export class Runs extends APIResource {
 
   /**
    * Returns a list of runs belonging to a thread.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const run of client.beta.threads.runs.list(
+   *   'thread_id',
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     threadID: string,
@@ -117,6 +151,14 @@ export class Runs extends APIResource {
 
   /**
    * Cancels a run that is `in_progress`.
+   *
+   * @example
+   * ```ts
+   * const run = await client.beta.threads.runs.cancel(
+   *   'run_id',
+   *   { thread_id: 'thread_id' },
+   * );
+   * ```
    */
   cancel(runID: string, params: RunCancelParams, options?: RequestOptions): APIPromise<Run> {
     const { thread_id } = params;
@@ -210,6 +252,15 @@ export class Runs extends APIResource {
    * `submit_tool_outputs`, this endpoint can be used to submit the outputs from the
    * tool calls once they're all completed. All outputs must be submitted in a single
    * request.
+   *
+   * @example
+   * ```ts
+   * const run =
+   *   await client.beta.threads.runs.submitToolOutputs(
+   *     'run_id',
+   *     { thread_id: 'thread_id', tool_outputs: [{}] },
+   *   );
+   * ```
    */
   submitToolOutputs(
     runID: string,

src/resources/beta/threads/runs/steps.ts

@@ -12,6 +12,15 @@ import { path } from '../../../../internal/utils/path';
 export class Steps extends APIResource {
   /**
    * Retrieves a run step.
+   *
+   * @example
+   * ```ts
+   * const runStep =
+   *   await client.beta.threads.runs.steps.retrieve('step_id', {
+   *     thread_id: 'thread_id',
+   *     run_id: 'run_id',
+   *   });
+   * ```
    */
   retrieve(stepID: string, params: StepRetrieveParams, options?: RequestOptions): APIPromise<RunStep> {
     const { thread_id, run_id, ...query } = params;
@@ -24,6 +33,17 @@ export class Steps extends APIResource {
 
   /**
    * Returns a list of run steps belonging to a run.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const runStep of client.beta.threads.runs.steps.list(
+   *   'run_id',
+   *   { thread_id: 'thread_id' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(runID: string, params: StepListParams, options?: RequestOptions): PagePromise<RunStepsPage, RunStep> {
     const { thread_id, ...query } = params;