@statelyai/agent 2.0.0-next.0 → 2.0.0-next.1

package/dist/index.mjs

@@ -4,7 +4,7 @@ import {
   fromTransition
 } from "xstate";
 
-// src/planners/simplePlanner.ts
+// src/planners/simple.ts
 import { generateText as generateText2 } from "ai";
 
 // src/utils.ts
@@ -70,8 +70,11 @@ function getTransitions(state, machine) {
   });
   return getAllTransitions(resolvedState);
 }
+function isMachineActor(actor) {
+  return "src" in actor && typeof actor.src === "object" && actor.src !== null && "definition" in actor.src;
+}
 
-// src/planners/simplePlanner.ts
+// src/planners/simple.ts
 import { getNextSnapshot } from "xstate";
 
 // src/templates/defaultText.ts
@@ -189,19 +192,27 @@ async function agentDecide(agent, options) {
     state,
     machine,
     model = agent.model,
+    messages,
     ...otherPlanInput
   } = resolvedOptions;
-  const plan = await planner(agent, {
-    model,
-    goal,
-    events,
-    state,
-    machine,
-    ...otherPlanInput
-  });
-  if (plan?.nextEvent) {
-    agent.addPlan(plan);
-    await resolvedOptions.execute?.(plan.nextEvent);
+  let attempts = 0;
+  const maxAttempts = resolvedOptions.maxAttempts ?? 2;
+  let plan;
+  while (attempts++ < maxAttempts) {
+    plan = await planner(agent, {
+      model,
+      goal,
+      events,
+      state,
+      machine,
+      messages,
+      // TODO: fix UIMessage thing
+      ...otherPlanInput
+    });
+    if (plan?.nextEvent) {
+      agent.addPlan(plan);
+      await resolvedOptions.execute?.(plan.nextEvent);
+    }
   }
   return plan;
 }
@@ -275,7 +286,7 @@ function getToolMap(_agent, input) {
   return toolMap;
 }
 
-// src/planners/simplePlanner.ts
+// src/planners/simple.ts
 var simplePlannerPromptTemplate = (data) => {
   return `
 ${defaultTextTemplate(data)}
@@ -309,12 +320,13 @@ async function simplePlanner(agent, input) {
   }) : void 0;
   const result = await generateText2({
     ...rest,
+    system: input.system ?? agent.description,
     model,
     messages,
     tools: toolMap,
     toolChoice: input.toolChoice ?? "required"
   });
-  result.responseMessages.forEach((m) => {
+  result.response.messages.forEach((m) => {
     const message = m;
     agent.addMessage({
       ...message,
@@ -361,13 +373,11 @@ function createAgentMiddleware(agent) {
     },
     wrapGenerate: async ({ doGenerate, params }) => {
       const id = randomId();
-      params.prompt.forEach((p) => {
+      params.prompt.forEach((message) => {
         agent.addMessage({
           id,
-          ...p,
-          timestamp: Date.now(),
-          correlationId: params.providerMetadata?.correlationId,
-          parentCorrelationId: params.providerMetadata?.parentCorrelationId
+          ...message,
+          timestamp: Date.now()
         });
       });
       const result = await doGenerate();
@@ -380,9 +390,7 @@ function createAgentMiddleware(agent) {
         agent.addMessage({
           id,
           ...message,
-          timestamp: Date.now(),
-          correlationId: params.providerMetadata?.correlationId,
-          parentCorrelationId: params.providerMetadata?.parentCorrelationId
+          timestamp: Date.now()
         });
       });
       const { stream, ...rest } = await doStream();
@@ -407,9 +415,7 @@ function createAgentMiddleware(agent) {
             timestamp: Date.now(),
             role: "assistant",
             content,
-            responseId: id,
-            correlationId: params.providerMetadata?.correlationId,
-            parentCorrelationId: params.providerMetadata?.parentCorrelationId
+            responseId: id
           });
         }
       });
@@ -462,8 +468,10 @@ var agentLogic = fromTransition(
         });
         break;
       }
-      default:
+      default: {
+        console.warn("Unrecognized event", event);
         break;
+      }
     }
     return state;
   },
@@ -476,22 +484,17 @@ var agentLogic = fromTransition(
 );
 function createAgent({
   id,
-  name,
   description,
   model,
   events,
   context,
   planner = simplePlanner,
-  stringify = JSON.stringify,
-  getMemory,
-  logic = agentLogic,
-  ...generateTextOptions
+  logic = agentLogic
 }) {
   return new Agent({
     id,
     context,
     events,
-    name,
     description,
     planner,
     model,
@@ -602,7 +605,8 @@ var Agent = class extends Actor {
     return this.getSnapshot().context.plans;
   }
   interact(actorRef, getInput) {
-    const actorRefCheck = isActorRef(actorRef);
+    const actorRefCheck = isActorRef(actorRef) && actorRef.src;
+    const machine = isMachineActor(actorRef) ? actorRef.src : void 0;
     let prevState = void 0;
     let subscribed = true;
     const agent = this;
@@ -610,14 +614,14 @@ var Agent = class extends Actor {
       const observation = agent.addObservation(observationInput);
       const input = getInput?.(observation);
       if (input) {
-        await agentDecide(agent, {
-          machine: actorRefCheck ? actorRef.src : void 0,
+        const res = await agentDecide(agent, {
+          machine,
           state: observation.state,
-          execute: async (event) => {
-            actorRef.send(event);
-          },
           ...input
         });
+        if (res?.nextEvent) {
+          actorRef.send(res.nextEvent);
+        }
       }
       prevState = observationInput.state;
     }

package/examples/chatbot-alt.ts

@@ -4,7 +4,7 @@ import { openai } from '@ai-sdk/openai';
 import { getFromTerminal } from './helpers/helpers';
 
 const agent = createAgent({
-  name: 'chatbot',
+  id: 'chatbot',
   model: openai('gpt-4o-mini'),
   events: {
     'agent.respond': z.object({

package/examples/chatbot.ts

@@ -5,7 +5,7 @@ import { assign, createActor, log, setup } from 'xstate';
 import { fromTerminal } from './helpers/helpers';
 
 const agent = createAgent({
-  name: 'chatbot',
+  id: 'chatbot',
   model: openai('gpt-4o-mini'),
   events: {
     'agent.respond': z.object({

package/examples/cot.ts

@@ -5,7 +5,7 @@ import { assign, createActor, log, setup } from 'xstate';
 import { fromTerminal } from './helpers/helpers';
 
 const agent = createAgent({
-  name: 'chain-of-thought',
+  id: 'chain-of-thought',
   model: openai('gpt-4o-mini'),
   events: {
     'agent.think': z.object({

package/examples/customer-service-sim.ts

@@ -5,7 +5,7 @@ import { z } from 'zod';
 
 // Create customer service agent
 const customerServiceAgent = createAgent({
-  name: 'customer-service',
+  id: 'customer-service',
   model: openai('gpt-4o'),
   events: {
     'agent.respond': z.object({
@@ -14,12 +14,12 @@ const customerServiceAgent = createAgent({
         .describe('The response from the customer service agent'),
     }),
   },
-  system: 'You are a customer service agent for an airline.',
+  description: 'You are a customer service agent for an airline.',
 });
 
 // Create simulated customer agent
 const customerAgent = createAgent({
-  name: 'customer',
+  id: 'customer',
   model: openai('gpt-4o-mini'),
   events: {
     'agent.respond': z.object({
@@ -27,7 +27,7 @@ const customerAgent = createAgent({
     }),
     'agent.finish': z.object({}).describe('End the conversation'),
   },
-  system: `You are Harrison, a customer trying to get a refund for a trip to Alaska.
+  description: `You are Harrison, a customer trying to get a refund for a trip to Alaska.
 You want them to give you ALL the money back. Be extremely persistent. This trip happened 5 years ago.
 If you have nothing more to add to the conversation, send agent.finish event.`,
 });

package/examples/email.ts

@@ -5,8 +5,8 @@ import { assign, createActor, setup } from 'xstate';
 import { fromTerminal } from './helpers/helpers';
 
 const agent = createAgent({
-  name: 'email',
-  model: openai('gpt-4o'),
+  id: 'email',
+  model: openai('gpt-4o-mini'),
   events: {
     askForClarification: z.object({
       questions: z.array(z.string()).describe('The questions to ask the agent'),
@@ -15,6 +15,14 @@ const agent = createAgent({
       email: z.string().describe('The email to submit'),
     }),
   },
+  context: {
+    email: z.string().describe('The email to respond to'),
+    instructions: z.string().describe('The instructions for the email'),
+    clarifications: z
+      .array(z.string())
+      .describe('The clarifications to the email'),
+    replyEmail: z.string().nullable().describe('The email to submit'),
+  },
 });
 
 const machine = setup({
@@ -24,14 +32,9 @@ const machine = setup({
       email: string;
       instructions: string;
     },
-    context: {} as {
-      email: string;
-      instructions: string;
-      clarifications: string[];
-      replyEmail: string | null;
-    },
+    context: agent.types.context,
   },
-  actors: { agent: fromDecision(agent), getFromTerminal: fromTerminal },
+  actors: { getFromTerminal: fromTerminal },
 }).createMachine({
   initial: 'checking',
   context: ({ input }) => ({
@@ -42,18 +45,6 @@ const machine = setup({
   }),
   states: {
     checking: {
-      invoke: {
-        src: 'agent',
-        input: ({ context }) => ({
-          context: {
-            email: context.email,
-            instructions: context.instructions,
-            clarifications: context.clarifications,
-          },
-          messages: agent.getMessages(),
-          goal: 'Respond to the email given the instructions and the provided clarifications. If not enough information is provided, ask for clarification. Otherwise, if you are absolutely sure that there is no ambiguous or missing information, create and submit a response email.',
-        }),
-      },
       on: {
         askForClarification: {
           actions: ({ event }) => console.log(event.questions.join('\n')),
@@ -78,17 +69,6 @@ const machine = setup({
       },
     },
     submitting: {
-      invoke: {
-        src: 'agent',
-        input: ({ context }) => ({
-          context: {
-            email: context.email,
-            instructions: context.instructions,
-            clarifications: context.clarifications,
-          },
-          goal: `Create and submit an email based on the instructions.`,
-        }),
-      },
       on: {
         submitEmail: {
           actions: assign({
@@ -109,10 +89,26 @@ const machine = setup({
   },
 });
 
-createActor(machine, {
+const actor = createActor(machine, {
   input: {
     email: 'That sounds great! When are you available?',
     instructions:
       'Tell them exactly when I am available. Address them by his full (first and last) name.',
   },
 }).start();
+
+agent.interact(actor, ({ state }) => {
+  if (state.matches('checking')) {
+    return {
+      goal: 'Respond to the email given the instructions and the provided clarifications. If not enough information is provided, ask for clarification. Otherwise, if you are absolutely sure that there is no ambiguous or missing information, create and submit a response email.',
+      context: state.context,
+    };
+  }
+
+  if (state.matches('submitting')) {
+    return {
+      goal: 'Create and submit an email based on the instructions.',
+      context: state.context,
+    };
+  }
+});

package/examples/example.ts

@@ -4,7 +4,7 @@ import { openai } from '@ai-sdk/openai';
 import { assign, createActor, setup } from 'xstate';
 
 const agent = createAgent({
-  name: 'example',
+  id: 'example',
   model: openai('gpt-4o-mini'),
   events: {
     'agent.englishSummary': z.object({

package/examples/goal.ts

@@ -5,7 +5,7 @@ import { assign, createActor, log, setup } from 'xstate';
 import { fromTerminal } from './helpers/helpers';
 
 const agent = createAgent({
-  name: 'goal',
+  id: 'goal',
   model: openai('gpt-4o-mini'),
   events: {
     'agent.createGoal': z.object({

package/examples/joke.ts

@@ -45,7 +45,7 @@ const loader = fromCallback(({ input }: { input: string }) => {
 });
 
 const agent = createAgent({
-  name: 'joke-teller',
+  id: 'joke-teller',
   model: openai('gpt-4o-mini'),
   events: {
     askForTopic: z

package/examples/jugs.ts

@@ -2,10 +2,10 @@ import { createAgent } from '../src';
 import { assign, createActor, setup } from 'xstate';
 import { openai } from '@ai-sdk/openai';
 import { z } from 'zod';
-import { shortestPathPlanner } from '../src/planners/shortestPathPlanner';
+import { experimental_createShortestPathPlanner } from '../src/planners/shortestPath';
 
 const agent = createAgent({
-  name: 'die-hard-solver',
+  id: 'die-hard-solver',
   model: openai('gpt-4o'),
   events: {
     fill3: z.object({}).describe('Fill the 3-gallon jug'),
@@ -106,7 +106,7 @@ async function main() {
       machine: waterJugMachine,
       goal: 'Get exactly 4 gallons of water in the 5-gallon jug',
       state: waterJugActor.getSnapshot(),
-      planner: shortestPathPlanner,
+      planner: experimental_createShortestPathPlanner(),
     });
 
     console.log(decision?.nextEvent);

package/examples/multi.ts

@@ -5,7 +5,7 @@ import { fromTerminal } from './helpers/helpers';
 import { openai } from '@ai-sdk/openai';
 
 const agent = createAgent({
-  name: 'multi',
+  id: 'multi',
   model: openai('gpt-4o-mini'),
   events: {
     'agent.respond': z.object({

package/examples/number.ts

@@ -5,7 +5,7 @@ import { openai } from '@ai-sdk/openai';
 import { fromTerminal } from './helpers/helpers';
 
 const agent = createAgent({
-  name: 'number-guesser',
+  id: 'number-guesser',
   model: openai('gpt-3.5-turbo-1106'),
   events: {
     'agent.guess': z.object({

package/examples/raffle.ts

@@ -5,7 +5,7 @@ import { assign, createActor, log, setup } from 'xstate';
 import { fromTerminal } from './helpers/helpers';
 
 const agent = createAgent({
-  name: 'raffle-chooser',
+  id: 'raffle-chooser',
   model: openai('gpt-4o-mini'),
   events: {
     'agent.collectEntries': z.object({}).describe('Collect more entries'),

package/examples/river-crossing.ts

@@ -2,10 +2,10 @@ import { createAgent } from '../src';
 import { assign, createActor, setup } from 'xstate';
 import { openai } from '@ai-sdk/openai';
 import { z } from 'zod';
-import { shortestPathPlanner } from '../src/planners/shortestPathPlanner';
+import { experimental_createShortestPathPlanner } from '../src/planners/shortestPath';
 
 const agent = createAgent({
-  name: 'river-crossing-solver',
+  id: 'river-crossing-solver',
   model: openai('gpt-4'),
   events: {
     takeWolf: z
@@ -121,7 +121,7 @@ async function main() {
       machine: riverCrossingMachine,
       goal: 'Get all items safely across the river. Remember: Cannot leave wolf with goat or goat with cabbage unattended.',
       state: riverActor.getSnapshot(),
-      planner: shortestPathPlanner,
+      planner: experimental_createShortestPathPlanner(),
     });
 
     console.log(decision?.nextEvent);

package/examples/simple.ts

@@ -4,7 +4,7 @@ import { setup, createActor } from 'xstate';
 import { openai } from '@ai-sdk/openai';
 
 const agent = createAgent({
-  name: 'simple',
+  id: 'simple',
   model: openai('gpt-4o-mini'),
   events: {
     'agent.thought': z.object({

package/examples/summary.ts

@@ -5,7 +5,7 @@ import { openai } from '@ai-sdk/openai';
 import { fromTerminal } from './helpers/helpers';
 
 const agent = createAgent({
-  name: 'summarizing-chat',
+  id: 'summarizing-chat',
   model: openai('gpt-4o'),
   events: {
     'agent.respond': z.object({

package/examples/support.ts

@@ -4,7 +4,7 @@ import { z } from 'zod';
 import { createActor, log, setup } from 'xstate';
 
 const agent = createAgent({
-  name: 'support-agent',
+  id: 'support-agent',
   model: openai('gpt-4o-mini'),
   events: {
     'agent.respond': z.object({

package/examples/ticTacToe.ts

@@ -39,14 +39,14 @@ const context = {
 };
 
 const xAgent = createAgent({
-  name: 'tic-tac-toe-learner',
+  id: 'tic-tac-toe-learner',
   model: openai('gpt-4o-mini'),
   events,
   context,
 });
 
 const oAgent = createAgent({
-  name: 'tic-tac-toe-noob',
+  id: 'tic-tac-toe-noob',
   model: openai('gpt-4o-mini'),
   events,
   context,

package/examples/todo.ts

@@ -5,7 +5,7 @@ import { openai } from '@ai-sdk/openai';
 import { fromTerminal } from './helpers/helpers';
 
 const agent = createAgent({
-  name: 'todo',
+  id: 'todo',
   model: openai('gpt-4o-mini'),
   events: {
     addTodo: z.object({

package/examples/tutor.ts

@@ -5,7 +5,7 @@ import { z } from 'zod';
 import { openai } from '@ai-sdk/openai';
 
 const agent = createAgent({
-  name: 'tutor',
+  id: 'tutor',
   model: openai('gpt-4o-mini'),
   events: {
     teach: z.object({
@@ -19,7 +19,7 @@ const agent = createAgent({
       response: z.string().describe('The response to the human in Spanish'),
     }),
   },
-  system:
+  description:
     'You are an expert Spanish tutor. You will respond to the human in Spanish.',
 });
 

package/examples/verify.ts

@@ -5,7 +5,7 @@ import { z } from 'zod';
 import { openai } from '@ai-sdk/openai';
 
 const agent = createAgent({
-  name: 'verifier',
+  id: 'verifier',
   model: openai('gpt-3.5-turbo-16k-0613'),
   events: {
     'agent.validateAnswer': z.object({

package/examples/weather.ts

@@ -49,7 +49,7 @@ const getWeather = fromPromise(async ({ input }: { input: string }) => {
 });
 
 const agent = createAgent({
-  name: 'weather',
+  id: 'weather',
   model: openai('gpt-4o-mini'),
   events: {
     'agent.getWeather': z.object({

package/examples/wiki.ts

@@ -4,7 +4,7 @@ import { openai } from '@ai-sdk/openai';
 import { CoreMessage, generateText, streamText } from 'ai';
 
 const agent = createAgent({
-  name: 'wiki',
+  id: 'wiki',
   model: openai('gpt-4o-mini'),
   events: {
     provideAnswer: z.object({

package/examples/word.ts

@@ -5,7 +5,7 @@ import { z } from 'zod';
 import { openai } from '@ai-sdk/openai';
 
 const agent = createAgent({
-  name: 'word',
+  id: 'word',
   model: openai('gpt-4o-mini'),
   context: {
     word: z.string().nullable().describe('The word to guess'),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@statelyai/agent",
-  "version": "2.0.0-next.0",
+  "version": "2.0.0-next.1",
   "description": "Stateful agents that make decisions based on finite-state machine models",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -24,6 +24,7 @@
     "@tavily/core": "^0.0.2",
     "@types/node": "^20.17.1",
     "@types/object-hash": "^3.0.6",
+    "@vitest/coverage-v8": "^2.1.4",
     "dotenv": "^16.4.5",
     "json-schema-to-ts": "^3.1.1",
     "ts-node": "^10.9.2",
@@ -38,7 +39,7 @@
   },
   "dependencies": {
     "@xstate/graph": "^2.0.1",
-    "ai": "^3.4.20",
+    "ai": "^3.4.31",
     "ajv": "^8.17.1",
     "object-hash": "^3.0.0",
     "xstate": "^5.18.2",
@@ -52,6 +53,7 @@
     "example": "ts-node examples/helpers/runner.ts",
     "changeset": "changeset",
     "release": "changeset publish",
-    "version": "changeset version"
+    "version": "changeset version",
+    "coverage": "vitest run --coverage"
   }
 }