@ai-sdk/openai 2.0.30 → 2.0.32

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @ai-sdk/openai
 
+## 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

package/dist/index.d.mts

@@ -57,6 +57,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
@@ -95,22 +126,52 @@ 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: _ai_sdk_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 size - Image dimensions (e.g., 1024x1024, 1024x1536)
+     * @param quality - Rendering quality (e.g. low, medium, high)
+     * @param format - File output format
+     * @param compression - Compression level (0-100%) for JPEG and WebP formats
+     * @param background - Transparent or opaque
+     */
+    imageGeneration: (args?: {
+        background?: "auto" | "opaque" | "transparent";
+        inputFidelity?: "low" | "high";
+        inputImageMask?: {
+            fileId?: string;
+            imageUrl?: string;
         };
+        model?: string;
+        moderation?: "auto";
+        outputCompression?: number;
+        outputFormat?: "png" | "jpeg" | "webp";
+        quality?: "auto" | "low" | "medium" | "high";
+        size?: "auto" | "1024x1024" | "1024x1536" | "1536x1024";
+    }) => _ai_sdk_provider_utils.Tool<{}, {
+        result: string;
     }>;
     /**
      * Web search allows models to access up-to-date information from the internet
@@ -244,33 +305,34 @@ 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>;
 

package/dist/index.d.ts

@@ -57,6 +57,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
@@ -95,22 +126,52 @@ 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: _ai_sdk_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 size - Image dimensions (e.g., 1024x1024, 1024x1536)
+     * @param quality - Rendering quality (e.g. low, medium, high)
+     * @param format - File output format
+     * @param compression - Compression level (0-100%) for JPEG and WebP formats
+     * @param background - Transparent or opaque
+     */
+    imageGeneration: (args?: {
+        background?: "auto" | "opaque" | "transparent";
+        inputFidelity?: "low" | "high";
+        inputImageMask?: {
+            fileId?: string;
+            imageUrl?: string;
         };
+        model?: string;
+        moderation?: "auto";
+        outputCompression?: number;
+        outputFormat?: "png" | "jpeg" | "webp";
+        quality?: "auto" | "low" | "medium" | "high";
+        size?: "auto" | "1024x1024" | "1024x1536" | "1536x1024";
+    }) => _ai_sdk_provider_utils.Tool<{}, {
+        result: string;
     }>;
     /**
      * Web search allows models to access up-to-date information from the internet
@@ -244,33 +305,34 @@ 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>;