ai 3.4.15 → 3.4.16

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ai
 
+## 3.4.16
+
+### Patch Changes
+
+- 01dcc44: feat (ai/core): add experimental activeTools option to generateText and streamText
+
 ## 3.4.15
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1580,7 +1580,7 @@ If set and supported by the model, calls will generate deterministic results.
 @returns
 A result object that contains the generated text, the results of the tool calls, and additional information.
  */
-declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxAutomaticRoundtrips, maxToolRoundtrips, maxSteps, experimental_continuationSteps, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxAutomaticRoundtrips, maxToolRoundtrips, maxSteps, experimental_continuationSteps, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_activeTools: activeTools, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1641,6 +1641,11 @@ functionality that can be fully encapsulated in the provider.
  */
     experimental_providerMetadata?: ProviderMetadata;
     /**
+Limits the tools that are available for the model to call without
+changing the tool call and result types in the result.
+     */
+    experimental_activeTools?: Array<keyof TOOLS>;
+    /**
     Callback that is called when each step (LLM call) is finished, including intermediate steps.
     */
     onStepFinish?: (event: StepResult<TOOLS>) => Promise<void> | void;
@@ -1931,7 +1936,7 @@ If set and supported by the model, calls will generate deterministic results.
 @return
 A result object for accessing different stream types and additional information.
  */
-declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxToolRoundtrips, maxSteps, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_toolCallStreaming: toolCallStreaming, onChunk, onFinish, onStepFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxToolRoundtrips, maxSteps, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_toolCallStreaming: toolCallStreaming, experimental_activeTools: activeTools, onChunk, onFinish, onStepFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1984,6 +1989,11 @@ functionality that can be fully encapsulated in the provider.
  */
     experimental_providerMetadata?: ProviderMetadata;
     /**
+Limits the tools that are available for the model to call without
+changing the tool call and result types in the result.
+     */
+    experimental_activeTools?: Array<keyof TOOLS>;
+    /**
 Enable streaming of tool call deltas as they are generated. Disabled by default.
      */
     experimental_toolCallStreaming?: boolean;

package/dist/index.d.ts

@@ -1580,7 +1580,7 @@ If set and supported by the model, calls will generate deterministic results.
 @returns
 A result object that contains the generated text, the results of the tool calls, and additional information.
  */
-declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxAutomaticRoundtrips, maxToolRoundtrips, maxSteps, experimental_continuationSteps, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxAutomaticRoundtrips, maxToolRoundtrips, maxSteps, experimental_continuationSteps, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_activeTools: activeTools, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1641,6 +1641,11 @@ functionality that can be fully encapsulated in the provider.
  */
     experimental_providerMetadata?: ProviderMetadata;
     /**
+Limits the tools that are available for the model to call without
+changing the tool call and result types in the result.
+     */
+    experimental_activeTools?: Array<keyof TOOLS>;
+    /**
     Callback that is called when each step (LLM call) is finished, including intermediate steps.
     */
     onStepFinish?: (event: StepResult<TOOLS>) => Promise<void> | void;
@@ -1931,7 +1936,7 @@ If set and supported by the model, calls will generate deterministic results.
 @return
 A result object for accessing different stream types and additional information.
  */
-declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxToolRoundtrips, maxSteps, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_toolCallStreaming: toolCallStreaming, onChunk, onFinish, onStepFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxToolRoundtrips, maxSteps, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_toolCallStreaming: toolCallStreaming, experimental_activeTools: activeTools, onChunk, onFinish, onStepFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1984,6 +1989,11 @@ functionality that can be fully encapsulated in the provider.
  */
     experimental_providerMetadata?: ProviderMetadata;
     /**
+Limits the tools that are available for the model to call without
+changing the tool call and result types in the result.
+     */
+    experimental_activeTools?: Array<keyof TOOLS>;
+    /**
 Enable streaming of tool call deltas as they are generated. Disabled by default.
      */
     experimental_toolCallStreaming?: boolean;

package/dist/index.js

@@ -3067,7 +3067,8 @@ function isNonEmptyObject(object) {
 // core/prompt/prepare-tools-and-tool-choice.ts
 function prepareToolsAndToolChoice({
   tools,
-  toolChoice
+  toolChoice,
+  activeTools
 }) {
   if (!isNonEmptyObject(tools)) {
     return {
@@ -3075,8 +3076,11 @@ function prepareToolsAndToolChoice({
       toolChoice: void 0
     };
   }
+  const filteredTools = activeTools != null ? Object.entries(tools).filter(
+    ([name11]) => activeTools.includes(name11)
+  ) : Object.entries(tools);
   return {
-    tools: Object.entries(tools).map(([name11, tool2]) => ({
+    tools: filteredTools.map(([name11, tool2]) => ({
       type: "function",
       name: name11,
       description: tool2.description,
@@ -3178,6 +3182,7 @@ async function generateText({
   experimental_continueSteps: continueSteps = experimental_continuationSteps != null ? experimental_continuationSteps : false,
   experimental_telemetry: telemetry,
   experimental_providerMetadata: providerMetadata,
+  experimental_activeTools: activeTools,
   _internal: {
     generateId: generateId3 = originalGenerateId3,
     currentDate = () => /* @__PURE__ */ new Date()
@@ -3227,7 +3232,7 @@ async function generateText({
       });
       const mode = {
         type: "regular",
-        ...prepareToolsAndToolChoice({ tools, toolChoice })
+        ...prepareToolsAndToolChoice({ tools, toolChoice, activeTools })
       };
       const callSettings = prepareCallSettings(settings);
       const promptMessages = await convertToLanguageModelPrompt({
@@ -3906,6 +3911,7 @@ async function streamText({
   experimental_telemetry: telemetry,
   experimental_providerMetadata: providerMetadata,
   experimental_toolCallStreaming: toolCallStreaming = false,
+  experimental_activeTools: activeTools,
   onChunk,
   onFinish,
   onStepFinish,
@@ -3994,7 +4000,11 @@ async function streamText({
               result: await model.doStream({
                 mode: {
                   type: "regular",
-                  ...prepareToolsAndToolChoice({ tools, toolChoice })
+                  ...prepareToolsAndToolChoice({
+                    tools,
+                    toolChoice,
+                    activeTools
+                  })
                 },
                 ...prepareCallSettings(settings),
                 inputFormat: promptType,