@ai-sdk/openai 2.0.125 → 2.0.126

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @ai-sdk/openai
 
+## 2.0.126
+
+### Patch Changes
+
+- 022f24b: Include explicit message item types in Azure AI Foundry Responses requests.
+- a15b75a: Add async function tool calling support for OpenAI Responses models.
+
 ## 2.0.125
 
 ### Patch Changes

package/dist/index.d.mts

@@ -187,6 +187,249 @@ type OpenAIResponsesFileSearchToolCompoundFilter = {
      */
     filters: Array<OpenAIResponsesFileSearchToolComparisonFilter | OpenAIResponsesFileSearchToolCompoundFilter>;
 };
+declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazyValidator<{
+    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;
+                cache_write_tokens?: number | null | undefined;
+                orchestration_input_tokens?: number | null | undefined;
+                orchestration_input_cached_tokens?: number | null | undefined;
+            } | null | undefined;
+            output_tokens_details?: {
+                reasoning_tokens?: number | null | undefined;
+                orchestration_output_tokens?: number | null | undefined;
+            } | null | undefined;
+        };
+        incomplete_details?: {
+            reason: string;
+        } | null | undefined;
+        reasoning?: {
+            context?: string | null | undefined;
+        } | 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;
+        phase?: "commentary" | "final_answer" | null | undefined;
+    } | {
+        type: "reasoning";
+        id: string;
+        encrypted_content?: string | null | undefined;
+    } | {
+        type: "function_call";
+        id: string;
+        call_id: string;
+        name: string;
+        arguments: string;
+        async?: boolean | null | undefined;
+    } | {
+        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: "response.output_item.done";
+    output_index: number;
+    item: {
+        type: "message";
+        id: string;
+        phase?: "commentary" | "final_answer" | null | undefined;
+    } | {
+        type: "reasoning";
+        id: string;
+        encrypted_content?: string | null | undefined;
+    } | {
+        type: "function_call";
+        id: string;
+        call_id: string;
+        name: string;
+        arguments: string;
+        status: "completed";
+        async?: boolean | null | undefined;
+    } | {
+        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;
+        } | null | undefined;
+    } | {
+        type: "file_search_call";
+        id: string;
+        queries: string[];
+        results?: {
+            attributes: Record<string, unknown>;
+            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: "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 | null | undefined;
+        index?: number | null | undefined;
+        start_index?: number | null | undefined;
+        end_index?: number | null | undefined;
+        quote?: string | null | undefined;
+    };
+} | {
+    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: "error";
+    sequence_number: number;
+    error: {
+        type: string;
+        code: string;
+        message: string;
+        param?: string | null | undefined;
+    };
+}>;
+type OpenAIResponsesChunk = InferValidator<typeof openaiResponsesChunkSchema>;
+type OpenAIResponsesLogprobs = NonNullable<(OpenAIResponsesChunk & {
+    type: 'response.output_text.delta';
+})['logprobs']> | null;
 
 declare const openaiTools: {
     /**
@@ -484,6 +727,42 @@ Default OpenAI provider instance.
  */
 declare const openai: OpenAIProvider;
 
+type OpenAIToolOptions = {
+    /**
+     * Whether the model can continue generating after calling this tool without
+     * waiting for its result.
+     */
+    async?: boolean;
+};
+
+type ResponsesProviderMetadata = {
+    responseId: string | null | undefined;
+    logprobs?: Array<OpenAIResponsesLogprobs>;
+    serviceTier?: string;
+    reasoningContext?: string;
+    /**
+     * Provider-specific token usage details, including prompt cache writes and
+     * orchestration usage. Surfaced here so downstream consumers can bill it.
+     */
+    usage?: ResponsesUsageProviderMetadata;
+};
+type ResponsesUsageProviderMetadata = {
+    cacheWriteTokens?: number;
+    orchestrationInputTokens?: number;
+    orchestrationInputCachedTokens?: number;
+    orchestrationOutputTokens?: number;
+};
+type OpenaiResponsesProviderMetadata = {
+    openai: ResponsesProviderMetadata;
+};
+type ResponsesToolCallProviderMetadata = {
+    itemId: string;
+    async?: boolean;
+};
+type OpenaiResponsesToolCallProviderMetadata = {
+    openai: ResponsesToolCallProviderMetadata;
+};
+
 declare const VERSION: string;
 
-export { type OpenAIChatLanguageModelOptions, type OpenAIImageModelGenerationOptions, type OpenAIImageModelOptions, type OpenAIProvider, type OpenAIProviderSettings, type OpenAIResponsesProviderOptions, VERSION, createOpenAI, openai };
+export { type OpenAIChatLanguageModelOptions, type OpenAIImageModelGenerationOptions, type OpenAIImageModelOptions, type OpenAIProvider, type OpenAIProviderSettings, type OpenAIResponsesProviderOptions, type OpenAIToolOptions, type OpenaiResponsesProviderMetadata, type OpenaiResponsesToolCallProviderMetadata, VERSION, createOpenAI, openai };

package/dist/index.d.ts

@@ -187,6 +187,249 @@ type OpenAIResponsesFileSearchToolCompoundFilter = {
      */
     filters: Array<OpenAIResponsesFileSearchToolComparisonFilter | OpenAIResponsesFileSearchToolCompoundFilter>;
 };
+declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazyValidator<{
+    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;
+                cache_write_tokens?: number | null | undefined;
+                orchestration_input_tokens?: number | null | undefined;
+                orchestration_input_cached_tokens?: number | null | undefined;
+            } | null | undefined;
+            output_tokens_details?: {
+                reasoning_tokens?: number | null | undefined;
+                orchestration_output_tokens?: number | null | undefined;
+            } | null | undefined;
+        };
+        incomplete_details?: {
+            reason: string;
+        } | null | undefined;
+        reasoning?: {
+            context?: string | null | undefined;
+        } | 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;
+        phase?: "commentary" | "final_answer" | null | undefined;
+    } | {
+        type: "reasoning";
+        id: string;
+        encrypted_content?: string | null | undefined;
+    } | {
+        type: "function_call";
+        id: string;
+        call_id: string;
+        name: string;
+        arguments: string;
+        async?: boolean | null | undefined;
+    } | {
+        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: "response.output_item.done";
+    output_index: number;
+    item: {
+        type: "message";
+        id: string;
+        phase?: "commentary" | "final_answer" | null | undefined;
+    } | {
+        type: "reasoning";
+        id: string;
+        encrypted_content?: string | null | undefined;
+    } | {
+        type: "function_call";
+        id: string;
+        call_id: string;
+        name: string;
+        arguments: string;
+        status: "completed";
+        async?: boolean | null | undefined;
+    } | {
+        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;
+        } | null | undefined;
+    } | {
+        type: "file_search_call";
+        id: string;
+        queries: string[];
+        results?: {
+            attributes: Record<string, unknown>;
+            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: "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 | null | undefined;
+        index?: number | null | undefined;
+        start_index?: number | null | undefined;
+        end_index?: number | null | undefined;
+        quote?: string | null | undefined;
+    };
+} | {
+    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: "error";
+    sequence_number: number;
+    error: {
+        type: string;
+        code: string;
+        message: string;
+        param?: string | null | undefined;
+    };
+}>;
+type OpenAIResponsesChunk = InferValidator<typeof openaiResponsesChunkSchema>;
+type OpenAIResponsesLogprobs = NonNullable<(OpenAIResponsesChunk & {
+    type: 'response.output_text.delta';
+})['logprobs']> | null;
 
 declare const openaiTools: {
     /**
@@ -484,6 +727,42 @@ Default OpenAI provider instance.
  */
 declare const openai: OpenAIProvider;
 
+type OpenAIToolOptions = {
+    /**
+     * Whether the model can continue generating after calling this tool without
+     * waiting for its result.
+     */
+    async?: boolean;
+};
+
+type ResponsesProviderMetadata = {
+    responseId: string | null | undefined;
+    logprobs?: Array<OpenAIResponsesLogprobs>;
+    serviceTier?: string;
+    reasoningContext?: string;
+    /**
+     * Provider-specific token usage details, including prompt cache writes and
+     * orchestration usage. Surfaced here so downstream consumers can bill it.
+     */
+    usage?: ResponsesUsageProviderMetadata;
+};
+type ResponsesUsageProviderMetadata = {
+    cacheWriteTokens?: number;
+    orchestrationInputTokens?: number;
+    orchestrationInputCachedTokens?: number;
+    orchestrationOutputTokens?: number;
+};
+type OpenaiResponsesProviderMetadata = {
+    openai: ResponsesProviderMetadata;
+};
+type ResponsesToolCallProviderMetadata = {
+    itemId: string;
+    async?: boolean;
+};
+type OpenaiResponsesToolCallProviderMetadata = {
+    openai: ResponsesToolCallProviderMetadata;
+};
+
 declare const VERSION: string;
 
-export { type OpenAIChatLanguageModelOptions, type OpenAIImageModelGenerationOptions, type OpenAIImageModelOptions, type OpenAIProvider, type OpenAIProviderSettings, type OpenAIResponsesProviderOptions, VERSION, createOpenAI, openai };
+export { type OpenAIChatLanguageModelOptions, type OpenAIImageModelGenerationOptions, type OpenAIImageModelOptions, type OpenAIProvider, type OpenAIProviderSettings, type OpenAIResponsesProviderOptions, type OpenAIToolOptions, type OpenaiResponsesProviderMetadata, type OpenaiResponsesToolCallProviderMetadata, VERSION, createOpenAI, openai };