openai 4.97.0 → 4.99.0

package/src/resources/beta/threads/messages.ts

@@ -10,6 +10,14 @@ import { CursorPage, type CursorPageParams } from '../../../pagination';
 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,
@@ -25,6 +33,14 @@ export class Messages extends APIResource {
 
   /**
    * Retrieve a message.
+   *
+   * @example
+   * ```ts
+   * const message = await client.beta.threads.messages.retrieve(
+   *   'thread_id',
+   *   'message_id',
+   * );
+   * ```
    */
   retrieve(threadId: string, messageId: string, options?: Core.RequestOptions): Core.APIPromise<Message> {
     return this._client.get(`/threads/${threadId}/messages/${messageId}`, {
@@ -35,6 +51,14 @@ export class Messages extends APIResource {
 
   /**
    * Modifies a message.
+   *
+   * @example
+   * ```ts
+   * const message = await client.beta.threads.messages.update(
+   *   'thread_id',
+   *   'message_id',
+   * );
+   * ```
    */
   update(
     threadId: string,
@@ -51,6 +75,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,
@@ -75,6 +109,15 @@ export class Messages extends APIResource {
 
   /**
    * Deletes a message.
+   *
+   * @example
+   * ```ts
+   * const messageDeleted =
+   *   await client.beta.threads.messages.del(
+   *     'thread_id',
+   *     'message_id',
+   *   );
+   * ```
    */
   del(threadId: string, messageId: string, options?: Core.RequestOptions): Core.APIPromise<MessageDeleted> {
     return this._client.delete(`/threads/${threadId}/messages/${messageId}`, {

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

@@ -45,6 +45,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,
@@ -78,6 +86,14 @@ export class Runs extends APIResource {
 
   /**
    * Retrieves a run.
+   *
+   * @example
+   * ```ts
+   * const run = await client.beta.threads.runs.retrieve(
+   *   'thread_id',
+   *   'run_id',
+   * );
+   * ```
    */
   retrieve(threadId: string, runId: string, options?: Core.RequestOptions): Core.APIPromise<Run> {
     return this._client.get(`/threads/${threadId}/runs/${runId}`, {
@@ -88,6 +104,14 @@ export class Runs extends APIResource {
 
   /**
    * Modifies a run.
+   *
+   * @example
+   * ```ts
+   * const run = await client.beta.threads.runs.update(
+   *   'thread_id',
+   *   'run_id',
+   * );
+   * ```
    */
   update(
     threadId: string,
@@ -104,6 +128,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,
@@ -128,6 +162,14 @@ export class Runs extends APIResource {
 
   /**
    * Cancels a run that is `in_progress`.
+   *
+   * @example
+   * ```ts
+   * const run = await client.beta.threads.runs.cancel(
+   *   'thread_id',
+   *   'run_id',
+   * );
+   * ```
    */
   cancel(threadId: string, runId: string, options?: Core.RequestOptions): Core.APIPromise<Run> {
     return this._client.post(`/threads/${threadId}/runs/${runId}/cancel`, {
@@ -229,6 +271,16 @@ 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(
+   *     'thread_id',
+   *     'run_id',
+   *     { tool_outputs: [{}] },
+   *   );
+   * ```
    */
   submitToolOutputs(
     threadId: string,

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

@@ -10,6 +10,16 @@ import { CursorPage, type CursorPageParams } from '../../../../pagination';
 export class Steps extends APIResource {
   /**
    * Retrieves a run step.
+   *
+   * @example
+   * ```ts
+   * const runStep =
+   *   await client.beta.threads.runs.steps.retrieve(
+   *     'thread_id',
+   *     'run_id',
+   *     'step_id',
+   *   );
+   * ```
    */
   retrieve(
     threadId: string,
@@ -43,6 +53,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(
+   *   'thread_id',
+   *   'run_id',
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     threadId: string,

package/src/resources/beta/threads/threads.ts

@@ -73,6 +73,11 @@ export class Threads extends APIResource {
 
   /**
    * Create a thread.
+   *
+   * @example
+   * ```ts
+   * const thread = await client.beta.threads.create();
+   * ```
    */
   create(body?: ThreadCreateParams, options?: Core.RequestOptions): Core.APIPromise<Thread>;
   create(options?: Core.RequestOptions): Core.APIPromise<Thread>;
@@ -92,6 +97,13 @@ export class Threads extends APIResource {
 
   /**
    * Retrieves a thread.
+   *
+   * @example
+   * ```ts
+   * const thread = await client.beta.threads.retrieve(
+   *   'thread_id',
+   * );
+   * ```
    */
   retrieve(threadId: string, options?: Core.RequestOptions): Core.APIPromise<Thread> {
     return this._client.get(`/threads/${threadId}`, {
@@ -102,6 +114,13 @@ export class Threads extends APIResource {
 
   /**
    * Modifies a thread.
+   *
+   * @example
+   * ```ts
+   * const thread = await client.beta.threads.update(
+   *   'thread_id',
+   * );
+   * ```
    */
   update(threadId: string, body: ThreadUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Thread> {
     return this._client.post(`/threads/${threadId}`, {
@@ -113,6 +132,13 @@ export class Threads extends APIResource {
 
   /**
    * Delete a thread.
+   *
+   * @example
+   * ```ts
+   * const threadDeleted = await client.beta.threads.del(
+   *   'thread_id',
+   * );
+   * ```
    */
   del(threadId: string, options?: Core.RequestOptions): Core.APIPromise<ThreadDeleted> {
     return this._client.delete(`/threads/${threadId}`, {
@@ -123,6 +149,13 @@ export class Threads extends APIResource {
 
   /**
    * Create a thread and run it in one request.
+   *
+   * @example
+   * ```ts
+   * const run = await client.beta.threads.createAndRun({
+   *   assistant_id: 'assistant_id',
+   * });
+   * ```
    */
   createAndRun(
     body: ThreadCreateAndRunParamsNonStreaming,

package/src/resources/chat/completions/completions.ts

@@ -33,6 +33,16 @@ export class Completions extends APIResource {
    * supported for reasoning models are noted below. For the current state of
    * unsupported parameters in reasoning models,
    * [refer to the reasoning guide](https://platform.openai.com/docs/guides/reasoning).
+   *
+   * @example
+   * ```ts
+   * const chatCompletion = await client.chat.completions.create(
+   *   {
+   *     messages: [{ content: 'string', role: 'developer' }],
+   *     model: 'gpt-4o',
+   *   },
+   * );
+   * ```
    */
   create(
     body: ChatCompletionCreateParamsNonStreaming,
@@ -58,6 +68,12 @@ export class Completions extends APIResource {
   /**
    * Get a stored chat completion. Only Chat Completions that have been created with
    * the `store` parameter set to `true` will be returned.
+   *
+   * @example
+   * ```ts
+   * const chatCompletion =
+   *   await client.chat.completions.retrieve('completion_id');
+   * ```
    */
   retrieve(completionId: string, options?: Core.RequestOptions): Core.APIPromise<ChatCompletion> {
     return this._client.get(`/chat/completions/${completionId}`, options);
@@ -67,6 +83,14 @@ export class Completions extends APIResource {
    * Modify a stored chat completion. Only Chat Completions that have been created
    * with the `store` parameter set to `true` can be modified. Currently, the only
    * supported modification is to update the `metadata` field.
+   *
+   * @example
+   * ```ts
+   * const chatCompletion = await client.chat.completions.update(
+   *   'completion_id',
+   *   { metadata: { foo: 'string' } },
+   * );
+   * ```
    */
   update(
     completionId: string,
@@ -79,6 +103,14 @@ export class Completions extends APIResource {
   /**
    * List stored Chat Completions. Only Chat Completions that have been stored with
    * the `store` parameter set to `true` will be returned.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const chatCompletion of client.chat.completions.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: ChatCompletionListParams,
@@ -98,6 +130,12 @@ export class Completions extends APIResource {
   /**
    * Delete a stored chat completion. Only Chat Completions that have been created
    * with the `store` parameter set to `true` can be deleted.
+   *
+   * @example
+   * ```ts
+   * const chatCompletionDeleted =
+   *   await client.chat.completions.del('completion_id');
+   * ```
    */
   del(completionId: string, options?: Core.RequestOptions): Core.APIPromise<ChatCompletionDeleted> {
     return this._client.delete(`/chat/completions/${completionId}`, options);

package/src/resources/chat/completions/messages.ts

@@ -11,6 +11,16 @@ export class Messages extends APIResource {
   /**
    * Get the messages in a stored chat completion. Only Chat Completions that have
    * been created with the `store` parameter set to `true` will be returned.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const chatCompletionStoreMessage of client.chat.completions.messages.list(
+   *   'completion_id',
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     completionId: string,

package/src/resources/completions.ts

@@ -10,6 +10,14 @@ import { Stream } from '../streaming';
 export class Completions extends APIResource {
   /**
    * Creates a completion for the provided prompt and parameters.
+   *
+   * @example
+   * ```ts
+   * const completion = await client.completions.create({
+   *   model: 'string',
+   *   prompt: 'This is a test.',
+   * });
+   * ```
    */
   create(body: CompletionCreateParamsNonStreaming, options?: Core.RequestOptions): APIPromise<Completion>;
   create(

package/src/resources/embeddings.ts

@@ -6,6 +6,15 @@ import * as Core from '../core';
 export class Embeddings extends APIResource {
   /**
    * Creates an embedding vector representing the input text.
+   *
+   * @example
+   * ```ts
+   * const createEmbeddingResponse =
+   *   await client.embeddings.create({
+   *     input: 'The quick brown fox jumped over the lazy dog',
+   *     model: 'text-embedding-3-small',
+   *   });
+   * ```
    */
   create(
     body: EmbeddingCreateParams,
@@ -121,11 +130,12 @@ export interface EmbeddingCreateParams {
    * Input text to embed, encoded as a string or array of tokens. To embed multiple
    * inputs in a single request, pass an array of strings or array of token arrays.
    * The input must not exceed the max input tokens for the model (8192 tokens for
-   * `text-embedding-ada-002`), cannot be an empty string, and any array must be 2048
+   * all embedding models), cannot be an empty string, and any array must be 2048
    * dimensions or less.
    * [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken)
-   * for counting tokens. Some models may also impose a limit on total number of
-   * tokens summed across inputs.
+   * for counting tokens. In addition to the per-input token limit, all embedding
+   * models enforce a maximum of 300,000 tokens summed across all inputs in a single
+   * request.
    */
   input: string | Array<string> | Array<number> | Array<Array<number>>;