Update type definition to include updated openai v4 types. (#458)

Co-authored-by: Max Leiter <max.leiter@vercel.com>
vercel · Aug 16, 2023 · 04084a8 · 04084a8
1 parent 799e385
commit 04084a8
Show file tree

Hide file tree

Showing 13 changed files with 122 additions and 440 deletions.
diff --git a/.changeset/silent-carpets-knock.md b/.changeset/silent-carpets-knock.md
@@ -0,0 +1,5 @@
+---
+'ai': patch
+---
+
+openai-stream: fix experimental_onFunctionCall types for OpenAI SDK v4
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -20,7 +20,7 @@ jobs:
       - name: Setup pnpm
         uses: pnpm/action-setup@v2.2.2
         with:
-          version: 8.6.3
+          version: 8.6.9
 
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v2

diff --git a/.github/workflows/quality.yml b/.github/workflows/quality.yml
@@ -17,7 +17,7 @@ jobs:
       - name: Setup pnpm
         uses: pnpm/action-setup@v2.2.4
         with:
-          version: 8.6.3
+          version: 8.6.9
 
       - name: Use Node.js 18
         uses: actions/setup-node@v3

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -19,7 +19,7 @@ jobs:
       - name: Setup pnpm 8
         uses: pnpm/action-setup@v2
         with:
-          version: 8.6.3
+          version: 8.6.9
 
       - name: Setup Node.js 18.x
         uses: actions/setup-node@v2

diff --git a/examples/next-openai-rate-limits/app/api/chat/route.ts b/examples/next-openai-rate-limits/app/api/chat/route.ts
@@ -6,7 +6,7 @@ import { Ratelimit } from '@upstash/ratelimit'
 
 // Create an OpenAI API client (that's edge friendly!)
 const openai = new OpenAI({
-  apiKey: process.env.OPENAI_API_KEY
+  apiKey: process.env.OPENAI_API_KEY || ''
 })
 
 // IMPORTANT! Set the runtime to edge

diff --git a/examples/next-openai/app/api/chat-with-functions/route.ts b/examples/next-openai/app/api/chat-with-functions/route.ts
@@ -3,7 +3,7 @@ import OpenAI from 'openai'
 import { CompletionCreateParams } from 'openai/resources/chat'
 // Create an OpenAI API client (that's edge friendly!)
 const openai = new OpenAI({
-  apiKey: process.env.OPENAI_API_KEY
+  apiKey: process.env.OPENAI_API_KEY || ''
 })
 
 // IMPORTANT! Set the runtime to edge

diff --git a/examples/next-openai/app/api/chat/route.ts b/examples/next-openai/app/api/chat/route.ts
@@ -4,7 +4,7 @@ import { OpenAIStream, StreamingTextResponse } from 'ai'
 
 // Create an OpenAI API client (that's edge friendly!)
 const openai = new OpenAI({
-  apiKey: process.env.OPENAI_API_KEY
+  apiKey: process.env.OPENAI_API_KEY || ''
 })
 
 // IMPORTANT! Set the runtime to edge

diff --git a/examples/nuxt-openai/package.json b/examples/nuxt-openai/package.json
@@ -19,9 +19,10 @@
     "@vue/shared": "^3.3.4",
     "ai": "2.2.0",
     "nuxt": "^3.6.5",
+    "openai": "4.0.0",
     "tailwindcss": "^3.3.3",
+    "ufo": "^1.2.0",
     "unctx": "^2.3.1",
-    "openai": "4.0.0",
     "vue": "^3.3.4"
   }
 }
diff --git a/examples/solidstart-openai/src/routes/api/chat/index.ts b/examples/solidstart-openai/src/routes/api/chat/index.ts
@@ -5,7 +5,7 @@ import { APIEvent } from 'solid-start/api'
 
 // Create an OpenAI API client
 const openai = new OpenAI({
-  apiKey: process.env['OPENAI_API_KEY']
+  apiKey: process.env['OPENAI_API_KEY'] || ''
 })
 
 export const POST = async (event: APIEvent) => {

diff --git a/examples/sveltekit-openai/src/routes/api/chat/+server.ts b/examples/sveltekit-openai/src/routes/api/chat/+server.ts
@@ -10,7 +10,7 @@ import type { RequestHandler } from './$types'
 
 // Create an OpenAI API client
 const openai = new OpenAI({
-  apiKey: env.OPENAI_API_KEY
+  apiKey: env.OPENAI_API_KEY || ''
 })
 
 export const POST = (async ({ request }) => {

diff --git a/package.json b/package.json
@@ -44,7 +44,7 @@
   "keywords": [
     "ai"
   ],
-  "packageManager": "pnpm@8.6.3",
+  "packageManager": "pnpm@8.6.9",
   "prettier": {
     "tabWidth": 2,
     "semi": false,

diff --git a/packages/core/streams/openai-stream.ts b/packages/core/streams/openai-stream.ts
@@ -50,7 +50,9 @@ export type OpenAIStreamCallbacks = AIStreamCallbacks & {
     createFunctionCallMessages: (
       functionCallResult: JSONValue
     ) => CreateMessage[]
-  ) => Promise<Response | undefined | void | string>
+  ) => Promise<
+    Response | undefined | void | string | AsyncIterable<ChatCompletionChunk>
+  >
 }
 
 // https://github.com/openai/openai-node/blob/07b3504e1c40fd929f4aae1651b83afc19e3baf8/src/resources/chat/completions.ts#L28-L40