@ai-sdk/openai 0.0.54 → 0.0.56

package/CHANGELOG.md

@@ -0,0 +1,438 @@
+# @ai-sdk/openai
+
+## 0.0.56
+
+### Patch Changes
+
+- 03313cd: feat (ai): expose response id, response model, response timestamp in telemetry and api
+- Updated dependencies [03313cd]
+- Updated dependencies [3be7c1c]
+  - @ai-sdk/provider-utils@1.0.18
+  - @ai-sdk/provider@0.0.23
+
+## 0.0.55
+
+### Patch Changes
+
+- 28cbf2e: fix (provider/openai): support tool call deltas when arguments are sent in the first chunk
+
+## 0.0.54
+
+### Patch Changes
+
+- 26515cb: feat (ai/provider): introduce ProviderV1 specification
+- Updated dependencies [26515cb]
+  - @ai-sdk/provider@0.0.22
+  - @ai-sdk/provider-utils@1.0.17
+
+## 0.0.53
+
+### Patch Changes
+
+- Updated dependencies [09f895f]
+  - @ai-sdk/provider-utils@1.0.16
+
+## 0.0.52
+
+### Patch Changes
+
+- d5b6a15: feat (provider/openai): support partial usage information
+
+## 0.0.51
+
+### Patch Changes
+
+- Updated dependencies [d67fa9c]
+  - @ai-sdk/provider-utils@1.0.15
+
+## 0.0.50
+
+### Patch Changes
+
+- Updated dependencies [f2c025e]
+  - @ai-sdk/provider@0.0.21
+  - @ai-sdk/provider-utils@1.0.14
+
+## 0.0.49
+
+### Patch Changes
+
+- f42d9bd: fix (provider/openai): support OpenRouter streaming errors
+
+## 0.0.48
+
+### Patch Changes
+
+- Updated dependencies [6ac355e]
+  - @ai-sdk/provider@0.0.20
+  - @ai-sdk/provider-utils@1.0.13
+
+## 0.0.47
+
+### Patch Changes
+
+- 4ffbaee: fix (provider/openai): fix strict flag for structured outputs with tools
+- dd712ac: fix: use FetchFunction type to prevent self-reference
+- Updated dependencies [dd712ac]
+  - @ai-sdk/provider-utils@1.0.12
+
+## 0.0.46
+
+### Patch Changes
+
+- 89b18ca: fix (ai/provider): send finish reason 'unknown' by default
+- Updated dependencies [dd4a0f5]
+  - @ai-sdk/provider@0.0.19
+  - @ai-sdk/provider-utils@1.0.11
+
+## 0.0.45
+
+### Patch Changes
+
+- Updated dependencies [4bd27a9]
+- Updated dependencies [845754b]
+  - @ai-sdk/provider-utils@1.0.10
+  - @ai-sdk/provider@0.0.18
+
+## 0.0.44
+
+### Patch Changes
+
+- 029af4c: feat (ai/core): support schema name & description in generateObject & streamObject
+- Updated dependencies [029af4c]
+  - @ai-sdk/provider@0.0.17
+  - @ai-sdk/provider-utils@1.0.9
+
+## 0.0.43
+
+### Patch Changes
+
+- d58517b: feat (ai/openai): structured outputs
+- c0a73ee: feat (provider/openai): add gpt-4o-2024-08-06 to list of supported models
+- Updated dependencies [d58517b]
+  - @ai-sdk/provider@0.0.16
+  - @ai-sdk/provider-utils@1.0.8
+
+## 0.0.42
+
+### Patch Changes
+
+- Updated dependencies [96aed25]
+  - @ai-sdk/provider@0.0.15
+  - @ai-sdk/provider-utils@1.0.7
+
+## 0.0.41
+
+### Patch Changes
+
+- 7a2eb27: feat (provider/openai): make role nullish to enhance provider support
+- Updated dependencies [9614584]
+- Updated dependencies [0762a22]
+  - @ai-sdk/provider-utils@1.0.6
+
+## 0.0.40
+
+### Patch Changes
+
+- Updated dependencies [a8d1c9e9]
+  - @ai-sdk/provider-utils@1.0.5
+  - @ai-sdk/provider@0.0.14
+
+## 0.0.39
+
+### Patch Changes
+
+- Updated dependencies [4f88248f]
+  - @ai-sdk/provider-utils@1.0.4
+
+## 0.0.38
+
+### Patch Changes
+
+- 2b9da0f0: feat (core): support stopSequences setting.
+- 909b9d27: feat (ai/openai): Support legacy function calls
+- a5b58845: feat (core): support topK setting
+- 4aa8deb3: feat (provider): support responseFormat setting in provider api
+- 13b27ec6: chore (ai/core): remove grammar mode
+- Updated dependencies [2b9da0f0]
+- Updated dependencies [a5b58845]
+- Updated dependencies [4aa8deb3]
+- Updated dependencies [13b27ec6]
+  - @ai-sdk/provider@0.0.13
+  - @ai-sdk/provider-utils@1.0.3
+
+## 0.0.37
+
+### Patch Changes
+
+- 89947fc5: chore (provider/openai): update model list for type-ahead support
+
+## 0.0.36
+
+### Patch Changes
+
+- b7290943: feat (ai/core): add token usage to embed and embedMany
+- Updated dependencies [b7290943]
+  - @ai-sdk/provider@0.0.12
+  - @ai-sdk/provider-utils@1.0.2
+
+## 0.0.35
+
+### Patch Changes
+
+- Updated dependencies [d481729f]
+  - @ai-sdk/provider-utils@1.0.1
+
+## 0.0.34
+
+### Patch Changes
+
+- 5edc6110: feat (ai/core): add custom request header support
+- Updated dependencies [5edc6110]
+- Updated dependencies [5edc6110]
+- Updated dependencies [5edc6110]
+  - @ai-sdk/provider@0.0.11
+  - @ai-sdk/provider-utils@1.0.0
+
+## 0.0.33
+
+### Patch Changes
+
+- Updated dependencies [02f6a088]
+  - @ai-sdk/provider-utils@0.0.16
+
+## 0.0.32
+
+### Patch Changes
+
+- 1b37b8b9: fix (@ai-sdk/openai): only send logprobs settings when logprobs are requested
+
+## 0.0.31
+
+### Patch Changes
+
+- eba071dd: feat (@ai-sdk/azure): add azure openai completion support
+- 1ea890fe: feat (@ai-sdk/azure): add azure openai completion support
+
+## 0.0.30
+
+### Patch Changes
+
+- Updated dependencies [85712895]
+- Updated dependencies [85712895]
+  - @ai-sdk/provider-utils@0.0.15
+
+## 0.0.29
+
+### Patch Changes
+
+- 4728c37f: feat (core): add text embedding model support to provider registry
+- 7910ae84: feat (providers): support custom fetch implementations
+- Updated dependencies [7910ae84]
+  - @ai-sdk/provider-utils@0.0.14
+
+## 0.0.28
+
+### Patch Changes
+
+- f9db8fd6: feat (@ai-sdk/openai): add parallelToolCalls setting
+
+## 0.0.27
+
+### Patch Changes
+
+- fc9552ec: fix (@ai-sdk/azure): allow for nullish delta
+
+## 0.0.26
+
+### Patch Changes
+
+- 7530f861: fix (@ai-sdk/openai): add internal dist to bundle
+
+## 0.0.25
+
+### Patch Changes
+
+- 8b1362a7: chore (@ai-sdk/openai): expose models under /internal for reuse in other providers
+
+## 0.0.24
+
+### Patch Changes
+
+- 0e78960c: fix (@ai-sdk/openai): make function name and arguments nullish
+
+## 0.0.23
+
+### Patch Changes
+
+- a68fe74a: fix (@ai-sdk/openai): allow null tool_calls value.
+
+## 0.0.22
+
+### Patch Changes
+
+- Updated dependencies [102ca22f]
+  - @ai-sdk/provider@0.0.10
+  - @ai-sdk/provider-utils@0.0.13
+
+## 0.0.21
+
+### Patch Changes
+
+- fca7d026: feat (provider/openai): support streaming tool calls that are sent in one chunk
+- Updated dependencies [09295e2e]
+- Updated dependencies [09295e2e]
+- Updated dependencies [043a5de2]
+  - @ai-sdk/provider@0.0.9
+  - @ai-sdk/provider-utils@0.0.12
+
+## 0.0.20
+
+### Patch Changes
+
+- a1d08f3e: fix (provider/openai): handle error chunks when streaming
+
+## 0.0.19
+
+### Patch Changes
+
+- beb8b739: fix (provider/openai): return unknown finish reasons as unknown
+
+## 0.0.18
+
+### Patch Changes
+
+- fb42e760: feat (provider/openai): send user message content as text when possible
+
+## 0.0.17
+
+### Patch Changes
+
+- f39c0dd2: feat (provider): implement toolChoice support
+- Updated dependencies [f39c0dd2]
+  - @ai-sdk/provider@0.0.8
+  - @ai-sdk/provider-utils@0.0.11
+
+## 0.0.16
+
+### Patch Changes
+
+- 2b18fa11: fix (provider/openai): remove object type validation
+
+## 0.0.15
+
+### Patch Changes
+
+- 24683b72: fix (providers): Zod is required dependency
+- Updated dependencies [8e780288]
+  - @ai-sdk/provider@0.0.7
+  - @ai-sdk/provider-utils@0.0.10
+
+## 0.0.14
+
+### Patch Changes
+
+- Updated dependencies [6a50ac4]
+- Updated dependencies [6a50ac4]
+  - @ai-sdk/provider@0.0.6
+  - @ai-sdk/provider-utils@0.0.9
+
+## 0.0.13
+
+### Patch Changes
+
+- 4e3c922: fix (provider/openai): introduce compatibility mode in which "stream_options" are not sent
+
+## 0.0.12
+
+### Patch Changes
+
+- 6f48839: feat (provider/openai): add gpt-4o to the list of supported models
+- 1009594: feat (provider/openai): set stream_options/include_usage to true when streaming
+- 0f6bc4e: feat (ai/core): add embed function
+- Updated dependencies [0f6bc4e]
+  - @ai-sdk/provider@0.0.5
+  - @ai-sdk/provider-utils@0.0.8
+
+## 0.0.11
+
+### Patch Changes
+
+- Updated dependencies [325ca55]
+  - @ai-sdk/provider@0.0.4
+  - @ai-sdk/provider-utils@0.0.7
+
+## 0.0.10
+
+### Patch Changes
+
+- Updated dependencies [276f22b]
+  - @ai-sdk/provider-utils@0.0.6
+
+## 0.0.9
+
+### Patch Changes
+
+- Updated dependencies [41d5736]
+  - @ai-sdk/provider@0.0.3
+  - @ai-sdk/provider-utils@0.0.5
+
+## 0.0.8
+
+### Patch Changes
+
+- Updated dependencies [56ef84a]
+  - @ai-sdk/provider-utils@0.0.4
+
+## 0.0.7
+
+### Patch Changes
+
+- 0833e19: Allow optional content to support Fireworks function calling.
+
+## 0.0.6
+
+### Patch Changes
+
+- d6431ae: ai/core: add logprobs support (thanks @SamStenner for the contribution)
+- 25f3350: ai/core: add support for getting raw response headers.
+- Updated dependencies [d6431ae]
+- Updated dependencies [25f3350]
+  - @ai-sdk/provider@0.0.2
+  - @ai-sdk/provider-utils@0.0.3
+
+## 0.0.5
+
+### Patch Changes
+
+- eb150a6: ai/core: remove scaling of setting values (breaking change). If you were using the temperature, frequency penalty, or presence penalty settings, you need to update the providers and adjust the setting values.
+- Updated dependencies [eb150a6]
+  - @ai-sdk/provider-utils@0.0.2
+  - @ai-sdk/provider@0.0.1
+
+## 0.0.4
+
+### Patch Changes
+
+- c6fc35b: Add custom header and OpenAI project support.
+
+## 0.0.3
+
+### Patch Changes
+
+- ab60b18: Simplified model construction by directly calling provider functions. Add create... functions to create provider instances.
+
+## 0.0.2
+
+### Patch Changes
+
+- 2bff460: Fix build for release.
+
+## 0.0.1
+
+### Patch Changes
+
+- 7b8791d: Support streams with 'chat.completion' objects.
+- 7b8791d: Rename baseUrl to baseURL. Automatically remove trailing slashes.
+- Updated dependencies [7b8791d]
+  - @ai-sdk/provider-utils@0.0.1

package/dist/index.js

@@ -196,6 +196,19 @@ var openaiFailedResponseHandler = (0, import_provider_utils2.createJsonErrorResp
   errorToMessage: (data) => data.error.message
 });
 
+// src/get-response-metadata.ts
+function getResponseMetadata({
+  id,
+  model,
+  created
+}) {
+  return {
+    id: id != null ? id : void 0,
+    modelId: model != null ? model : void 0,
+    timestamp: created != null ? new Date(created * 1e3) : void 0
+  };
+}
+
 // src/openai-chat-language-model.ts
 var OpenAIChatLanguageModel = class {
   constructor(modelId, settings, config) {
@@ -394,6 +407,7 @@ var OpenAIChatLanguageModel = class {
       },
       rawCall: { rawPrompt, rawSettings },
       rawResponse: { headers: responseHeaders },
+      response: getResponseMetadata(response),
       warnings,
       logprobs: mapOpenAIChatLogProbsOutput(choice.logprobs)
     };
@@ -427,6 +441,7 @@ var OpenAIChatLanguageModel = class {
       completionTokens: void 0
     };
     let logprobs;
+    let isFirstChunk = true;
     const { useLegacyFunctionCalling } = this.settings;
     return {
       stream: response.pipeThrough(
@@ -444,6 +459,13 @@ var OpenAIChatLanguageModel = class {
               controller.enqueue({ type: "error", error: value.error });
               return;
             }
+            if (isFirstChunk) {
+              isFirstChunk = false;
+              controller.enqueue({
+                type: "response-metadata",
+                ...getResponseMetadata(value)
+              });
+            }
             if (value.usage != null) {
               usage = {
                 promptTokens: (_a = value.usage.prompt_tokens) != null ? _a : void 0,
@@ -510,21 +532,25 @@ var OpenAIChatLanguageModel = class {
                     }
                   };
                   const toolCall2 = toolCalls[index];
-                  if (((_e = toolCall2.function) == null ? void 0 : _e.name) != null && ((_f = toolCall2.function) == null ? void 0 : _f.arguments) != null && (0, import_provider_utils3.isParsableJson)(toolCall2.function.arguments)) {
-                    controller.enqueue({
-                      type: "tool-call-delta",
-                      toolCallType: "function",
-                      toolCallId: toolCall2.id,
-                      toolName: toolCall2.function.name,
-                      argsTextDelta: toolCall2.function.arguments
-                    });
-                    controller.enqueue({
-                      type: "tool-call",
-                      toolCallType: "function",
-                      toolCallId: (_g = toolCall2.id) != null ? _g : (0, import_provider_utils3.generateId)(),
-                      toolName: toolCall2.function.name,
-                      args: toolCall2.function.arguments
-                    });
+                  if (((_e = toolCall2.function) == null ? void 0 : _e.name) != null && ((_f = toolCall2.function) == null ? void 0 : _f.arguments) != null) {
+                    if (toolCall2.function.arguments.length > 0) {
+                      controller.enqueue({
+                        type: "tool-call-delta",
+                        toolCallType: "function",
+                        toolCallId: toolCall2.id,
+                        toolName: toolCall2.function.name,
+                        argsTextDelta: toolCall2.function.arguments
+                      });
+                    }
+                    if ((0, import_provider_utils3.isParsableJson)(toolCall2.function.arguments)) {
+                      controller.enqueue({
+                        type: "tool-call",
+                        toolCallType: "function",
+                        toolCallId: (_g = toolCall2.id) != null ? _g : (0, import_provider_utils3.generateId)(),
+                        toolName: toolCall2.function.name,
+                        args: toolCall2.function.arguments
+                      });
+                    }
                   }
                   continue;
                 }
@@ -576,6 +602,9 @@ var openAITokenUsageSchema = import_zod2.z.object({
   completion_tokens: import_zod2.z.number().nullish()
 }).nullish();
 var openAIChatResponseSchema = import_zod2.z.object({
+  id: import_zod2.z.string().nullish(),
+  created: import_zod2.z.number().nullish(),
+  model: import_zod2.z.string().nullish(),
   choices: import_zod2.z.array(
     import_zod2.z.object({
       message: import_zod2.z.object({
@@ -618,6 +647,9 @@ var openAIChatResponseSchema = import_zod2.z.object({
 });
 var openaiChatChunkSchema = import_zod2.z.union([
   import_zod2.z.object({
+    id: import_zod2.z.string().nullish(),
+    created: import_zod2.z.number().nullish(),
+    model: import_zod2.z.string().nullish(),
     choices: import_zod2.z.array(
       import_zod2.z.object({
         delta: import_zod2.z.object({
@@ -962,6 +994,7 @@ var OpenAICompletionLanguageModel = class {
       logprobs: mapOpenAICompletionLogProbs(choice.logprobs),
       rawCall: { rawPrompt, rawSettings },
       rawResponse: { headers: responseHeaders },
+      response: getResponseMetadata(response),
       warnings
     };
   }
@@ -993,6 +1026,7 @@ var OpenAICompletionLanguageModel = class {
       completionTokens: Number.NaN
     };
     let logprobs;
+    let isFirstChunk = true;
     return {
       stream: response.pipeThrough(
         new TransformStream({
@@ -1008,6 +1042,13 @@ var OpenAICompletionLanguageModel = class {
               controller.enqueue({ type: "error", error: value.error });
               return;
             }
+            if (isFirstChunk) {
+              isFirstChunk = false;
+              controller.enqueue({
+                type: "response-metadata",
+                ...getResponseMetadata(value)
+              });
+            }
             if (value.usage != null) {
               usage = {
                 promptTokens: value.usage.prompt_tokens,
@@ -1049,6 +1090,9 @@ var OpenAICompletionLanguageModel = class {
   }
 };
 var openAICompletionResponseSchema = import_zod3.z.object({
+  id: import_zod3.z.string().nullish(),
+  created: import_zod3.z.number().nullish(),
+  model: import_zod3.z.string().nullish(),
   choices: import_zod3.z.array(
     import_zod3.z.object({
       text: import_zod3.z.string(),
@@ -1057,7 +1101,7 @@ var openAICompletionResponseSchema = import_zod3.z.object({
         tokens: import_zod3.z.array(import_zod3.z.string()),
         token_logprobs: import_zod3.z.array(import_zod3.z.number()),
         top_logprobs: import_zod3.z.array(import_zod3.z.record(import_zod3.z.string(), import_zod3.z.number())).nullable()
-      }).nullable().optional()
+      }).nullish()
     })
   ),
   usage: import_zod3.z.object({
@@ -1067,6 +1111,9 @@ var openAICompletionResponseSchema = import_zod3.z.object({
 });
 var openaiCompletionChunkSchema = import_zod3.z.union([
   import_zod3.z.object({
+    id: import_zod3.z.string().nullish(),
+    created: import_zod3.z.number().nullish(),
+    model: import_zod3.z.string().nullish(),
     choices: import_zod3.z.array(
       import_zod3.z.object({
         text: import_zod3.z.string(),
@@ -1076,13 +1123,13 @@ var openaiCompletionChunkSchema = import_zod3.z.union([
           tokens: import_zod3.z.array(import_zod3.z.string()),
           token_logprobs: import_zod3.z.array(import_zod3.z.number()),
           top_logprobs: import_zod3.z.array(import_zod3.z.record(import_zod3.z.string(), import_zod3.z.number())).nullable()
-        }).nullable().optional()
+        }).nullish()
       })
     ),
     usage: import_zod3.z.object({
       prompt_tokens: import_zod3.z.number(),
       completion_tokens: import_zod3.z.number()
-    }).optional().nullable()
+    }).nullish()
   }),
   openAIErrorDataSchema
 ]);