addHistory -> addMessage + changeset

.changeset/cuddly-pillows-glow.md

@@ -0,0 +1,17 @@
+---
+'@statelyai/agent': minor
+---
+
+First minor release of `@statelyai/agent`! The API has been simplified from experimental earlier versions. Here are the main methods:
+
+- `createAgent({ … })` creates an agent
+- `agent.decide({ … })` decides on a plan to achieve the goal
+- `agent.generateText({ … })` generates text based on a prompt
+- `agent.streamText({ … })` streams text based on a prompt
+- `agent.addObservation(observation)` adds an observation and returns a full observation object
+- `agent.addFeedback(feedback)` adds a feedback and returns a full feedback object
+- `agent.addMessage(message)` adds a message and returns a full message object
+- `agent.addPlan(plan)` adds a plan and returns a full plan object
+- `agent.onMessage(cb)` listens to messages
+- `agent.select(selector)` selects data from the agent context
+- `agent.interact(actorRef, getInput)` interacts with an actor and makes decisions to accomplish a goal

src/agent.test.ts

@@ -14,26 +14,26 @@ test('an agent has the expected interface', () => {
   expect(agent.streamText).toBeDefined();
 
   expect(agent.addFeedback).toBeDefined();
-  expect(agent.addHistory).toBeDefined();
+  expect(agent.addMessage).toBeDefined();
   expect(agent.addObservation).toBeDefined();
   expect(agent.addPlan).toBeDefined();
 
   expect(agent.interact).toBeDefined();
 });
 
-test('agent.addHistory() adds to history', () => {
+test('agent.addMessage() adds to message history', () => {
   const agent = createAgent({
     name: 'test',
     events: {},
     model: {} as any,
   });
 
-  agent.addHistory({
+  agent.addMessage({
     content: 'msg 1',
     role: 'user',
   });
 
-  const messageHistory = agent.addHistory({
+  const messageHistory = agent.addMessage({
     content: 'response 1',
     role: 'assistant',
   });

src/agent.ts

@@ -141,7 +141,7 @@ export function createAgent<
     return agentDecide(agent, opts);
   };
 
-  agent.addHistory = (messageInput) => {
+  agent.addMessage = (messageInput) => {
     const message = {
       ...messageInput,
       id: messageInput.id ?? randomUUID(),

src/strategies/chain-of-note.ts

@@ -118,7 +118,7 @@ export const chainOfNote = setup({
 //           return summary.extract;
 //         })
 //       );
-//       x.agent?.addHistory({
+//       x.agent?.addMessage({
 //         content: x.prompt!,
 //         id: Date.now() + '',
 //         role: 'user',
@@ -142,7 +142,7 @@ export const chainOfNote = setup({
 //         prompt: `${x.prompt!}`,
 //       });
 
-//       x.agent?.addHistory({
+//       x.agent?.addMessage({
 //         content: result.text,
 //         id: Date.now() + '',
 //         role: 'user',

src/text.ts

@@ -75,7 +75,7 @@ export async function agentGenerateText<T extends Agent<any>>(
 
   const messages = await getMessages(agent, promptWithContext, resolvedOptions);
 
-  agent.addHistory({
+  agent.addMessage({
     id,
     role: 'user',
     content: promptWithContext,
@@ -88,7 +88,7 @@ export async function agentGenerateText<T extends Agent<any>>(
     messages,
   });
 
-  agent.addHistory({
+  agent.addMessage({
     content: result.toolResults ?? result.text,
     id,
     role: 'assistant',
@@ -123,7 +123,7 @@ export async function agentStreamText(
 
   const messages = await getMessages(agent, promptWithContext, resolvedOptions);
 
-  agent.addHistory({
+  agent.addMessage({
     role: 'user',
     content: promptWithContext,
     id,
@@ -135,7 +135,7 @@ export async function agentStreamText(
     prompt: undefined,
     messages,
     onFinish: async (res) => {
-      agent.addHistory({
+      agent.addMessage({
         role: 'assistant',
         result: {
           text: res.text,

src/types.ts

@@ -274,7 +274,7 @@ export type Agent<TEvents extends EventObject> = ActorRefFrom<
   ) => Promise<StreamTextResult<Record<string, CoreTool<any, any>>>>;
 
   addObservation: (observation: AgentObservationInput) => AgentObservation<any>; // TODO
-  addHistory: (history: AgentMessageHistoryInput) => AgentMessageHistory;
+  addMessage: (history: AgentMessageHistoryInput) => AgentMessageHistory;
   addFeedback: (feedbackItem: AgentFeedbackInput) => AgentFeedback;
   addPlan: (plan: AgentPlan<TEvents>) => void;
   /**