openai 4.16.0 → 4.16.2

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

@@ -8,7 +8,7 @@ import { CursorPage, type CursorPageParams } from "../../../../pagination";
 
 export class Steps extends APIResource {
   /**
-   * Retrieves a Run Step.
+   * Retrieves a run step.
    */
   retrieve(
     threadId: string,
@@ -23,7 +23,7 @@ export class Steps extends APIResource {
   }
 
   /**
-   * Returns a list of Run Steps belonging to a Run.
+   * Returns a list of run steps belonging to a run.
    */
   list(
     threadId: string,
@@ -56,7 +56,7 @@ export class Steps extends APIResource {
 export class RunStepsPage extends CursorPage<RunStep> {}
 
 /**
- * Details of the Code Interpreter tool call the Run Step was involved in.
+ * Details of the Code Interpreter tool call the run step was involved in.
  */
 export interface CodeToolCall {
   /**
@@ -65,7 +65,7 @@ export interface CodeToolCall {
   id: string;
 
   /**
-   * The code interpreter tool call definition.
+   * The Code Interpreter tool call definition.
    */
   code_interpreter: CodeToolCall.CodeInterpreter;
 
@@ -78,7 +78,7 @@ export interface CodeToolCall {
 
 export namespace CodeToolCall {
   /**
-   * The code interpreter tool call definition.
+   * The Code Interpreter tool call definition.
    */
   export interface CodeInterpreter {
     /**
@@ -96,7 +96,7 @@ export namespace CodeToolCall {
 
   export namespace CodeInterpreter {
     /**
-     * Text output from the Code Interpreter tool call as part of a Run Step.
+     * Text output from the Code Interpreter tool call as part of a run step.
      */
     export interface Logs {
       /**
@@ -105,7 +105,7 @@ export namespace CodeToolCall {
       logs: string;
 
       /**
-       * Will always be `logs`.
+       * Always `logs`.
        */
       type: 'logs';
     }
@@ -114,7 +114,7 @@ export namespace CodeToolCall {
       image: Image.Image;
 
       /**
-       * Will always be `image`.
+       * Always `image`.
        */
       type: 'image';
     }
@@ -122,7 +122,7 @@ export namespace CodeToolCall {
     export namespace Image {
       export interface Image {
         /**
-         * The [File](https://platform.openai.com/docs/api-reference/files) ID of the
+         * The [file](https://platform.openai.com/docs/api-reference/files) ID of the
          * image.
          */
         file_id: string;
@@ -174,13 +174,13 @@ export namespace FunctionToolCall {
 }
 
 /**
- * Details of the Message creation activity that the Run Step was involved in.
+ * Details of the message creation by the run step.
  */
 export interface MessageCreationStepDetails {
   message_creation: MessageCreationStepDetails.MessageCreation;
 
   /**
-   * Will always be `message_creation``.
+   * Always `message_creation``.
    */
   type: 'message_creation';
 }
@@ -188,7 +188,7 @@ export interface MessageCreationStepDetails {
 export namespace MessageCreationStepDetails {
   export interface MessageCreation {
     /**
-     * The ID of the Message that was created by this Run Step.
+     * The ID of the message that was created by this run step.
      */
     message_id: string;
   }
@@ -213,7 +213,7 @@ export interface RetrievalToolCall {
 }
 
 /**
- * Represents a Step in execution of a Run.
+ * Represents a step in execution of a run.
  */
 export interface RunStep {
   /**
@@ -223,39 +223,39 @@ export interface RunStep {
 
   /**
    * The ID of the
-   * [Assistant](https://platform.openai.com/docs/api-reference/assistants)
-   * associated with the Run Step.
+   * [assistant](https://platform.openai.com/docs/api-reference/assistants)
+   * associated with the run step.
    */
   assistant_id: string;
 
   /**
-   * The Unix timestamp (in seconds) for when the Run Step was cancelled.
+   * The Unix timestamp (in seconds) for when the run step was cancelled.
    */
   cancelled_at: number | null;
 
   /**
-   * The Unix timestamp (in seconds) for when the Run Step was completed.
+   * The Unix timestamp (in seconds) for when the run step completed.
    */
   completed_at: number | null;
 
   /**
-   * The Unix timestamp (in seconds) for when the Run Step was created.
+   * The Unix timestamp (in seconds) for when the run step was created.
    */
   created_at: number;
 
   /**
-   * The Unix timestamp (in seconds) for when the Run Step expired. A step is
-   * considered expired if the parent Run is expired.
+   * The Unix timestamp (in seconds) for when the run step expired. A step is
+   * considered expired if the parent run is expired.
    */
   expired_at: number | null;
 
   /**
-   * The Unix timestamp (in seconds) for when the Run Step failed.
+   * The Unix timestamp (in seconds) for when the run step failed.
    */
   failed_at: number | null;
 
   /**
-   * The last error associated with this Run Step. Will be `null` if there are no
+   * The last error associated with this run step. Will be `null` if there are no
    * errors.
    */
   last_error: RunStep.LastError | null;
@@ -274,8 +274,8 @@ export interface RunStep {
   object: 'assistant.run.step';
 
   /**
-   * The ID of the [Run](https://platform.openai.com/docs/api-reference/runs) that
-   * this Run Step is a part of.
+   * The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that
+   * this run step is a part of.
    */
   run_id: string;
 
@@ -286,25 +286,25 @@ export interface RunStep {
   status: 'in_progress' | 'cancelled' | 'failed' | 'completed' | 'expired';
 
   /**
-   * The details of the activity the Run Step was involved in.
+   * The details of the run step.
    */
   step_details: MessageCreationStepDetails | ToolCallsStepDetails;
 
   /**
-   * The ID of the [Thread](https://platform.openai.com/docs/api-reference/threads)
-   * that was Run.
+   * The ID of the [thread](https://platform.openai.com/docs/api-reference/threads)
+   * that was run.
    */
   thread_id: string;
 
   /**
-   * The type of Run Step, which can be either `message_creation` or `tool_calls`.
+   * The type of run step, which can be either `message_creation` or `tool_calls`.
    */
   type: 'message_creation' | 'tool_calls';
 }
 
 export namespace RunStep {
   /**
-   * The last error associated with this Run Step. Will be `null` if there are no
+   * The last error associated with this run step. Will be `null` if there are no
    * errors.
    */
   export interface LastError {
@@ -321,18 +321,18 @@ export namespace RunStep {
 }
 
 /**
- * Details of the Tool Call activity that the Run Step was involved in.
+ * Details of the tool call.
  */
 export interface ToolCallsStepDetails {
   /**
-   * An array of tool calls the Run Step was involved in. These can be associated
+   * An array of tool calls the run step was involved in. These can be associated
    * with one of three types of tools: `code_interpreter`, `retrieval`, or
    * `function`.
    */
   tool_calls: Array<CodeToolCall | RetrievalToolCall | FunctionToolCall>;
 
   /**
-   * Will always be `tool_calls`.
+   * Always `tool_calls`.
    */
   type: 'tool_calls';
 }

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

@@ -2,6 +2,7 @@
 
 import * as Core from "../../../core";
 import { APIResource } from "../../../resource";
+import { isRequestOptions } from "../../../core";
 import * as ThreadsAPI from "./threads";
 import * as MessagesAPI from "./messages/messages";
 import * as RunsAPI from "./runs/runs";
@@ -11,9 +12,17 @@ export class Threads extends APIResource {
   messages: MessagesAPI.Messages = new MessagesAPI.Messages(this.client);
 
   /**
-   * Create a Thread.
+   * Create a thread.
    */
-  create(body: ThreadCreateParams, options?: Core.RequestOptions): Core.APIPromise<Thread> {
+  create(body?: ThreadCreateParams, options?: Core.RequestOptions): Core.APIPromise<Thread>;
+  create(options?: Core.RequestOptions): Core.APIPromise<Thread>;
+  create(
+    body: ThreadCreateParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Thread> {
+    if (isRequestOptions(body)) {
+      return this.create({}, body);
+    }
     return this.post('/threads', {
       body,
       ...options,
@@ -22,7 +31,7 @@ export class Threads extends APIResource {
   }
 
   /**
-   * Retrieves a Thread.
+   * Retrieves a thread.
    */
   retrieve(threadId: string, options?: Core.RequestOptions): Core.APIPromise<Thread> {
     return this.get(`/threads/${threadId}`, {
@@ -32,7 +41,7 @@ export class Threads extends APIResource {
   }
 
   /**
-   * Modifies a Thread.
+   * Modifies a thread.
    */
   update(threadId: string, body: ThreadUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Thread> {
     return this.post(`/threads/${threadId}`, {
@@ -43,7 +52,7 @@ export class Threads extends APIResource {
   }
 
   /**
-   * Delete a Thread.
+   * Delete a thread.
    */
   del(threadId: string, options?: Core.RequestOptions): Core.APIPromise<ThreadDeleted> {
     return this.delete(`/threads/${threadId}`, {
@@ -53,7 +62,7 @@ export class Threads extends APIResource {
   }
 
   /**
-   * Create a Thread and Run it in one request.
+   * Create a thread and run it in one request.
    */
   createAndRun(body: ThreadCreateAndRunParams, options?: Core.RequestOptions): Core.APIPromise<RunsAPI.Run> {
     return this.post('/threads/runs', {
@@ -65,8 +74,8 @@ export class Threads extends APIResource {
 }
 
 /**
- * Represents a Thread that contains
- * [Messages](https://platform.openai.com/docs/api-reference/messages).
+ * Represents a thread that contains
+ * [messages](https://platform.openai.com/docs/api-reference/messages).
  */
 export interface Thread {
   /**
@@ -75,7 +84,7 @@ export interface Thread {
   id: string;
 
   /**
-   * The Unix timestamp (in seconds) for when the Thread was created.
+   * The Unix timestamp (in seconds) for when the thread was created.
    */
   created_at: number;
 
@@ -103,8 +112,8 @@ export interface ThreadDeleted {
 
 export interface ThreadCreateParams {
   /**
-   * A list of [Messages](https://platform.openai.com/docs/api-reference/messages) to
-   * start the Thread with.
+   * A list of [messages](https://platform.openai.com/docs/api-reference/messages) to
+   * start the thread with.
    */
   messages?: Array<ThreadCreateParams.Message>;
 
@@ -120,20 +129,20 @@ export interface ThreadCreateParams {
 export namespace ThreadCreateParams {
   export interface Message {
     /**
-     * The content of the Message.
+     * The content of the message.
      */
     content: string;
 
     /**
-     * The role of the entity that is creating the Message. Currently only `user` is
+     * The role of the entity that is creating the message. Currently only `user` is
      * supported.
      */
     role: 'user';
 
     /**
      * A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that
-     * the Message should use. There can be a maximum of 10 files attached to a
-     * Message. Useful for tools like `retrieval` and `code_interpreter` that can
+     * the message should use. There can be a maximum of 10 files attached to a
+     * message. Useful for tools like `retrieval` and `code_interpreter` that can
      * access and use files.
      */
     file_ids?: Array<string>;
@@ -161,13 +170,13 @@ export interface ThreadUpdateParams {
 export interface ThreadCreateAndRunParams {
   /**
    * The ID of the
-   * [Assistant](https://platform.openai.com/docs/api-reference/assistants) to use to
-   * execute this Run.
+   * [assistant](https://platform.openai.com/docs/api-reference/assistants) to use to
+   * execute this run.
    */
   assistant_id: string;
 
   /**
-   * Override the default system message of the Assistant. This is useful for
+   * Override the default system message of the assistant. This is useful for
    * modifying the behavior on a per-run basis.
    */
   instructions?: string | null;
@@ -182,19 +191,19 @@ export interface ThreadCreateAndRunParams {
 
   /**
    * The ID of the [Model](https://platform.openai.com/docs/api-reference/models) to
-   * be used to execute this Run. If a value is provided here, it will override the
-   * model associated with the Assistant. If not, the model associated with the
-   * Assistant will be used.
+   * be used to execute this run. If a value is provided here, it will override the
+   * model associated with the assistant. If not, the model associated with the
+   * assistant will be used.
    */
   model?: string | null;
 
   /**
-   * If no Thread is provided, an empty Thread will be created.
+   * If no thread is provided, an empty thread will be created.
    */
   thread?: ThreadCreateAndRunParams.Thread;
 
   /**
-   * Override the tools the Assistant can use for this Run. This is useful for
+   * Override the tools the assistant can use for this run. This is useful for
    * modifying the behavior on a per-run basis.
    */
   tools?: Array<
@@ -206,12 +215,12 @@ export interface ThreadCreateAndRunParams {
 
 export namespace ThreadCreateAndRunParams {
   /**
-   * If no Thread is provided, an empty Thread will be created.
+   * If no thread is provided, an empty thread will be created.
    */
   export interface Thread {
     /**
-     * A list of [Messages](https://platform.openai.com/docs/api-reference/messages) to
-     * start the Thread with.
+     * A list of [messages](https://platform.openai.com/docs/api-reference/messages) to
+     * start the thread with.
      */
     messages?: Array<Thread.Message>;
 
@@ -227,20 +236,20 @@ export namespace ThreadCreateAndRunParams {
   export namespace Thread {
     export interface Message {
       /**
-       * The content of the Message.
+       * The content of the message.
        */
       content: string;
 
       /**
-       * The role of the entity that is creating the Message. Currently only `user` is
+       * The role of the entity that is creating the message. Currently only `user` is
        * supported.
        */
       role: 'user';
 
       /**
        * A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that
-       * the Message should use. There can be a maximum of 10 files attached to a
-       * Message. Useful for tools like `retrieval` and `code_interpreter` that can
+       * the message should use. There can be a maximum of 10 files attached to a
+       * message. Useful for tools like `retrieval` and `code_interpreter` that can
        * access and use files.
        */
       file_ids?: Array<string>;
@@ -264,9 +273,9 @@ export namespace ThreadCreateAndRunParams {
 
   export interface AssistantToolsRetrieval {
     /**
-     * The type of tool being defined: `retreival`
+     * The type of tool being defined: `retrieval`
      */
-    type: 'retreival';
+    type: 'retrieval';
   }
 
   export interface AssistantToolsFunction {

package/src/resources/chat/completions.ts

@@ -177,6 +177,14 @@ export interface ChatCompletionChunk {
    * The object type, which is always `chat.completion.chunk`.
    */
   object: 'chat.completion.chunk';
+
+  /**
+   * This fingerprint represents the backend configuration that the model runs with.
+   *
+   * Can be used in conjunction with the `seed` request parameter to understand when
+   * backend changes have been made that might impact determinism.
+   */
+  system_fingerprint?: string;
 }
 
 export namespace ChatCompletionChunk {
@@ -296,14 +304,14 @@ export interface ChatCompletionContentPartImage {
 export namespace ChatCompletionContentPartImage {
   export interface ImageURL {
     /**
-     * Specifies the detail level of the image.
+     * Either a URL of the image or the base64 encoded image data.
      */
-    detail?: 'auto' | 'low' | 'high';
+    url: string;
 
     /**
-     * Either a URL of the image or the base64 encoded image data.
+     * Specifies the detail level of the image.
      */
-    url?: string;
+    detail?: 'auto' | 'low' | 'high';
   }
 }
 
@@ -579,6 +587,8 @@ export interface ChatCompletionCreateParamsBase {
    */
   model:
     | (string & {})
+    | 'gpt-4-1106-preview'
+    | 'gpt-4-vision-preview'
     | 'gpt-4'
     | 'gpt-4-0314'
     | 'gpt-4-0613'

package/src/resources/embeddings.ts

@@ -28,9 +28,9 @@ export interface CreateEmbeddingResponse {
   model: string;
 
   /**
-   * The object type, which is always "embedding".
+   * The object type, which is always "list".
    */
-  object: 'embedding';
+  object: 'list';
 
   /**
    * The usage information for the request.

package/src/resources/files.ts

@@ -112,7 +112,7 @@ export interface FileDeleted {
  */
 export interface FileObject {
   /**
-   * The File identifier, which can be referenced in the API endpoints.
+   * The file identifier, which can be referenced in the API endpoints.
    */
   id: string;
 
@@ -122,12 +122,12 @@ export interface FileObject {
   bytes: number;
 
   /**
-   * The Unix timestamp (in seconds) for when the File was created.
+   * The Unix timestamp (in seconds) for when the file was created.
    */
   created_at: number;
 
   /**
-   * The name of the File.
+   * The name of the file.
    */
   filename: string;
 
@@ -137,13 +137,13 @@ export interface FileObject {
   object: 'file';
 
   /**
-   * The intended purpose of the File. Supported values are `fine-tune`,
+   * The intended purpose of the file. Supported values are `fine-tune`,
    * `fine-tune-results`, `assistants`, and `assistants_output`.
    */
   purpose: 'fine-tune' | 'fine-tune-results' | 'assistants' | 'assistants_output';
 
   /**
-   * Deprecated. The current status of the File, which can be either `uploaded`,
+   * Deprecated. The current status of the file, which can be either `uploaded`,
    * `processed`, or `error`.
    */
   status: 'uploaded' | 'processed' | 'error';

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.16.0'; // x-release-please-version
+export const VERSION = '4.16.2'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "4.16.0";
+export declare const VERSION = "4.16.2";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '4.16.0'; // x-release-please-version
+exports.VERSION = '4.16.2'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '4.16.0'; // x-release-please-version
+export const VERSION = '4.16.2'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map