openai 4.96.2 → 4.98.0

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);
@@ -1169,7 +1207,7 @@ export interface ChatCompletionCreateParamsBase {
   frequency_penalty?: number | null;
 
   /**
-   * Deprecated in favor of `tool_choice`.
+   * @deprecated Deprecated in favor of `tool_choice`.
    *
    * Controls which (if any) function is called by the model.
    *
@@ -1187,7 +1225,7 @@ export interface ChatCompletionCreateParamsBase {
   function_call?: 'none' | 'auto' | ChatCompletionFunctionCallOption;
 
   /**
-   * Deprecated in favor of `tools`.
+   * @deprecated Deprecated in favor of `tools`.
    *
    * A list of functions the model may generate JSON inputs for.
    */
@@ -1220,8 +1258,8 @@ export interface ChatCompletionCreateParamsBase {
   max_completion_tokens?: number | null;
 
   /**
-   * The maximum number of [tokens](/tokenizer) that can be generated in the chat
-   * completion. This value can be used to control
+   * @deprecated The maximum number of [tokens](/tokenizer) that can be generated in
+   * the chat completion. This value can be used to control
    * [costs](https://openai.com/api/pricing/) for text generated via API.
    *
    * This value is now deprecated in favor of `max_completion_tokens`, and is not

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,