Merge pull request #723 from openai/release-please--branches--master--changes--next--components--openai

nknj · web-flow · commit d4673f1b089d · 2024-03-19T08:50:20.000-07:00
release: 4.29.2
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -1,3 +1,3 @@
 {
-  ".": "4.29.1"
+  ".": "4.29.2"
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,19 @@
 # Changelog
 
+## 4.29.2 (2024-03-19)
+
+Full Changelog: [v4.29.1...v4.29.2](https://github.com/openai/openai-node/compare/v4.29.1...v4.29.2)
+
+### Chores
+
+* **internal:** update generated pragma comment ([#724](https://github.com/openai/openai-node/issues/724)) ([139e205](https://github.com/openai/openai-node/commit/139e205ed1ed30cb1df982d852a093dcea945aba))
+
+
+### Documentation
+
+* assistant improvements ([#725](https://github.com/openai/openai-node/issues/725)) ([6a2c41b](https://github.com/openai/openai-node/commit/6a2c41b0ce833eba0cdea6a7d221697f3be26abb))
+* fix typo in CONTRIBUTING.md ([#722](https://github.com/openai/openai-node/issues/722)) ([05ff8f7](https://github.com/openai/openai-node/commit/05ff8f7671fe6ce5d9517034f76a166a0bd27803))
+
 ## 4.29.1 (2024-03-15)
 
 Full Changelog: [v4.29.0...v4.29.1](https://github.com/openai/openai-node/compare/v4.29.0...v4.29.1)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -68,7 +68,7 @@ pnpm link -—global openai
 Most tests require you to [set up a mock server](https://github.com/stoplightio/prism) against the OpenAPI spec to run the tests.
 
 ```bash
-npx prism path/to/your/openapi.yml
+npx prism mock path/to/your/openapi.yml
 ```
 
 ```bash
diff --git a/README.md b/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.29.1/mod.ts';
+import OpenAI from 'https://deno.land/x/openai@v4.29.2/mod.ts';
 ```
 
 <!-- x-release-please-end -->
@@ -100,6 +100,37 @@ Documentation for each method, request param, and response field are available i
 > [!IMPORTANT]
 > Previous versions of this SDK used a `Configuration` class. See the [v3 to v4 migration guide](https://github.com/openai/openai-node/discussions/217).
 
+### Streaming Helpers
+
+The SDK also includes helpers to process streams and handle the incoming events.
+
+```ts
+const run = openai.beta.threads.runs
+  .createAndStream(thread.id, {
+    assistant_id: assistant.id,
+  })
+  .on('textCreated', (text) => process.stdout.write('\nassistant > '))
+  .on('textDelta', (textDelta, snapshot) => process.stdout.write(textDelta.value))
+  .on('toolCallCreated', (toolCall) => process.stdout.write(`\nassistant > ${toolCall.type}\n\n`))
+  .on('toolCallDelta', (toolCallDelta, snapshot) => {
+    if (toolCallDelta.type === 'code_interpreter') {
+      if (toolCallDelta.code_interpreter.input) {
+        process.stdout.write(toolCallDelta.code_interpreter.input);
+      }
+      if (toolCallDelta.code_interpreter.outputs) {
+        process.stdout.write('\noutput >\n');
+        toolCallDelta.code_interpreter.outputs.forEach((output) => {
+          if (output.type === 'logs') {
+            process.stdout.write(`\n${output.logs}\n`);
+          }
+        });
+      }
+    }
+  });
+```
+
+More information on streaming helpers can be found in the dedicated documentation: [helpers.md](helpers.md)
+
 ### Streaming responses
 
 This library provides several conveniences for streaming chat completions, for example:
diff --git a/build-deno b/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.29.1/mod.ts";
+import OpenAI from "https://deno.land/x/openai@v4.29.2/mod.ts";
 
 const client = new OpenAI();
 \`\`\`
diff --git a/helpers.md b/helpers.md
@@ -36,6 +36,29 @@ const run = openai.beta.threads.runs
   });
 ```
 
+### Starting a stream
+
+There are three helper methods for creating streams:
+
+```ts
+openai.beta.threads.runs.createAndStream();
+```
+
+This method can be used to start and stream the response to an existing run with an associated thread
+that is already populated with messages.
+
+```ts
+openai.beta.threads.createAndRunStream();
+```
+
+This method can be used to add a message to a thread, start a run and then stream the response.
+
+```ts
+openai.beta.threads.runs.submitToolOutputsStream();
+```
+
+This method can be used to submit a tool output to a run waiting on the output and start a stream.
+
 ### Assistant Events
 
 The assistant API provides events you can subscribe to for the following events.
@@ -108,25 +131,25 @@ The last event send when a stream ends.
 The assistant streaming object also provides a few methods for convenience:
 
 ```ts
-.currentEvent()
+.currentEvent(): AssistantStreamEvent | undefined
 
-.currentRun()
+.currentRun(): Run | undefined
 
-.currentMessageSnapshot()
+.currentMessageSnapshot(): Message
 
-.currentRunStepSnapshot()
+.currentRunStepSnapshot(): Runs.RunStep
 ```
 
 These methods are provided to allow you to access additional context from within event handlers. In many cases
 the handlers should include all the information you need for processing, but if additional context is required it
 can be accessed.
 
-Note: There is not always a relevant context in certain situations (these will be undefined in those cases).
+Note: There is not always a relevant context in certain situations (these will be `undefined` in those cases).
 
 ```ts
-await.finalMessages();
+await .finalMessages() : Promise<Message[]>
 
-await.finalRunSteps();
+await .finalRunSteps(): Promise<RunStep[]>
 ```
 
 These methods are provided for convenience to collect information at the end of a stream. Calling these events
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "openai",
-  "version": "4.29.1",
+  "version": "4.29.2",
   "description": "The official TypeScript library for the OpenAI API",
   "author": "OpenAI <support@openai.com>",
   "types": "dist/index.d.ts",
diff --git a/src/error.ts b/src/error.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { castToError, Headers } from './core';
 
diff --git a/src/index.ts b/src/index.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as Core from './core';
 import * as Errors from './error';
diff --git a/src/pagination.ts b/src/pagination.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { AbstractPage, Response, APIClient, FinalRequestOptions, PageInfo } from './core';
 
diff --git a/src/resource.ts b/src/resource.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import type { OpenAI } from './index';
 
diff --git a/src/resources/audio/audio.ts b/src/resources/audio/audio.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from 'openai/resource';
 import * as SpeechAPI from 'openai/resources/audio/speech';
diff --git a/src/resources/audio/index.ts b/src/resources/audio/index.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export { Audio } from './audio';
 export { SpeechCreateParams, Speech } from './speech';
diff --git a/src/resources/audio/speech.ts b/src/resources/audio/speech.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
diff --git a/src/resources/audio/transcriptions.ts b/src/resources/audio/transcriptions.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
diff --git a/src/resources/audio/translations.ts b/src/resources/audio/translations.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
diff --git a/src/resources/beta/assistants/assistants.ts b/src/resources/beta/assistants/assistants.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
diff --git a/src/resources/beta/assistants/files.ts b/src/resources/beta/assistants/files.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
diff --git a/src/resources/beta/assistants/index.ts b/src/resources/beta/assistants/index.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export {
   Assistant,
diff --git a/src/resources/beta/beta.ts b/src/resources/beta/beta.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from 'openai/resource';
 import * as AssistantsAPI from 'openai/resources/beta/assistants/assistants';
diff --git a/src/resources/beta/chat/chat.ts b/src/resources/beta/chat/chat.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from 'openai/resource';
 import * as CompletionsAPI from 'openai/resources/beta/chat/completions';
diff --git a/src/resources/beta/chat/completions.ts b/src/resources/beta/chat/completions.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
diff --git a/src/resources/beta/chat/index.ts b/src/resources/beta/chat/index.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export { Chat } from './chat';
 export { Completions } from './completions';
diff --git a/src/resources/beta/index.ts b/src/resources/beta/index.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export {
   Assistant,
diff --git a/src/resources/beta/threads/index.ts b/src/resources/beta/threads/index.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export {
   Annotation,
diff --git a/src/resources/beta/threads/messages/files.ts b/src/resources/beta/threads/messages/files.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
diff --git a/src/resources/beta/threads/messages/index.ts b/src/resources/beta/threads/messages/index.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export {
   Annotation,
diff --git a/src/resources/beta/threads/messages/messages.ts b/src/resources/beta/threads/messages/messages.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
diff --git a/src/resources/beta/threads/runs/index.ts b/src/resources/beta/threads/runs/index.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export {
   CodeInterpreterLogs,
diff --git a/src/resources/beta/threads/runs/runs.ts b/src/resources/beta/threads/runs/runs.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as Core from 'openai/core';
 import { APIPromise } from 'openai/core';
diff --git a/src/resources/beta/threads/runs/steps.ts b/src/resources/beta/threads/runs/steps.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
diff --git a/src/resources/beta/threads/threads.ts b/src/resources/beta/threads/threads.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as Core from 'openai/core';
 import { APIPromise } from 'openai/core';
diff --git a/src/resources/chat/chat.ts b/src/resources/chat/chat.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from 'openai/resource';
 import * as CompletionsAPI from 'openai/resources/chat/completions';
diff --git a/src/resources/chat/completions.ts b/src/resources/chat/completions.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as Core from 'openai/core';
 import { APIPromise } from 'openai/core';
diff --git a/src/resources/chat/index.ts b/src/resources/chat/index.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export { Chat } from './chat';
 export {
diff --git a/src/resources/completions.ts b/src/resources/completions.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as Core from 'openai/core';
 import { APIPromise } from 'openai/core';
diff --git a/src/resources/embeddings.ts b/src/resources/embeddings.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
diff --git a/src/resources/files.ts b/src/resources/files.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
diff --git a/src/resources/fine-tuning/fine-tuning.ts b/src/resources/fine-tuning/fine-tuning.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from 'openai/resource';
 import * as JobsAPI from 'openai/resources/fine-tuning/jobs';
diff --git a/src/resources/fine-tuning/index.ts b/src/resources/fine-tuning/index.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export { FineTuning } from './fine-tuning';
 export {
diff --git a/src/resources/fine-tuning/jobs.ts b/src/resources/fine-tuning/jobs.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
diff --git a/src/resources/images.ts b/src/resources/images.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
diff --git a/src/resources/index.ts b/src/resources/index.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export * from './chat/index';
 export * from './shared';
diff --git a/src/resources/models.ts b/src/resources/models.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
diff --git a/src/resources/moderations.ts b/src/resources/moderations.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
diff --git a/src/resources/shared.ts b/src/resources/shared.ts
@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless.
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export interface ErrorObject {
   code: string | null;
diff --git a/src/version.ts b/src/version.ts
@@ -1 +1 @@
-export const VERSION = '4.29.1'; // x-release-please-version
+export const VERSION = '4.29.2'; // x-release-please-version
diff --git a/tests/api-resources/audio/speech.test.ts b/tests/api-resources/audio/speech.test.ts
diff --git a/tests/api-resources/audio/transcriptions.test.ts b/tests/api-resources/audio/transcriptions.test.ts
diff --git a/tests/api-resources/audio/translations.test.ts b/tests/api-resources/audio/translations.test.ts
diff --git a/tests/api-resources/beta/assistants/assistants.test.ts b/tests/api-resources/beta/assistants/assistants.test.ts
diff --git a/tests/api-resources/beta/assistants/files.test.ts b/tests/api-resources/beta/assistants/files.test.ts
diff --git a/tests/api-resources/beta/threads/messages/files.test.ts b/tests/api-resources/beta/threads/messages/files.test.ts
diff --git a/tests/api-resources/beta/threads/messages/messages.test.ts b/tests/api-resources/beta/threads/messages/messages.test.ts
diff --git a/tests/api-resources/beta/threads/runs/runs.test.ts b/tests/api-resources/beta/threads/runs/runs.test.ts
diff --git a/tests/api-resources/beta/threads/runs/steps.test.ts b/tests/api-resources/beta/threads/runs/steps.test.ts
diff --git a/tests/api-resources/beta/threads/threads.test.ts b/tests/api-resources/beta/threads/threads.test.ts
diff --git a/tests/api-resources/chat/completions.test.ts b/tests/api-resources/chat/completions.test.ts
diff --git a/tests/api-resources/completions.test.ts b/tests/api-resources/completions.test.ts
diff --git a/tests/api-resources/embeddings.test.ts b/tests/api-resources/embeddings.test.ts
diff --git a/tests/api-resources/files.test.ts b/tests/api-resources/files.test.ts
diff --git a/tests/api-resources/fine-tuning/jobs.test.ts b/tests/api-resources/fine-tuning/jobs.test.ts
diff --git a/tests/api-resources/images.test.ts b/tests/api-resources/images.test.ts
diff --git a/tests/api-resources/models.test.ts b/tests/api-resources/models.test.ts
diff --git a/tests/api-resources/moderations.test.ts b/tests/api-resources/moderations.test.ts
diff --git a/tests/index.test.ts b/tests/index.test.ts

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`{`
`2`		`- ".": "4.29.1"`
	`2`	`+ ".": "4.29.2"`
`3`	`3`	`}`
-Original file line number
+Diff line change
 Usage:
 \`\`\`ts
 -import OpenAI from "https://deno.land/x/[email protected].1/mod.ts";
 +import OpenAI from "https://deno.land/x/[email protected].2/mod.ts";
 const client = new OpenAI();
 \`\`\`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "openai",`
`3`		`- "version": "4.29.1",`
	`3`	`+ "version": "4.29.2",`
`4`	`4`	`"description": "The official TypeScript library for the OpenAI API",`
`5`	`5`	`"author": "OpenAI <[email protected]>",`
`6`	`6`	`"types": "dist/index.d.ts",`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// File generated from our OpenAPI spec by Stainless.`
	`1`	`+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.`
`2`	`2`
`3`	`3`	`import { castToError, Headers } from './core';`
`4`	`4`