ai 3.1.14 → 3.1.16

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai",
-  "version": "3.1.14",
+  "version": "3.1.16",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -57,8 +57,8 @@
     }
   },
   "dependencies": {
-    "@ai-sdk/provider": "0.0.6",
-    "@ai-sdk/provider-utils": "0.0.9",
+    "@ai-sdk/provider": "0.0.8",
+    "@ai-sdk/provider-utils": "0.0.11",
     "secure-json-parse": "2.7.0",
     "eventsource-parser": "1.1.2",
     "jsondiffpatch": "0.6.0",
@@ -101,7 +101,7 @@
     "tsup": "^7.2.0",
     "typescript": "5.1.3",
     "vite-plugin-solid": "2.7.2",
-    "zod": "3.22.4",
+    "zod": "3.23.8",
     "@vercel/ai-tsconfig": "0.0.0",
     "eslint-config-vercel-ai": "0.0.0"
   },

package/rsc/dist/index.d.ts

@@ -422,6 +422,19 @@ type Prompt = {
     messages?: Array<CoreMessage>;
 };
 
+/**
+Tool choice for the generation. It supports the following settings:
+
+- `auto` (default): the model can choose whether and which tools to call.
+- `required`: the model must call a tool. It can choose which tool to call.
+- `none`: the model must not call tools
+- `{ type: 'tool', tooName: string (typed) }`: the model must call the specified tool
+ */
+type CoreToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | 'required' | {
+    type: 'tool';
+    toolName: keyof TOOLS;
+};
+
 type Streamable = ReactNode | Promise<ReactNode>;
 type Renderer<T extends Array<any>> = (...args: T) => Streamable | Generator<Streamable, Streamable, void> | AsyncGenerator<Streamable, Streamable, void>;
 type RenderTool<PARAMETERS extends z.ZodTypeAny = any> = {
@@ -460,7 +473,7 @@ type RenderResult = {
  */
 declare function streamUI<TOOLS extends {
     [name: string]: z.ZodTypeAny;
-} = {}>({ model, tools, system, prompt, messages, maxRetries, abortSignal, initial, text, ...settings }: CallSettings & Prompt & {
+} = {}>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, initial, text, ...settings }: CallSettings & Prompt & {
     /**
      * The language model to use.
      */
@@ -471,6 +484,10 @@ declare function streamUI<TOOLS extends {
     tools?: {
         [name in keyof TOOLS]: RenderTool<TOOLS[name]>;
     };
+    /**
+The tool choice strategy. Default: 'auto'.
+     */
+    toolChoice?: CoreToolChoice<TOOLS>;
     text?: RenderText;
     initial?: ReactNode;
 }): Promise<RenderResult>;

package/rsc/dist/rsc-server.d.mts

@@ -420,6 +420,19 @@ type Prompt = {
     messages?: Array<CoreMessage>;
 };
 
+/**
+Tool choice for the generation. It supports the following settings:
+
+- `auto` (default): the model can choose whether and which tools to call.
+- `required`: the model must call a tool. It can choose which tool to call.
+- `none`: the model must not call tools
+- `{ type: 'tool', tooName: string (typed) }`: the model must call the specified tool
+ */
+type CoreToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | 'required' | {
+    type: 'tool';
+    toolName: keyof TOOLS;
+};
+
 type Streamable = ReactNode | Promise<ReactNode>;
 type Renderer<T extends Array<any>> = (...args: T) => Streamable | Generator<Streamable, Streamable, void> | AsyncGenerator<Streamable, Streamable, void>;
 type RenderTool<PARAMETERS extends z.ZodTypeAny = any> = {
@@ -458,7 +471,7 @@ type RenderResult = {
  */
 declare function streamUI<TOOLS extends {
     [name: string]: z.ZodTypeAny;
-} = {}>({ model, tools, system, prompt, messages, maxRetries, abortSignal, initial, text, ...settings }: CallSettings & Prompt & {
+} = {}>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, initial, text, ...settings }: CallSettings & Prompt & {
     /**
      * The language model to use.
      */
@@ -469,6 +482,10 @@ declare function streamUI<TOOLS extends {
     tools?: {
         [name in keyof TOOLS]: RenderTool<TOOLS[name]>;
     };
+    /**
+The tool choice strategy. Default: 'auto'.
+     */
+    toolChoice?: CoreToolChoice<TOOLS>;
     text?: RenderText;
     initial?: ReactNode;
 }): Promise<RenderResult>;

package/rsc/dist/rsc-server.mjs

@@ -500,6 +500,33 @@ function convertZodToJSONSchema(zodSchema) {
   return zodToJsonSchema(zodSchema);
 }
 
+// core/util/is-non-empty-object.ts
+function isNonEmptyObject(object) {
+  return object != null && Object.keys(object).length > 0;
+}
+
+// core/prompt/prepare-tools-and-tool-choice.ts
+function prepareToolsAndToolChoice({
+  tools,
+  toolChoice
+}) {
+  if (!isNonEmptyObject(tools)) {
+    return {
+      tools: void 0,
+      toolChoice: void 0
+    };
+  }
+  return {
+    tools: Object.entries(tools).map(([name, tool]) => ({
+      type: "function",
+      name,
+      description: tool.description,
+      parameters: convertZodToJSONSchema(tool.parameters)
+    })),
+    toolChoice: toolChoice == null ? { type: "auto" } : typeof toolChoice === "string" ? { type: toolChoice } : { type: "tool", toolName: toolChoice.toolName }
+  };
+}
+
 // shared/stream-parts.ts
 var textStreamPart = {
   code: "0",
@@ -1641,6 +1668,7 @@ var defaultTextRenderer = ({ content }) => content;
 async function streamUI({
   model,
   tools,
+  toolChoice,
   system,
   prompt,
   messages,
@@ -1720,12 +1748,7 @@ async function streamUI({
     () => model.doStream({
       mode: {
         type: "regular",
-        tools: tools == null ? void 0 : Object.entries(tools).map(([name, tool]) => ({
-          type: "function",
-          name,
-          description: tool.description,
-          parameters: convertZodToJSONSchema(tool.parameters)
-        }))
+        ...prepareToolsAndToolChoice({ tools, toolChoice })
       },
       ...prepareCallSettings(settings),
       inputFormat: validatedPrompt.type,