@upstash/workflow 0.2.22-rc → 0.3.0-rc

package/tanstack.mjs

@@ -2,7 +2,7 @@ import {
   SDK_TELEMETRY,
   serveBase,
   serveManyBase
-} from "./chunk-CAQSUCHB.mjs";
+} from "./chunk-AGYYZKP7.mjs";
 
 // platforms/tanstack.ts
 var telemetry = {

package/{types-Q3dM0UlR.d.ts → types-DESkn7K9.d.mts}

@@ -1,8 +1,5 @@
-import { QstashError, PublishRequest, FlowControl, Client, Receiver, HTTPMethods as HTTPMethods$1 } from '@upstash/qstash';
-import { ZodType, z } from 'zod';
-import * as ai from 'ai';
-import { CoreTool, generateText } from 'ai';
-import { createOpenAI } from '@ai-sdk/openai';
+import { QstashError, PublishRequest, FlowControl, HTTPMethods as HTTPMethods$1, Client, Receiver } from '@upstash/qstash';
+import { z } from 'zod';
 
 /**
  * Error raised during Workflow execution
@@ -38,6 +35,14 @@ declare class WorkflowNonRetryableError extends WorkflowAbort {
      */
     constructor(message?: string);
 }
+declare class WorkflowRetryAfterError extends WorkflowAbort {
+    retryAfter: number | Duration;
+    /**
+     * @param retryAfter time in seconds after which the workflow should be retried
+     * @param message error message to be displayed
+     */
+    constructor(message: string, retryAfter: number | Duration);
+}
 
 declare const LOG_LEVELS: readonly ["DEBUG", "INFO", "SUBMIT", "WARN", "ERROR"];
 type LogLevel = (typeof LOG_LEVELS)[number];
@@ -453,304 +458,6 @@ declare class WorkflowApi extends BaseWorkflowApi {
     get anthropic(): AnthropicAPI;
 }
 
-/**
- * An Agent which utilizes the model and tools available to it
- * to achieve a given task
- *
- * @param name Name of the agent
- * @param background Background of the agent
- * @param model LLM model to use
- * @param tools tools available to the agent
- * @param maxSteps number of times the agent can call the LLM at most. If
- *   the agent abruptly stops execution after calling tools, you may need
- *   to increase maxSteps
- * @param temparature temparature used when calling the LLM
- */
-declare class Agent {
-    readonly name: AgentParameters["name"];
-    readonly tools: AgentParameters["tools"];
-    readonly maxSteps: AgentParameters["maxSteps"];
-    readonly background: AgentParameters["background"];
-    readonly model: AgentParameters["model"];
-    readonly temparature: AgentParameters["temparature"];
-    private readonly context;
-    constructor({ tools, maxSteps, background, name, model, temparature }: AgentParameters, context: WorkflowContext);
-    /**
-     * Trigger the agent by passing a prompt
-     *
-     * @param prompt task to assign to the agent
-     * @returns Response as `{ text: string }`
-     */
-    call({ prompt }: {
-        prompt: string;
-    }): Promise<{
-        text: string;
-    }>;
-    /**
-     * Convert the agent to a tool which can be used by other agents.
-     *
-     * @returns the agent as a tool
-     */
-    asTool(): AISDKTool;
-}
-
-declare class WorkflowTool<TSchema extends ZodType = ZodType> implements LangchainTool {
-    /**
-     * description of the tool
-     */
-    readonly description: string;
-    /**
-     * schema of the tool
-     */
-    readonly schema: TSchema;
-    /**
-     * function to invoke the tool
-     */
-    readonly invoke: (params: z.infer<TSchema>) => any;
-    /**
-     * whether the invoke method of the tool is to be wrapped with `context.run`
-     */
-    readonly executeAsStep: boolean;
-    /**
-     *
-     * @param description description of the tool
-     * @param schema schema of the tool
-     * @param invoke function to invoke the tool
-     * @param executeAsStep whether the invoke method of the tool is to be wrapped with `context.run`
-     */
-    constructor(params: {
-        /**
-         * description of the tool
-         */
-        description: string;
-        /**
-         * schema of the tool
-         */
-        schema: TSchema;
-        /**
-         * invoke function to invoke the tool
-         */
-        invoke: (params: z.infer<TSchema>) => any;
-        /**
-         * whether the invoke method is to be wrapped with `context.run`.
-         *
-         * When you pass a LangChain, AI SDK tool or a WorkflowTool to your agent,
-         * the execute/invoke method of the tool is wrapped with `context.run` by default.
-         *
-         * This option allows you to disable this behavior.
-         *
-         * You may want to disable wrapping with context.run if you want to run context.run,
-         * context.call or any other workflow step yourself in the execute/invoke method
-         * of the tool.
-         *
-         * @default true
-         */
-        executeAsStep?: boolean;
-    });
-}
-
-type AISDKTool = CoreTool;
-type LangchainTool = {
-    description: string;
-    schema: AISDKTool["parameters"];
-    invoke: (...params: any[]) => any;
-};
-type GenerateTextParams = Parameters<typeof generateText>[0];
-type Model = GenerateTextParams["model"];
-type AgentParameters<TTool extends AISDKTool | LangchainTool | WorkflowTool = AISDKTool> = {
-    /**
-     * number of times the agent can call the LLM at most. If
-     * the agent abruptly stops execution after calling tools, you may need
-     * to increase maxSteps
-     */
-    maxSteps: number;
-    /**
-     * Background of the agent
-     */
-    background: string;
-    /**
-     * tools available to the agent
-     */
-    tools: Record<string, TTool>;
-    /**
-     * Name of the agent
-     */
-    name: string;
-    /**
-     * LLM model to use
-     */
-    model: Model;
-    /**
-     * temparature used when calling the LLM
-     *
-     * @default 0.1
-     */
-    temparature?: number;
-};
-type TaskParams = {
-    /**
-     * task assigned to the agent
-     */
-    prompt: string;
-};
-type SingleAgentTaskParams = TaskParams & {
-    /**
-     * agent to perform the task
-     */
-    agent: Agent;
-};
-type MultiAgentTaskParams = TaskParams & {
-    /**
-     * Agents which will collaborate to achieve the task
-     */
-    agents: Agent[];
-    /**
-     * number of times the manager agent can call the LLM at most.
-     * If the agent abruptly stops execution after calling other agents, you may
-     * need to increase maxSteps
-     */
-    maxSteps: number;
-    /**
-     * LLM model to use
-     */
-    model: Model;
-    /**
-     * Background of the agent. If not passed, default will be used.
-     */
-    background?: string;
-};
-type ModelParams = Parameters<ReturnType<typeof createOpenAI>>;
-type AgentCallParams = Pick<CallSettings, "flowControl" | "retries" | "timeout" | "retryDelay">;
-type CustomModelSettings = ModelParams["1"] & {
-    baseURL?: string;
-    apiKey?: string;
-} & {
-    callSettings: AgentCallParams;
-};
-type CustomModelParams = [ModelParams[0], CustomModelSettings?];
-type ProviderFunction = (params: {
-    fetch: typeof fetch;
-}) => any;
-
-/**
- * An Agent Task
- *
- * Can be run to make the agent(s) complete it using the tools available to them
- *
- * Can consist of a single agent or multiple agents.
- *
- * Single agent:
- *
- * ```ts
- * const task = context.agents.task({
- *   agent: researcherAgent,
- *   prompt: "Tell me about 5 topics in advanced physics.",
- * });
- * const { text } = await task.run();
- * ```
- *
- * Multi Agent:
- *
- * ```ts
- * const task = context.agents.task({
- *   model,
- *   maxSteps: 3,
- *   agents: [researcherAgent, mathAgent],
- *   prompt: "Tell me about 3 cities in Japan and calculate the sum of their populations",
- * });
- * const { text } = await task.run();
- * ```
- */
-declare class Task {
-    private readonly context;
-    private readonly taskParameters;
-    constructor({ context, taskParameters, }: {
-        context: WorkflowContext;
-        taskParameters: SingleAgentTaskParams | MultiAgentTaskParams;
-    });
-    /**
-     * Run the agents to complete the task
-     *
-     * @returns Result of the task as { text: string }
-     */
-    run(): Promise<{
-        text: string;
-    }>;
-}
-
-/**
- * Workflow Agents API
- *
- * https://upstash.com/docs/workflow/agents/overview
- *
- * Allows defining agents which can complete a given task
- * using tools available to them.
- */
-declare class WorkflowAgents {
-    private context;
-    constructor({ context }: {
-        context: WorkflowContext;
-    });
-    /**
-     * Defines an agent
-     *
-     * ```ts
-     * const researcherAgent = context.agents.agent({
-     *   model,
-     *   name: 'academic',
-     *   maxSteps: 2,
-     *   tools: {
-     *     wikiTool: new WikipediaQueryRun({
-     *       topKResults: 1,
-     *       maxDocContentLength: 500,
-     *     })
-     *   },
-     *   background:
-     *     'You are researcher agent with access to Wikipedia. ' +
-     *     'Utilize Wikipedia as much as possible for correct information',
-     * });
-     * ```
-     *
-     * @param params agent parameters
-     * @returns
-     */
-    agent(params: AgentParameters<AISDKTool | LangchainTool>): Agent;
-    /**
-     * Defines a task to be executed by a single agent
-     *
-     * ```ts
-     * const task = context.agents.task({
-     *   agent: researcherAgent,
-     *   prompt: "Tell me about 5 topics in advanced physics.",
-     * });
-     * ```
-     */
-    task(taskParameters: SingleAgentTaskParams): Task;
-    /**
-     * Defines a task to be executed by multiple collaborating agents
-     *
-     * ```ts
-     * const task = context.agents.task({
-     *  model,
-     *  maxSteps: 3,
-     *  agents: [researcherAgent, mathAgent],
-     *  prompt: "Tell me about 3 cities in Japan and calculate the sum of their populations",
-     * });
-     * ```
-     */
-    task(taskParameters: MultiAgentTaskParams): Task;
-    /**
-     * creates an openai model for agents
-     */
-    openai(...params: CustomModelParams): ai.LanguageModelV1;
-    AISDKModel: <TProvider extends ProviderFunction>({ context, provider, providerParams, agentCallParams, }: {
-        context: WorkflowContext;
-        provider: TProvider;
-        providerParams?: Omit<Required<Parameters<TProvider>>[0], "fetch">;
-        agentCallParams?: AgentCallParams;
-    }) => ReturnType<TProvider>;
-}
-
 /**
  * Upstash Workflow context
  *
@@ -1109,7 +816,6 @@ declare class WorkflowContext<TInitialPayload = unknown> {
      */
     protected addStep<TResult = unknown>(step: BaseLazyStep<TResult>): Promise<TResult>;
     get api(): WorkflowApi;
-    get agents(): WorkflowAgents;
 }
 
 /**
@@ -1223,6 +929,9 @@ type DetailedFinishCondition = {
 } | {
     condition: "non-retryable-error";
     result: WorkflowNonRetryableError;
+} | {
+    condition: "retry-after-error";
+    result: WorkflowRetryAfterError;
 } | {
     condition: "failure-callback";
     result: string | void;
@@ -1282,7 +991,7 @@ type WorkflowServeOptions<TResponse extends Response = Response, TInitialPayload
      * @returns void
      */
     failureFunction?: (failureData: {
-        context: Omit<WorkflowContext<TInitialPayload>, "run" | "sleepUntil" | "sleep" | "call" | "waitForEvent" | "notify" | "cancel" | "api" | "invoke" | "agents">;
+        context: Omit<WorkflowContext<TInitialPayload>, "run" | "sleepUntil" | "sleep" | "call" | "waitForEvent" | "notify" | "cancel" | "api" | "invoke">;
         failStatus: number;
         failResponse: string;
         failHeaders: Record<string, string[]>;
@@ -1628,4 +1337,4 @@ type InvokableWorkflow<TInitialPayload, TResult> = {
     workflowId?: string;
 };
 
-export { type AsyncStepFunction as A, type WorkflowLoggerOptions as B, type CallResponse as C, type DetailedFinishCondition as D, type ExclusiveValidationOptions as E, type FinishCondition as F, WorkflowLogger as G, type HeaderParams as H, type InvokeWorkflowRequest as I, type LazyInvokeStepParams as L, type NotifyResponse as N, type ParallelCallState as P, type RouteFunction as R, type StepType as S, type Telemetry as T, type WorkflowServeOptions as W, type RawStep as a, type Waiter as b, WorkflowError as c, WorkflowAbort as d, WorkflowNonRetryableError as e, WorkflowTool as f, WorkflowContext as g, type WorkflowClient as h, type WorkflowReceiver as i, StepTypes as j, type Step as k, type SyncStepFunction as l, type StepFunction as m, type PublicServeOptions as n, type FailureFunctionPayload as o, type RequiredExceptFields as p, type WaitRequest as q, type WaitStepResponse as r, type NotifyStepResponse as s, type Duration as t, type WaitEventOptions as u, type StringifyBody as v, type CallSettings as w, type InvokeStepResponse as x, type InvokableWorkflow as y, type LogLevel as z };
+export { type AsyncStepFunction as A, type WorkflowLoggerOptions as B, type CallResponse as C, type DetailedFinishCondition as D, type ExclusiveValidationOptions as E, type FinishCondition as F, WorkflowLogger as G, type HeaderParams as H, type InvokeWorkflowRequest as I, type LazyInvokeStepParams as L, type NotifyResponse as N, type ParallelCallState as P, type RouteFunction as R, type StepType as S, type Telemetry as T, type WorkflowServeOptions as W, type RawStep as a, type Waiter as b, WorkflowError as c, WorkflowAbort as d, WorkflowNonRetryableError as e, WorkflowRetryAfterError as f, WorkflowContext as g, type WorkflowClient as h, type WorkflowReceiver as i, StepTypes as j, type Step as k, type SyncStepFunction as l, type StepFunction as m, type PublicServeOptions as n, type FailureFunctionPayload as o, type RequiredExceptFields as p, type WaitRequest as q, type WaitStepResponse as r, type NotifyStepResponse as s, type Duration as t, type WaitEventOptions as u, type StringifyBody as v, type CallSettings as w, type InvokeStepResponse as x, type InvokableWorkflow as y, type LogLevel as z };