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

package/dist/internal/index.d.mts

@@ -201,6 +201,133 @@ declare class OpenAIResponsesLanguageModel implements LanguageModelV3 {
     doStream(options: Parameters<LanguageModelV3['doStream']>[0]): Promise<Awaited<ReturnType<LanguageModelV3['doStream']>>>;
 }
 
+/**
+ * Schema for the apply_patch input - what the model sends.
+ *
+ * Refer the official spec here: https://platform.openai.com/docs/api-reference/responses/create#responses_create-input-input_item_list-item-apply_patch_tool_call
+ *
+ */
+declare const applyPatchInputSchema: _ai_sdk_provider_utils.LazySchema<{
+    callId: string;
+    operation: {
+        type: "create_file";
+        path: string;
+        diff: string;
+    } | {
+        type: "delete_file";
+        path: string;
+    } | {
+        type: "update_file";
+        path: string;
+        diff: string;
+    };
+}>;
+/**
+ * Schema for the apply_patch output - what we send back.
+ */
+declare const applyPatchOutputSchema: _ai_sdk_provider_utils.LazySchema<{
+    status: "completed" | "failed";
+    output?: string | undefined;
+}>;
+/**
+ * Schema for tool arguments (configuration options).
+ * The apply_patch tool doesn't require any configuration options.
+ */
+declare const applyPatchArgsSchema: _ai_sdk_provider_utils.LazySchema<Record<string, never>>;
+/**
+ * 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;
+};
+/**
+ * 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.
+ *
+ * The tool factory creates a provider-defined tool that:
+ * - Receives patch operations from the model (create_file, update_file, delete_file)
+ * - Returns the status of applying those patches (completed or failed)
+ *
+ */
+declare const applyPatchToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{
+    /**
+     * The unique ID of the apply patch tool call generated by the model.
+     */
+    callId: string;
+    /**
+     * The specific create, delete, or update instruction for the apply_patch tool call.
+     */
+    operation: ApplyPatchOperation;
+}, {
+    /**
+     * The status of the apply patch tool call output.
+     * - 'completed': The patch was applied successfully.
+     * - 'failed': The patch failed to apply.
+     */
+    status: "completed" | "failed";
+    /**
+     * Optional human-readable log text from the apply patch tool
+     * (e.g., patch results or errors).
+     */
+    output?: string;
+}, {}>;
+/**
+ * Creates an apply_patch tool instance.
+ *
+ * The apply_patch tool lets GPT-5.1 create, update, and delete files in your
+ * codebase using structured diffs.
+ *
+ * @returns A provider-defined tool for applying patches.
+ */
+declare const applyPatch: () => _ai_sdk_provider_utils.Tool<{
+    /**
+     * The unique ID of the apply patch tool call generated by the model.
+     */
+    callId: string;
+    /**
+     * The specific create, delete, or update instruction for the apply_patch tool call.
+     */
+    operation: ApplyPatchOperation;
+}, {
+    /**
+     * The status of the apply patch tool call output.
+     * - 'completed': The patch was applied successfully.
+     * - 'failed': The patch failed to apply.
+     */
+    status: "completed" | "failed";
+    /**
+     * Optional human-readable log text from the apply patch tool
+     * (e.g., patch results or errors).
+     */
+    output?: string;
+}>;
+
 declare const codeInterpreterInputSchema: _ai_sdk_provider_utils.LazySchema<{
     containerId: string;
     code?: string | null | undefined;
@@ -229,7 +356,7 @@ type CodeInterpreterArgs = {
         fileIds?: string[];
     };
 };
-declare const codeInterpreterToolFactory: _ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{
+declare const codeInterpreterToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{
     /**
      * The code to run, or null if not available.
      */
@@ -336,7 +463,7 @@ declare const fileSearchOutputSchema: _ai_sdk_provider_utils.LazySchema<{
         text: string;
     }[] | null;
 }>;
-declare const fileSearch: _ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{}, {
+declare const fileSearch: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{}, {
     /**
      * The search query to execute.
      */
@@ -492,7 +619,7 @@ declare const webSearchPreviewArgsSchema: _ai_sdk_provider_utils.LazySchema<{
     } | undefined;
 }>;
 declare const webSearchPreviewInputSchema: _ai_sdk_provider_utils.LazySchema<Record<string, never>>;
-declare const webSearchPreview: _ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{}, {
+declare const webSearchPreview: _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).
@@ -564,4 +691,4 @@ declare const webSearchPreview: _ai_sdk_provider_utils.ProviderDefinedToolFactor
     };
 }>;
 
-export { OpenAIChatLanguageModel, type OpenAIChatLanguageModelOptions, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, type OpenAICompletionProviderOptions, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingProviderOptions, OpenAIImageModel, type OpenAIImageModelId, OpenAIResponsesLanguageModel, type OpenAISpeechCallOptions, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionProviderOptions, codeInterpreter, codeInterpreterArgsSchema, codeInterpreterInputSchema, codeInterpreterOutputSchema, codeInterpreterToolFactory, fileSearch, fileSearchArgsSchema, fileSearchOutputSchema, hasDefaultResponseFormat, imageGeneration, imageGenerationArgsSchema, imageGenerationOutputSchema, modelMaxImagesPerCall, openAITranscriptionProviderOptions, openaiChatLanguageModelOptions, openaiCompletionProviderOptions, openaiEmbeddingProviderOptions, openaiSpeechProviderOptionsSchema, webSearchPreview, webSearchPreviewArgsSchema, webSearchPreviewInputSchema };
+export { type ApplyPatchOperation, OpenAIChatLanguageModel, type OpenAIChatLanguageModelOptions, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, type OpenAICompletionProviderOptions, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingProviderOptions, OpenAIImageModel, type OpenAIImageModelId, OpenAIResponsesLanguageModel, type OpenAISpeechCallOptions, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionProviderOptions, applyPatch, applyPatchArgsSchema, applyPatchInputSchema, applyPatchOutputSchema, applyPatchToolFactory, codeInterpreter, codeInterpreterArgsSchema, codeInterpreterInputSchema, codeInterpreterOutputSchema, codeInterpreterToolFactory, fileSearch, fileSearchArgsSchema, fileSearchOutputSchema, hasDefaultResponseFormat, imageGeneration, imageGenerationArgsSchema, imageGenerationOutputSchema, modelMaxImagesPerCall, openAITranscriptionProviderOptions, openaiChatLanguageModelOptions, openaiCompletionProviderOptions, openaiEmbeddingProviderOptions, openaiSpeechProviderOptionsSchema, webSearchPreview, webSearchPreviewArgsSchema, webSearchPreviewInputSchema };

package/dist/internal/index.d.ts

@@ -201,6 +201,133 @@ declare class OpenAIResponsesLanguageModel implements LanguageModelV3 {
     doStream(options: Parameters<LanguageModelV3['doStream']>[0]): Promise<Awaited<ReturnType<LanguageModelV3['doStream']>>>;
 }
 
+/**
+ * Schema for the apply_patch input - what the model sends.
+ *
+ * Refer the official spec here: https://platform.openai.com/docs/api-reference/responses/create#responses_create-input-input_item_list-item-apply_patch_tool_call
+ *
+ */
+declare const applyPatchInputSchema: _ai_sdk_provider_utils.LazySchema<{
+    callId: string;
+    operation: {
+        type: "create_file";
+        path: string;
+        diff: string;
+    } | {
+        type: "delete_file";
+        path: string;
+    } | {
+        type: "update_file";
+        path: string;
+        diff: string;
+    };
+}>;
+/**
+ * Schema for the apply_patch output - what we send back.
+ */
+declare const applyPatchOutputSchema: _ai_sdk_provider_utils.LazySchema<{
+    status: "completed" | "failed";
+    output?: string | undefined;
+}>;
+/**
+ * Schema for tool arguments (configuration options).
+ * The apply_patch tool doesn't require any configuration options.
+ */
+declare const applyPatchArgsSchema: _ai_sdk_provider_utils.LazySchema<Record<string, never>>;
+/**
+ * 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;
+};
+/**
+ * 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.
+ *
+ * The tool factory creates a provider-defined tool that:
+ * - Receives patch operations from the model (create_file, update_file, delete_file)
+ * - Returns the status of applying those patches (completed or failed)
+ *
+ */
+declare const applyPatchToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{
+    /**
+     * The unique ID of the apply patch tool call generated by the model.
+     */
+    callId: string;
+    /**
+     * The specific create, delete, or update instruction for the apply_patch tool call.
+     */
+    operation: ApplyPatchOperation;
+}, {
+    /**
+     * The status of the apply patch tool call output.
+     * - 'completed': The patch was applied successfully.
+     * - 'failed': The patch failed to apply.
+     */
+    status: "completed" | "failed";
+    /**
+     * Optional human-readable log text from the apply patch tool
+     * (e.g., patch results or errors).
+     */
+    output?: string;
+}, {}>;
+/**
+ * Creates an apply_patch tool instance.
+ *
+ * The apply_patch tool lets GPT-5.1 create, update, and delete files in your
+ * codebase using structured diffs.
+ *
+ * @returns A provider-defined tool for applying patches.
+ */
+declare const applyPatch: () => _ai_sdk_provider_utils.Tool<{
+    /**
+     * The unique ID of the apply patch tool call generated by the model.
+     */
+    callId: string;
+    /**
+     * The specific create, delete, or update instruction for the apply_patch tool call.
+     */
+    operation: ApplyPatchOperation;
+}, {
+    /**
+     * The status of the apply patch tool call output.
+     * - 'completed': The patch was applied successfully.
+     * - 'failed': The patch failed to apply.
+     */
+    status: "completed" | "failed";
+    /**
+     * Optional human-readable log text from the apply patch tool
+     * (e.g., patch results or errors).
+     */
+    output?: string;
+}>;
+
 declare const codeInterpreterInputSchema: _ai_sdk_provider_utils.LazySchema<{
     containerId: string;
     code?: string | null | undefined;
@@ -229,7 +356,7 @@ type CodeInterpreterArgs = {
         fileIds?: string[];
     };
 };
-declare const codeInterpreterToolFactory: _ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{
+declare const codeInterpreterToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{
     /**
      * The code to run, or null if not available.
      */
@@ -336,7 +463,7 @@ declare const fileSearchOutputSchema: _ai_sdk_provider_utils.LazySchema<{
         text: string;
     }[] | null;
 }>;
-declare const fileSearch: _ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{}, {
+declare const fileSearch: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{}, {
     /**
      * The search query to execute.
      */
@@ -492,7 +619,7 @@ declare const webSearchPreviewArgsSchema: _ai_sdk_provider_utils.LazySchema<{
     } | undefined;
 }>;
 declare const webSearchPreviewInputSchema: _ai_sdk_provider_utils.LazySchema<Record<string, never>>;
-declare const webSearchPreview: _ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{}, {
+declare const webSearchPreview: _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).
@@ -564,4 +691,4 @@ declare const webSearchPreview: _ai_sdk_provider_utils.ProviderDefinedToolFactor
     };
 }>;
 
-export { OpenAIChatLanguageModel, type OpenAIChatLanguageModelOptions, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, type OpenAICompletionProviderOptions, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingProviderOptions, OpenAIImageModel, type OpenAIImageModelId, OpenAIResponsesLanguageModel, type OpenAISpeechCallOptions, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionProviderOptions, codeInterpreter, codeInterpreterArgsSchema, codeInterpreterInputSchema, codeInterpreterOutputSchema, codeInterpreterToolFactory, fileSearch, fileSearchArgsSchema, fileSearchOutputSchema, hasDefaultResponseFormat, imageGeneration, imageGenerationArgsSchema, imageGenerationOutputSchema, modelMaxImagesPerCall, openAITranscriptionProviderOptions, openaiChatLanguageModelOptions, openaiCompletionProviderOptions, openaiEmbeddingProviderOptions, openaiSpeechProviderOptionsSchema, webSearchPreview, webSearchPreviewArgsSchema, webSearchPreviewInputSchema };
+export { type ApplyPatchOperation, OpenAIChatLanguageModel, type OpenAIChatLanguageModelOptions, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, type OpenAICompletionProviderOptions, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingProviderOptions, OpenAIImageModel, type OpenAIImageModelId, OpenAIResponsesLanguageModel, type OpenAISpeechCallOptions, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionProviderOptions, applyPatch, applyPatchArgsSchema, applyPatchInputSchema, applyPatchOutputSchema, applyPatchToolFactory, codeInterpreter, codeInterpreterArgsSchema, codeInterpreterInputSchema, codeInterpreterOutputSchema, codeInterpreterToolFactory, fileSearch, fileSearchArgsSchema, fileSearchOutputSchema, hasDefaultResponseFormat, imageGeneration, imageGenerationArgsSchema, imageGenerationOutputSchema, modelMaxImagesPerCall, openAITranscriptionProviderOptions, openaiChatLanguageModelOptions, openaiCompletionProviderOptions, openaiEmbeddingProviderOptions, openaiSpeechProviderOptionsSchema, webSearchPreview, webSearchPreviewArgsSchema, webSearchPreviewInputSchema };