Merge pull request #96 from reworkd/feat/refactor_interfaces_and_types

feat: add interfaces, types and constants file

src/components/AutonomousAgent.ts

@@ -1,12 +1,12 @@
 import type { Message } from "./ChatWindow";
 import axios from "axios";
+import type { ModelSettings } from "../utils/types";
 
 class AutonomousAgent {
   name: string;
   goal: string;
   tasks: string[] = [];
-  customApiKey: string;
-  customModelName: string;
+  modelSettings: ModelSettings;
   isRunning = true;
   sendMessage: (message: Message) => void;
   shutdown: () => void;
@@ -17,15 +17,13 @@ class AutonomousAgent {
     goal: string,
     addMessage: (message: Message) => void,
     shutdown: () => void,
-    customApiKey: string,
-    customModelName: string
+    modelSettings: ModelSettings
   ) {
     this.name = name;
     this.goal = goal;
     this.sendMessage = addMessage;
     this.shutdown = shutdown;
-    this.customApiKey = customApiKey;
-    this.customModelName = customModelName;
+    this.modelSettings = modelSettings;
   }
 
   async run() {
@@ -42,7 +40,7 @@ class AutonomousAgent {
     } catch (e) {
       console.log(e);
       this.sendErrorMessage(
-        this.customApiKey !== ""
+        this.modelSettings.customApiKey !== ""
           ? `ERROR retrieving initial tasks array. Make sure your API key is not the free tier, make your goal more clear, or revise your goal such that it is within our model's policies to run. Shutting Down.`
           : `ERROR retrieving initial tasks array. Retry, make your goal more clear, or revise your goal such that it is within our model's policies to run. Shutting Down.`
       );
@@ -70,7 +68,7 @@ class AutonomousAgent {
     }
 
     this.numLoops += 1;
-    const maxLoops = this.customApiKey === "" ? 4 : 25;
+    const maxLoops = this.modelSettings.customApiKey === "" ? 4 : 25;
     if (this.numLoops > maxLoops) {
       this.sendLoopMessage();
       this.shutdown();
@@ -120,8 +118,7 @@ class AutonomousAgent {
 
   async getInitialTasks(): Promise<string[]> {
     const res = await axios.post(`/api/chain`, {
-      customApiKey: this.customApiKey,
-      customModelName: this.customModelName,
+      modelSettings: this.modelSettings,
       goal: this.goal,
     });
 
@@ -134,8 +131,7 @@ class AutonomousAgent {
     result: string
   ): Promise<string[]> {
     const res = await axios.post(`/api/create`, {
-      customApiKey: this.customApiKey,
-      customModelName: this.customModelName,
+      modelSettings: this.modelSettings,
       goal: this.goal,
       tasks: this.tasks,
       lastTask: currentTask,
@@ -147,8 +143,7 @@ class AutonomousAgent {
 
   async executeTask(task: string): Promise<string> {
     const res = await axios.post(`/api/execute`, {
-      customApiKey: this.customApiKey,
-      customModelName: this.customModelName,
+      modelSettings: this.modelSettings,
       goal: this.goal,
       task: task,
     });
@@ -168,7 +163,7 @@ class AutonomousAgent {
     this.sendMessage({
       type: "system",
       value:
-        this.customApiKey !== ""
+        this.modelSettings.customApiKey !== ""
           ? `This agent has been running for too long (25 Loops). To save your wallet, and our infrastructure costs, this agent is shutting down. In the future, the number of iterations will be configurable.`
           : "We're sorry, because this is a demo, we cannot have our agents running for too long. Note, if you desire longer runs, please provide your own API key in Settings. Shutting down.",
     });

src/pages/api/chain.ts

@@ -6,25 +6,16 @@ import {
 } from "../../utils/chain";
 import type { NextRequest } from "next/server";
 import { NextResponse } from "next/server";
+import type { RequestBody } from "../../utils/interfaces";
 
 export const config = {
   runtime: "edge",
 };
 
-interface RequestBody {
-  customApiKey: string;
-  customModelName: string;
-  goal: string;
-}
-
 const handler = async (request: NextRequest) => {
   try {
-    const { customApiKey, customModelName, goal } =
-      (await request.json()) as RequestBody;
-    const completion = await startGoalAgent(
-      createModel({ customApiKey, customModelName }),
-      goal
-    );
+    const { modelSettings, goal } = (await request.json()) as RequestBody;
+    const completion = await startGoalAgent(createModel(modelSettings), goal);
 
     const newTasks = extractArray(completion.text as string).filter(
       realTasksFilter

src/pages/api/create.ts

@@ -6,26 +6,23 @@ import {
 } from "../../utils/chain";
 import type { NextRequest } from "next/server";
 import { NextResponse } from "next/server";
+import type { RequestBody } from "../../utils/interfaces";
 
 export const config = {
   runtime: "edge",
 };
 
-interface RequestBody {
-  customApiKey: string;
-  customModelName: string;
-  goal: string;
-  tasks: string[];
-  lastTask: string;
-  result: string;
-}
-
 const handler = async (request: NextRequest) => {
   try {
-    const { customApiKey, customModelName, goal, tasks, lastTask, result } =
+    const { modelSettings, goal, tasks, lastTask, result } =
       (await request.json()) as RequestBody;
+
+    if (tasks === undefined || lastTask === undefined || result === undefined) {
+      return;
+    }
+
     const completion = await executeCreateTaskAgent(
-      createModel({ customApiKey, customModelName }),
+      createModel(modelSettings),
       goal,
       tasks,
       lastTask,

src/pages/api/execute.ts

@@ -1,23 +1,22 @@
 import { createModel, executeTaskAgent } from "../../utils/chain";
 import type { NextRequest } from "next/server";
 import { NextResponse } from "next/server";
+import type { RequestBody } from "../../utils/interfaces";
 
-interface RequestBody {
-  customApiKey: string;
-  customModelName: string;
-  goal: string;
-  task: string;
-}
 export const config = {
   runtime: "edge",
 };
 
 const handler = async (request: NextRequest) => {
   try {
-    const { customApiKey, customModelName, goal, task } =
-      (await request.json()) as RequestBody;
+    const { modelSettings, goal, task } = (await request.json()) as RequestBody;
+
+    if (task === undefined) {
+      return;
+    }
+
     const completion = await executeTaskAgent(
-      createModel({ customApiKey, customModelName }),
+      createModel(modelSettings),
       goal,
       task
     );

src/pages/index.tsx

@@ -53,13 +53,13 @@ const Home: NextPage = () => {
   const handleNewGoal = () => {
     const addMessage = (message: Message) =>
       setMessages((prev) => [...prev, message]);
+
     const agent = new AutonomousAgent(
       name,
       goalInput,
       addMessage,
       () => setAgent(null),
-      customApiKey,
-      customModelName
+      { customApiKey, customModelName }
     );
     setAgent(agent);
     agent.run().then(console.log).catch(console.error);

src/utils/chain.ts

@@ -1,19 +1,18 @@
 import { OpenAI } from "langchain/llms/openai";
 import { PromptTemplate } from "langchain/prompts";
 import { LLMChain } from "langchain/chains";
+import type { ModelSettings } from "./types";
+import { GPT_35_TURBO } from "./constants";
 
-type ModelOptions = {
-  customApiKey: string;
-  customModelName: string;
-};
-
-export const createModel = (opts: ModelOptions) =>
+export const createModel = (settings: ModelSettings) =>
   new OpenAI({
     openAIApiKey:
-      opts.customApiKey === "" ? process.env.OPENAI_API_KEY : opts.customApiKey,
+      settings.customApiKey === ""
+        ? process.env.OPENAI_API_KEY
+        : settings.customApiKey,
     temperature: 0.9,
     modelName:
-      opts.customModelName === "" ? "gpt-3.5-turbo" : opts.customModelName,
+      settings.customModelName === "" ? GPT_35_TURBO : settings.customModelName,
     maxTokens: 300,
   });
 

src/utils/constants.ts

@@ -0,0 +1 @@
+export const GPT_35_TURBO = "gpt-3.5-turbo";

src/utils/interfaces.ts

@@ -0,0 +1,10 @@
+import type { ModelSettings } from "./types";
+
+export interface RequestBody {
+  modelSettings: ModelSettings;
+  goal: string;
+  task?: string;
+  tasks?: string[];
+  lastTask?: string;
+  result?: string;
+}

src/utils/types.ts

@@ -0,0 +1,4 @@
+export type ModelSettings = {
+  customApiKey: string;
+  customModelName: string;
+};