@ai-sdk/openai 3.0.45 → 3.0.46

package/src/tool/tool-search.ts

@@ -0,0 +1,98 @@
+import { JSONObject } from '@ai-sdk/provider';
+import {
+  createProviderToolFactoryWithOutputSchema,
+  FlexibleSchema,
+  lazySchema,
+  zodSchema,
+} 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 = createProviderToolFactoryWithOutputSchema<
+  {
+    /**
+     * 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);