Update OpenAI completion chunk types to OpenAI SDK 4.16.1 (#715)

Co-authored-by: Max Leiter <max.leiter@vercel.com>

.changeset/orange-keys-attend.md

@@ -0,0 +1,5 @@
+---
+'ai': patch
+---
+
+Support openai@4.16.0 and later

examples/next-fireworks/package.json

@@ -11,7 +11,7 @@
   "dependencies": {
     "ai": "2.2.20",
     "next": "13.4.12",
-    "openai": "4.11.0",
+    "openai": "4.16.1",
     "react": "18.2.0",
     "react-dom": "^18.2.0"
   },

examples/next-openai-rate-limits/package.json

@@ -13,7 +13,7 @@
     "@vercel/kv": "^0.2.2",
     "ai": "2.2.20",
     "next": "13.4.12",
-    "openai": "4.11.0",
+    "openai": "4.16.1",
     "react": "18.2.0",
     "react-dom": "^18.2.0",
     "sonner": "^0.6.2"

examples/next-openai/package.json

@@ -11,7 +11,7 @@
   "dependencies": {
     "ai": "2.2.20",
     "next": "13.4.12",
-    "openai": "4.11.0",
+    "openai": "4.16.1",
     "react": "18.2.0",
     "react-dom": "^18.2.0"
   },

examples/nuxt-openai/package.json

@@ -19,7 +19,7 @@
     "@vue/shared": "^3.3.4",
     "ai": "2.2.20",
     "nuxt": "^3.6.5",
-    "openai": "4.11.0",
+    "openai": "4.16.1",
     "tailwindcss": "^3.3.3",
     "ufo": "^1.2.0",
     "unctx": "^2.3.1",

examples/solidstart-openai/package.json

@@ -19,7 +19,7 @@
     "@solidjs/meta": "^0.28.2",
     "@solidjs/router": "^0.8.2",
     "ai": "2.2.20",
-    "openai": "4.11.0",
+    "openai": "4.16.1",
     "solid-js": "^1.7.2",
     "solid-start": "^0.2.26",
     "undici": "^5.15.1"

examples/sveltekit-openai/package.json

@@ -10,7 +10,7 @@
     "check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch"
   },
   "dependencies": {
-    "openai": "4.11.0",
+    "openai": "4.16.1",
     "ai": "2.2.20"
   },
   "devDependencies": {

packages/core/package.json

@@ -88,6 +88,7 @@
     "eslint-config-vercel-ai": "workspace:*",
     "jest": "29.2.1",
     "langchain": "0.0.172",
+    "openai": "4.16.1",
     "ts-jest": "29.0.3",
     "tsup": "^6.7.0",
     "typescript": "5.1.3"

packages/core/streams/openai-stream.test.ts

@@ -3,6 +3,7 @@ import {
   StreamingTextResponse,
   experimental_StreamData,
 } from '.';
+import OpenAI from 'openai';
 import { createClient } from '../tests/utils/mock-client';
 import { setup } from '../tests/utils/mock-service';
 
@@ -13,6 +14,25 @@ describe('OpenAIStream', () => {
   });
   afterAll(async () => server.teardown());
 
+  // deactivated to only test types
+  xit('should not throw type errors', async () => {
+    const openai = new OpenAI({
+      apiKey: process.env.OPENAI_API_KEY,
+    });
+
+    const response = await openai.chat.completions.create({
+      model: 'gpt-3.5-turbo-16k',
+      stream: true,
+      temperature: 0.0,
+      messages: [
+        { role: 'system', content: 'You are a helpful yada yada' },
+        { role: 'user', content: '' },
+      ],
+    });
+
+    const stream = OpenAIStream(response);
+  });
+
   it('should be able to parse SSE and receive the streamed response', async () => {
     const stream = OpenAIStream(
       await fetch(server.api, {

packages/core/streams/openai-stream.ts

@@ -65,13 +65,21 @@ interface ChatCompletionChunk {
 
 // https://github.com/openai/openai-node/blob/07b3504e1c40fd929f4aae1651b83afc19e3baf8/src/resources/chat/completions.ts#L43-L49
 // Updated for https://github.com/openai/openai-node/commit/f10c757d831d90407ba47b4659d9cd34b1a35b1d
+// Updated to https://github.com/openai/openai-node/commit/84b43280089eacdf18f171723591856811beddce
 interface ChatCompletionChunkChoice {
   delta: ChoiceDelta;
-  finish_reason: 'stop' | 'length' | 'function_call' | 'content_filter' | null;
+  finish_reason:
+    | 'stop'
+    | 'length'
+    | 'tool_calls'
+    | 'content_filter'
+    | 'function_call'
+    | null;
   index: number;
 }
 
 // https://github.com/openai/openai-node/blob/07b3504e1c40fd929f4aae1651b83afc19e3baf8/src/resources/chat/completions.ts#L123-L139
+// Updated to https://github.com/openai/openai-node/commit/84b43280089eacdf18f171723591856811beddce
 interface ChoiceDelta {
   /**
    * The contents of the chunk message.
@@ -87,7 +95,44 @@ interface ChoiceDelta {
   /**
    * The role of the author of this message.
    */
-  role?: 'system' | 'user' | 'assistant' | 'function';
+  role?: 'system' | 'user' | 'assistant' | 'tool';
+
+  tool_calls?: Array<DeltaToolCall>;
+}
+
+// From https://github.com/openai/openai-node/blob/master/src/resources/chat/completions.ts
+// Updated to https://github.com/openai/openai-node/commit/84b43280089eacdf18f171723591856811beddce
+interface DeltaToolCall {
+  index: number;
+
+  /**
+   * The ID of the tool call.
+   */
+  id?: string;
+
+  function?: ToolCallFunction;
+
+  /**
+   * The type of the tool. Currently, only `function` is supported.
+   */
+  type?: 'function';
+}
+
+// From https://github.com/openai/openai-node/blob/master/src/resources/chat/completions.ts
+// Updated to https://github.com/openai/openai-node/commit/84b43280089eacdf18f171723591856811beddce
+interface ToolCallFunction {
+  /**
+   * The arguments to call the function with, as generated by the model in JSON
+   * format. Note that the model does not always generate valid JSON, and may
+   * hallucinate parameters not defined by your function schema. Validate the
+   * arguments in your code before calling your function.
+   */
+  arguments?: string;
+
+  /**
+   * The name of the function to call.
+   */
+  name?: string;
 }
 
 /**