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

package/src/types.ts

@@ -27,21 +27,25 @@ export type GenerateTextOptions = Parameters<typeof generateText>[0];
 
 export type StreamTextOptions = Parameters<typeof streamText>[0];
 
-export type CostFunction<TEvent extends EventObject> = (
-  path: AgentPath<TEvent>
+export type CostFunction<TAgent extends AnyAgent> = (
+  path: AgentPath<TAgent>
 ) => number;
 
-export type AgentPlanInput<TEvent extends EventObject> = Omit<
-  AgentGenerateTextOptions,
+export type AgentDecideInput<TAgent extends AnyAgent> = Omit<
+  AgentGenerateTextOptions<TAgent>,
   'prompt' | 'tools'
 > & {
   /**
    * The currently observed state.
    */
-  state: ObservedState;
+  state: ObservedState<TAgent>;
+  /**
+   * The context to provide in the prompt to the agent. This overrides the `state.context`.
+   */
+  context?: Record<string, any>;
   /**
    * The goal for the agent to accomplish.
-   * The agent will create a plan based on this goal.
+   * The agent will make a decision based on this goal.
    */
   goal: string;
   /**
@@ -54,58 +58,55 @@ export type AgentPlanInput<TEvent extends EventObject> = Omit<
    * is interacting with.
    */
   machine?: AnyStateMachine;
-  /**
-   * The previous plan.
-   */
-  previousPlan?: AgentPlan<TEvent>;
 
   /**
    * The total cost of the path to the goal state.
    */
-  costFunction?: CostFunction<TEvent>;
+  costFunction?: CostFunction<TAgent>;
 
   /**
-   * The maximum number of attempts to generate a plan.
+   * The maximum number of attempts to make a decision.
    * Defaults to 2.
    */
   maxAttempts?: number;
 };
 
-export type AgentStep<TEvent extends EventObject> = {
+export type AgentStep<TAgent extends AnyAgent> = {
   /** The event to take */
-  event: TEvent;
+  event: EventFromAgent<TAgent>;
   /** The next expected state after taking the event */
-  state: ObservedState | undefined;
+  state: ObservedState<TAgent> | undefined;
 };
 
-export type AgentPath<TEvent extends EventObject> = {
+export type AgentPath<TAgent extends AnyAgent> = {
   /** The expected ending state of the path */
-  state: ObservedState | undefined;
+  state: ObservedState<TAgent> | undefined;
   /** The steps to reach the ending state */
-  steps: Array<AgentStep<TEvent>>;
+  steps: Array<AgentStep<TAgent>>;
   weight?: number;
 };
 
-export type AgentPlan<TEvent extends EventObject> = {
+export type AgentDecision<TAgent extends AnyAgent> = {
+  id: string;
   /**
-   * The planner used to generate the plan
+   * The strategy used to generate the decision
    */
-  planner: string;
+  strategy: string;
   goal: string;
   /**
-   * The ending state of the plan.
+   * The ending state of the decision.
    */
-  goalState: ObservedState | undefined;
+  goalState: ObservedState<TAgent> | undefined;
   /**
    * The next event that the agent decided needs to occur to achieve the `goal`.
    *
    * This next event is chosen from the
    */
-  nextEvent: TEvent | undefined;
+  nextEvent: EventFromAgent<TAgent> | undefined;
   /**
    * The paths that the agent can take to achieve the goal.
    */
-  paths: AgentPath<TEvent>[];
+  paths: AgentPath<TAgent>[];
   episodeId: string;
   timestamp: number;
   // result: GenerateObjectResult<any>;
@@ -118,17 +119,13 @@ export interface TransitionData {
   target?: any;
 }
 
-export type PromptTemplate<TEvents extends EventObject> = (data: {
+export type PromptTemplate<TAgent extends AnyAgent> = (data: {
   goal: string;
   /**
    * The observed state
    */
-  state?: ObservedState;
-  /**
-   * The context to provide.
-   * This overrides the observed state.context, if provided.
-   */
-  context?: any;
+  stateValue?: any;
+  context?: Record<string, any>;
   /**
    * The state machine model of the observed environment
    */
@@ -144,22 +141,34 @@ export type PromptTemplate<TEvents extends EventObject> = (data: {
   observations?: AgentObservation<any>[]; // TODO
   feedback?: AgentFeedback[];
   messages?: AgentMessage[];
-  plans?: AgentPlan<TEvents>[];
+  decisions?: AgentDecision<TAgent>[];
 }) => string;
 
-export type AgentPlanner<T extends AnyAgent> = (
-  agent: T,
-  input: AgentPlanInput<T['types']['events']>
-) => Promise<AgentPlan<T['types']['events']> | undefined>;
+export type AgentStrategy<TAgent extends AnyAgent> = (
+  agent: TAgent,
+  input: AgentDecideInput<EventFromAgent<TAgent>>
+) => Promise<AgentDecision<TAgent> | undefined>;
+
+export type AgentInteractInput<T extends AnyAgent> = Omit<
+  AgentDecideOptions<T>,
+  'state'
+> & {
+  state?: never;
+};
 
-export type AgentDecideOptions<T extends AnyAgent> = {
+export type AgentDecideOptions<TAgent extends AnyAgent> = {
   goal: string;
-  model?: LanguageModel;
-  state: ObservedState;
+  state: ObservedState<TAgent>;
+  /**
+   * The context to provide in the prompt to the agent. This overrides the `state.context`.
+   */
+  context?: Record<string, any>;
   machine?: AnyStateMachine;
+  model?: LanguageModel;
   execute?: (event: AnyEventObject) => Promise<void>;
-  planner?: AgentPlanner<T>;
+  strategy?: AgentStrategy<TAgent>;
   events?: ZodEventMapping;
+  allowedEvents?: Array<EventFromAgent<TAgent>['type']>;
   /**
    * The maximum number of times the agent will attempt to make a decision.
    * Defaults to 2.
@@ -168,23 +177,23 @@ export type AgentDecideOptions<T extends AnyAgent> = {
 } & Omit<Parameters<typeof generateText>[0], 'model' | 'tools' | 'prompt'>;
 
 export interface AgentFeedback {
-  goal?: string;
-  observationId?: string;
+  observationId: string;
+  score: number;
+  comment: string | undefined;
   /**
    * The message correlation that the feedback is relevant for
    */
   attributes: Record<string, any>;
-  reward: number;
   timestamp: number;
   episodeId: string;
 }
 
 export interface AgentFeedbackInput {
-  goal?: string;
-  observationId?: string;
+  observationId: string;
+  score: number;
+  comment?: string;
   attributes?: Record<string, any>;
   timestamp?: number;
-  reward?: number;
 }
 
 export type AgentMessage = CoreMessage & {
@@ -327,6 +336,7 @@ export type AgentMessageInput = CoreMessage & {
 
 export interface AgentObservation<TActor extends ActorRefLike> {
   id: string;
+  goal?: string;
   prevState: SnapshotFrom<TActor> | undefined;
   event: EventFrom<TActor> | undefined;
   state: SnapshotFrom<TActor>;
@@ -335,13 +345,14 @@ export interface AgentObservation<TActor extends ActorRefLike> {
   timestamp: number;
 }
 
-export interface AgentObservationInput {
+export interface AgentObservationInput<TAgent extends AnyAgent> {
   id?: string;
-  prevState?: ObservedState;
+  prevState?: ObservedState<TAgent>;
   event?: AnyEventObject;
-  state: ObservedState;
+  state: ObservedState<TAgent>;
   machine?: AnyStateMachine;
   timestamp?: number;
+  goal: string | undefined;
 }
 
 export type AgentDecisionInput = {
@@ -350,12 +361,12 @@ export type AgentDecisionInput = {
   context?: Record<string, any>;
 } & Omit<Parameters<typeof generateText>[0], 'model' | 'tools' | 'prompt'>;
 
-export type AgentDecisionLogic<TEvents extends EventObject> = PromiseActorLogic<
-  AgentPlan<TEvents> | undefined,
+export type AgentDecisionLogic<TAgent extends AnyAgent> = PromiseActorLogic<
+  AgentDecision<TAgent> | undefined,
   AgentDecisionInput | string
 >;
 
-export type AgentEmitted<TEvents extends EventObject> =
+export type AgentEmitted<TAgent extends AnyAgent> =
   | {
       type: 'feedback';
       feedback: AgentFeedback;
@@ -369,12 +380,12 @@ export type AgentEmitted<TEvents extends EventObject> =
       message: AgentMessage;
     }
   | {
-      type: 'plan';
-      plan: AgentPlan<TEvents>;
+      type: 'decision';
+      decision: AgentDecision<TAgent>;
     };
 
-export type AgentLogic<TEvents extends EventObject> = ActorLogic<
-  TransitionSnapshot<AgentMemoryContext>,
+export type AgentLogic<TAgent extends AnyAgent> = ActorLogic<
+  TransitionSnapshot<AgentMemoryContext<TAgent>>,
   | {
       type: 'agent.feedback';
       feedback: AgentFeedback;
@@ -388,20 +399,22 @@ export type AgentLogic<TEvents extends EventObject> = ActorLogic<
       message: AgentMessage;
     }
   | {
-      type: 'agent.plan';
-      plan: AgentPlan<TEvents>;
+      type: 'agent.decision';
+      decision: AgentDecision<TAgent>;
     },
   any, // TODO: input
   any,
-  AgentEmitted<TEvents>
+  AgentEmitted<TAgent>
 >;
 
 export type EventsFromZodEventMapping<TEventSchemas extends ZodEventMapping> =
-  Values<{
-    [K in keyof TEventSchemas & string]: {
-      type: K;
-    } & TypeOf<TEventSchemas[K]>;
-  }>;
+  Compute<
+    Values<{
+      [K in keyof TEventSchemas & string]: {
+        type: K;
+      } & TypeOf<TEventSchemas[K]>;
+    }>
+  >;
 
 export type ContextFromZodContextMapping<
   TContextSchema extends ZodContextMapping
@@ -413,27 +426,27 @@ export type AnyAgent = Agent<any, any, any, any>;
 
 export type FromAgent<T> = T | ((agent: AnyAgent) => T | Promise<T>);
 
-export type CommonTextOptions = {
+export type CommonTextOptions<TAgent extends AnyAgent> = {
   prompt: FromAgent<string>;
   model?: LanguageModel;
-  context?: Record<string, any>;
   messages?: FromAgent<CoreMessage[]>;
   template?: PromptTemplate<any>;
+  context?: Record<string, any>;
 };
 
-export type AgentGenerateTextOptions = Omit<
+export type AgentGenerateTextOptions<TAgent extends AnyAgent> = Omit<
   GenerateTextOptions,
   'model' | 'prompt' | 'messages'
 > &
-  CommonTextOptions;
+  CommonTextOptions<TAgent>;
 
-export type AgentStreamTextOptions = Omit<
+export type AgentStreamTextOptions<TAgent extends AnyAgent> = Omit<
   StreamTextOptions,
   'model' | 'prompt' | 'messages'
 > &
-  CommonTextOptions;
+  CommonTextOptions<TAgent>;
 
-export interface ObservedState {
+export interface ObservedState<TAgent extends AnyAgent> {
   /**
    * The current state value of the state machine, e.g.
    * `"loading"` or `"processing"` or `"ready"`
@@ -442,7 +455,7 @@ export interface ObservedState {
   /**
    * Additional contextual data related to the current state
    */
-  context?: Record<string, unknown>;
+  context?: ContextFromAgent<TAgent>;
 }
 
 export type ObservedStateFrom<TActor extends ActorRefLike> = Pick<
@@ -450,25 +463,53 @@ export type ObservedStateFrom<TActor extends ActorRefLike> = Pick<
   'value' | 'context'
 >;
 
-export type AgentMemoryContext = {
-  observations: AgentObservation<any>[]; // TODO
+export type AgentMemoryContext<TAgent extends AnyAgent> = {
+  observations: AgentObservation<TAgent>[]; // TODO
   messages: AgentMessage[];
-  plans: AgentPlan<any>[];
+  decisions: AgentDecision<TAgent>[];
   feedback: AgentFeedback[];
 };
 
-export interface AgentLongTermMemory {
-  get<K extends keyof AgentMemoryContext>(
+export interface AgentLongTermMemory<TAgent extends AnyAgent> {
+  get<K extends keyof AgentMemoryContext<TAgent>>(
     key: K
-  ): Promise<AgentMemoryContext[K]>;
-  append<K extends keyof AgentMemoryContext>(
+  ): Promise<AgentMemoryContext<TAgent>[K]>;
+  append<K extends keyof AgentMemoryContext<TAgent>>(
     key: K,
-    item: AgentMemoryContext[K][0]
+    item: AgentMemoryContext<TAgent>[K][0]
   ): Promise<void>;
-  set<K extends keyof AgentMemoryContext>(
+  set<K extends keyof AgentMemoryContext<TAgent>>(
     key: K,
-    items: AgentMemoryContext[K]
+    items: AgentMemoryContext<TAgent>[K]
   ): Promise<void>;
 }
 
 export type Compute<A extends any> = { [K in keyof A]: A[K] } & unknown;
+
+export type MaybePromise<T> = T | Promise<T>;
+
+export type EventFromAgent<T extends AnyAgent> = T extends Agent<
+  infer _,
+  infer __,
+  infer TEvents,
+  infer ___
+>
+  ? TEvents
+  : never;
+
+export type TypesFromAgent<T extends AnyAgent> = T extends Agent<
+  infer TContextSchema,
+  infer TEventSchema
+>
+  ? {
+      context: ContextFromZodContextMapping<TContextSchema>;
+      events: EventsFromZodEventMapping<TEventSchema>;
+    }
+  : never;
+
+export type ContextFromAgent<T extends AnyAgent> = T extends Agent<
+  infer TContextSchema,
+  infer _TEventSchema
+>
+  ? ContextFromZodContextMapping<TContextSchema>
+  : never;

package/src/utils.ts

@@ -59,6 +59,18 @@ export function wrapInXml(tagName: string, content: string): string {
   return `<${tagName}>${content}</${tagName}>`;
 }
 
+export function convertToXml(obj: Record<string, any>): string {
+  return Object.entries(obj)
+    .map(([key, value]) => {
+      if (typeof value === 'object' && value !== null) {
+        return wrapInXml(key, convertToXml(value));
+      } else {
+        return wrapInXml(key, value);
+      }
+    })
+    .join('');
+}
+
 export function randomId(prefix?: string): string {
   const timestamp = Date.now().toString(36);
   const random = Math.random().toString(36).substring(2, 9);
@@ -89,7 +101,7 @@ export function isActorRef(
 }
 
 export function getTransitions(
-  state: ObservedState,
+  state: ObservedState<any>,
   machine: AnyStateMachine
 ): TransitionData[] {
   if (!machine) {

package/src/planners/shortestPath.ts

@@ -1,177 +0,0 @@
-import { generateObject } from 'ai';
-import {
-  AgentPlan,
-  AgentPlanInput,
-  AgentPlanner,
-  AgentStep,
-  AnyAgent,
-  CostFunction,
-  ObservedState,
-} from '../types';
-import { getShortestPaths } from '@xstate/graph';
-import { z } from 'zod';
-import { zodToJsonSchema } from 'zod-to-json-schema';
-import Ajv from 'ajv';
-import { AnyMachineSnapshot } from 'xstate';
-
-const ajv = new Ajv();
-
-function observedStatesEqual(state1: ObservedState, state2: ObservedState) {
-  // check state value && state context
-  return (
-    JSON.stringify(state1.value) === JSON.stringify(state2.value) &&
-    JSON.stringify(state1.context) === JSON.stringify(state2.context)
-  );
-}
-
-function trimSteps(steps: AgentStep<any>[], currentState: ObservedState) {
-  const index = steps.findIndex(
-    (step) => step.state && observedStatesEqual(step.state, currentState)
-  );
-
-  if (index === -1) {
-    return undefined;
-  }
-
-  return steps.slice(index + 1, steps.length);
-}
-
-export function experimental_createShortestPathPlanner<
-  T extends AnyAgent
->(): AgentPlanner<T> {
-  return async function shortestPathPlanner<T extends AnyAgent>(
-    agent: T,
-    input: AgentPlanInput<any>
-  ): Promise<AgentPlan<any> | undefined> {
-    const costFunction: CostFunction<any> =
-      input.costFunction ?? ((path) => path.weight ?? Infinity);
-    const existingPlan = agent
-      .getPlans()
-      .find((p) => p.planner === 'shortestPath' && p.goal === input.goal);
-
-    let paths = existingPlan?.paths;
-
-    if (existingPlan) {
-      console.log('Existing plan found');
-    }
-
-    if (!input.machine && !existingPlan) {
-      return;
-    }
-
-    if (input.machine && !existingPlan) {
-      const contextSchema = zodToJsonSchema(z.object(agent.context));
-      const result = await generateObject({
-        model: agent.model,
-        system: input.system ?? agent.description,
-        prompt: `
-  <goal>
-  ${input.goal}
-  </goal>
-  <contextSchema>
-  ${contextSchema}
-  </contextSchema>
-  
-  
-  Update the context JSON schema so that it validates the context to determine that it reaches the goal. Return the result as a diff.
-  
-  The contextSchema properties must not change. Do not add or remove properties, or modify the name of the properties.
-  Use "const" for exact required values and define ranges/types for flexible conditions.
-  
-  Examples:
-  1. For "user is logged in with admin role":
-  {
-    "contextSchema": "{"type": "object", "properties": {"role": {"const": "admin"}, "lastLogin": {"type": "string"}}, "required": ["role"]}"
-  }
-  
-  2. For "score is above 100":
-  {
-    "contextSchema": "{"type": "object", "properties": {"score": {"type": "number", "minimum": 100}}, "required": ["score"]}"
-  }
-
-  3. For "fruits contain apple, orange, banana":
-  {
-    "type": "array",
-    "allOf": [
-      { "contains": { "const": "apple" } },
-      { "contains": { "const": "orange" } },
-      { "contains": { "const": "banana" } }
-    ]
-  }
-      `.trim(),
-        schema: z.object({
-          // valueSchema: z
-          //   .string()
-          //   .describe('The JSON Schema representing the goal state value'),
-          contextSchema: z
-            .object({
-              type: z.literal('object'),
-              properties: z.object(
-                Object.keys((contextSchema as any).properties).reduce(
-                  (acc, key) => {
-                    acc[key] = z.any();
-                    return acc;
-                  },
-                  {} as any
-                )
-              ),
-              required: z.array(z.string()).optional(),
-            })
-            .describe('The JSON Schema representing the goal state context'),
-        }),
-      });
-
-      console.log(result.object);
-      const validateContext = ajv.compile(result.object.contextSchema);
-
-      const stateFilter = (state: AnyMachineSnapshot) => {
-        return validateContext(state.context);
-      };
-
-      const resolvedState = input.machine.resolveState({
-        ...input.state,
-        context: input.state.context ?? {},
-      });
-
-      paths = getShortestPaths(input.machine, {
-        fromState: resolvedState,
-        toState: stateFilter,
-      });
-    }
-
-    if (!paths) {
-      return undefined;
-    }
-
-    const trimmedPaths = paths
-      .map((path) => {
-        const trimmedSteps = trimSteps(path.steps, input.state);
-        if (!trimmedSteps) {
-          return undefined;
-        }
-        return {
-          ...path,
-          steps: trimmedSteps,
-        };
-      })
-      .filter((p): p is NonNullable<typeof p> => p !== undefined);
-
-    // Sort paths from least weight to most weight
-    const sortedPaths = trimmedPaths.sort(
-      (a, b) => costFunction(a) - costFunction(b)
-    );
-
-    const leastWeightPath = sortedPaths[0];
-    const nextStep = leastWeightPath?.steps[0];
-
-    return {
-      planner: 'shortestPath',
-      episodeId: agent.episodeId,
-      goal: input.goal,
-      goalState: paths[0]?.state,
-      nextEvent: nextStep?.event,
-      paths,
-      timestamp: Date.now(),
-    };
-  };
-}