@ai-sdk/openai 4.0.0-beta.7 → 4.0.0-beta.74

package/src/tool/local-shell.ts

@@ -1,5 +1,5 @@
 import {
-  createProviderToolFactoryWithOutputSchema,
+  createProviderDefinedToolFactoryWithOutputSchema,
   lazySchema,
   zodSchema,
 } from '@ai-sdk/provider-utils';
@@ -24,7 +24,7 @@ export const localShellOutputSchema = lazySchema(() =>
   zodSchema(z.object({ output: z.string() })),
 );
 
-export const localShell = createProviderToolFactoryWithOutputSchema<
+export const localShell = createProviderDefinedToolFactoryWithOutputSchema<
   {
     /**
      * Execute a shell command on the server.

package/src/tool/mcp.ts

@@ -1,9 +1,9 @@
 import {
-  createProviderToolFactoryWithOutputSchema,
+  createProviderExecutedToolFactory,
   lazySchema,
   zodSchema,
 } from '@ai-sdk/provider-utils';
-import { JSONValue } from '@ai-sdk/provider';
+import type { JSONValue } from '@ai-sdk/provider';
 import { z } from 'zod/v4';
 
 const jsonValueSchema: z.ZodType<JSONValue> = z.lazy(() =>
@@ -105,7 +105,7 @@ type McpArgs = {
   serverUrl?: string;
 };
 
-export const mcpToolFactory = createProviderToolFactoryWithOutputSchema<
+export const mcpToolFactory = createProviderExecutedToolFactory<
   {},
   {
     type: 'call';

package/src/tool/shell.ts

@@ -1,8 +1,9 @@
 import {
-  createProviderToolFactoryWithOutputSchema,
+  createProviderDefinedToolFactoryWithOutputSchema,
   lazySchema,
   zodSchema,
 } from '@ai-sdk/provider-utils';
+import type { SharedV4ProviderReference } from '@ai-sdk/provider';
 import { z } from 'zod/v4';
 
 export const shellInputSchema = lazySchema(() =>
@@ -39,7 +40,7 @@ const shellSkillsSchema = z
     z.discriminatedUnion('type', [
       z.object({
         type: z.literal('skillReference'),
-        skillId: z.string(),
+        providerReference: z.record(z.string(), z.string()),
         version: z.string().optional(),
       }),
       z.object({
@@ -125,7 +126,11 @@ type ShellArgs = {
               }>;
             };
         skills?: Array<
-          | { type: 'skillReference'; skillId: string; version?: string }
+          | {
+              type: 'skillReference';
+              providerReference: SharedV4ProviderReference;
+              version?: string;
+            }
           | {
               type: 'inline';
               name: string;
@@ -152,7 +157,7 @@ type ShellArgs = {
       };
 };
 
-export const shell = createProviderToolFactoryWithOutputSchema<
+export const shell = createProviderDefinedToolFactoryWithOutputSchema<
   {
     /**
      * Shell tool action containing commands to execute.

package/src/tool/tool-search.ts

@@ -0,0 +1,98 @@
+import type { JSONObject } from '@ai-sdk/provider';
+import {
+  createProviderDefinedToolFactoryWithOutputSchema,
+  lazySchema,
+  zodSchema,
+  type FlexibleSchema,
+} from '@ai-sdk/provider-utils';
+import { z } from 'zod/v4';
+
+export const toolSearchArgsSchema = lazySchema(() =>
+  zodSchema(
+    z.object({
+      execution: z.enum(['server', 'client']).optional(),
+      description: z.string().optional(),
+      parameters: z.record(z.string(), z.unknown()).optional(),
+    }),
+  ),
+);
+
+export const toolSearchInputSchema = lazySchema(() =>
+  zodSchema(
+    z.object({
+      arguments: z.unknown().optional(),
+      call_id: z.string().nullish(),
+    }),
+  ),
+);
+
+export const toolSearchOutputSchema: FlexibleSchema<{
+  tools: Array<JSONObject>;
+}> = lazySchema(() =>
+  zodSchema(
+    z.object({
+      tools: z.array(z.record(z.string(), z.unknown())),
+    }),
+  ),
+) as FlexibleSchema<{ tools: Array<JSONObject> }>;
+
+const toolSearchToolFactory = createProviderDefinedToolFactoryWithOutputSchema<
+  {
+    /**
+     * The arguments from the tool_search_call.
+     * This is preserved for multi-turn conversation reconstruction.
+     */
+    arguments?: unknown;
+
+    /**
+     * The call ID from the tool_search_call.
+     * Present for client-executed tool search; null for hosted.
+     */
+    call_id?: string | null;
+  },
+  {
+    /**
+     * The tools that were loaded by the tool search.
+     * These are the deferred tools that the model requested to load.
+     * Each tool is represented as a JSON object with properties depending on its type.
+     *
+     * Common properties include:
+     * - `type`: The type of the tool (e.g., 'function', 'web_search', etc.)
+     * - `name`: The name of the tool (for function tools)
+     * - `description`: A description of the tool
+     * - `deferLoading`: Whether this tool was deferred (had defer_loading: true)
+     * - `parameters`: The JSON Schema for the function parameters (for function tools)
+     * - `strict`: Whether to enable strict schema adherence (for function tools)
+     */
+    tools: Array<JSONObject>;
+  },
+  {
+    /**
+     * Whether the tool search is executed by the server (hosted) or client.
+     * - `'server'` (default): OpenAI performs the search across deferred tools.
+     * - `'client'`: The model emits a `tool_search_call` and your `execute`
+     *   function performs the lookup, returning the tools to load.
+     */
+    execution?: 'server' | 'client';
+
+    /**
+     * A description of the tool search capability.
+     * Only used for client-executed tool search.
+     */
+    description?: string;
+
+    /**
+     * JSON Schema for the search arguments your application expects.
+     * Only used for client-executed tool search.
+     */
+    parameters?: Record<string, unknown>;
+  }
+>({
+  id: 'openai.tool_search',
+  inputSchema: toolSearchInputSchema,
+  outputSchema: toolSearchOutputSchema,
+});
+
+export const toolSearch = (
+  args: Parameters<typeof toolSearchToolFactory>[0] = {},
+) => toolSearchToolFactory(args);

package/src/tool/web-search-preview.ts

@@ -1,5 +1,5 @@
 import {
-  createProviderToolFactoryWithOutputSchema,
+  createProviderExecutedToolFactory,
   lazySchema,
   zodSchema,
 } from '@ai-sdk/provider-utils';
@@ -50,7 +50,7 @@ const webSearchPreviewOutputSchema = lazySchema(() =>
   ),
 );
 
-export const webSearchPreview = createProviderToolFactoryWithOutputSchema<
+export const webSearchPreview = createProviderExecutedToolFactory<
   {
     // Web search preview doesn't take input parameters - it's controlled by the prompt
   },

package/src/tool/web-search.ts

@@ -1,5 +1,5 @@
 import {
-  createProviderToolFactoryWithOutputSchema,
+  createProviderExecutedToolFactory,
   lazySchema,
   zodSchema,
 } from '@ai-sdk/provider-utils';
@@ -36,6 +36,7 @@ export const webSearchOutputSchema = lazySchema(() =>
           z.object({
             type: z.literal('search'),
             query: z.string().optional(),
+            queries: z.array(z.string()).optional(),
           }),
           z.object({
             type: z.literal('openPage'),
@@ -60,7 +61,7 @@ export const webSearchOutputSchema = lazySchema(() =>
   ),
 );
 
-export const webSearchToolFactory = createProviderToolFactoryWithOutputSchema<
+export const webSearchToolFactory = createProviderExecutedToolFactory<
   {
     // Web search doesn't take input parameters - it's controlled by the prompt
   },
@@ -78,8 +79,15 @@ export const webSearchToolFactory = createProviderToolFactoryWithOutputSchema<
 
           /**
            * The search query.
+           *
+           * @deprecated Use `queries` instead.
            */
           query?: string;
+
+          /**
+           * The search queries the model used.
+           */
+          queries?: string[];
         }
       | {
           /**

package/src/transcription/{openai-transcription-options.ts → openai-transcription-model-options.ts}

@@ -1,4 +1,8 @@
-import { InferSchema, lazySchema, zodSchema } from '@ai-sdk/provider-utils';
+import {
+  lazySchema,
+  zodSchema,
+  type InferSchema,
+} from '@ai-sdk/provider-utils';
 import { z } from 'zod/v4';
 
 export type OpenAITranscriptionModelId =

package/src/transcription/openai-transcription-model.ts

@@ -1,4 +1,4 @@
-import {
+import type {
   TranscriptionModelV4,
   TranscriptionModelV4CallOptions,
   SharedV4Warning,
@@ -10,16 +10,18 @@ import {
   mediaTypeToExtension,
   parseProviderOptions,
   postFormDataToApi,
+  serializeModelOptions,
+  WORKFLOW_DESERIALIZE,
+  WORKFLOW_SERIALIZE,
 } from '@ai-sdk/provider-utils';
-import { OpenAIConfig } from '../openai-config';
+import type { OpenAIConfig } from '../openai-config';
 import { openaiFailedResponseHandler } from '../openai-error';
 import { openaiTranscriptionResponseSchema } from './openai-transcription-api';
 import {
-  OpenAITranscriptionModelId,
   openAITranscriptionModelOptions,
-  OpenAITranscriptionModelOptions,
-} from './openai-transcription-options';
-
+  type OpenAITranscriptionModelId,
+  type OpenAITranscriptionModelOptions,
+} from './openai-transcription-model-options';
 export type OpenAITranscriptionCallOptions = Omit<
   TranscriptionModelV4CallOptions,
   'providerOptions'
@@ -99,6 +101,20 @@ const languageMap = {
 export class OpenAITranscriptionModel implements TranscriptionModelV4 {
   readonly specificationVersion = 'v4';
 
+  static [WORKFLOW_SERIALIZE](model: OpenAITranscriptionModel) {
+    return serializeModelOptions({
+      modelId: model.modelId,
+      config: model.config,
+    });
+  }
+
+  static [WORKFLOW_DESERIALIZE](options: {
+    modelId: OpenAITranscriptionModelId;
+    config: OpenAITranscriptionModelConfig;
+  }) {
+    return new OpenAITranscriptionModel(options.modelId, options.config);
+  }
+
   get provider(): string {
     return this.config.provider;
   }
@@ -137,20 +153,26 @@ export class OpenAITranscriptionModel implements TranscriptionModelV4 {
       `audio.${fileExtension}`,
     );
 
+    if (this.modelId === 'whisper-1') {
+      formData.append('response_format', 'verbose_json');
+    }
+
     // Add provider-specific options
     if (openAIOptions) {
+      const isGpt4oTranscribeModel = [
+        'gpt-4o-transcribe',
+        'gpt-4o-mini-transcribe',
+      ].includes(this.modelId);
+
       const transcriptionModelOptions = {
         include: openAIOptions.include,
         language: openAIOptions.language,
         prompt: openAIOptions.prompt,
         // https://platform.openai.com/docs/api-reference/audio/createTranscription#audio_createtranscription-response_format
         // prefer verbose_json to get segments for models that support it
-        response_format: [
-          'gpt-4o-transcribe',
-          'gpt-4o-mini-transcribe',
-        ].includes(this.modelId)
-          ? 'json'
-          : 'verbose_json',
+        ...(this.modelId !== 'whisper-1' && {
+          response_format: isGpt4oTranscribeModel ? 'json' : 'verbose_json',
+        }),
         temperature: openAIOptions.temperature,
         timestamp_granularities: openAIOptions.timestampGranularities,
       };
@@ -189,7 +211,7 @@ export class OpenAITranscriptionModel implements TranscriptionModelV4 {
         path: '/audio/transcriptions',
         modelId: this.modelId,
       }),
-      headers: combineHeaders(this.config.headers(), options.headers),
+      headers: combineHeaders(this.config.headers?.(), options.headers),
       formData,
       failedResponseHandler: openaiFailedResponseHandler,
       successfulResponseHandler: createJsonResponseHandler(