release: 4.33.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "4.32.2"
+  ".": "4.33.0"
 }

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 4.33.0 (2024-04-05)
+
+Full Changelog: [v4.32.2...v4.33.0](https://github.com/openai/openai-node/compare/v4.32.2...v4.33.0)
+
+### Features
+
+* **api:** add additional messages when creating thread run ([#759](https://github.com/openai/openai-node/issues/759)) ([f1fdb41](https://github.com/openai/openai-node/commit/f1fdb410e087f9b94faeda0558de573ec1118601))
+
 ## 4.32.2 (2024-04-04)
 
 Full Changelog: [v4.32.1...v4.32.2](https://github.com/openai/openai-node/compare/v4.32.1...v4.32.2)

README.md

@@ -19,7 +19,7 @@ You can import in Deno via:
 <!-- x-release-please-start-version -->
 
 ```ts
-import OpenAI from 'https://deno.land/x/openai@v4.32.2/mod.ts';
+import OpenAI from 'https://deno.land/x/openai@v4.33.0/mod.ts';
 ```
 
 <!-- x-release-please-end -->

build-deno

@@ -14,7 +14,7 @@ This is a build produced from https://github.com/openai/openai-node – please g
 Usage:
 
 \`\`\`ts
-import OpenAI from "https://deno.land/x/openai@v4.32.2/mod.ts";
+import OpenAI from "https://deno.land/x/openai@v4.33.0/mod.ts";
 
 const client = new OpenAI();
 \`\`\`

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openai",
-  "version": "4.32.2",
+  "version": "4.33.0",
   "description": "The official TypeScript library for the OpenAI API",
   "author": "OpenAI <support@openai.com>",
   "types": "dist/index.d.ts",

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

@@ -529,6 +529,11 @@ export interface RunCreateParamsBase {
    */
   additional_instructions?: string | null;
 
+  /**
+   * Adds additional messages to the thread before creating the run.
+   */
+  additional_messages?: Array<RunCreateParams.AdditionalMessage> | null;
+
   /**
    * Overrides the
    * [instructions](https://platform.openai.com/docs/api-reference/assistants/createAssistant)
@@ -574,6 +579,39 @@ export interface RunCreateParamsBase {
 }
 
 export namespace RunCreateParams {
+  export interface AdditionalMessage {
+    /**
+     * The content of the message.
+     */
+    content: string;
+
+    /**
+     * The role of the entity that is creating the message. Allowed values include:
+     *
+     * - `user`: Indicates the message is sent by an actual user and should be used in
+     *   most cases to represent user-generated messages.
+     * - `assistant`: Indicates the message is generated by the assistant. Use this
+     *   value to insert messages from the assistant into the conversation.
+     */
+    role: 'user' | 'assistant';
+
+    /**
+     * 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
+     * access and use files.
+     */
+    file_ids?: Array<string>;
+
+    /**
+     * Set of 16 key-value pairs that can be attached to an object. This can be useful
+     * for storing additional information about the object in a structured format. Keys
+     * can be a maximum of 64 characters long and values can be a maxium of 512
+     * characters long.
+     */
+    metadata?: unknown | null;
+  }
+
   export type RunCreateParamsNonStreaming = RunsAPI.RunCreateParamsNonStreaming;
   export type RunCreateParamsStreaming = RunsAPI.RunCreateParamsStreaming;
 }
@@ -637,6 +675,11 @@ export interface RunCreateAndPollParams {
    */
   additional_instructions?: string | null;
 
+  /**
+   * Adds additional messages to the thread before creating the run.
+   */
+  additional_messages?: Array<RunCreateAndPollParams.AdditionalMessage> | null;
+
   /**
    * Overrides the
    * [instructions](https://platform.openai.com/docs/api-reference/assistants/createAssistant)
@@ -674,6 +717,41 @@ export interface RunCreateAndPollParams {
   tools?: Array<AssistantsAPI.AssistantTool> | null;
 }
 
+export namespace RunCreateAndPollParams {
+  export interface AdditionalMessage {
+    /**
+     * The content of the message.
+     */
+    content: string;
+
+    /**
+     * The role of the entity that is creating the message. Allowed values include:
+     *
+     * - `user`: Indicates the message is sent by an actual user and should be used in
+     *   most cases to represent user-generated messages.
+     * - `assistant`: Indicates the message is generated by the assistant. Use this
+     *   value to insert messages from the assistant into the conversation.
+     */
+    role: 'user' | 'assistant';
+
+    /**
+     * 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
+     * access and use files.
+     */
+    file_ids?: Array<string>;
+
+    /**
+     * Set of 16 key-value pairs that can be attached to an object. This can be useful
+     * for storing additional information about the object in a structured format. Keys
+     * can be a maximum of 64 characters long and values can be a maxium of 512
+     * characters long.
+     */
+    metadata?: unknown | null;
+  }
+}
+
 export interface RunCreateAndStreamParams {
   /**
    * The ID of the
@@ -689,6 +767,11 @@ export interface RunCreateAndStreamParams {
    */
   additional_instructions?: string | null;
 
+  /**
+   * Adds additional messages to the thread before creating the run.
+   */
+  additional_messages?: Array<RunCreateAndStreamParams.AdditionalMessage> | null;
+
   /**
    * Overrides the
    * [instructions](https://platform.openai.com/docs/api-reference/assistants/createAssistant)
@@ -726,6 +809,41 @@ export interface RunCreateAndStreamParams {
   tools?: Array<AssistantsAPI.AssistantTool> | null;
 }
 
+export namespace RunCreateAndStreamParams {
+  export interface AdditionalMessage {
+    /**
+     * The content of the message.
+     */
+    content: string;
+
+    /**
+     * The role of the entity that is creating the message. Allowed values include:
+     *
+     * - `user`: Indicates the message is sent by an actual user and should be used in
+     *   most cases to represent user-generated messages.
+     * - `assistant`: Indicates the message is generated by the assistant. Use this
+     *   value to insert messages from the assistant into the conversation.
+     */
+    role: 'user' | 'assistant';
+
+    /**
+     * 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
+     * access and use files.
+     */
+    file_ids?: Array<string>;
+
+    /**
+     * Set of 16 key-value pairs that can be attached to an object. This can be useful
+     * for storing additional information about the object in a structured format. Keys
+     * can be a maximum of 64 characters long and values can be a maxium of 512
+     * characters long.
+     */
+    metadata?: unknown | null;
+  }
+}
+
 export interface RunStreamParams {
   /**
    * The ID of the
@@ -741,6 +859,11 @@ export interface RunStreamParams {
    */
   additional_instructions?: string | null;
 
+  /**
+   * Adds additional messages to the thread before creating the run.
+   */
+  additional_messages?: Array<RunStreamParams.AdditionalMessage> | null;
+
   /**
    * Overrides the
    * [instructions](https://platform.openai.com/docs/api-reference/assistants/createAssistant)
@@ -778,6 +901,41 @@ export interface RunStreamParams {
   tools?: Array<AssistantsAPI.AssistantTool> | null;
 }
 
+export namespace RunStreamParams {
+  export interface AdditionalMessage {
+    /**
+     * The content of the message.
+     */
+    content: string;
+
+    /**
+     * The role of the entity that is creating the message. Allowed values include:
+     *
+     * - `user`: Indicates the message is sent by an actual user and should be used in
+     *   most cases to represent user-generated messages.
+     * - `assistant`: Indicates the message is generated by the assistant. Use this
+     *   value to insert messages from the assistant into the conversation.
+     */
+    role: 'user' | 'assistant';
+
+    /**
+     * 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
+     * access and use files.
+     */
+    file_ids?: Array<string>;
+
+    /**
+     * Set of 16 key-value pairs that can be attached to an object. This can be useful
+     * for storing additional information about the object in a structured format. Keys
+     * can be a maximum of 64 characters long and values can be a maxium of 512
+     * characters long.
+     */
+    metadata?: unknown | null;
+  }
+}
+
 export type RunSubmitToolOutputsParams =
   | RunSubmitToolOutputsParamsNonStreaming
   | RunSubmitToolOutputsParamsStreaming;

src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.32.2'; // x-release-please-version
+export const VERSION = '4.33.0'; // x-release-please-version

tests/api-resources/beta/threads/runs/runs.test.ts

@@ -24,6 +24,11 @@ describe('resource runs', () => {
     const response = await openai.beta.threads.runs.create('string', {
       assistant_id: 'string',
       additional_instructions: 'string',
+      additional_messages: [
+        { role: 'user', content: 'x', file_ids: ['string'], metadata: {} },
+        { role: 'user', content: 'x', file_ids: ['string'], metadata: {} },
+        { role: 'user', content: 'x', file_ids: ['string'], metadata: {} },
+      ],
       instructions: 'string',
       metadata: {},
       model: 'string',