@ai-sdk/openai 3.0.0-beta.72 → 3.0.0-beta.74

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @ai-sdk/openai
 
+## 3.0.0-beta.74
+
+### Patch Changes
+
+- 88fc415: feat(openai): add the new provider 'apply_patch' tool
+
+## 3.0.0-beta.73
+
+### Patch Changes
+
+- 544d4e8: chore(specification): rename v3 provider defined tool to provider tool
+- Updated dependencies [544d4e8]
+  - @ai-sdk/provider-utils@4.0.0-beta.40
+  - @ai-sdk/provider@3.0.0-beta.22
+
 ## 3.0.0-beta.72
 
 ### Patch Changes

package/dist/index.d.mts

@@ -30,7 +30,7 @@ type OpenAIEmbeddingModelId = 'text-embedding-3-small' | 'text-embedding-3-large
 
 type OpenAIImageModelId = 'dall-e-3' | 'dall-e-2' | 'gpt-image-1' | 'gpt-image-1-mini' | (string & {});
 
-declare const webSearchToolFactory: _ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{}, {
+declare const webSearchToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{}, {
     /**
      * An object describing the specific action taken in this web search call.
      * Includes details on how the model used the web (search, open_page, find).
@@ -160,7 +160,52 @@ type OpenAIResponsesFileSearchToolCompoundFilter = {
     filters: Array<OpenAIResponsesFileSearchToolComparisonFilter | OpenAIResponsesFileSearchToolCompoundFilter>;
 };
 
+/**
+ * Type definitions for the apply_patch operations.
+ */
+type ApplyPatchOperation = {
+    type: 'create_file';
+    /**
+     * Path of the file to create relative to the workspace root.
+     */
+    path: string;
+    /**
+     * Unified diff content to apply when creating the file.
+     */
+    diff: string;
+} | {
+    type: 'delete_file';
+    /**
+     * Path of the file to delete relative to the workspace root.
+     */
+    path: string;
+} | {
+    type: 'update_file';
+    /**
+     * Path of the file to update relative to the workspace root.
+     */
+    path: string;
+    /**
+     * Unified diff content to apply to the existing file.
+     */
+    diff: string;
+};
+
 declare const openaiTools: {
+    /**
+     * The apply_patch tool lets GPT-5.1 create, update, and delete files in your
+     * codebase using structured diffs. Instead of just suggesting edits, the model
+     * emits patch operations that your application applies and then reports back on,
+     * enabling iterative, multi-step code editing workflows.
+     *
+     */
+    applyPatch: () => _ai_sdk_provider_utils.Tool<{
+        callId: string;
+        operation: ApplyPatchOperation;
+    }, {
+        status: "completed" | "failed";
+        output?: string;
+    }>;
     /**
      * The Code Interpreter tool allows models to write and run Python code in a
      * sandboxed environment to solve complex problems in domains like data analysis,
@@ -194,7 +239,7 @@ 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.ProviderDefinedToolFactoryWithOutputSchema<{}, {
+    fileSearch: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{}, {
         queries: string[];
         results: null | {
             attributes: Record<string, unknown>;
@@ -251,7 +296,7 @@ declare const openaiTools: {
      *
      * Supported models: `gpt-5-codex` and `codex-mini-latest`
      */
-    localShell: _ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{
+    localShell: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{
         action: {
             type: "exec";
             command: string[];
@@ -270,7 +315,7 @@ 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.
      */
-    webSearchPreview: _ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{}, {
+    webSearchPreview: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{}, {
         action: {
             type: "search";
             query?: string;
@@ -289,7 +334,16 @@ declare const openaiTools: {
             country?: string;
             city?: string;
             region?: string;
-            timezone?: string;
+            timezone
+            /**
+             * Web search allows models to access up-to-date information from the internet
+             * and provide answers with sourced citations.
+             *
+             * @param filters - The filters to use for the web search.
+             * @param searchContextSize - The search context size to use for the web search.
+             * @param userLocation - The user location to use for the web search.
+             */
+            ?: string;
         };
     }>;
     /**

package/dist/index.d.ts

@@ -30,7 +30,7 @@ type OpenAIEmbeddingModelId = 'text-embedding-3-small' | 'text-embedding-3-large
 
 type OpenAIImageModelId = 'dall-e-3' | 'dall-e-2' | 'gpt-image-1' | 'gpt-image-1-mini' | (string & {});
 
-declare const webSearchToolFactory: _ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{}, {
+declare const webSearchToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{}, {
     /**
      * An object describing the specific action taken in this web search call.
      * Includes details on how the model used the web (search, open_page, find).
@@ -160,7 +160,52 @@ type OpenAIResponsesFileSearchToolCompoundFilter = {
     filters: Array<OpenAIResponsesFileSearchToolComparisonFilter | OpenAIResponsesFileSearchToolCompoundFilter>;
 };
 
+/**
+ * Type definitions for the apply_patch operations.
+ */
+type ApplyPatchOperation = {
+    type: 'create_file';
+    /**
+     * Path of the file to create relative to the workspace root.
+     */
+    path: string;
+    /**
+     * Unified diff content to apply when creating the file.
+     */
+    diff: string;
+} | {
+    type: 'delete_file';
+    /**
+     * Path of the file to delete relative to the workspace root.
+     */
+    path: string;
+} | {
+    type: 'update_file';
+    /**
+     * Path of the file to update relative to the workspace root.
+     */
+    path: string;
+    /**
+     * Unified diff content to apply to the existing file.
+     */
+    diff: string;
+};
+
 declare const openaiTools: {
+    /**
+     * The apply_patch tool lets GPT-5.1 create, update, and delete files in your
+     * codebase using structured diffs. Instead of just suggesting edits, the model
+     * emits patch operations that your application applies and then reports back on,
+     * enabling iterative, multi-step code editing workflows.
+     *
+     */
+    applyPatch: () => _ai_sdk_provider_utils.Tool<{
+        callId: string;
+        operation: ApplyPatchOperation;
+    }, {
+        status: "completed" | "failed";
+        output?: string;
+    }>;
     /**
      * The Code Interpreter tool allows models to write and run Python code in a
      * sandboxed environment to solve complex problems in domains like data analysis,
@@ -194,7 +239,7 @@ 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.ProviderDefinedToolFactoryWithOutputSchema<{}, {
+    fileSearch: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{}, {
         queries: string[];
         results: null | {
             attributes: Record<string, unknown>;
@@ -251,7 +296,7 @@ declare const openaiTools: {
      *
      * Supported models: `gpt-5-codex` and `codex-mini-latest`
      */
-    localShell: _ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{
+    localShell: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{
         action: {
             type: "exec";
             command: string[];
@@ -270,7 +315,7 @@ 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.
      */
-    webSearchPreview: _ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{}, {
+    webSearchPreview: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{}, {
         action: {
             type: "search";
             query?: string;
@@ -289,7 +334,16 @@ declare const openaiTools: {
             country?: string;
             city?: string;
             region?: string;
-            timezone?: string;
+            timezone
+            /**
+             * Web search allows models to access up-to-date information from the internet
+             * and provide answers with sourced citations.
+             *
+             * @param filters - The filters to use for the web search.
+             * @param searchContextSize - The search context size to use for the web search.
+             * @param userLocation - The user location to use for the web search.
+             */
+            ?: string;
         };
     }>;
     /**