@statelyai/agent 0.1.4 → 1.0.0-beta.1

package/dist/index.d.mts

@@ -4,14 +4,28 @@ import { generateText, streamText, LanguageModel, CoreMessage, GenerateTextResul
 
 type GenerateTextOptions = Parameters<typeof generateText>[0];
 type StreamTextOptions = Parameters<typeof streamText>[0];
-type AgentPlanInput<TEvent extends EventObject> = {
-    model: LanguageModel;
+type AgentPlanInput<TEvent extends EventObject> = Omit<GenerateTextOptions, 'prompt' | 'messages' | 'tools'> & {
+    /**
+     * The currently observed state.
+     */
     state: ObservedState;
+    /**
+     * The goal for the agent to accomplish.
+     * The agent will create a plan based on this goal.
+     */
     goal: string;
+    /**
+     * The events that the agent can trigger. This is a mapping of
+     * event types to Zod event schemas.
+     */
     events: ZodEventMapping;
+    /**
+     * The state machine that represents the environment the agent
+     * is interacting with.
+     */
     machine?: AnyStateMachine;
     /**
-     * The previous plan
+     * The previous plan.
      */
     previousPlan?: AgentPlan<TEvent>;
 };

package/dist/index.d.ts

@@ -4,14 +4,28 @@ import { generateText, streamText, LanguageModel, CoreMessage, GenerateTextResul
 
 type GenerateTextOptions = Parameters<typeof generateText>[0];
 type StreamTextOptions = Parameters<typeof streamText>[0];
-type AgentPlanInput<TEvent extends EventObject> = {
-    model: LanguageModel;
+type AgentPlanInput<TEvent extends EventObject> = Omit<GenerateTextOptions, 'prompt' | 'messages' | 'tools'> & {
+    /**
+     * The currently observed state.
+     */
     state: ObservedState;
+    /**
+     * The goal for the agent to accomplish.
+     * The agent will create a plan based on this goal.
+     */
     goal: string;
+    /**
+     * The events that the agent can trigger. This is a mapping of
+     * event types to Zod event schemas.
+     */
     events: ZodEventMapping;
+    /**
+     * The state machine that represents the environment the agent
+     * is interacting with.
+     */
     machine?: AnyStateMachine;
     /**
-     * The previous plan
+     * The previous plan.
      */
     previousPlan?: AgentPlan<TEvent>;
 };

package/dist/index.js

@@ -48,6 +48,11 @@ function getAllTransitions(state) {
 function wrapInXml(tagName, content) {
   return `<${tagName}>${content}</${tagName}>`;
 }
+function randomId() {
+  const timestamp = Date.now().toString(36);
+  const random = Math.random().toString(36).substring(2, 9);
+  return timestamp + random;
+}
 
 // src/templates/defaultText.ts
 var defaultTextTemplate = (data) => {
@@ -118,10 +123,10 @@ async function simplePlanner(agent, input) {
     goal: input.goal
   });
   const result = await agent.generateText({
+    ...input,
     prompt,
     tools: toolMap,
-    toolChoice: "required",
-    ...input
+    toolChoice: "required"
   });
   const singleResult = result.toolResults[0];
   if (!singleResult) {
@@ -144,7 +149,6 @@ async function simplePlanner(agent, input) {
 
 // src/text.ts
 var import_xstate = require("xstate");
-var import_nanoid = require("nanoid");
 async function getMessages(agent, prompt, options) {
   let messages = [];
   if (options.messages === true) {
@@ -166,7 +170,7 @@ async function agentGenerateText(agent, options) {
     ...options
   };
   const template = resolvedOptions.template ?? defaultTextTemplate;
-  const id = (0, import_nanoid.nanoid)();
+  const id = randomId();
   const goal = typeof resolvedOptions.prompt === "string" ? resolvedOptions.prompt : await resolvedOptions.prompt(agent);
   const promptWithContext = template({
     goal,
@@ -200,7 +204,7 @@ async function agentStreamText(agent, options) {
     ...options
   };
   const template = resolvedOptions.template ?? defaultTextTemplate;
-  const id = (0, import_nanoid.nanoid)();
+  const id = randomId();
   const goal = typeof resolvedOptions.prompt === "string" ? resolvedOptions.prompt : await resolvedOptions.prompt(agent);
   const promptWithContext = template({
     goal,
@@ -232,7 +236,7 @@ async function agentStreamText(agent, options) {
           rawResponse: res.rawResponse
         },
         content: res.text,
-        id: (0, import_nanoid.nanoid)(),
+        id: randomId(),
         timestamp: Date.now(),
         responseId: id
       });
@@ -352,7 +356,6 @@ var vercelAdapter = {
 };
 
 // src/agent.ts
-var import_nanoid2 = require("nanoid");
 var agentLogic = (0, import_xstate3.fromTransition)(
   (state, event, { emit }) => {
     switch (event.type) {
@@ -437,7 +440,7 @@ function createAgent({
   agent.addMessage = (messageInput) => {
     const message = {
       ...messageInput,
-      id: messageInput.id ?? (0, import_nanoid2.nanoid)(),
+      id: messageInput.id ?? randomId(),
       timestamp: messageInput.timestamp ?? Date.now(),
       sessionId: agent.sessionId
     };
@@ -464,7 +467,7 @@ function createAgent({
   agent.addObservation = (observationInput) => {
     const observation = {
       ...observationInput,
-      id: observationInput.id ?? (0, import_nanoid2.nanoid)(),
+      id: observationInput.id ?? randomId(),
       sessionId: agent.sessionId,
       timestamp: observationInput.timestamp ?? Date.now()
     };

package/dist/index.mjs

@@ -21,6 +21,11 @@ function getAllTransitions(state) {
 function wrapInXml(tagName, content) {
   return `<${tagName}>${content}</${tagName}>`;
 }
+function randomId() {
+  const timestamp = Date.now().toString(36);
+  const random = Math.random().toString(36).substring(2, 9);
+  return timestamp + random;
+}
 
 // src/templates/defaultText.ts
 var defaultTextTemplate = (data) => {
@@ -91,10 +96,10 @@ async function simplePlanner(agent, input) {
     goal: input.goal
   });
   const result = await agent.generateText({
+    ...input,
     prompt,
     tools: toolMap,
-    toolChoice: "required",
-    ...input
+    toolChoice: "required"
   });
   const singleResult = result.toolResults[0];
   if (!singleResult) {
@@ -121,7 +126,6 @@ import {
   fromPromise,
   toObserver
 } from "xstate";
-import { nanoid } from "nanoid";
 async function getMessages(agent, prompt, options) {
   let messages = [];
   if (options.messages === true) {
@@ -143,7 +147,7 @@ async function agentGenerateText(agent, options) {
     ...options
   };
   const template = resolvedOptions.template ?? defaultTextTemplate;
-  const id = nanoid();
+  const id = randomId();
   const goal = typeof resolvedOptions.prompt === "string" ? resolvedOptions.prompt : await resolvedOptions.prompt(agent);
   const promptWithContext = template({
     goal,
@@ -177,7 +181,7 @@ async function agentStreamText(agent, options) {
     ...options
   };
   const template = resolvedOptions.template ?? defaultTextTemplate;
-  const id = nanoid();
+  const id = randomId();
   const goal = typeof resolvedOptions.prompt === "string" ? resolvedOptions.prompt : await resolvedOptions.prompt(agent);
   const promptWithContext = template({
     goal,
@@ -209,7 +213,7 @@ async function agentStreamText(agent, options) {
           rawResponse: res.rawResponse
         },
         content: res.text,
-        id: nanoid(),
+        id: randomId(),
         timestamp: Date.now(),
         responseId: id
       });
@@ -329,7 +333,6 @@ var vercelAdapter = {
 };
 
 // src/agent.ts
-import { nanoid as nanoid2 } from "nanoid";
 var agentLogic = fromTransition(
   (state, event, { emit }) => {
     switch (event.type) {
@@ -414,7 +417,7 @@ function createAgent({
   agent.addMessage = (messageInput) => {
     const message = {
       ...messageInput,
-      id: messageInput.id ?? nanoid2(),
+      id: messageInput.id ?? randomId(),
       timestamp: messageInput.timestamp ?? Date.now(),
       sessionId: agent.sessionId
     };
@@ -441,7 +444,7 @@ function createAgent({
   agent.addObservation = (observationInput) => {
     const observation = {
       ...observationInput,
-      id: observationInput.id ?? nanoid2(),
+      id: observationInput.id ?? randomId(),
       sessionId: agent.sessionId,
       timestamp: observationInput.timestamp ?? Date.now()
     };

package/examples/ticTacToe.ts

@@ -2,7 +2,6 @@ import { assign, setup, assertEvent, createActor } from 'xstate';
 import { z } from 'zod';
 import { createAgent, fromDecision, fromTextStream } from '../src';
 import { openai } from '@ai-sdk/openai';
-import { defaultToolCallTemplate } from '../src/templates/defaultToolCall';
 
 const agent = createAgent({
   name: 'tic-tac-toe-bot',

package/examples/word.ts

@@ -12,7 +12,7 @@ const context = {
 
 const agent = createAgent({
   name: 'word',
-  model: openai('gpt-4-1106-preview'),
+  model: openai('gpt-4o'),
   events: {
     'agent.guessLetter': z.object({
       letter: z.string().min(1).max(1).describe('The letter guessed'),
@@ -42,12 +42,15 @@ const wordGuesserMachine = setup({
     agent: fromDecision(agent),
     getFromTerminal,
   },
+  actions: {
+    resetContext: assign(context),
+  },
 }).createMachine({
   initial: 'providingWord',
   context,
   states: {
     providingWord: {
-      entry: assign(context),
+      entry: 'resetContext',
       invoke: {
         src: 'getFromTerminal',
         input: 'Enter a word, and an agent will try to guess it.',

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@statelyai/agent",
-  "version": "0.1.4",
-  "description": "",
+  "version": "1.0.0-beta.1",
+  "description": "Stateful agents that make decisions based on finite-state machine models",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
@@ -9,13 +9,20 @@
     "build": "tsup src/index.ts --format cjs,esm --dts",
     "lint": "tsc --noEmit",
     "test": "vitest",
+    "test:ci": "vitest --run",
     "example": "ts-node examples/helpers/runner.ts",
     "prepublishOnly": "tsup src/index.ts --format cjs,esm --dts",
     "changeset": "changeset",
     "release": "changeset publish",
     "version": "changeset version"
   },
-  "keywords": [],
+  "keywords": [
+    "ai",
+    "state machine",
+    "agent",
+    "rl",
+    "reinforcement learning"
+  ],
   "author": "",
   "license": "MIT",
   "devDependencies": {
@@ -24,7 +31,7 @@
     "@langchain/community": "^0.0.53",
     "@langchain/core": "^0.1.63",
     "@langchain/openai": "^0.0.28",
-    "@types/node": "^20.14.2",
+    "@types/node": "^20.14.6",
     "dotenv": "^16.4.5",
     "json-schema-to-ts": "^3.1.0",
     "ts-node": "^10.9.2",
@@ -38,10 +45,9 @@
     "access": "public"
   },
   "dependencies": {
-    "@ai-sdk/openai": "^0.0.13",
+    "@ai-sdk/openai": "^0.0.31",
     "@xstate/graph": "^2.0.0",
-    "ai": "^3.1.32",
-    "nanoid": "^5.0.7",
+    "ai": "^3.2.1",
     "xstate": "^5.13.2"
   },
   "packageManager": "pnpm@8.11.0"

package/src/agent.ts

@@ -25,7 +25,7 @@ import { simplePlanner } from './planners/simplePlanner';
 import { agentGenerateText, agentStreamText } from './text';
 import { agentDecide } from './decision';
 import { vercelAdapter } from './adapters/vercel';
-import { nanoid } from 'nanoid';
+import { randomId } from './utils';
 
 export const agentLogic: AgentLogic<AnyEventObject> = fromTransition(
   (state, event, { emit }) => {
@@ -144,7 +144,7 @@ export function createAgent<
   agent.addMessage = (messageInput) => {
     const message = {
       ...messageInput,
-      id: messageInput.id ?? nanoid(),
+      id: messageInput.id ?? randomId(),
       timestamp: messageInput.timestamp ?? Date.now(),
       sessionId: agent.sessionId,
     };
@@ -176,7 +176,7 @@ export function createAgent<
   agent.addObservation = (observationInput) => {
     const observation = {
       ...observationInput,
-      id: observationInput.id ?? nanoid(),
+      id: observationInput.id ?? randomId(),
       sessionId: agent.sessionId,
       timestamp: observationInput.timestamp ?? Date.now(),
     };

package/src/planners/simplePlanner.ts

@@ -100,10 +100,10 @@ export async function simplePlanner<T extends Agent<any>>(
   });
 
   const result = await agent.generateText({
+    ...input,
     prompt,
     tools: toolMap,
     toolChoice: 'required',
-    ...input,
   });
 
   const singleResult = result.toolResults[0];

package/src/text.ts

@@ -19,7 +19,7 @@ import {
   fromPromise,
   toObserver,
 } from 'xstate';
-import { nanoid } from 'nanoid';
+import { randomId } from './utils';
 
 /**
  * Gets an array of messages from the given prompt, based on the agent and options.
@@ -61,7 +61,7 @@ export async function agentGenerateText<T extends Agent<any>>(
   };
   const template = resolvedOptions.template ?? defaultTextTemplate;
   // TODO: check if messages was provided instead
-  const id = nanoid();
+  const id = randomId();
   const goal =
     typeof resolvedOptions.prompt === 'string'
       ? resolvedOptions.prompt
@@ -109,7 +109,7 @@ export async function agentStreamText(
   };
   const template = resolvedOptions.template ?? defaultTextTemplate;
 
-  const id = nanoid();
+  const id = randomId();
   const goal =
     typeof resolvedOptions.prompt === 'string'
       ? resolvedOptions.prompt
@@ -148,7 +148,7 @@ export async function agentStreamText(
           rawResponse: res.rawResponse,
         },
         content: res.text,
-        id: nanoid(),
+        id: randomId(),
         timestamp: Date.now(),
         responseId: id,
       });

package/src/types.ts

@@ -29,14 +29,31 @@ export type GenerateTextOptions = Parameters<typeof generateText>[0];
 
 export type StreamTextOptions = Parameters<typeof streamText>[0];
 
-export type AgentPlanInput<TEvent extends EventObject> = {
-  model: LanguageModel;
+export type AgentPlanInput<TEvent extends EventObject> = Omit<
+  GenerateTextOptions,
+  'prompt' | 'messages' | 'tools'
+> & {
+  /**
+   * The currently observed state.
+   */
   state: ObservedState;
+  /**
+   * The goal for the agent to accomplish.
+   * The agent will create a plan based on this goal.
+   */
   goal: string;
+  /**
+   * The events that the agent can trigger. This is a mapping of
+   * event types to Zod event schemas.
+   */
   events: ZodEventMapping;
+  /**
+   * The state machine that represents the environment the agent
+   * is interacting with.
+   */
   machine?: AnyStateMachine;
   /**
-   * The previous plan
+   * The previous plan.
    */
   previousPlan?: AgentPlan<TEvent>;
 };

package/src/utils.ts

@@ -20,3 +20,9 @@ export function getAllTransitions(state: AnyMachineSnapshot): TransitionData[] {
 export function wrapInXml(tagName: string, content: string): string {
   return `<${tagName}>${content}</${tagName}>`;
 }
+
+export function randomId() {
+  const timestamp = Date.now().toString(36);
+  const random = Math.random().toString(36).substring(2, 9);
+  return timestamp + random;
+}