@ai-sdk/openai 2.0.0-canary.5 → 2.0.0-canary.7

package/CHANGELOG.md

@@ -1,5 +1,45 @@
 # @ai-sdk/openai
 
+## 2.0.0-canary.7
+
+### Patch Changes
+
+- 26735b5: chore(embedding-model): add v2 interface
+- 443d8ec: feat(embedding-model-v2): add response body field
+- fd65bc6: chore(embedding-model-v2): rename rawResponse to response
+- Updated dependencies [26735b5]
+- Updated dependencies [443d8ec]
+- Updated dependencies [14c9410]
+- Updated dependencies [d9c98f4]
+- Updated dependencies [c4a2fec]
+- Updated dependencies [0054544]
+- Updated dependencies [9e9c809]
+- Updated dependencies [32831c6]
+- Updated dependencies [d0f9495]
+- Updated dependencies [fd65bc6]
+- Updated dependencies [393138b]
+- Updated dependencies [7182d14]
+  - @ai-sdk/provider@2.0.0-canary.6
+  - @ai-sdk/provider-utils@3.0.0-canary.7
+
+## 2.0.0-canary.6
+
+### Patch Changes
+
+- 948b755: chore(providers/openai): convert to providerOptions
+- 3b1ea10: adding support for gpt-4o-search-preview and handling unsupported parameters
+- 442be08: fix: propagate openai transcription fixes
+- 5147e6e: chore(openai): remove simulateStreaming
+- c2b92cc: chore(openai): remove legacy function calling
+- f10304b: feat(tool-calling): don't require the user to have to pass parameters
+- Updated dependencies [411e483]
+- Updated dependencies [79457bd]
+- Updated dependencies [ad80501]
+- Updated dependencies [1766ede]
+- Updated dependencies [f10304b]
+  - @ai-sdk/provider@2.0.0-canary.5
+  - @ai-sdk/provider-utils@3.0.0-canary.6
+
 ## 2.0.0-canary.5
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,63 +1,15 @@
-import { LanguageModelV2, ProviderV2, EmbeddingModelV1, ImageModelV1, TranscriptionModelV1 } from '@ai-sdk/provider';
+import { LanguageModelV2, ProviderV2, EmbeddingModelV2, ImageModelV1, TranscriptionModelV1 } from '@ai-sdk/provider';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 import { z } from 'zod';
 
-type OpenAIChatModelId = 'o1' | 'o1-2024-12-17' | 'o1-mini' | 'o1-mini-2024-09-12' | 'o1-preview' | 'o1-preview-2024-09-12' | 'o3-mini' | 'o3-mini-2025-01-31' | 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-11-20' | 'gpt-4o-audio-preview' | 'gpt-4o-audio-preview-2024-10-01' | 'gpt-4o-audio-preview-2024-12-17' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-turbo-preview' | 'gpt-4-0125-preview' | 'gpt-4-1106-preview' | 'gpt-4' | 'gpt-4-0613' | 'gpt-4.5-preview' | 'gpt-4.5-preview-2025-02-27' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | 'chatgpt-4o-latest' | (string & {});
+type OpenAIChatModelId = 'o1' | 'o1-2024-12-17' | 'o1-mini' | 'o1-mini-2024-09-12' | 'o1-preview' | 'o1-preview-2024-09-12' | 'o3-mini' | 'o3-mini-2025-01-31' | 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-11-20' | 'gpt-4o-audio-preview' | 'gpt-4o-audio-preview-2024-10-01' | 'gpt-4o-audio-preview-2024-12-17' | 'gpt-4o-search-preview' | 'gpt-4o-search-preview-2025-03-11' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-turbo-preview' | 'gpt-4-0125-preview' | 'gpt-4-1106-preview' | 'gpt-4' | 'gpt-4-0613' | 'gpt-4.5-preview' | 'gpt-4.5-preview-2025-02-27' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | 'chatgpt-4o-latest' | (string & {});
 interface OpenAIChatSettings {
     /**
-  Modify the likelihood of specified tokens appearing in the completion.
-  
-  Accepts a JSON object that maps tokens (specified by their token ID in
-  the GPT tokenizer) to an associated bias value from -100 to 100. You
-  can use this tokenizer tool to convert text to token IDs. Mathematically,
-  the bias is added to the logits generated by the model prior to sampling.
-  The exact effect will vary per model, but values between -1 and 1 should
-  decrease or increase likelihood of selection; values like -100 or 100
-  should result in a ban or exclusive selection of the relevant token.
-  
-  As an example, you can pass {"50256": -100} to prevent the <|endoftext|>
-  token from being generated.
-  */
-    logitBias?: Record<number, number>;
-    /**
-  Return the log probabilities of the tokens. Including logprobs will increase
-  the response size and can slow down response times. However, it can
-  be useful to better understand how the model is behaving.
-  
-  Setting to true will return the log probabilities of the tokens that
-  were generated.
-  
-  Setting to a number will return the log probabilities of the top n
-  tokens that were generated.
-  */
-    logprobs?: boolean | number;
-    /**
-  Whether to enable parallel function calling during tool use. Default to true.
-     */
-    parallelToolCalls?: boolean;
-    /**
   Whether to use structured outputs. Defaults to false.
   
   When enabled, tool calls and object generation will be strict and follow the provided schema.
-   */
-    structuredOutputs?: boolean;
-    /**
-  Whether to use legacy function calling. Defaults to false.
-  
-  Required by some open source inference engines which do not support the `tools` API. May also
-  provide a workaround for `parallelToolCalls` resulting in the provider buffering tool calls,
-  which causes `streamObject` to be non-streaming.
-  
-  Prefer setting `parallelToolCalls: false` over this option.
-  
-  @deprecated this API is supported but deprecated by OpenAI.
-     */
-    useLegacyFunctionCalling?: boolean;
-    /**
-  A unique identifier representing your end-user, which can help OpenAI to
-  monitor and detect abuse. Learn more.
   */
-    user?: string;
+    structuredOutputs?: boolean;
     /**
   Automatically download images and pass the image as data to the model.
   OpenAI supports image URLs for public models, so this is only needed for
@@ -66,19 +18,6 @@ interface OpenAIChatSettings {
   Defaults to `false`.
      */
     downloadImages?: boolean;
-    /**
-  Simulates streaming by using a normal generate call and returning it as a stream.
-  Enable this if the model that you are using does not support streaming.
-  
-  Defaults to `false`.
-  
-  @deprecated Use `simulateStreamingMiddleware` instead.
-     */
-    simulateStreaming?: boolean;
-    /**
-  Reasoning effort for reasoning models. Defaults to `medium`.
-     */
-    reasoningEffort?: 'low' | 'medium' | 'high';
 }
 
 type OpenAICompletionModelId = 'gpt-3.5-turbo-instruct' | (string & {});
@@ -226,17 +165,17 @@ interface OpenAIProvider extends ProviderV2 {
     /**
   Creates a model for text embeddings.
      */
-    embedding(modelId: OpenAIEmbeddingModelId, settings?: OpenAIEmbeddingSettings): EmbeddingModelV1<string>;
+    embedding(modelId: OpenAIEmbeddingModelId, settings?: OpenAIEmbeddingSettings): EmbeddingModelV2<string>;
     /**
   Creates a model for text embeddings.
   
   @deprecated Use `textEmbeddingModel` instead.
      */
-    textEmbedding(modelId: OpenAIEmbeddingModelId, settings?: OpenAIEmbeddingSettings): EmbeddingModelV1<string>;
+    textEmbedding(modelId: OpenAIEmbeddingModelId, settings?: OpenAIEmbeddingSettings): EmbeddingModelV2<string>;
     /**
   Creates a model for text embeddings.
      */
-    textEmbeddingModel(modelId: OpenAIEmbeddingModelId, settings?: OpenAIEmbeddingSettings): EmbeddingModelV1<string>;
+    textEmbeddingModel(modelId: OpenAIEmbeddingModelId, settings?: OpenAIEmbeddingSettings): EmbeddingModelV2<string>;
     /**
   Creates a model for image generation.
      */
@@ -311,19 +250,19 @@ declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
     instructions: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     user?: string | null | undefined;
+    parallelToolCalls?: boolean | null | undefined;
+    reasoningEffort?: string | null | undefined;
     store?: boolean | null | undefined;
     metadata?: any;
-    reasoningEffort?: string | null | undefined;
-    parallelToolCalls?: boolean | null | undefined;
     previousResponseId?: string | null | undefined;
     strictSchemas?: boolean | null | undefined;
     instructions?: string | null | undefined;
 }, {
     user?: string | null | undefined;
+    parallelToolCalls?: boolean | null | undefined;
+    reasoningEffort?: string | null | undefined;
     store?: boolean | null | undefined;
     metadata?: any;
-    reasoningEffort?: string | null | undefined;
-    parallelToolCalls?: boolean | null | undefined;
     previousResponseId?: string | null | undefined;
     strictSchemas?: boolean | null | undefined;
     instructions?: string | null | undefined;

package/dist/index.d.ts

@@ -1,63 +1,15 @@
-import { LanguageModelV2, ProviderV2, EmbeddingModelV1, ImageModelV1, TranscriptionModelV1 } from '@ai-sdk/provider';
+import { LanguageModelV2, ProviderV2, EmbeddingModelV2, ImageModelV1, TranscriptionModelV1 } from '@ai-sdk/provider';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 import { z } from 'zod';
 
-type OpenAIChatModelId = 'o1' | 'o1-2024-12-17' | 'o1-mini' | 'o1-mini-2024-09-12' | 'o1-preview' | 'o1-preview-2024-09-12' | 'o3-mini' | 'o3-mini-2025-01-31' | 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-11-20' | 'gpt-4o-audio-preview' | 'gpt-4o-audio-preview-2024-10-01' | 'gpt-4o-audio-preview-2024-12-17' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-turbo-preview' | 'gpt-4-0125-preview' | 'gpt-4-1106-preview' | 'gpt-4' | 'gpt-4-0613' | 'gpt-4.5-preview' | 'gpt-4.5-preview-2025-02-27' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | 'chatgpt-4o-latest' | (string & {});
+type OpenAIChatModelId = 'o1' | 'o1-2024-12-17' | 'o1-mini' | 'o1-mini-2024-09-12' | 'o1-preview' | 'o1-preview-2024-09-12' | 'o3-mini' | 'o3-mini-2025-01-31' | 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-11-20' | 'gpt-4o-audio-preview' | 'gpt-4o-audio-preview-2024-10-01' | 'gpt-4o-audio-preview-2024-12-17' | 'gpt-4o-search-preview' | 'gpt-4o-search-preview-2025-03-11' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-turbo-preview' | 'gpt-4-0125-preview' | 'gpt-4-1106-preview' | 'gpt-4' | 'gpt-4-0613' | 'gpt-4.5-preview' | 'gpt-4.5-preview-2025-02-27' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | 'chatgpt-4o-latest' | (string & {});
 interface OpenAIChatSettings {
     /**
-  Modify the likelihood of specified tokens appearing in the completion.
-  
-  Accepts a JSON object that maps tokens (specified by their token ID in
-  the GPT tokenizer) to an associated bias value from -100 to 100. You
-  can use this tokenizer tool to convert text to token IDs. Mathematically,
-  the bias is added to the logits generated by the model prior to sampling.
-  The exact effect will vary per model, but values between -1 and 1 should
-  decrease or increase likelihood of selection; values like -100 or 100
-  should result in a ban or exclusive selection of the relevant token.
-  
-  As an example, you can pass {"50256": -100} to prevent the <|endoftext|>
-  token from being generated.
-  */
-    logitBias?: Record<number, number>;
-    /**
-  Return the log probabilities of the tokens. Including logprobs will increase
-  the response size and can slow down response times. However, it can
-  be useful to better understand how the model is behaving.
-  
-  Setting to true will return the log probabilities of the tokens that
-  were generated.
-  
-  Setting to a number will return the log probabilities of the top n
-  tokens that were generated.
-  */
-    logprobs?: boolean | number;
-    /**
-  Whether to enable parallel function calling during tool use. Default to true.
-     */
-    parallelToolCalls?: boolean;
-    /**
   Whether to use structured outputs. Defaults to false.
   
   When enabled, tool calls and object generation will be strict and follow the provided schema.
-   */
-    structuredOutputs?: boolean;
-    /**
-  Whether to use legacy function calling. Defaults to false.
-  
-  Required by some open source inference engines which do not support the `tools` API. May also
-  provide a workaround for `parallelToolCalls` resulting in the provider buffering tool calls,
-  which causes `streamObject` to be non-streaming.
-  
-  Prefer setting `parallelToolCalls: false` over this option.
-  
-  @deprecated this API is supported but deprecated by OpenAI.
-     */
-    useLegacyFunctionCalling?: boolean;
-    /**
-  A unique identifier representing your end-user, which can help OpenAI to
-  monitor and detect abuse. Learn more.
   */
-    user?: string;
+    structuredOutputs?: boolean;
     /**
   Automatically download images and pass the image as data to the model.
   OpenAI supports image URLs for public models, so this is only needed for
@@ -66,19 +18,6 @@ interface OpenAIChatSettings {
   Defaults to `false`.
      */
     downloadImages?: boolean;
-    /**
-  Simulates streaming by using a normal generate call and returning it as a stream.
-  Enable this if the model that you are using does not support streaming.
-  
-  Defaults to `false`.
-  
-  @deprecated Use `simulateStreamingMiddleware` instead.
-     */
-    simulateStreaming?: boolean;
-    /**
-  Reasoning effort for reasoning models. Defaults to `medium`.
-     */
-    reasoningEffort?: 'low' | 'medium' | 'high';
 }
 
 type OpenAICompletionModelId = 'gpt-3.5-turbo-instruct' | (string & {});
@@ -226,17 +165,17 @@ interface OpenAIProvider extends ProviderV2 {
     /**
   Creates a model for text embeddings.
      */
-    embedding(modelId: OpenAIEmbeddingModelId, settings?: OpenAIEmbeddingSettings): EmbeddingModelV1<string>;
+    embedding(modelId: OpenAIEmbeddingModelId, settings?: OpenAIEmbeddingSettings): EmbeddingModelV2<string>;
     /**
   Creates a model for text embeddings.
   
   @deprecated Use `textEmbeddingModel` instead.
      */
-    textEmbedding(modelId: OpenAIEmbeddingModelId, settings?: OpenAIEmbeddingSettings): EmbeddingModelV1<string>;
+    textEmbedding(modelId: OpenAIEmbeddingModelId, settings?: OpenAIEmbeddingSettings): EmbeddingModelV2<string>;
     /**
   Creates a model for text embeddings.
      */
-    textEmbeddingModel(modelId: OpenAIEmbeddingModelId, settings?: OpenAIEmbeddingSettings): EmbeddingModelV1<string>;
+    textEmbeddingModel(modelId: OpenAIEmbeddingModelId, settings?: OpenAIEmbeddingSettings): EmbeddingModelV2<string>;
     /**
   Creates a model for image generation.
      */
@@ -311,19 +250,19 @@ declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
     instructions: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     user?: string | null | undefined;
+    parallelToolCalls?: boolean | null | undefined;
+    reasoningEffort?: string | null | undefined;
     store?: boolean | null | undefined;
     metadata?: any;
-    reasoningEffort?: string | null | undefined;
-    parallelToolCalls?: boolean | null | undefined;
     previousResponseId?: string | null | undefined;
     strictSchemas?: boolean | null | undefined;
     instructions?: string | null | undefined;
 }, {
     user?: string | null | undefined;
+    parallelToolCalls?: boolean | null | undefined;
+    reasoningEffort?: string | null | undefined;
     store?: boolean | null | undefined;
     metadata?: any;
-    reasoningEffort?: string | null | undefined;
-    parallelToolCalls?: boolean | null | undefined;
     previousResponseId?: string | null | undefined;
     strictSchemas?: boolean | null | undefined;
     instructions?: string | null | undefined;