@zenning/openai 2.0.29 → 2.2.0

package/CHANGELOG.md

@@ -1,5 +1,153 @@
 # @ai-sdk/openai
 
+## 2.1.0-beta.11
+
+### Patch Changes
+
+- 0adc679: feat(provider): shared spec v3
+- 2b0caef: feat(provider/openai): preview image generation results
+- Updated dependencies [0adc679]
+- Updated dependencies [2b0caef]
+  - @ai-sdk/provider-utils@3.1.0-beta.6
+  - @ai-sdk/provider@2.1.0-beta.4
+
+## 2.1.0-beta.10
+
+### Patch Changes
+
+- d64ece9: enables image_generation capabilities in the Azure provider through the Responses API.
+
+## 2.1.0-beta.9
+
+### Patch Changes
+
+- 9a51b92: support OPENAI_BASE_URL env
+
+## 2.1.0-beta.8
+
+### Patch Changes
+
+- 4122d2a: feat(provider/openai): add gpt-5-codex model id
+- 3997a42: feat(provider/openai): local shell tool
+- cb4d238: The built in Code Interpreter tool input code is streamed in `tool-input-<start/delta/end>` chunks.
+
+## 2.1.0-beta.7
+
+### Patch Changes
+
+- 77f2b20: enables code_interpreter and file_search capabilities in the Azure provider through the Responses API
+- 8dac895: feat: `LanguageModelV3`
+- 10c1322: fix: moved dependency `@ai-sdk/test-server` to devDependencies
+- Updated dependencies [8dac895]
+  - @ai-sdk/provider-utils@3.1.0-beta.5
+  - @ai-sdk/provider@2.1.0-beta.3
+
+## 2.1.0-beta.6
+
+### Patch Changes
+
+- fe49278: feat(provider/openai): only send item references for reasoning when store: true
+
+## 2.1.0-beta.5
+
+### Patch Changes
+
+- 4616b86: chore: update zod peer depenedency version
+- Updated dependencies [4616b86]
+  - @ai-sdk/provider-utils@3.1.0-beta.4
+
+## 2.1.0-beta.4
+
+### Patch Changes
+
+- ed329cb: feat: `Provider-V3`
+- 522f6b8: feat: `ImageModelV3`
+- Updated dependencies [ed329cb]
+- Updated dependencies [522f6b8]
+  - @ai-sdk/provider@2.1.0-beta.2
+  - @ai-sdk/provider-utils@3.1.0-beta.3
+
+## 2.1.0-beta.3
+
+### Patch Changes
+
+- 2e86082: feat(provider/openai): `OpenAIChatLanguageModelOptions` type
+
+  ```ts
+  import { openai, type OpenAIChatLanguageModelOptions } from '@ai-sdk/openai';
+  import { generateText } from 'ai';
+
+  await generateText({
+    model: openai.chat('gpt-4o'),
+    prompt: 'Invent a new holiday and describe its traditions.',
+    providerOptions: {
+      openai: {
+        user: 'user-123',
+      } satisfies OpenAIChatLanguageModelOptions,
+    },
+  });
+  ```
+
+## 2.1.0-beta.2
+
+### Patch Changes
+
+- 4920119: fix the "incomplete_details" key from nullable to nullish for openai compatibility
+- 0c4822d: feat: `EmbeddingModelV3`
+- 1cad0ab: feat: add provider version to user-agent header
+- Updated dependencies [0c4822d]
+  - @ai-sdk/provider@2.1.0-beta.1
+  - @ai-sdk/provider-utils@3.1.0-beta.2
+
+## 2.1.0-beta.1
+
+### Patch Changes
+
+- Updated dependencies [953d0f2]
+- Updated dependencies [cbb1d35]
+  - @ai-sdk/test-server@1.0.0-beta.0
+  - @ai-sdk/provider-utils@3.1.0-beta.1
+
+## 2.1.0-beta.0
+
+### Minor Changes
+
+- 78928cb: release: start 5.1 beta
+
+### Patch Changes
+
+- Updated dependencies [78928cb]
+  - @ai-sdk/provider@2.1.0-beta.0
+  - @ai-sdk/provider-utils@3.1.0-beta.0
+
+## 2.0.32
+
+### Patch Changes
+
+- 1cf857d: fix(provider/openai): remove provider-executed tools from chat completions model
+- 01de47f: feat(provider/openai): rework file search tool
+
+## 2.0.31
+
+### Patch Changes
+
+- bb94467: feat(provider/openai): add maxToolCalls provider option
+- 4a2b70e: feat(provider/openai): send item references for provider-executed tool results
+- 643711d: feat (provider/openai): provider defined image generation tool support
+
+## 2.0.30
+
+### Patch Changes
+
+- Updated dependencies [0294b58]
+  - @ai-sdk/provider-utils@3.0.9
+
+## 2.0.29
+
+### Patch Changes
+
+- 4235eb3: feat(provider/openai): code interpreter tool calls and results
+
 ## 2.0.28
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,9 +1,40 @@
-import { ProviderV2, LanguageModelV2, EmbeddingModelV2, ImageModelV2, TranscriptionModelV2, SpeechModelV2 } from '@ai-sdk/provider';
-import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
-import { FetchFunction } from '@ai-sdk/provider-utils';
+import { ProviderV3, LanguageModelV3, EmbeddingModelV3, ImageModelV3, TranscriptionModelV2, SpeechModelV2 } from '@zenning/provider';
+import * as _zenning_provider_utils from '@zenning/provider-utils';
+import { FetchFunction } from '@zenning/provider-utils';
 import { z } from 'zod/v4';
 
 type OpenAIChatModelId = 'o1' | 'o1-2024-12-17' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o3' | 'o3-2025-04-16' | 'gpt-4.1' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano' | 'gpt-4.1-nano-2025-04-14' | 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-11-20' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | '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' | 'gpt-5' | 'gpt-5-2025-08-07' | 'gpt-5-mini' | 'gpt-5-mini-2025-08-07' | 'gpt-5-nano' | 'gpt-5-nano-2025-08-07' | 'gpt-5-chat-latest' | (string & {});
+declare const openaiChatLanguageModelOptions: z.ZodObject<{
+    logitBias: z.ZodOptional<z.ZodRecord<z.ZodCoercedNumber<string>, z.ZodNumber>>;
+    logprobs: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodNumber]>>;
+    parallelToolCalls: z.ZodOptional<z.ZodBoolean>;
+    user: z.ZodOptional<z.ZodString>;
+    reasoningEffort: z.ZodOptional<z.ZodEnum<{
+        minimal: "minimal";
+        low: "low";
+        medium: "medium";
+        high: "high";
+    }>>;
+    maxCompletionTokens: z.ZodOptional<z.ZodNumber>;
+    store: z.ZodOptional<z.ZodBoolean>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    prediction: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    structuredOutputs: z.ZodOptional<z.ZodBoolean>;
+    serviceTier: z.ZodOptional<z.ZodEnum<{
+        auto: "auto";
+        flex: "flex";
+        priority: "priority";
+    }>>;
+    strictJsonSchema: z.ZodOptional<z.ZodBoolean>;
+    textVerbosity: z.ZodOptional<z.ZodEnum<{
+        low: "low";
+        medium: "medium";
+        high: "high";
+    }>>;
+    promptCacheKey: z.ZodOptional<z.ZodString>;
+    safetyIdentifier: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type OpenAIChatLanguageModelOptions = z.infer<typeof openaiChatLanguageModelOptions>;
 
 type OpenAICompletionModelId = 'gpt-3.5-turbo-instruct' | (string & {});
 
@@ -11,7 +42,7 @@ type OpenAIEmbeddingModelId = 'text-embedding-3-small' | 'text-embedding-3-large
 
 type OpenAIImageModelId = 'gpt-image-1' | 'dall-e-3' | 'dall-e-2' | (string & {});
 
-declare const webSearchToolFactory: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
+declare const webSearchToolFactory: _zenning_provider_utils.ProviderDefinedToolFactory<{}, {
     /**
      * Filters for the search.
      */
@@ -57,6 +88,37 @@ declare const webSearchToolFactory: _ai_sdk_provider_utils.ProviderDefinedToolFa
     };
 }>;
 
+/**
+ * A filter used to compare a specified attribute key to a given value using a defined comparison operation.
+ */
+type OpenAIResponsesFileSearchToolComparisonFilter = {
+    /**
+     * The key to compare against the value.
+     */
+    key: string;
+    /**
+     * Specifies the comparison operator: eq, ne, gt, gte, lt, lte.
+     */
+    type: 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte';
+    /**
+     * The value to compare against the attribute key; supports string, number, or boolean types.
+     */
+    value: string | number | boolean;
+};
+/**
+ * Combine multiple filters using and or or.
+ */
+type OpenAIResponsesFileSearchToolCompoundFilter = {
+    /**
+     * Type of operation: and or or.
+     */
+    type: 'and' | 'or';
+    /**
+     * Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.
+     */
+    filters: Array<OpenAIResponsesFileSearchToolComparisonFilter | OpenAIResponsesFileSearchToolCompoundFilter>;
+};
+
 declare const openaiTools: {
     /**
      * The Code Interpreter tool allows models to write and run Python code in a
@@ -71,7 +133,7 @@ declare const openaiTools: {
         container?: string | {
             fileIds?: string[];
         };
-    }) => _ai_sdk_provider_utils.Tool<{
+    }) => _zenning_provider_utils.Tool<{
         code?: string | null;
         containerId: string;
     }, {
@@ -95,23 +157,79 @@ declare const openaiTools: {
      * @param ranking - The ranking options to use for the file search.
      * @param filters - The filters to use for the file search.
      */
-    fileSearch: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{
-        query?: string;
+    fileSearch: _zenning_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{}, {
+        queries: string[];
+        results: null | {
+            attributes: Record<string, unknown>;
+            fileId: string;
+            filename: string;
+            score: number;
+            text: string;
+        }[];
     }, {
-        vectorStoreIds?: string[];
+        vectorStoreIds: string[];
         maxNumResults?: number;
         ranking?: {
-            ranker?: "auto" | "default-2024-08-21";
+            ranker?: string;
+            scoreThreshold?: number;
         };
-        filters?: {
-            key: string;
-            type: "eq" | "ne" | "gt" | "gte" | "lt" | "lte";
-            value: string | number | boolean;
-        } | {
-            type: "and" | "or";
-            filters: any[];
+        filters?: OpenAIResponsesFileSearchToolComparisonFilter | OpenAIResponsesFileSearchToolCompoundFilter;
+    }>;
+    /**
+     * The image generation tool allows you to generate images using a text prompt,
+     * and optionally image inputs. It leverages the GPT Image model,
+     * and automatically optimizes text inputs for improved performance.
+     *
+     * Must have name `image_generation`.
+     *
+     * @param background - Background type for the generated image. One of 'auto', 'opaque', or 'transparent'.
+     * @param inputFidelity - Input fidelity for the generated image. One of 'low' or 'high'.
+     * @param inputImageMask - Optional mask for inpainting. Contains fileId and/or imageUrl.
+     * @param model - The image generation model to use. Default: gpt-image-1.
+     * @param moderation - Moderation level for the generated image. Default: 'auto'.
+     * @param outputCompression - Compression level for the output image (0-100).
+     * @param outputFormat - The output format of the generated image. One of 'png', 'jpeg', or 'webp'.
+     * @param partialImages - Number of partial images to generate in streaming mode (0-3).
+     * @param quality - The quality of the generated image. One of 'auto', 'low', 'medium', or 'high'.
+     * @param size - The size of the generated image. One of 'auto', '1024x1024', '1024x1536', or '1536x1024'.
+     */
+    imageGeneration: (args?: {
+        background?: "auto" | "opaque" | "transparent";
+        inputFidelity?: "low" | "high";
+        inputImageMask?: {
+            fileId?: string;
+            imageUrl?: string;
         };
+        model?: string;
+        moderation?: "auto";
+        outputCompression?: number;
+        outputFormat?: "png" | "jpeg" | "webp";
+        partialImages?: number;
+        quality?: "auto" | "low" | "medium" | "high";
+        size?: "auto" | "1024x1024" | "1024x1536" | "1536x1024";
+    }) => _zenning_provider_utils.Tool<{}, {
+        result: string;
     }>;
+    /**
+     * Local shell is a tool that allows agents to run shell commands locally
+     * on a machine you or the user provides.
+     *
+     * Supported models: `gpt-5-codex` and `codex-mini-latest`
+     *
+     * Must have name `local_shell`.
+     */
+    localShell: _zenning_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{
+        action: {
+            type: "exec";
+            command: string[];
+            timeoutMs?: number;
+            user?: string;
+            workingDirectory?: string;
+            env?: Record<string, string>;
+        };
+    }, {
+        output: string;
+    }, {}>;
     /**
      * Web search allows models to access up-to-date information from the internet
      * and provide answers with sourced citations.
@@ -123,7 +241,7 @@ declare const openaiTools: {
      *
      * @deprecated Use `webSearch` instead.
      */
-    webSearchPreview: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
+    webSearchPreview: _zenning_provider_utils.ProviderDefinedToolFactory<{}, {
         searchContextSize?: "low" | "medium" | "high";
         userLocation?: {
             type: "approximate";
@@ -143,53 +261,53 @@ declare const openaiTools: {
      * @param searchContextSize - The search context size to use for the web search.
      * @param userLocation - The user location to use for the web search.
      */
-    webSearch: (args?: Parameters<typeof webSearchToolFactory>[0]) => _ai_sdk_provider_utils.Tool<{}, unknown>;
+    webSearch: (args?: Parameters<typeof webSearchToolFactory>[0]) => _zenning_provider_utils.Tool<{}, unknown>;
 };
 
-type OpenAIResponsesModelId = 'o1' | 'o1-2024-12-17' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o3' | 'o3-2025-04-16' | 'gpt-5' | 'gpt-5-2025-08-07' | 'gpt-5-mini' | 'gpt-5-mini-2025-08-07' | 'gpt-5-nano' | 'gpt-5-nano-2025-08-07' | 'gpt-5-chat-latest' | 'gpt-4.1' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano' | 'gpt-4.1-nano-2025-04-14' | 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-11-20' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4' | 'gpt-4-0613' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | 'chatgpt-4o-latest' | (string & {});
+type OpenAIResponsesModelId = 'o1' | 'o1-2024-12-17' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o3' | 'o3-2025-04-16' | 'gpt-5' | 'gpt-5-2025-08-07' | 'gpt-5-mini' | 'gpt-5-mini-2025-08-07' | 'gpt-5-nano' | 'gpt-5-nano-2025-08-07' | 'gpt-5-chat-latest' | 'gpt-5-codex' | 'gpt-4.1' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano' | 'gpt-4.1-nano-2025-04-14' | 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-11-20' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4' | 'gpt-4-0613' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | 'chatgpt-4o-latest' | (string & {});
 
 type OpenAISpeechModelId = 'tts-1' | 'tts-1-hd' | 'gpt-4o-mini-tts' | (string & {});
 
 type OpenAITranscriptionModelId = 'whisper-1' | 'gpt-4o-mini-transcribe' | 'gpt-4o-transcribe' | (string & {});
 
-interface OpenAIProvider extends ProviderV2 {
-    (modelId: OpenAIResponsesModelId): LanguageModelV2;
+interface OpenAIProvider extends ProviderV3 {
+    (modelId: OpenAIResponsesModelId): LanguageModelV3;
     /**
   Creates an OpenAI model for text generation.
      */
-    languageModel(modelId: OpenAIResponsesModelId): LanguageModelV2;
+    languageModel(modelId: OpenAIResponsesModelId): LanguageModelV3;
     /**
   Creates an OpenAI chat model for text generation.
      */
-    chat(modelId: OpenAIChatModelId): LanguageModelV2;
+    chat(modelId: OpenAIChatModelId): LanguageModelV3;
     /**
   Creates an OpenAI responses API model for text generation.
      */
-    responses(modelId: OpenAIResponsesModelId): LanguageModelV2;
+    responses(modelId: OpenAIResponsesModelId): LanguageModelV3;
     /**
   Creates an OpenAI completion model for text generation.
      */
-    completion(modelId: OpenAICompletionModelId): LanguageModelV2;
+    completion(modelId: OpenAICompletionModelId): LanguageModelV3;
     /**
   Creates a model for text embeddings.
      */
-    embedding(modelId: OpenAIEmbeddingModelId): EmbeddingModelV2<string>;
+    embedding(modelId: OpenAIEmbeddingModelId): EmbeddingModelV3<string>;
     /**
   Creates a model for text embeddings.
      */
-    textEmbedding(modelId: OpenAIEmbeddingModelId): EmbeddingModelV2<string>;
+    textEmbedding(modelId: OpenAIEmbeddingModelId): EmbeddingModelV3<string>;
     /**
   Creates a model for text embeddings.
      */
-    textEmbeddingModel(modelId: OpenAIEmbeddingModelId): EmbeddingModelV2<string>;
+    textEmbeddingModel(modelId: OpenAIEmbeddingModelId): EmbeddingModelV3<string>;
     /**
   Creates a model for image generation.
      */
-    image(modelId: OpenAIImageModelId): ImageModelV2;
+    image(modelId: OpenAIImageModelId): ImageModelV3;
     /**
   Creates a model for image generation.
      */
-    imageModel(modelId: OpenAIImageModelId): ImageModelV2;
+    imageModel(modelId: OpenAIImageModelId): ImageModelV3;
     /**
   Creates a model for transcription.
      */
@@ -244,34 +362,37 @@ Default OpenAI provider instance.
 declare const openai: OpenAIProvider;
 
 declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
+    include: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodEnum<{
+        "file_search_call.results": "file_search_call.results";
+        "message.output_text.logprobs": "message.output_text.logprobs";
+        "reasoning.encrypted_content": "reasoning.encrypted_content";
+    }>>>>;
+    instructions: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    logprobs: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodNumber]>>;
+    maxToolCalls: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     metadata: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
     parallelToolCalls: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
     previousResponseId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    store: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
-    user: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    promptCacheKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     reasoningEffort: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    strictJsonSchema: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
-    instructions: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     reasoningSummary: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    safetyIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     serviceTier: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
         auto: "auto";
         flex: "flex";
         priority: "priority";
     }>>>;
-    include: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodEnum<{
-        "file_search_call.results": "file_search_call.results";
-        "message.output_text.logprobs": "message.output_text.logprobs";
-        "reasoning.encrypted_content": "reasoning.encrypted_content";
-    }>>>>;
+    store: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    strictJsonSchema: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
     textVerbosity: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
         low: "low";
         medium: "medium";
         high: "high";
     }>>>;
-    promptCacheKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    safetyIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    logprobs: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodNumber]>>;
+    user: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
 type OpenAIResponsesProviderOptions = z.infer<typeof openaiResponsesProviderOptionsSchema>;
 
-export { type OpenAIProvider, type OpenAIProviderSettings, type OpenAIResponsesProviderOptions, createOpenAI, openai };
+declare const VERSION: string;
+
+export { type OpenAIChatLanguageModelOptions, type OpenAIProvider, type OpenAIProviderSettings, type OpenAIResponsesProviderOptions, VERSION, createOpenAI, openai };