@ai-sdk/openai 3.0.7 → 3.0.9

package/dist/internal/index.d.ts

@@ -202,6 +202,411 @@ declare class OpenAIResponsesLanguageModel implements LanguageModelV3 {
     doStream(options: LanguageModelV3CallOptions): Promise<LanguageModelV3StreamResult>;
 }
 
+/**
+ * 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, in, nin.
+     */
+    type: 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'nin';
+    /**
+     * The value to compare against the attribute key; supports string, number, boolean, or array of string types.
+     */
+    value: string | number | boolean | string[];
+};
+/**
+ * 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 openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
+    type: "unknown_chunk";
+    message: string;
+} | {
+    type: "response.output_text.delta";
+    item_id: string;
+    delta: string;
+    logprobs?: {
+        token: string;
+        logprob: number;
+        top_logprobs: {
+            token: string;
+            logprob: number;
+        }[];
+    }[] | null | undefined;
+} | {
+    type: "response.completed" | "response.incomplete";
+    response: {
+        usage: {
+            input_tokens: number;
+            output_tokens: number;
+            input_tokens_details?: {
+                cached_tokens?: number | null | undefined;
+            } | null | undefined;
+            output_tokens_details?: {
+                reasoning_tokens?: number | null | undefined;
+            } | null | undefined;
+        };
+        incomplete_details?: {
+            reason: string;
+        } | null | undefined;
+        service_tier?: string | null | undefined;
+    };
+} | {
+    type: "response.created";
+    response: {
+        id: string;
+        created_at: number;
+        model: string;
+        service_tier?: string | null | undefined;
+    };
+} | {
+    type: "response.output_item.added";
+    output_index: number;
+    item: {
+        type: "message";
+        id: string;
+    } | {
+        type: "reasoning";
+        id: string;
+        encrypted_content?: string | null | undefined;
+    } | {
+        type: "function_call";
+        id: string;
+        call_id: string;
+        name: string;
+        arguments: string;
+    } | {
+        type: "web_search_call";
+        id: string;
+        status: string;
+    } | {
+        type: "computer_call";
+        id: string;
+        status: string;
+    } | {
+        type: "file_search_call";
+        id: string;
+    } | {
+        type: "image_generation_call";
+        id: string;
+    } | {
+        type: "code_interpreter_call";
+        id: string;
+        container_id: string;
+        code: string | null;
+        outputs: ({
+            type: "logs";
+            logs: string;
+        } | {
+            type: "image";
+            url: string;
+        })[] | null;
+        status: string;
+    } | {
+        type: "mcp_call";
+        id: string;
+        status: string;
+        approval_request_id?: string | null | undefined;
+    } | {
+        type: "mcp_list_tools";
+        id: string;
+    } | {
+        type: "mcp_approval_request";
+        id: string;
+    } | {
+        type: "apply_patch_call";
+        id: string;
+        call_id: string;
+        status: "completed" | "in_progress";
+        operation: {
+            type: "create_file";
+            path: string;
+            diff: string;
+        } | {
+            type: "delete_file";
+            path: string;
+        } | {
+            type: "update_file";
+            path: string;
+            diff: string;
+        };
+    } | {
+        type: "shell_call";
+        id: string;
+        call_id: string;
+        status: "completed" | "in_progress" | "incomplete";
+        action: {
+            commands: string[];
+        };
+    };
+} | {
+    type: "response.output_item.done";
+    output_index: number;
+    item: {
+        type: "message";
+        id: string;
+    } | {
+        type: "reasoning";
+        id: string;
+        encrypted_content?: string | null | undefined;
+    } | {
+        type: "function_call";
+        id: string;
+        call_id: string;
+        name: string;
+        arguments: string;
+        status: "completed";
+    } | {
+        type: "code_interpreter_call";
+        id: string;
+        code: string | null;
+        container_id: string;
+        outputs: ({
+            type: "logs";
+            logs: string;
+        } | {
+            type: "image";
+            url: string;
+        })[] | null;
+    } | {
+        type: "image_generation_call";
+        id: string;
+        result: string;
+    } | {
+        type: "web_search_call";
+        id: string;
+        status: string;
+        action: {
+            type: "search";
+            query?: string | null | undefined;
+            sources?: ({
+                type: "url";
+                url: string;
+            } | {
+                type: "api";
+                name: string;
+            })[] | null | undefined;
+        } | {
+            type: "open_page";
+            url?: string | null | undefined;
+        } | {
+            type: "find_in_page";
+            url?: string | null | undefined;
+            pattern?: string | null | undefined;
+        };
+    } | {
+        type: "file_search_call";
+        id: string;
+        queries: string[];
+        results?: {
+            attributes: Record<string, string | number | boolean>;
+            file_id: string;
+            filename: string;
+            score: number;
+            text: string;
+        }[] | null | undefined;
+    } | {
+        type: "local_shell_call";
+        id: string;
+        call_id: string;
+        action: {
+            type: "exec";
+            command: string[];
+            timeout_ms?: number | undefined;
+            user?: string | undefined;
+            working_directory?: string | undefined;
+            env?: Record<string, string> | undefined;
+        };
+    } | {
+        type: "computer_call";
+        id: string;
+        status: "completed";
+    } | {
+        type: "mcp_call";
+        id: string;
+        status: string;
+        arguments: string;
+        name: string;
+        server_label: string;
+        output?: string | null | undefined;
+        error?: string | {
+            [x: string]: unknown;
+            type?: string | undefined;
+            code?: string | number | undefined;
+            message?: string | undefined;
+        } | null | undefined;
+        approval_request_id?: string | null | undefined;
+    } | {
+        type: "mcp_list_tools";
+        id: string;
+        server_label: string;
+        tools: {
+            name: string;
+            input_schema: any;
+            description?: string | undefined;
+            annotations?: Record<string, unknown> | undefined;
+        }[];
+        error?: string | {
+            [x: string]: unknown;
+            type?: string | undefined;
+            code?: string | number | undefined;
+            message?: string | undefined;
+        } | undefined;
+    } | {
+        type: "mcp_approval_request";
+        id: string;
+        server_label: string;
+        name: string;
+        arguments: string;
+        approval_request_id?: string | undefined;
+    } | {
+        type: "apply_patch_call";
+        id: string;
+        call_id: string;
+        status: "completed" | "in_progress";
+        operation: {
+            type: "create_file";
+            path: string;
+            diff: string;
+        } | {
+            type: "delete_file";
+            path: string;
+        } | {
+            type: "update_file";
+            path: string;
+            diff: string;
+        };
+    } | {
+        type: "shell_call";
+        id: string;
+        call_id: string;
+        status: "completed" | "in_progress" | "incomplete";
+        action: {
+            commands: string[];
+        };
+    };
+} | {
+    type: "response.function_call_arguments.delta";
+    item_id: string;
+    output_index: number;
+    delta: string;
+} | {
+    type: "response.image_generation_call.partial_image";
+    item_id: string;
+    output_index: number;
+    partial_image_b64: string;
+} | {
+    type: "response.code_interpreter_call_code.delta";
+    item_id: string;
+    output_index: number;
+    delta: string;
+} | {
+    type: "response.code_interpreter_call_code.done";
+    item_id: string;
+    output_index: number;
+    code: string;
+} | {
+    type: "response.output_text.annotation.added";
+    annotation: {
+        type: "url_citation";
+        start_index: number;
+        end_index: number;
+        url: string;
+        title: string;
+    } | {
+        type: "file_citation";
+        file_id: string;
+        filename: string;
+        index: number;
+    } | {
+        type: "container_file_citation";
+        container_id: string;
+        file_id: string;
+        filename: string;
+        start_index: number;
+        end_index: number;
+    } | {
+        type: "file_path";
+        file_id: string;
+        index: number;
+    };
+} | {
+    type: "response.reasoning_summary_part.added";
+    item_id: string;
+    summary_index: number;
+} | {
+    type: "response.reasoning_summary_text.delta";
+    item_id: string;
+    summary_index: number;
+    delta: string;
+} | {
+    type: "response.reasoning_summary_part.done";
+    item_id: string;
+    summary_index: number;
+} | {
+    type: "response.apply_patch_call_operation_diff.delta";
+    item_id: string;
+    output_index: number;
+    delta: string;
+    obfuscation?: string | null | undefined;
+} | {
+    type: "response.apply_patch_call_operation_diff.done";
+    item_id: string;
+    output_index: number;
+    diff: string;
+} | {
+    type: "error";
+    sequence_number: number;
+    error: {
+        type: string;
+        code: string;
+        message: string;
+        param?: string | null | undefined;
+    };
+}>;
+
+type OpenaiResponsesChunk = InferSchema<typeof openaiResponsesChunkSchema>;
+type ResponsesOutputTextAnnotationProviderMetadata = Extract<OpenaiResponsesChunk, {
+    type: 'response.output_text.annotation.added';
+}>['annotation'];
+type ResponsesTextProviderMetadata = {
+    itemId: string;
+    annotations?: Array<ResponsesOutputTextAnnotationProviderMetadata>;
+};
+type OpenaiResponsesTextProviderMetadata = {
+    openai: ResponsesTextProviderMetadata;
+};
+type ResponsesSourceDocumentProviderMetadata = {
+    type: 'file_citation';
+    fileId: string;
+    index: number;
+} | {
+    type: 'container_file_citation';
+    fileId: string;
+    containerId: string;
+} | {
+    type: 'file_path';
+    fileId: string;
+    index: number;
+};
+type OpenaiResponsesSourceDocumentProviderMetadata = {
+    openai: ResponsesSourceDocumentProviderMetadata;
+};
+
 /**
  * Schema for the apply_patch input - what the model sends.
  *
@@ -412,37 +817,6 @@ declare const codeInterpreter: (args?: CodeInterpreterArgs) => _ai_sdk_provider_
     }> | null;
 }>;
 
-/**
- * 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, in, nin.
-     */
-    type: 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'nin';
-    /**
-     * The value to compare against the attribute key; supports string, number, boolean, or array of string types.
-     */
-    value: string | number | boolean | string[];
-};
-/**
- * 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 fileSearchArgsSchema: _ai_sdk_provider_utils.LazySchema<{
     vectorStoreIds: string[];
     maxNumResults?: number | undefined;
@@ -690,4 +1064,4 @@ declare const webSearchPreview: _ai_sdk_provider_utils.ProviderToolFactoryWithOu
     };
 }>;
 
-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 };
+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, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, type ResponsesSourceDocumentProviderMetadata, type ResponsesTextProviderMetadata, 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 };