ai 6.0.13 → 6.0.14

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ai
 
+## 6.0.14
+
+### Patch Changes
+
+- 3f9453f: feat(ai): add timeout option to generateText, streamText, and Agent
+
 ## 6.0.13
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1006,6 +1006,11 @@ type CallSettings = {
      */
     abortSignal?: AbortSignal;
     /**
+  Timeout in milliseconds. The call will be aborted if it takes longer
+  than the specified timeout. Can be used alongside abortSignal.
+     */
+    timeout?: number;
+    /**
   Additional HTTP headers to be sent with the request.
   Only applicable for HTTP-based providers.
      */
@@ -1317,6 +1322,7 @@ If set and supported by the model, calls will generate deterministic results.
 
 @param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
 @param abortSignal - An optional abort signal that can be used to cancel the call.
+@param timeout - An optional timeout in milliseconds. The call will be aborted if it takes longer than the specified timeout.
 @param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
 
 @param experimental_generateMessageId - Generate a unique ID for each message.
@@ -1327,7 +1333,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 ToolSet, OUTPUT extends Output = Output<string, string>>({ model: modelArg, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, stopWhen, experimental_output, output, experimental_telemetry: telemetry, providerOptions, experimental_activeTools, activeTools, experimental_prepareStep, prepareStep, experimental_repairToolCall: repairToolCall, experimental_download: download, experimental_context, _internal: { generateId, currentDate, }, onStepFinish, onFinish, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends ToolSet, OUTPUT extends Output = Output<string, string>>({ model: modelArg, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, timeout, headers, stopWhen, experimental_output, output, experimental_telemetry: telemetry, providerOptions, experimental_activeTools, activeTools, experimental_prepareStep, prepareStep, experimental_repairToolCall: repairToolCall, experimental_download: download, experimental_context, _internal: { generateId, currentDate, }, onStepFinish, onFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -2611,6 +2617,7 @@ If set and supported by the model, calls will generate deterministic results.
 
 @param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
 @param abortSignal - An optional abort signal that can be used to cancel the call.
+@param timeout - An optional timeout in milliseconds. The call will be aborted if it takes longer than the specified timeout.
 @param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
 
 @param onChunk - Callback that is called for each chunk of the stream. The stream processing will pause until the callback promise is resolved.
@@ -2621,7 +2628,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 ToolSet, OUTPUT extends Output = Output<string, string>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, stopWhen, experimental_output, output, experimental_telemetry: telemetry, prepareStep, providerOptions, experimental_activeTools, activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, experimental_download: download, includeRawChunks, onChunk, onError, onFinish, onAbort, onStepFinish, experimental_context, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends ToolSet, OUTPUT extends Output = Output<string, string>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, timeout, headers, stopWhen, experimental_output, output, experimental_telemetry: telemetry, prepareStep, providerOptions, experimental_activeTools, activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, experimental_download: download, includeRawChunks, onChunk, onError, onFinish, onAbort, onStepFinish, experimental_context, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -2784,6 +2791,10 @@ type AgentCallParameters<CALL_OPTIONS> = ([CALL_OPTIONS] extends [never] ? {
      * Abort signal.
      */
     abortSignal?: AbortSignal;
+    /**
+     * Timeout in milliseconds.
+     */
+    timeout?: number;
 };
 /**
  * Parameters for streaming an output from an agent.
@@ -2979,11 +2990,11 @@ declare class ToolLoopAgent<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OU
     /**
      * Generates an output from the agent (non-streaming).
      */
-    generate({ abortSignal, ...options }: AgentCallParameters<CALL_OPTIONS>): Promise<GenerateTextResult<TOOLS, OUTPUT>>;
+    generate({ abortSignal, timeout, ...options }: AgentCallParameters<CALL_OPTIONS>): Promise<GenerateTextResult<TOOLS, OUTPUT>>;
     /**
      * Streams an output from the agent (streaming).
      */
-    stream({ abortSignal, experimental_transform, ...options }: AgentStreamParameters<CALL_OPTIONS, TOOLS>): Promise<StreamTextResult<TOOLS, OUTPUT>>;
+    stream({ abortSignal, timeout, experimental_transform, ...options }: AgentStreamParameters<CALL_OPTIONS, TOOLS>): Promise<StreamTextResult<TOOLS, OUTPUT>>;
 }
 
 /**
@@ -3008,6 +3019,7 @@ declare function createAgentUIStreamResponse<CALL_OPTIONS = never, TOOLS extends
     agent: Agent<CALL_OPTIONS, TOOLS, OUTPUT>;
     uiMessages: unknown[];
     abortSignal?: AbortSignal;
+    timeout?: number;
     options?: CALL_OPTIONS;
     experimental_transform?: StreamTextTransform<TOOLS> | Array<StreamTextTransform<TOOLS>>;
 } & UIMessageStreamResponseInit & UIMessageStreamOptions<UIMessage<MESSAGE_METADATA, never, InferUITools<TOOLS>>>): Promise<Response>;
@@ -3718,15 +3730,17 @@ declare const UI_MESSAGE_STREAM_HEADERS: {
  * @param agent - The agent to run.
  * @param uiMessages - The input UI messages.
  * @param abortSignal - The abort signal. Optional.
+ * @param timeout - Timeout in milliseconds. Optional.
  * @param options - The options for the agent.
  * @param experimental_transform - The stream transformations. Optional.
  *
  * @returns The UI message stream.
  */
-declare function createAgentUIStream<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ agent, uiMessages, options, abortSignal, experimental_transform, ...uiMessageStreamOptions }: {
+declare function createAgentUIStream<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ agent, uiMessages, options, abortSignal, timeout, experimental_transform, ...uiMessageStreamOptions }: {
     agent: Agent<CALL_OPTIONS, TOOLS, OUTPUT>;
     uiMessages: unknown[];
     abortSignal?: AbortSignal;
+    timeout?: number;
     options?: CALL_OPTIONS;
     experimental_transform?: StreamTextTransform<TOOLS> | Array<StreamTextTransform<TOOLS>>;
 } & UIMessageStreamOptions<UIMessage<MESSAGE_METADATA, never, InferUITools<TOOLS>>>): Promise<AsyncIterableStream<InferUIMessageChunk<UIMessage<MESSAGE_METADATA, never, InferUITools<TOOLS>>>>>;
@@ -3742,6 +3756,7 @@ declare function pipeAgentUIStreamToResponse<CALL_OPTIONS = never, TOOLS extends
     agent: Agent<CALL_OPTIONS, TOOLS, OUTPUT>;
     uiMessages: unknown[];
     abortSignal?: AbortSignal;
+    timeout?: number;
     options?: CALL_OPTIONS;
     experimental_transform?: StreamTextTransform<TOOLS> | Array<StreamTextTransform<TOOLS>>;
 } & UIMessageStreamResponseInit & UIMessageStreamOptions<UIMessage<MESSAGE_METADATA, never, InferUITools<TOOLS>>>): Promise<void>;

package/dist/index.d.ts

@@ -1006,6 +1006,11 @@ type CallSettings = {
      */
     abortSignal?: AbortSignal;
     /**
+  Timeout in milliseconds. The call will be aborted if it takes longer
+  than the specified timeout. Can be used alongside abortSignal.
+     */
+    timeout?: number;
+    /**
   Additional HTTP headers to be sent with the request.
   Only applicable for HTTP-based providers.
      */
@@ -1317,6 +1322,7 @@ If set and supported by the model, calls will generate deterministic results.
 
 @param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
 @param abortSignal - An optional abort signal that can be used to cancel the call.
+@param timeout - An optional timeout in milliseconds. The call will be aborted if it takes longer than the specified timeout.
 @param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
 
 @param experimental_generateMessageId - Generate a unique ID for each message.
@@ -1327,7 +1333,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 ToolSet, OUTPUT extends Output = Output<string, string>>({ model: modelArg, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, stopWhen, experimental_output, output, experimental_telemetry: telemetry, providerOptions, experimental_activeTools, activeTools, experimental_prepareStep, prepareStep, experimental_repairToolCall: repairToolCall, experimental_download: download, experimental_context, _internal: { generateId, currentDate, }, onStepFinish, onFinish, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends ToolSet, OUTPUT extends Output = Output<string, string>>({ model: modelArg, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, timeout, headers, stopWhen, experimental_output, output, experimental_telemetry: telemetry, providerOptions, experimental_activeTools, activeTools, experimental_prepareStep, prepareStep, experimental_repairToolCall: repairToolCall, experimental_download: download, experimental_context, _internal: { generateId, currentDate, }, onStepFinish, onFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -2611,6 +2617,7 @@ If set and supported by the model, calls will generate deterministic results.
 
 @param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
 @param abortSignal - An optional abort signal that can be used to cancel the call.
+@param timeout - An optional timeout in milliseconds. The call will be aborted if it takes longer than the specified timeout.
 @param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
 
 @param onChunk - Callback that is called for each chunk of the stream. The stream processing will pause until the callback promise is resolved.
@@ -2621,7 +2628,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 ToolSet, OUTPUT extends Output = Output<string, string>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, stopWhen, experimental_output, output, experimental_telemetry: telemetry, prepareStep, providerOptions, experimental_activeTools, activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, experimental_download: download, includeRawChunks, onChunk, onError, onFinish, onAbort, onStepFinish, experimental_context, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends ToolSet, OUTPUT extends Output = Output<string, string>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, timeout, headers, stopWhen, experimental_output, output, experimental_telemetry: telemetry, prepareStep, providerOptions, experimental_activeTools, activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, experimental_download: download, includeRawChunks, onChunk, onError, onFinish, onAbort, onStepFinish, experimental_context, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -2784,6 +2791,10 @@ type AgentCallParameters<CALL_OPTIONS> = ([CALL_OPTIONS] extends [never] ? {
      * Abort signal.
      */
     abortSignal?: AbortSignal;
+    /**
+     * Timeout in milliseconds.
+     */
+    timeout?: number;
 };
 /**
  * Parameters for streaming an output from an agent.
@@ -2979,11 +2990,11 @@ declare class ToolLoopAgent<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OU
     /**
      * Generates an output from the agent (non-streaming).
      */
-    generate({ abortSignal, ...options }: AgentCallParameters<CALL_OPTIONS>): Promise<GenerateTextResult<TOOLS, OUTPUT>>;
+    generate({ abortSignal, timeout, ...options }: AgentCallParameters<CALL_OPTIONS>): Promise<GenerateTextResult<TOOLS, OUTPUT>>;
     /**
      * Streams an output from the agent (streaming).
      */
-    stream({ abortSignal, experimental_transform, ...options }: AgentStreamParameters<CALL_OPTIONS, TOOLS>): Promise<StreamTextResult<TOOLS, OUTPUT>>;
+    stream({ abortSignal, timeout, experimental_transform, ...options }: AgentStreamParameters<CALL_OPTIONS, TOOLS>): Promise<StreamTextResult<TOOLS, OUTPUT>>;
 }
 
 /**
@@ -3008,6 +3019,7 @@ declare function createAgentUIStreamResponse<CALL_OPTIONS = never, TOOLS extends
     agent: Agent<CALL_OPTIONS, TOOLS, OUTPUT>;
     uiMessages: unknown[];
     abortSignal?: AbortSignal;
+    timeout?: number;
     options?: CALL_OPTIONS;
     experimental_transform?: StreamTextTransform<TOOLS> | Array<StreamTextTransform<TOOLS>>;
 } & UIMessageStreamResponseInit & UIMessageStreamOptions<UIMessage<MESSAGE_METADATA, never, InferUITools<TOOLS>>>): Promise<Response>;
@@ -3718,15 +3730,17 @@ declare const UI_MESSAGE_STREAM_HEADERS: {
  * @param agent - The agent to run.
  * @param uiMessages - The input UI messages.
  * @param abortSignal - The abort signal. Optional.
+ * @param timeout - Timeout in milliseconds. Optional.
  * @param options - The options for the agent.
  * @param experimental_transform - The stream transformations. Optional.
  *
  * @returns The UI message stream.
  */
-declare function createAgentUIStream<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ agent, uiMessages, options, abortSignal, experimental_transform, ...uiMessageStreamOptions }: {
+declare function createAgentUIStream<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ agent, uiMessages, options, abortSignal, timeout, experimental_transform, ...uiMessageStreamOptions }: {
     agent: Agent<CALL_OPTIONS, TOOLS, OUTPUT>;
     uiMessages: unknown[];
     abortSignal?: AbortSignal;
+    timeout?: number;
     options?: CALL_OPTIONS;
     experimental_transform?: StreamTextTransform<TOOLS> | Array<StreamTextTransform<TOOLS>>;
 } & UIMessageStreamOptions<UIMessage<MESSAGE_METADATA, never, InferUITools<TOOLS>>>): Promise<AsyncIterableStream<InferUIMessageChunk<UIMessage<MESSAGE_METADATA, never, InferUITools<TOOLS>>>>>;
@@ -3742,6 +3756,7 @@ declare function pipeAgentUIStreamToResponse<CALL_OPTIONS = never, TOOLS extends
     agent: Agent<CALL_OPTIONS, TOOLS, OUTPUT>;
     uiMessages: unknown[];
     abortSignal?: AbortSignal;
+    timeout?: number;
     options?: CALL_OPTIONS;
     experimental_transform?: StreamTextTransform<TOOLS> | Array<StreamTextTransform<TOOLS>>;
 } & UIMessageStreamResponseInit & UIMessageStreamOptions<UIMessage<MESSAGE_METADATA, never, InferUITools<TOOLS>>>): Promise<void>;

package/dist/index.js

@@ -1001,7 +1001,7 @@ var import_provider_utils3 = require("@ai-sdk/provider-utils");
 var import_provider_utils4 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "6.0.13" : "0.0.0-test";
+var VERSION = true ? "6.0.14" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({ url }) => {
@@ -3582,6 +3582,34 @@ async function toResponseMessages({
   return responseMessages;
 }
 
+// src/util/merge-abort-signals.ts
+function mergeAbortSignals(...signals) {
+  const validSignals = signals.filter(
+    (signal) => signal != null
+  );
+  if (validSignals.length === 0) {
+    return void 0;
+  }
+  if (validSignals.length === 1) {
+    return validSignals[0];
+  }
+  const controller = new AbortController();
+  for (const signal of validSignals) {
+    if (signal.aborted) {
+      controller.abort(signal.reason);
+      return controller.signal;
+    }
+    signal.addEventListener(
+      "abort",
+      () => {
+        controller.abort(signal.reason);
+      },
+      { once: true }
+    );
+  }
+  return controller.signal;
+}
+
 // src/generate-text/generate-text.ts
 var originalGenerateId = (0, import_provider_utils15.createIdGenerator)({
   prefix: "aitxt",
@@ -3596,6 +3624,7 @@ async function generateText({
   messages,
   maxRetries: maxRetriesArg,
   abortSignal,
+  timeout,
   headers,
   stopWhen = stepCountIs(1),
   experimental_output,
@@ -3619,9 +3648,13 @@ async function generateText({
 }) {
   const model = resolveLanguageModel(modelArg);
   const stopConditions = asArray(stopWhen);
+  const mergedAbortSignal = mergeAbortSignals(
+    abortSignal,
+    timeout != null ? AbortSignal.timeout(timeout) : void 0
+  );
   const { maxRetries, retry } = prepareRetries({
     maxRetries: maxRetriesArg,
-    abortSignal
+    abortSignal: mergedAbortSignal
   });
   const callSettings = prepareCallSettings(settings);
   const headersWithUserAgent = (0, import_provider_utils15.withUserAgentSuffix)(
@@ -3678,7 +3711,7 @@ async function generateText({
             tracer,
             telemetry,
             messages: initialMessages,
-            abortSignal,
+            abortSignal: mergedAbortSignal,
             experimental_context
           });
           const toolContent = [];
@@ -3824,7 +3857,7 @@ async function generateText({
                     responseFormat: await (output == null ? void 0 : output.responseFormat),
                     prompt: promptMessages,
                     providerOptions: stepProviderOptions,
-                    abortSignal,
+                    abortSignal: mergedAbortSignal,
                     headers: headersWithUserAgent
                   });
                   const responseData = {
@@ -3900,7 +3933,7 @@ async function generateText({
                 input: toolCall.input,
                 toolCallId: toolCall.toolCallId,
                 messages: stepInputMessages,
-                abortSignal,
+                abortSignal: mergedAbortSignal,
                 experimental_context
               });
             }
@@ -3944,7 +3977,7 @@ async function generateText({
                 tracer,
                 telemetry,
                 messages: stepInputMessages,
-                abortSignal,
+                abortSignal: mergedAbortSignal,
                 experimental_context
               })
             );
@@ -5674,6 +5707,7 @@ function streamText({
   messages,
   maxRetries,
   abortSignal,
+  timeout,
   headers,
   stopWhen = stepCountIs(1),
   experimental_output,
@@ -5708,7 +5742,10 @@ function streamText({
     headers,
     settings,
     maxRetries,
-    abortSignal,
+    abortSignal: mergeAbortSignals(
+      abortSignal,
+      timeout != null ? AbortSignal.timeout(timeout) : void 0
+    ),
     system,
     prompt,
     messages,
@@ -7204,11 +7241,13 @@ var ToolLoopAgent = class {
    */
   async generate({
     abortSignal,
+    timeout,
     ...options
   }) {
     return generateText({
       ...await this.prepareCall(options),
-      abortSignal
+      abortSignal,
+      timeout
     });
   }
   /**
@@ -7216,12 +7255,14 @@ var ToolLoopAgent = class {
    */
   async stream({
     abortSignal,
+    timeout,
     experimental_transform,
     ...options
   }) {
     return streamText({
       ...await this.prepareCall(options),
       abortSignal,
+      timeout,
       experimental_transform
     });
   }
@@ -7975,6 +8016,7 @@ async function createAgentUIStream({
   uiMessages,
   options,
   abortSignal,
+  timeout,
   experimental_transform,
   ...uiMessageStreamOptions
 }) {
@@ -7989,6 +8031,7 @@ async function createAgentUIStream({
     prompt: modelMessages,
     options,
     abortSignal,
+    timeout,
     experimental_transform
   });
   return result.toUIMessageStream(uiMessageStreamOptions);