ai 6.0.0-beta.64 → 6.0.0-beta.66

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # ai
 
+## 6.0.0-beta.66
+
+### Patch Changes
+
+- fca786b: feat(agent): configurable call options
+- Updated dependencies [fca786b]
+  - @ai-sdk/provider-utils@4.0.0-beta.20
+  - @ai-sdk/gateway@2.0.0-beta.36
+
+## 6.0.0-beta.65
+
+### Patch Changes
+
+- dce4e7b: chore(agent): rename system to instructions
+
 ## 6.0.0-beta.64
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 export { createGateway, gateway } from '@ai-sdk/gateway';
 import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
-import { Tool, InferToolInput, InferToolOutput, AssistantModelMessage, ToolModelMessage, ReasoningPart, FlexibleSchema, InferSchema, ModelMessage, SystemModelMessage, UserModelMessage, ProviderOptions, IdGenerator, ToolCall, Resolvable, FetchFunction, DataContent } from '@ai-sdk/provider-utils';
+import { Tool, InferToolInput, InferToolOutput, AssistantModelMessage, ToolModelMessage, ReasoningPart, FlexibleSchema, InferSchema, ModelMessage, SystemModelMessage, UserModelMessage, ProviderOptions, IdGenerator, ToolCall, MaybePromiseLike, Resolvable, FetchFunction, DataContent } from '@ai-sdk/provider-utils';
 export { AssistantContent, AssistantModelMessage, DataContent, FilePart, FlexibleSchema, IdGenerator, ImagePart, InferSchema, InferToolInput, InferToolOutput, ModelMessage, Schema, SystemModelMessage, TextPart, Tool, ToolApprovalRequest, ToolApprovalResponse, ToolCallOptions, ToolCallPart, ToolContent, ToolExecuteFunction, ToolModelMessage, ToolResultPart, UserContent, UserModelMessage, asSchema, createIdGenerator, dynamicTool, generateId, jsonSchema, parseJsonEventStream, tool, zodSchema } from '@ai-sdk/provider-utils';
 import * as _ai_sdk_provider from '@ai-sdk/provider';
 import { EmbeddingModelV3, EmbeddingModelV2, EmbeddingModelV3Embedding, ImageModelV3, ImageModelV3CallWarning, ImageModelV3ProviderMetadata, JSONValue as JSONValue$1, LanguageModelV3, LanguageModelV2, LanguageModelV3FinishReason, LanguageModelV3CallWarning, LanguageModelV3Source, LanguageModelV3Middleware, SharedV3ProviderMetadata, SpeechModelV3, SpeechModelV2, SpeechModelV3CallWarning, TranscriptionModelV3, TranscriptionModelV2, TranscriptionModelV3CallWarning, LanguageModelV3Usage, LanguageModelV3CallOptions, AISDKError, LanguageModelV3ToolCall, JSONSchema7, JSONParseError, TypeValidationError, ProviderV3, ProviderV2, NoSuchModelError, JSONObject } from '@ai-sdk/provider';
@@ -2380,7 +2380,11 @@ type TextStreamPart<TOOLS extends ToolSet> = {
     rawValue: unknown;
 };
 
-type AgentCallParameters = {
+type AgentCallParameters<CALL_OPTIONS> = ([CALL_OPTIONS] extends [never] ? {
+    options?: never;
+} : {
+    options: CALL_OPTIONS;
+}) & ({
     /**
      * A prompt. It can be either a text prompt or a list of messages.
      *
@@ -2406,7 +2410,7 @@ type AgentCallParameters = {
      * You can either use `prompt` or `messages` but not both.
      */
     prompt?: never;
-};
+});
 /**
  * An Agent receives a prompt (text or messages) and generates or streams an output
  * that consists of steps, tool calls, data parts, etc.
@@ -2414,7 +2418,7 @@ type AgentCallParameters = {
  * You can implement your own Agent by implementing the `Agent` interface,
  * or use the `ToolLoopAgent` class.
  */
-interface Agent<TOOLS extends ToolSet = {}, OUTPUT extends Output = never> {
+interface Agent<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never> {
     /**
      * The specification version of the agent interface. This will enable
      * us to evolve the agent interface and retain backwards compatibility.
@@ -2431,11 +2435,11 @@ interface Agent<TOOLS extends ToolSet = {}, OUTPUT extends Output = never> {
     /**
      * Generates an output from the agent (non-streaming).
      */
-    generate(options: AgentCallParameters): PromiseLike<GenerateTextResult<TOOLS, InferGenerateOutput<OUTPUT>>>;
+    generate(options: AgentCallParameters<CALL_OPTIONS>): PromiseLike<GenerateTextResult<TOOLS, InferGenerateOutput<OUTPUT>>>;
     /**
      * Streams an output from the agent (streaming).
      */
-    stream(options: AgentCallParameters): StreamTextResult<TOOLS, InferStreamOutput<OUTPUT>>;
+    stream(options: AgentCallParameters<CALL_OPTIONS>): PromiseLike<StreamTextResult<TOOLS, InferStreamOutput<OUTPUT>>>;
 }
 
 /**
@@ -2464,15 +2468,15 @@ type ToolLoopAgentOnStepFinishCallback<TOOLS extends ToolSet = {}> = (stepResult
 /**
  * Configuration options for an agent.
  */
-type ToolLoopAgentSettings<TOOLS extends ToolSet = {}, OUTPUT extends Output = never> = CallSettings & {
+type ToolLoopAgentSettings<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never> = CallSettings & {
     /**
      * The id of the agent.
      */
     id?: string;
     /**
-     * The system prompt to use.
+     * The instructions for the agent.
      */
-    system?: string;
+    instructions?: string;
     /**
   The language model to use.
      */
@@ -2506,10 +2510,6 @@ type ToolLoopAgentSettings<TOOLS extends ToolSet = {}, OUTPUT extends Output = n
      */
     experimental_output?: OUTPUT;
     /**
-     * @deprecated Use `prepareStep` instead.
-     */
-    experimental_prepareStep?: PrepareStepFunction<NoInfer<TOOLS>>;
-    /**
   Optional function that you can use to provide different settings for a step.
     */
     prepareStep?: PrepareStepFunction<NoInfer<TOOLS>>;
@@ -2539,6 +2539,16 @@ type ToolLoopAgentSettings<TOOLS extends ToolSet = {}, OUTPUT extends Output = n
      * @default undefined
      */
     experimental_context?: unknown;
+    /**
+     * The schema for the call options.
+     */
+    callOptionsSchema?: FlexibleSchema<CALL_OPTIONS>;
+    /**
+     * Prepare the parameters for the generateText or streamText call.
+     *
+     * You can use this to have templates based on call options.
+     */
+    prepareCall?: (options: AgentCallParameters<CALL_OPTIONS> & Pick<ToolLoopAgentSettings<CALL_OPTIONS, TOOLS, OUTPUT>, 'model' | 'tools' | 'maxOutputTokens' | 'temperature' | 'topP' | 'topK' | 'presencePenalty' | 'frequencyPenalty' | 'stopSequences' | 'seed' | 'headers' | 'instructions' | 'stopWhen' | 'experimental_telemetry' | 'activeTools' | 'providerOptions' | 'experimental_context'>) => MaybePromiseLike<Pick<ToolLoopAgentSettings<CALL_OPTIONS, TOOLS, OUTPUT>, 'model' | 'tools' | 'maxOutputTokens' | 'temperature' | 'topP' | 'topK' | 'presencePenalty' | 'frequencyPenalty' | 'stopSequences' | 'seed' | 'headers' | 'instructions' | 'stopWhen' | 'experimental_telemetry' | 'activeTools' | 'providerOptions' | 'experimental_context'> & Omit<Prompt, 'system'>>;
 };
 
 /**
@@ -2552,10 +2562,10 @@ type ToolLoopAgentSettings<TOOLS extends ToolSet = {}, OUTPUT extends Output = n
  * - A tool call needs approval, or
  * - A stop condition is met (default stop condition is stepCountIs(20))
  */
-declare class ToolLoopAgent<TOOLS extends ToolSet = {}, OUTPUT extends Output = never> implements Agent<TOOLS, OUTPUT> {
+declare class ToolLoopAgent<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never> implements Agent<CALL_OPTIONS, TOOLS, OUTPUT> {
     readonly version = "agent-v1";
     private readonly settings;
-    constructor(settings: ToolLoopAgentSettings<TOOLS, OUTPUT>);
+    constructor(settings: ToolLoopAgentSettings<CALL_OPTIONS, TOOLS, OUTPUT>);
     /**
      * The id of the agent.
      */
@@ -2564,20 +2574,21 @@ declare class ToolLoopAgent<TOOLS extends ToolSet = {}, OUTPUT extends Output =
      * The tools that the agent can use.
      */
     get tools(): TOOLS;
+    private prepareCall;
     /**
      * Generates an output from the agent (non-streaming).
      */
-    generate(options: AgentCallParameters): Promise<GenerateTextResult<TOOLS, InferGenerateOutput<OUTPUT>>>;
+    generate(options: AgentCallParameters<CALL_OPTIONS>): Promise<GenerateTextResult<TOOLS, InferGenerateOutput<OUTPUT>>>;
     /**
      * Streams an output from the agent (streaming).
      */
-    stream(options: AgentCallParameters): StreamTextResult<TOOLS, InferStreamOutput<OUTPUT>>;
+    stream(options: AgentCallParameters<CALL_OPTIONS>): Promise<StreamTextResult<TOOLS, InferStreamOutput<OUTPUT>>>;
 }
 
 /**
  * Infer the type of the tools of an agent.
  */
-type InferAgentTools<AGENT> = AGENT extends Agent<infer TOOLS, never> ? TOOLS : never;
+type InferAgentTools<AGENT> = AGENT extends Agent<any, infer TOOLS, any> ? TOOLS : never;
 
 /**
  * Infer the UI message type of an agent.
@@ -2592,10 +2603,11 @@ type InferAgentUIMessage<AGENT> = UIMessage<never, never, InferUITools<InferAgen
  *
  * @returns The response object.
  */
-declare function createAgentUIStreamResponse<TOOLS extends ToolSet = {}, OUTPUT extends Output = never>({ headers, status, statusText, consumeSseStream, ...options }: {
-    agent: Agent<TOOLS, OUTPUT>;
+declare function createAgentUIStreamResponse<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ headers, status, statusText, consumeSseStream, ...options }: {
+    agent: Agent<CALL_OPTIONS, TOOLS, OUTPUT>;
     messages: unknown[];
-} & UIMessageStreamResponseInit & UIMessageStreamOptions<UIMessage<never, never, InferUITools<TOOLS>>>): Promise<Response>;
+    options?: CALL_OPTIONS;
+} & UIMessageStreamResponseInit & UIMessageStreamOptions<UIMessage<MESSAGE_METADATA, never, InferUITools<TOOLS>>>): Promise<Response>;
 
 declare const getOriginalFetch: () => typeof fetch;
 declare function callCompletionApi({ api, prompt, credentials, headers, body, streamProtocol, setCompletion, setLoading, setError, setAbortController, onFinish, onError, fetch, }: {
@@ -3245,10 +3257,11 @@ declare const UI_MESSAGE_STREAM_HEADERS: {
  *
  * @returns The UI message stream.
  */
-declare function createAgentUIStream<TOOLS extends ToolSet = {}, OUTPUT extends Output = never>({ agent, messages, ...uiMessageStreamOptions }: {
-    agent: Agent<TOOLS, OUTPUT>;
+declare function createAgentUIStream<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ agent, messages, options, ...uiMessageStreamOptions }: {
+    agent: Agent<CALL_OPTIONS, TOOLS, OUTPUT>;
     messages: unknown[];
-} & UIMessageStreamOptions<UIMessage<never, never, InferUITools<TOOLS>>>): Promise<AsyncIterableStream<InferUIMessageChunk<UIMessage<never, never, InferUITools<TOOLS>>>>>;
+    options?: CALL_OPTIONS;
+} & UIMessageStreamOptions<UIMessage<MESSAGE_METADATA, never, InferUITools<TOOLS>>>): Promise<AsyncIterableStream<InferUIMessageChunk<UIMessage<MESSAGE_METADATA, never, InferUITools<TOOLS>>>>>;
 
 /**
  * Pipes the agent UI message stream to a Node.js ServerResponse object.
@@ -3256,11 +3269,12 @@ declare function createAgentUIStream<TOOLS extends ToolSet = {}, OUTPUT extends
  * @param agent - The agent to run.
  * @param messages - The input UI messages.
  */
-declare function pipeAgentUIStreamToResponse<TOOLS extends ToolSet = {}, OUTPUT extends Output = never>({ response, headers, status, statusText, consumeSseStream, ...options }: {
+declare function pipeAgentUIStreamToResponse<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ response, headers, status, statusText, consumeSseStream, ...options }: {
     response: ServerResponse;
-    agent: Agent<TOOLS, OUTPUT>;
+    agent: Agent<CALL_OPTIONS, TOOLS, OUTPUT>;
     messages: unknown[];
-} & UIMessageStreamResponseInit & UIMessageStreamOptions<UIMessage<never, never, InferUITools<TOOLS>>>): Promise<void>;
+    options?: CALL_OPTIONS;
+} & UIMessageStreamResponseInit & UIMessageStreamOptions<UIMessage<MESSAGE_METADATA, never, InferUITools<TOOLS>>>): Promise<void>;
 
 /**
 The result of an `embed` call.

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export { createGateway, gateway } from '@ai-sdk/gateway';
 import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
-import { Tool, InferToolInput, InferToolOutput, AssistantModelMessage, ToolModelMessage, ReasoningPart, FlexibleSchema, InferSchema, ModelMessage, SystemModelMessage, UserModelMessage, ProviderOptions, IdGenerator, ToolCall, Resolvable, FetchFunction, DataContent } from '@ai-sdk/provider-utils';
+import { Tool, InferToolInput, InferToolOutput, AssistantModelMessage, ToolModelMessage, ReasoningPart, FlexibleSchema, InferSchema, ModelMessage, SystemModelMessage, UserModelMessage, ProviderOptions, IdGenerator, ToolCall, MaybePromiseLike, Resolvable, FetchFunction, DataContent } from '@ai-sdk/provider-utils';
 export { AssistantContent, AssistantModelMessage, DataContent, FilePart, FlexibleSchema, IdGenerator, ImagePart, InferSchema, InferToolInput, InferToolOutput, ModelMessage, Schema, SystemModelMessage, TextPart, Tool, ToolApprovalRequest, ToolApprovalResponse, ToolCallOptions, ToolCallPart, ToolContent, ToolExecuteFunction, ToolModelMessage, ToolResultPart, UserContent, UserModelMessage, asSchema, createIdGenerator, dynamicTool, generateId, jsonSchema, parseJsonEventStream, tool, zodSchema } from '@ai-sdk/provider-utils';
 import * as _ai_sdk_provider from '@ai-sdk/provider';
 import { EmbeddingModelV3, EmbeddingModelV2, EmbeddingModelV3Embedding, ImageModelV3, ImageModelV3CallWarning, ImageModelV3ProviderMetadata, JSONValue as JSONValue$1, LanguageModelV3, LanguageModelV2, LanguageModelV3FinishReason, LanguageModelV3CallWarning, LanguageModelV3Source, LanguageModelV3Middleware, SharedV3ProviderMetadata, SpeechModelV3, SpeechModelV2, SpeechModelV3CallWarning, TranscriptionModelV3, TranscriptionModelV2, TranscriptionModelV3CallWarning, LanguageModelV3Usage, LanguageModelV3CallOptions, AISDKError, LanguageModelV3ToolCall, JSONSchema7, JSONParseError, TypeValidationError, ProviderV3, ProviderV2, NoSuchModelError, JSONObject } from '@ai-sdk/provider';
@@ -2380,7 +2380,11 @@ type TextStreamPart<TOOLS extends ToolSet> = {
     rawValue: unknown;
 };
 
-type AgentCallParameters = {
+type AgentCallParameters<CALL_OPTIONS> = ([CALL_OPTIONS] extends [never] ? {
+    options?: never;
+} : {
+    options: CALL_OPTIONS;
+}) & ({
     /**
      * A prompt. It can be either a text prompt or a list of messages.
      *
@@ -2406,7 +2410,7 @@ type AgentCallParameters = {
      * You can either use `prompt` or `messages` but not both.
      */
     prompt?: never;
-};
+});
 /**
  * An Agent receives a prompt (text or messages) and generates or streams an output
  * that consists of steps, tool calls, data parts, etc.
@@ -2414,7 +2418,7 @@ type AgentCallParameters = {
  * You can implement your own Agent by implementing the `Agent` interface,
  * or use the `ToolLoopAgent` class.
  */
-interface Agent<TOOLS extends ToolSet = {}, OUTPUT extends Output = never> {
+interface Agent<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never> {
     /**
      * The specification version of the agent interface. This will enable
      * us to evolve the agent interface and retain backwards compatibility.
@@ -2431,11 +2435,11 @@ interface Agent<TOOLS extends ToolSet = {}, OUTPUT extends Output = never> {
     /**
      * Generates an output from the agent (non-streaming).
      */
-    generate(options: AgentCallParameters): PromiseLike<GenerateTextResult<TOOLS, InferGenerateOutput<OUTPUT>>>;
+    generate(options: AgentCallParameters<CALL_OPTIONS>): PromiseLike<GenerateTextResult<TOOLS, InferGenerateOutput<OUTPUT>>>;
     /**
      * Streams an output from the agent (streaming).
      */
-    stream(options: AgentCallParameters): StreamTextResult<TOOLS, InferStreamOutput<OUTPUT>>;
+    stream(options: AgentCallParameters<CALL_OPTIONS>): PromiseLike<StreamTextResult<TOOLS, InferStreamOutput<OUTPUT>>>;
 }
 
 /**
@@ -2464,15 +2468,15 @@ type ToolLoopAgentOnStepFinishCallback<TOOLS extends ToolSet = {}> = (stepResult
 /**
  * Configuration options for an agent.
  */
-type ToolLoopAgentSettings<TOOLS extends ToolSet = {}, OUTPUT extends Output = never> = CallSettings & {
+type ToolLoopAgentSettings<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never> = CallSettings & {
     /**
      * The id of the agent.
      */
     id?: string;
     /**
-     * The system prompt to use.
+     * The instructions for the agent.
      */
-    system?: string;
+    instructions?: string;
     /**
   The language model to use.
      */
@@ -2506,10 +2510,6 @@ type ToolLoopAgentSettings<TOOLS extends ToolSet = {}, OUTPUT extends Output = n
      */
     experimental_output?: OUTPUT;
     /**
-     * @deprecated Use `prepareStep` instead.
-     */
-    experimental_prepareStep?: PrepareStepFunction<NoInfer<TOOLS>>;
-    /**
   Optional function that you can use to provide different settings for a step.
     */
     prepareStep?: PrepareStepFunction<NoInfer<TOOLS>>;
@@ -2539,6 +2539,16 @@ type ToolLoopAgentSettings<TOOLS extends ToolSet = {}, OUTPUT extends Output = n
      * @default undefined
      */
     experimental_context?: unknown;
+    /**
+     * The schema for the call options.
+     */
+    callOptionsSchema?: FlexibleSchema<CALL_OPTIONS>;
+    /**
+     * Prepare the parameters for the generateText or streamText call.
+     *
+     * You can use this to have templates based on call options.
+     */
+    prepareCall?: (options: AgentCallParameters<CALL_OPTIONS> & Pick<ToolLoopAgentSettings<CALL_OPTIONS, TOOLS, OUTPUT>, 'model' | 'tools' | 'maxOutputTokens' | 'temperature' | 'topP' | 'topK' | 'presencePenalty' | 'frequencyPenalty' | 'stopSequences' | 'seed' | 'headers' | 'instructions' | 'stopWhen' | 'experimental_telemetry' | 'activeTools' | 'providerOptions' | 'experimental_context'>) => MaybePromiseLike<Pick<ToolLoopAgentSettings<CALL_OPTIONS, TOOLS, OUTPUT>, 'model' | 'tools' | 'maxOutputTokens' | 'temperature' | 'topP' | 'topK' | 'presencePenalty' | 'frequencyPenalty' | 'stopSequences' | 'seed' | 'headers' | 'instructions' | 'stopWhen' | 'experimental_telemetry' | 'activeTools' | 'providerOptions' | 'experimental_context'> & Omit<Prompt, 'system'>>;
 };
 
 /**
@@ -2552,10 +2562,10 @@ type ToolLoopAgentSettings<TOOLS extends ToolSet = {}, OUTPUT extends Output = n
  * - A tool call needs approval, or
  * - A stop condition is met (default stop condition is stepCountIs(20))
  */
-declare class ToolLoopAgent<TOOLS extends ToolSet = {}, OUTPUT extends Output = never> implements Agent<TOOLS, OUTPUT> {
+declare class ToolLoopAgent<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never> implements Agent<CALL_OPTIONS, TOOLS, OUTPUT> {
     readonly version = "agent-v1";
     private readonly settings;
-    constructor(settings: ToolLoopAgentSettings<TOOLS, OUTPUT>);
+    constructor(settings: ToolLoopAgentSettings<CALL_OPTIONS, TOOLS, OUTPUT>);
     /**
      * The id of the agent.
      */
@@ -2564,20 +2574,21 @@ declare class ToolLoopAgent<TOOLS extends ToolSet = {}, OUTPUT extends Output =
      * The tools that the agent can use.
      */
     get tools(): TOOLS;
+    private prepareCall;
     /**
      * Generates an output from the agent (non-streaming).
      */
-    generate(options: AgentCallParameters): Promise<GenerateTextResult<TOOLS, InferGenerateOutput<OUTPUT>>>;
+    generate(options: AgentCallParameters<CALL_OPTIONS>): Promise<GenerateTextResult<TOOLS, InferGenerateOutput<OUTPUT>>>;
     /**
      * Streams an output from the agent (streaming).
      */
-    stream(options: AgentCallParameters): StreamTextResult<TOOLS, InferStreamOutput<OUTPUT>>;
+    stream(options: AgentCallParameters<CALL_OPTIONS>): Promise<StreamTextResult<TOOLS, InferStreamOutput<OUTPUT>>>;
 }
 
 /**
  * Infer the type of the tools of an agent.
  */
-type InferAgentTools<AGENT> = AGENT extends Agent<infer TOOLS, never> ? TOOLS : never;
+type InferAgentTools<AGENT> = AGENT extends Agent<any, infer TOOLS, any> ? TOOLS : never;
 
 /**
  * Infer the UI message type of an agent.
@@ -2592,10 +2603,11 @@ type InferAgentUIMessage<AGENT> = UIMessage<never, never, InferUITools<InferAgen
  *
  * @returns The response object.
  */
-declare function createAgentUIStreamResponse<TOOLS extends ToolSet = {}, OUTPUT extends Output = never>({ headers, status, statusText, consumeSseStream, ...options }: {
-    agent: Agent<TOOLS, OUTPUT>;
+declare function createAgentUIStreamResponse<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ headers, status, statusText, consumeSseStream, ...options }: {
+    agent: Agent<CALL_OPTIONS, TOOLS, OUTPUT>;
     messages: unknown[];
-} & UIMessageStreamResponseInit & UIMessageStreamOptions<UIMessage<never, never, InferUITools<TOOLS>>>): Promise<Response>;
+    options?: CALL_OPTIONS;
+} & UIMessageStreamResponseInit & UIMessageStreamOptions<UIMessage<MESSAGE_METADATA, never, InferUITools<TOOLS>>>): Promise<Response>;
 
 declare const getOriginalFetch: () => typeof fetch;
 declare function callCompletionApi({ api, prompt, credentials, headers, body, streamProtocol, setCompletion, setLoading, setError, setAbortController, onFinish, onError, fetch, }: {
@@ -3245,10 +3257,11 @@ declare const UI_MESSAGE_STREAM_HEADERS: {
  *
  * @returns The UI message stream.
  */
-declare function createAgentUIStream<TOOLS extends ToolSet = {}, OUTPUT extends Output = never>({ agent, messages, ...uiMessageStreamOptions }: {
-    agent: Agent<TOOLS, OUTPUT>;
+declare function createAgentUIStream<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ agent, messages, options, ...uiMessageStreamOptions }: {
+    agent: Agent<CALL_OPTIONS, TOOLS, OUTPUT>;
     messages: unknown[];
-} & UIMessageStreamOptions<UIMessage<never, never, InferUITools<TOOLS>>>): Promise<AsyncIterableStream<InferUIMessageChunk<UIMessage<never, never, InferUITools<TOOLS>>>>>;
+    options?: CALL_OPTIONS;
+} & UIMessageStreamOptions<UIMessage<MESSAGE_METADATA, never, InferUITools<TOOLS>>>): Promise<AsyncIterableStream<InferUIMessageChunk<UIMessage<MESSAGE_METADATA, never, InferUITools<TOOLS>>>>>;
 
 /**
  * Pipes the agent UI message stream to a Node.js ServerResponse object.
@@ -3256,11 +3269,12 @@ declare function createAgentUIStream<TOOLS extends ToolSet = {}, OUTPUT extends
  * @param agent - The agent to run.
  * @param messages - The input UI messages.
  */
-declare function pipeAgentUIStreamToResponse<TOOLS extends ToolSet = {}, OUTPUT extends Output = never>({ response, headers, status, statusText, consumeSseStream, ...options }: {
+declare function pipeAgentUIStreamToResponse<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ response, headers, status, statusText, consumeSseStream, ...options }: {
     response: ServerResponse;
-    agent: Agent<TOOLS, OUTPUT>;
+    agent: Agent<CALL_OPTIONS, TOOLS, OUTPUT>;
     messages: unknown[];
-} & UIMessageStreamResponseInit & UIMessageStreamOptions<UIMessage<never, never, InferUITools<TOOLS>>>): Promise<void>;
+    options?: CALL_OPTIONS;
+} & UIMessageStreamResponseInit & UIMessageStreamOptions<UIMessage<MESSAGE_METADATA, never, InferUITools<TOOLS>>>): Promise<void>;
 
 /**
 The result of an `embed` call.

package/dist/index.js

@@ -873,7 +873,7 @@ function detectMediaType({
 var import_provider_utils2 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "6.0.0-beta.64" : "0.0.0-test";
+var VERSION = true ? "6.0.0-beta.66" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({ url }) => {
@@ -6341,27 +6341,32 @@ var ToolLoopAgent = class {
   get tools() {
     return this.settings.tools;
   }
+  async prepareCall(options) {
+    var _a17, _b, _c, _d;
+    const baseCallArgs = {
+      ...this.settings,
+      stopWhen: (_a17 = this.settings.stopWhen) != null ? _a17 : stepCountIs(20),
+      ...options
+    };
+    const preparedCallArgs = (_d = await ((_c = (_b = this.settings).prepareCall) == null ? void 0 : _c.call(_b, baseCallArgs))) != null ? _d : baseCallArgs;
+    const { instructions, messages, prompt, ...callArgs } = preparedCallArgs;
+    return {
+      ...callArgs,
+      // restore prompt types
+      ...{ system: instructions, messages, prompt }
+    };
+  }
   /**
    * Generates an output from the agent (non-streaming).
    */
   async generate(options) {
-    var _a17;
-    return generateText({
-      ...this.settings,
-      stopWhen: (_a17 = this.settings.stopWhen) != null ? _a17 : stepCountIs(20),
-      ...options
-    });
+    return generateText(await this.prepareCall(options));
   }
   /**
    * Streams an output from the agent (streaming).
    */
-  stream(options) {
-    var _a17;
-    return streamText({
-      ...this.settings,
-      stopWhen: (_a17 = this.settings.stopWhen) != null ? _a17 : stepCountIs(20),
-      ...options
-    });
+  async stream(options) {
+    return streamText(await this.prepareCall(options));
   }
 };
 
@@ -7084,6 +7089,7 @@ async function validateUIMessages({
 async function createAgentUIStream({
   agent,
   messages,
+  options,
   ...uiMessageStreamOptions
 }) {
   const validatedMessages = await validateUIMessages({
@@ -7093,7 +7099,10 @@ async function createAgentUIStream({
   const modelMessages = convertToModelMessages(validatedMessages, {
     tools: agent.tools
   });
-  const result = agent.stream({ prompt: modelMessages });
+  const result = await agent.stream({
+    prompt: modelMessages,
+    options
+  });
   return result.toUIMessageStream(uiMessageStreamOptions);
 }