@autobe/agent 0.5.2 → 0.6.0

package/src/factory/createAutoBeApplication.ts

@@ -5,8 +5,8 @@ import typia from "typia";
 import { AutoBeContext } from "../context/AutoBeContext";
 import { IAutoBeApplication } from "../context/IAutoBeApplication";
 import { assertSchemaModel } from "../context/assertSchemaModel";
+import { orchestrateAnalyze } from "../orchestrate/analyze/orchestrateAnalyze";
 import { orchestrateInterface } from "../orchestrate/interface/orchestrateInterface";
-import { orchestrateAnalyze } from "../orchestrate/orchestrateAnalyze";
 import { orchestrateRealize } from "../orchestrate/orchestrateRealize";
 import { orchestrateTest } from "../orchestrate/orchestrateTest";
 import { orchestratePrisma } from "../orchestrate/prisma/orchestratePrisma";

package/src/{analyze → orchestrate/analyze}/AutoBeAnalyzeAgent.ts

@@ -1,38 +1,37 @@
 import { IAgenticaController, MicroAgentica } from "@agentica/core";
 import { ILlmApplication, ILlmSchema } from "@samchon/openapi";
-import { IPointer } from "tstl";
 import typia from "typia";
+import { v4 } from "uuid";
 
-import { AutoBeSystemPromptConstant } from "../constants/AutoBeSystemPromptConstant";
-import { AutoBeContext } from "../context/AutoBeContext";
-import { assertSchemaModel } from "../context/assertSchemaModel";
+import { AutoBeSystemPromptConstant } from "../../constants/AutoBeSystemPromptConstant";
+import { AutoBeContext } from "../../context/AutoBeContext";
+import { assertSchemaModel } from "../../context/assertSchemaModel";
 import {
   AutoBeAnalyzeFileSystem,
   IAutoBeAnalyzeFileSystem,
 } from "./AutoBeAnalyzeFileSystem";
+import {
+  AutoBEAnalyzeFileMap,
+  AutoBeAnalyzePointer,
+} from "./AutoBeAnalyzePointer";
 import { AutoBeAnalyzeReviewer } from "./AutoBeAnalyzeReviewer";
 
-type Filename = string;
-type FileContent = string;
-
 export class AutoBeAnalyzeAgent<Model extends ILlmSchema.Model> {
   private readonly createAnalyzeAgent: () => MicroAgentica<Model>;
-  private readonly fileMap: Record<Filename, FileContent> = {};
+  private readonly fileMap: AutoBEAnalyzeFileMap = {};
 
   constructor(
     private readonly createReviewerAgentFn: typeof AutoBeAnalyzeReviewer,
     private readonly ctx: AutoBeContext<Model>,
-    private readonly pointer: IPointer<{
-      files: Record<Filename, FileContent>;
-    } | null>,
-    filenames: string[],
+    private readonly pointer: AutoBeAnalyzePointer,
+    private readonly filenames: string[],
   ) {
     assertSchemaModel(ctx.model);
 
     const controller = createController<Model>({
       model: ctx.model,
       execute: new AutoBeAnalyzeFileSystem(this.fileMap),
-      build: async (files: Record<Filename, FileContent>) => {
+      build: async (files: AutoBEAnalyzeFileMap) => {
         this.pointer.value = { files };
       },
     });
@@ -53,6 +52,8 @@ export class AutoBeAnalyzeAgent<Model extends ILlmSchema.Model> {
         tokenUsage: ctx.usage(),
         histories: [
           {
+            id: v4(),
+            created_at: new Date().toISOString(),
             type: "systemMessage",
             text: AutoBeSystemPromptConstant.ANALYZE.replace(
               "{% User Locale %}",
@@ -60,6 +61,8 @@ export class AutoBeAnalyzeAgent<Model extends ILlmSchema.Model> {
             ),
           },
           {
+            id: v4(),
+            created_at: new Date().toISOString(),
             type: "systemMessage",
             text: [
               "# Guidelines",
@@ -68,11 +71,13 @@ export class AutoBeAnalyzeAgent<Model extends ILlmSchema.Model> {
             ].join("\n"),
           },
           {
+            id: v4(),
+            created_at: new Date().toISOString(),
             type: "systemMessage",
             text: [
               "The following is the name of the entire file.",
               "Use it to build a table of contents.",
-              filenames.map((filename) => `- ${filename}`),
+              this.filenames.map((filename) => `- ${filename}`),
               "",
               "However, do not touch other than the file you have to create.",
             ].join("\n"),
@@ -167,7 +172,7 @@ export class AutoBeAnalyzeAgent<Model extends ILlmSchema.Model> {
 function createController<Model extends ILlmSchema.Model>(props: {
   model: Model;
   execute: AutoBeAnalyzeFileSystem;
-  build: (input: Record<Filename, FileContent>) => void;
+  build: (input: AutoBEAnalyzeFileMap) => void;
 }): IAgenticaController.IClass<Model> {
   assertSchemaModel(props.model);
   const application: ILlmApplication<Model> = collection[

package/src/orchestrate/analyze/AutoBeAnalyzePointer.ts

@@ -0,0 +1,10 @@
+import { IPointer } from "tstl";
+
+type Filename = string;
+type FileContent = string;
+
+export interface AutoBEAnalyzeFileMap extends Record<Filename, FileContent> {}
+
+export type AutoBeAnalyzePointer = IPointer<{
+  files: AutoBEAnalyzeFileMap;
+} | null>;

package/src/{analyze → orchestrate/analyze}/AutoBeAnalyzeReviewer.ts

@@ -1,8 +1,9 @@
 import { MicroAgentica } from "@agentica/core";
 import { ILlmSchema } from "@samchon/openapi";
+import { v4 } from "uuid";
 
-import { AutoBeSystemPromptConstant } from "../constants/AutoBeSystemPromptConstant";
-import { AutoBeContext } from "../context/AutoBeContext";
+import { AutoBeSystemPromptConstant } from "../../constants/AutoBeSystemPromptConstant";
+import { AutoBeContext } from "../../context/AutoBeContext";
 
 export const AutoBeAnalyzeReviewer = <Model extends ILlmSchema.Model>(
   ctx: AutoBeContext<Model>,
@@ -27,10 +28,14 @@ export const AutoBeAnalyzeReviewer = <Model extends ILlmSchema.Model>(
           (el) => el.type === "assistantMessage" || el.type === "userMessage",
         ),
       {
+        id: v4(),
+        created_at: new Date().toISOString(),
         type: "systemMessage",
         text: AutoBeSystemPromptConstant.ANALYZE_REVIEWER,
       },
       {
+        id: v4(),
+        created_at: new Date().toISOString(),
         type: "systemMessage",
         text: [
           "Below are all of the files.",

package/src/orchestrate/{orchestrateAnalyze.ts → analyze/orchestrateAnalyze.ts}

@@ -4,20 +4,17 @@ import {
   AutoBeAssistantMessageHistory,
 } from "@autobe/interface";
 import { ILlmApplication, ILlmSchema } from "@samchon/openapi";
-import { IPointer } from "tstl";
 import typia from "typia";
 import { v4 } from "uuid";
 
-import { AutoBeAnalyzeAgent } from "../analyze/AutoBeAnalyzeAgent";
-import { IFile } from "../analyze/AutoBeAnalyzeFileSystem";
-import { AutoBeAnalyzeReviewer } from "../analyze/AutoBeAnalyzeReviewer";
-import { AutoBeSystemPromptConstant } from "../constants/AutoBeSystemPromptConstant";
-import { AutoBeContext } from "../context/AutoBeContext";
-import { IAutoBeApplicationProps } from "../context/IAutoBeApplicationProps";
-import { assertSchemaModel } from "../context/assertSchemaModel";
-
-type Filename = string;
-type FileContent = string;
+import { AutoBeSystemPromptConstant } from "../../constants/AutoBeSystemPromptConstant";
+import { AutoBeContext } from "../../context/AutoBeContext";
+import { IAutoBeApplicationProps } from "../../context/IAutoBeApplicationProps";
+import { assertSchemaModel } from "../../context/assertSchemaModel";
+import { AutoBeAnalyzeAgent } from "./AutoBeAnalyzeAgent";
+import { IFile } from "./AutoBeAnalyzeFileSystem";
+import { AutoBeAnalyzePointer } from "./AutoBeAnalyzePointer";
+import { AutoBeAnalyzeReviewer } from "./AutoBeAnalyzeReviewer";
 
 /** @todo Kakasoo */
 export const orchestrateAnalyze =
@@ -98,14 +95,16 @@ export const orchestrateAnalyze =
     }
 
     const described = determined.find((el) => el.type === "describe");
-    const filenames = Array.from(
+    const describedFiles = Array.from(
       new Set(
         described
           ? described.executes
               .flatMap((el) => {
                 if (el.protocol === "class") {
                   return (
-                    el.arguments as { files: Array<Pick<IFile, "filename">> }
+                    el.arguments as {
+                      files: Array<Pick<IFile, "filename" | "reason">>;
+                    }
                   ).files;
                 }
                 return null;
@@ -115,33 +114,49 @@ export const orchestrateAnalyze =
       ),
     );
 
+    if (describedFiles.length === 0) {
+      const history: AutoBeAssistantMessageHistory = {
+        id: v4(),
+        type: "assistantMessage",
+        text: "The current requirements are insufficient, so file generation will be suspended. It would be better to continue the conversation.",
+        created_at,
+        completed_at: new Date().toISOString(),
+      };
+      ctx.dispatch({
+        type: "assistantMessage",
+        text: "The current requirements are insufficient, so file generation will be suspended. It would be better to continue the conversation.",
+        created_at,
+      });
+      return history;
+    }
+
     const pointers = await Promise.all(
-      filenames.map(async ({ filename }) => {
-        const pointer: IPointer<{
-          files: Record<Filename, FileContent>;
-        } | null> = {
-          value: null,
-        };
+      describedFiles.map(async ({ filename, reason }) => {
+        const pointer: AutoBeAnalyzePointer = { value: null };
 
         const agent = new AutoBeAnalyzeAgent(
           AutoBeAnalyzeReviewer,
           ctx,
           pointer,
-          filenames.map((el) => el.filename),
+          describedFiles.map((el) => el.filename),
         );
 
         await agent.conversate(
           [
-            `The names of all the files are as follows: ${filenames.join(",")}`,
+            `# Instruction`,
+            `The names of all the files are as follows: ${describedFiles.join(",")}`,
             "Assume that all files are in the same folder. Also, when pointing to the location of a file, go to the relative path.",
             "",
             `Among the various documents, the part you decided to take care of is as follows.: ${filename}`,
             `Only write this document named '${filename}'.`,
             "Never write other documents.",
             "",
+            "# User Planning Requirements",
             "```md",
             JSON.stringify(userPlanningRequirements),
             "```",
+            "The reason why this document needs to be written is as follows.",
+            `- reason: ${reason}`,
           ].join("\n"),
         );
 
@@ -193,16 +208,20 @@ export const orchestrateAnalyze =
 
 class DeterminingFiles {
   /**
-   * Determining the Initial File List
+   * Determining the Initial File List.
    *
    * Design a list of initial documents that you need to create for that
    * requirement. The list of documents is determined only by the name of the
-   * file.
+   * file. If you determine from the conversation that the user's requirements
+   * have not been fully gathered, you must stop the analysis and continue
+   * collecting the remaining requirements. In this case, you do not need to
+   * generate any files. Simply pass an empty array to `input.files`, which is
+   * the input value for the `determine` tool.
    *
    * @param input
    * @returns
    */
-  determine(input: { files: Array<Pick<IFile, "filename">> }) {
+  determine(input: { files: Array<Pick<IFile, "filename" | "reason">> }) {
     return input;
   }
 }

package/src/orchestrate/index.ts

@@ -1,5 +1,5 @@
-export { orchestrateAnalyze as analyze } from "./orchestrateAnalyze";
+export { orchestrateAnalyze as analyze } from "./analyze/orchestrateAnalyze";
 export { orchestrateInterface as interface } from "./interface/orchestrateInterface";
-export { orchestratePrisma as prisma } from "./prisma/orchestratePrisma";
-export { orchestrateTest as test } from "./orchestrateTest";
 export { orchestrateRealize as realize } from "./orchestrateRealize";
+export { orchestrateTest as test } from "./orchestrateTest";
+export { orchestratePrisma as prisma } from "./prisma/orchestratePrisma";

package/src/orchestrate/interface/orchestrateInterfaceComplement.ts

@@ -8,6 +8,7 @@ import {
 import { OpenApiV3_1Emender } from "@samchon/openapi/lib/converters/OpenApiV3_1Emender";
 import { IPointer } from "tstl";
 import typia from "typia";
+import { v4 } from "uuid";
 
 import { AutoBeSystemPromptConstant } from "../../constants/AutoBeSystemPromptConstant";
 import { AutoBeContext } from "../../context/AutoBeContext";
@@ -51,6 +52,8 @@ async function step<Model extends ILlmSchema.Model>(
         AutoBeSystemPromptConstant.INTERFACE_COMPLEMENT,
       ),
       {
+        id: v4(),
+        created_at: new Date().toISOString(),
         type: "assistantMessage",
         text: [
           "Here is the OpenAPI document what you've made:",
@@ -61,6 +64,8 @@ async function step<Model extends ILlmSchema.Model>(
         ].join("\n"),
       },
       {
+        id: v4(),
+        created_at: new Date().toISOString(),
         type: "assistantMessage",
         text: [
           "You have missed below schema types in the document.components.schemas:",

package/src/orchestrate/interface/orchestrateInterfaceComponents.ts

@@ -4,6 +4,7 @@ import { ILlmApplication, ILlmSchema } from "@samchon/openapi";
 import { OpenApiV3_1Emender } from "@samchon/openapi/lib/converters/OpenApiV3_1Emender";
 import { IPointer } from "tstl";
 import typia from "typia";
+import { v4 } from "uuid";
 
 import { AutoBeSystemPromptConstant } from "../../constants/AutoBeSystemPromptConstant";
 import { AutoBeContext } from "../../context/AutoBeContext";
@@ -113,6 +114,8 @@ async function process<Model extends ILlmSchema.Model>(
         AutoBeSystemPromptConstant.INTERFACE_SCHEMA,
       ),
       {
+        id: v4(),
+        created_at: new Date().toISOString(),
         type: "assistantMessage",
         text: [
           "Here is the OpenAPI operations generated by phase 2.",

package/src/orchestrate/interface/transformInterfaceHistories.ts

@@ -1,4 +1,5 @@
 import { IAgenticaHistoryJson } from "@agentica/core";
+import { v4 } from "uuid";
 
 import { AutoBeState } from "../../context/AutoBeState";
 
@@ -11,6 +12,8 @@ export const transformInterfaceHistories = (
   if (state.analyze === null)
     return [
       {
+        id: v4(),
+        created_at: new Date().toISOString(),
         type: "systemMessage",
         text: [
           "Requirement analysis is not yet completed.",
@@ -22,6 +25,8 @@ export const transformInterfaceHistories = (
   else if (state.prisma === null)
     return [
       {
+        id: v4(),
+        created_at: new Date().toISOString(),
         type: "systemMessage",
         text: [
           "Prisma DB schema generation is not yet completed.",
@@ -33,6 +38,8 @@ export const transformInterfaceHistories = (
   else if (state.analyze.step !== state.prisma.step)
     return [
       {
+        id: v4(),
+        created_at: new Date().toISOString(),
         type: "systemMessage",
         text: [
           "Prisma DB schema generation has not been updated",
@@ -45,6 +52,8 @@ export const transformInterfaceHistories = (
   else if (state.prisma.compiled.type !== "success")
     return [
       {
+        id: v4(),
+        created_at: new Date().toISOString(),
         type: "systemMessage",
         text: [
           "Prisma DB schema generation has not been updated",
@@ -56,10 +65,14 @@ export const transformInterfaceHistories = (
     ];
   return [
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "systemMessage",
       text: systemMessage,
     },
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "assistantMessage",
       text: [
         "Requirement analysis and Prisma DB schema generation are ready.",
@@ -81,6 +94,8 @@ export const transformInterfaceHistories = (
       ].join("\n"),
     },
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "assistantMessage",
       text: [
         "Database schema and entity relationship diagrams are ready.",

package/src/orchestrate/prisma/transformPrismaComponentsHistories.ts

@@ -1,4 +1,5 @@
 import { IAgenticaHistoryJson } from "@agentica/core";
+import { v4 } from "uuid";
 
 import { AutoBeSystemPromptConstant } from "../../constants/AutoBeSystemPromptConstant";
 import { AutoBeState } from "../../context/AutoBeState";
@@ -11,6 +12,8 @@ export const transformPrismaComponentsHistories = (
   if (state.analyze === null)
     return [
       {
+        id: v4(),
+        created_at: new Date().toISOString(),
         type: "systemMessage",
         text: [
           "Requirement analysis is not yet completed.",
@@ -21,10 +24,14 @@ export const transformPrismaComponentsHistories = (
     ];
   return [
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "systemMessage",
       text: AutoBeSystemPromptConstant.PRISMA_COMPONENT,
     },
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "assistantMessage",
       text: [
         "Here is the requirement analysis report.",

package/src/orchestrate/prisma/transformPrismaCorrectHistories.ts

@@ -1,5 +1,6 @@
 import { IAgenticaHistoryJson } from "@agentica/core";
 import { IAutoBePrismaValidation } from "@autobe/interface";
+import { v4 } from "uuid";
 
 import { AutoBeSystemPromptConstant } from "../../constants/AutoBeSystemPromptConstant";
 
@@ -10,10 +11,14 @@ export const transformPrismaCorrectHistories = (
 > => {
   return [
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "systemMessage",
       text: AutoBeSystemPromptConstant.PRISMA_CORRECT,
     },
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "assistantMessage",
       text: [
         "Here is the Prisma application data what you made:",
@@ -24,6 +29,8 @@ export const transformPrismaCorrectHistories = (
       ].join("\n"),
     },
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "assistantMessage",
       text: [
         "Below are the list of errors what you have to fix:",
@@ -34,6 +41,8 @@ export const transformPrismaCorrectHistories = (
       ].join("\n"),
     },
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "systemMessage",
       text: [
         "Before fixing the schema files,",

package/src/orchestrate/prisma/transformPrismaHistories.ts

@@ -1,4 +1,5 @@
 import { IAgenticaHistoryJson } from "@agentica/core";
+import { v4 } from "uuid";
 
 import { AutoBeSystemPromptConstant } from "../../constants/AutoBeSystemPromptConstant";
 import { AutoBeState } from "../../context/AutoBeState";
@@ -11,6 +12,8 @@ export const transformPrismaHistories = (
   if (state.analyze === null)
     return [
       {
+        id: v4(),
+        created_at: new Date().toISOString(),
         type: "systemMessage",
         text: [
           "Requirement analysis is not yet completed.",
@@ -21,14 +24,20 @@ export const transformPrismaHistories = (
     ];
   return [
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "systemMessage",
       text: AutoBeSystemPromptConstant.PRISMA,
     },
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "assistantMessage",
       text: AutoBeSystemPromptConstant.PRISMA_EXAMPLE,
     },
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "assistantMessage",
       text: [
         "Here is the requirement analysis report.",

package/src/orchestrate/prisma/transformPrismaSchemaHistories.ts

@@ -1,5 +1,6 @@
 import { IAgenticaHistoryJson } from "@agentica/core";
 import { AutoBeAnalyzeHistory } from "@autobe/interface";
+import { v4 } from "uuid";
 
 import { AutoBeSystemPromptConstant } from "../../constants/AutoBeSystemPromptConstant";
 
@@ -15,10 +16,14 @@ export const transformPrismaSchemaHistories = (
 > => {
   return [
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "systemMessage",
       text: AutoBeSystemPromptConstant.PRISMA_SCHEMA,
     },
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "systemMessage",
       text: [
         "Before making prisma schema files,",
@@ -29,6 +34,8 @@ export const transformPrismaSchemaHistories = (
       ].join("\n"),
     },
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "assistantMessage",
       text: [
         "Here is the requirement analysis report.",

package/src/structures/IAutoBeVendor.ts

@@ -1,3 +1,49 @@
-import { IAgenticaVendor } from "@agentica/core";
+import OpenAI from "openai";
 
-export type IAutoBeVendor = IAgenticaVendor;
+/**
+ * LLM service vendor for Agentica Chat.
+ *
+ * `IAgenticaVendor` is a type represents an LLM (Large Language Model) vendor
+ * of the {@link AutoBeAgent}.
+ *
+ * Currently, {@link AutoBeAgent} supports OpenAI SDK. However, it does not mean
+ * that you can use only OpenAI's GPT model in the {@link AutoBeAgent}. The
+ * OpenAI SDK is just a connection tool to the LLM vendor's API, and you can use
+ * other LLM vendors by configuring its `baseURL` and API key.
+ *
+ * Therefore, if you want to use another LLM vendor like Claude or Gemini,
+ * please configure the `baseURL` to the {@link api}, and set
+ * {@link IAutoBeProps.model schema model} as "cluade" or "gemini".
+ *
+ * @author Samchon
+ */
+export interface IAutoBeVendor {
+  /** OpenAI API instance. */
+  api: OpenAI;
+
+  /**
+   * Chat model to be used.
+   *
+   * `({}) & string` means to support third party hosting cloud(eg. openRouter,
+   * aws)
+   */
+  model: OpenAI.ChatModel | ({} & string);
+
+  /** Options for the request. */
+  options?: OpenAI.RequestOptions | undefined;
+
+  /**
+   * Number of concurrent requests allowed.
+   *
+   * If you configure this property, {@link AutoBeAgent} will constrain the
+   * number of concurrent requests to the LLM vendor. If you want to share the
+   * semaphore instance with other agents, you can directly assign the
+   * {@link Semaphore} instance to this property.
+   *
+   * Otherwise, it will not limit the number of concurrent requests, and the
+   * {@link AutoBeAgent} will send requests asynchronously without any limit.
+   *
+   * @default 16
+   */
+  semaphore?: number | undefined;
+}

package/lib/analyze/AnalyzeAgent.d.ts

@@ -1,24 +0,0 @@
-import { ILlmSchema } from "@samchon/openapi";
-import { IPointer } from "tstl";
-import { AutoBeContext } from "../context/AutoBeContext";
-import { AutoBeAnalyzeReviewer } from "./AutoBeAnalyzeReviewer";
-type Filename = string;
-type FileContent = string;
-export declare class AnalyzeAgent<Model extends ILlmSchema.Model> {
-    private readonly createReviewerAgentFn;
-    private readonly ctx;
-    private readonly pointer;
-    private readonly createInnerAgent;
-    private readonly fileMap;
-    constructor(createReviewerAgentFn: typeof AutoBeAnalyzeReviewer, ctx: AutoBeContext<Model>, pointer: IPointer<{
-        files: Record<Filename, FileContent>;
-    } | null>);
-    /**
-     * Conversate with planner agent
-     *
-     * @param content Conversation from user in this time.
-     * @returns
-     */
-    conversate(content: string): Promise<string>;
-}
-export {};