release: 4.37.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "4.36.0"
+  ".": "4.37.0"
 }

.stats.yml

@@ -1 +1 @@
-configured_endpoints: 55
+configured_endpoints: 62

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 4.37.0 (2024-04-17)
+
+Full Changelog: [v4.36.0...v4.37.0](https://github.com/openai/openai-node/compare/v4.36.0...v4.37.0)
+
+### Features
+
+* **api:** add vector stores ([#776](https://github.com/openai/openai-node/issues/776)) ([8bb929b](https://github.com/openai/openai-node/commit/8bb929b2ee91c1bec0a00347bf4f7628652d1be3))
+
 ## 4.36.0 (2024-04-16)
 
 Full Changelog: [v4.35.0...v4.36.0](https://github.com/openai/openai-node/compare/v4.35.0...v4.36.0)

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.36.0/mod.ts';
+import OpenAI from 'https://deno.land/x/openai@v4.37.0/mod.ts';
 ```
 
 <!-- x-release-please-end -->
@@ -102,7 +102,7 @@ Documentation for each method, request param, and response field are available i
 
 ### Polling Helpers
 
-When interacting with the API some actions such as starting a Run may take time to complete. The SDK includes
+When interacting with the API some actions such as starting a Run and adding files to vector stores are asynchronous and take time to complete. The SDK includes
 helper functions which will poll the status until it reaches a terminal state and then return the resulting object.
 If an API method results in an action which could benefit from polling there will be a corresponding version of the
 method ending in 'AndPoll'.
@@ -117,6 +117,20 @@ const run = await openai.beta.threads.runs.createAndPoll(thread.id, {
 
 More information on the lifecycle of a Run can be found in the [Run Lifecycle Documentation](https://platform.openai.com/docs/assistants/how-it-works/run-lifecycle)
 
+### Bulk Upload Helpers
+
+When creating an interacting with vector stores, you can use the polling helpers to monitor the status of operations.
+For convenience, we also provide a bulk upload helper to allow you to simultaneously upload several files at once.
+
+```ts
+const fileList = [
+  createReadStream('/home/data/example.pdf'),
+  ...
+];
+
+const batch = await openai.vectorStores.fileBatches.uploadAndPoll(vectorStore.id, fileList);
+```
+
 ### Streaming Helpers
 
 The SDK also includes helpers to process streams and handle the incoming events.

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.36.0/mod.ts";
+import OpenAI from "https://deno.land/x/openai@v4.37.0/mod.ts";
 
 const client = new OpenAI();
 \`\`\`

helpers.md

@@ -1,4 +1,4 @@
-# Streaming Helpers
+# Helpers
 
 OpenAI supports streaming responses when interacting with the [Chat](#chat-streaming) or [Assistant](#assistant-streaming-api) APIs.
 
@@ -449,3 +449,24 @@ See an example of a Next.JS integration here [`examples/stream-to-client-next.ts
 #### Proxy Streaming to a Browser
 
 See an example of using express to stream to a browser here [`examples/stream-to-client-express.ts`](examples/stream-to-client-express.ts).
+
+# Polling Helpers
+
+When interacting with the API some actions such as starting a Run and adding files to vector stores are asynchronous and take time to complete.
+The SDK includes helper functions which will poll the status until it reaches a terminal state and then return the resulting object.
+If an API method results in an action which could benefit from polling there will be a corresponding version of the
+method ending in `_AndPoll`.
+
+All methods also allow you to set the polling frequency, how often the API is checked for an update, via a function argument (`pollIntervalMs`).
+
+The polling methods are:
+
+```ts
+client.beta.threads.createAndRunPoll(...)
+client.beta.threads.runs.createAndPoll((...)
+client.beta.threads.runs.submitToolOutputsAndPoll((...)
+client.beta.vectorStores.files.uploadAndPoll((...)
+client.beta.vectorStores.files.createAndPoll((...)
+client.beta.vectorStores.fileBatches.createAndPoll((...)
+client.beta.vectorStores.fileBatches.uploadAndPoll((...)
+```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openai",
-  "version": "4.36.0",
+  "version": "4.37.0",
   "description": "The official TypeScript library for the OpenAI API",
   "author": "OpenAI <[email protected]>",
   "types": "dist/index.d.ts",

src/lib/AssistantStream.ts

@@ -7,7 +7,7 @@ import {
   ImageFile,
   TextDelta,
   Messages,
-} from 'openai/resources/beta/threads/messages/messages';
+} from 'openai/resources/beta/threads/messages';
 import * as Core from 'openai/core';
 import { RequestOptions } from 'openai/core';
 import {
@@ -30,7 +30,7 @@ import {
   MessageStreamEvent,
   RunStepStreamEvent,
   RunStreamEvent,
-} from 'openai/resources/beta/assistants/assistants';
+} from 'openai/resources/beta/assistants';
 import { RunStep, RunStepDelta, ToolCall, ToolCallDelta } from 'openai/resources/beta/threads/runs/steps';
 import { ThreadCreateAndRunParamsBase, Threads } from 'openai/resources/beta/threads/threads';
 import MessageDelta = Messages.MessageDelta;

src/lib/Util.ts

@@ -0,0 +1,23 @@
+/**
+ * Like `Promise.allSettled()` but throws an error if any promises are rejected.
+ */
+export const allSettledWithThrow = async <R>(promises: Promise<R>[]): Promise<R[]> => {
+  const results = await Promise.allSettled(promises);
+  const rejected = results.filter((result): result is PromiseRejectedResult => result.status === 'rejected');
+  if (rejected.length) {
+    for (const result of rejected) {
+      console.error(result.reason);
+    }
+
+    throw new Error(`${rejected.length} promise(s) failed - see the above errors`);
+  }
+
+  // Note: TS was complaining about using `.filter().map()` here for some reason
+  const values: R[] = [];
+  for (const result of results) {
+    if (result.status === 'fulfilled') {
+      values.push(result.value);
+    }
+  }
+  return values;
+};