@autobe/agent 0.20.0 → 0.22.0

package/src/context/AutoBeContext.ts

@@ -1,6 +1,7 @@
 import {
   IAgenticaVendor,
   IMicroAgenticaHistoryJson,
+  MicroAgentica,
   MicroAgenticaHistory,
 } from "@agentica/core";
 import {
@@ -29,6 +30,7 @@ export interface AutoBeContext<Model extends ILlmSchema.Model> {
   model: Model;
   vendor: IAgenticaVendor;
   locale: string;
+  retry: number;
 
   // accessors
   compilerListener: IAutoBeCompilerListener;
@@ -49,6 +51,7 @@ export interface AutoBeContext<Model extends ILlmSchema.Model> {
   // factories
   conversate(
     props: AutoBeContext.IConversate<Model>,
+    closure?: (agent: MicroAgentica<Model>) => void,
   ): Promise<AutoBeContext.IResult<Model>>;
 }
 export namespace AutoBeContext {

package/src/context/AutoBeTokenUsageComponent.ts

@@ -95,10 +95,10 @@ export class AutoBeTokenUsageComponent
         accepted_prediction: 0,
         rejected_prediction: 0,
       };
-      return;
+    } else {
+      this.input = props.input;
+      this.output = props.output;
     }
-    this.input = props.input;
-    this.output = props.output;
   }
 
   /**

package/src/factory/consentFunctionCall.ts

@@ -12,6 +12,7 @@ import { IPointer } from "tstl";
 import typia from "typia";
 import { v7 } from "uuid";
 
+import { AutoBeConfigConstant } from "../constants/AutoBeConfigConstant";
 import { AutoBeSystemPromptConstant } from "../constants/AutoBeSystemPromptConstant";
 import { IAutoBeConfig } from "../structures/IAutoBeConfig";
 import { IAutoBeVendor } from "../structures/IAutoBeVendor";
@@ -31,6 +32,7 @@ export const consentFunctionCall = async (props: {
     vendor: props.vendor,
     config: {
       ...(props.config ?? []),
+      retry: props.config?.retry ?? AutoBeConfigConstant.DEFAULT_RETRY,
       executor: {
         describe: null,
       },

package/src/factory/createAutoBeContext.ts

@@ -27,6 +27,7 @@ import { ILlmSchema } from "@samchon/openapi";
 import typia from "typia";
 import { v7 } from "uuid";
 
+import { AutoBeConfigConstant } from "../constants/AutoBeConfigConstant";
 import { AutoBeContext } from "../context/AutoBeContext";
 import { AutoBeState } from "../context/AutoBeState";
 import { AutoBeTokenUsage } from "../context/AutoBeTokenUsage";
@@ -47,151 +48,160 @@ export const createAutoBeContext = <Model extends ILlmSchema.Model>(props: {
   histories: () => AutoBeHistory[];
   usage: () => AutoBeTokenUsage;
   dispatch: (event: AutoBeEvent) => Promise<void>;
-}): AutoBeContext<Model> => ({
-  model: props.model,
-  vendor: props.vendor,
-  locale: props.config.locale ?? "en-US",
-  compilerListener: props.compilerListener,
-  compiler: props.compiler,
-  files: props.files,
-  histories: props.histories,
-  state: props.state,
-  usage: props.usage,
-  dispatch: createDispatch(props),
-  assistantMessage: (message) => {
-    props.histories().push(message);
-    setTimeout(() => props.dispatch(message).catch(() => {}));
-    return message;
-  },
-  conversate: async (next) => {
-    const execute = async (): Promise<AutoBeContext.IResult<Model>> => {
-      const agent: MicroAgentica<Model> = new MicroAgentica<Model>({
-        model: props.model,
-        vendor: props.vendor,
-        config: {
-          ...(props.config ?? {}),
-          executor: {
-            describe: null,
+}): AutoBeContext<Model> => {
+  const retry: number =
+    props.config?.retry ?? AutoBeConfigConstant.DEFAULT_RETRY;
+  const locale: string = props.config.locale ?? "en-US";
+  return {
+    model: props.model,
+    vendor: props.vendor,
+    retry,
+    locale,
+    compilerListener: props.compilerListener,
+    compiler: props.compiler,
+    files: props.files,
+    histories: props.histories,
+    state: props.state,
+    usage: props.usage,
+    dispatch: createDispatch(props),
+    assistantMessage: (message) => {
+      props.histories().push(message);
+      setTimeout(() => props.dispatch(message).catch(() => {}));
+      return message;
+    },
+    conversate: async (next, closure) => {
+      const execute = async (): Promise<AutoBeContext.IResult<Model>> => {
+        const agent: MicroAgentica<Model> = new MicroAgentica<Model>({
+          model: props.model,
+          vendor: props.vendor,
+          config: {
+            ...(props.config ?? {}),
+            retry: props.config?.retry ?? AutoBeConfigConstant.DEFAULT_RETRY,
+            executor: {
+              describe: null,
+            },
           },
-        },
-        histories: next.histories,
-        controllers: [next.controller],
-      });
-      agent.on("request", async (event) => {
-        if (next.enforceFunctionCall === true && event.body.tools)
-          event.body.tool_choice = "required";
-        if (event.body.parallel_tool_calls !== undefined)
-          delete event.body.parallel_tool_calls;
-        if (next.promptCacheKey)
-          event.body.prompt_cache_key = next.promptCacheKey;
-        await props.dispatch({
-          ...event,
-          type: "vendorRequest",
-          source: next.source,
+          histories: next.histories,
+          controllers: [next.controller],
         });
-      });
-      agent.on("response", (event) => {
-        void props
-          .dispatch({
-            ...event,
-            type: "vendorResponse",
-            source: next.source,
-          })
-          .catch(() => {});
-      });
-      agent.on("jsonParseError", (event) => {
-        void props
-          .dispatch({
+        agent.on("request", async (event) => {
+          if (next.enforceFunctionCall === true && event.body.tools)
+            event.body.tool_choice = "required";
+          if (event.body.parallel_tool_calls !== undefined)
+            delete event.body.parallel_tool_calls;
+          if (next.promptCacheKey)
+            event.body.prompt_cache_key = next.promptCacheKey;
+          await props.dispatch({
             ...event,
+            type: "vendorRequest",
             source: next.source,
-          })
-          .catch(() => {});
-      });
-      agent.on("validate", (event) => {
-        void props
-          .dispatch({
-            type: "jsonValidateError",
-            id: v7(),
-            source: next.source,
-            result: event.result,
-            created_at: event.created_at,
-          })
-          .catch(() => {});
-      });
+          });
+        });
+        agent.on("response", (event) => {
+          void props
+            .dispatch({
+              ...event,
+              type: "vendorResponse",
+              source: next.source,
+            })
+            .catch(() => {});
+        });
+        agent.on("jsonParseError", (event) => {
+          void props
+            .dispatch({
+              ...event,
+              source: next.source,
+            })
+            .catch(() => {});
+        });
+        agent.on("validate", (event) => {
+          void props
+            .dispatch({
+              type: "jsonValidateError",
+              id: v7(),
+              source: next.source,
+              result: event.result,
+              created_at: event.created_at,
+            })
+            .catch(() => {});
+        });
+        if (closure) closure(agent);
 
-      const histories: MicroAgenticaHistory<Model>[] = await agent.conversate(
-        next.message,
-      );
-      const tokenUsage: IAutoBeTokenUsageJson.IComponent = agent
-        .getTokenUsage()
-        .toJSON().aggregate;
-      props
-        .usage()
-        .record(tokenUsage, [
-          STAGES.find((stage) => next.source.startsWith(stage)) ?? "analyze",
-        ]);
+        const histories: MicroAgenticaHistory<Model>[] = await agent.conversate(
+          next.message,
+        );
+        const tokenUsage: IAutoBeTokenUsageJson.IComponent = agent
+          .getTokenUsage()
+          .toJSON().aggregate;
+        props
+          .usage()
+          .record(tokenUsage, [
+            STAGES.find((stage) => next.source.startsWith(stage)) ?? "analyze",
+          ]);
 
-      if (
-        true === next.enforceFunctionCall &&
-        false ===
-          histories.some((h) => h.type === "execute" && h.success === true)
-      ) {
-        const failure = () => {
-          throw new Error(
-            `Failed to function calling in the ${next.source} step`,
-          );
-        };
-        const last: MicroAgenticaHistory<Model> | undefined = histories.at(-1);
         if (
-          last?.type === "assistantMessage" &&
-          last.text.trim().length !== 0
+          true === next.enforceFunctionCall &&
+          false ===
+            histories.some((h) => h.type === "execute" && h.success === true)
         ) {
-          const consent: string | null = await consentFunctionCall({
-            source: next.source,
-            dispatch: (e) => {
-              props.dispatch(e).catch(() => {});
-            },
-            config: props.config,
-            vendor: props.vendor,
-            assistantMessage: last.text,
-          });
-          if (consent !== null) {
-            const newHistories: MicroAgenticaHistory<Model>[] =
-              await agent.conversate(consent);
-            const newTokenUsage: IAutoBeTokenUsageJson.IComponent = agent
-              .getTokenUsage()
-              .toJSON().aggregate;
-            props
-              .usage()
-              .record(
-                AutoBeTokenUsageComponent.minus(
-                  new AutoBeTokenUsageComponent(newTokenUsage),
-                  new AutoBeTokenUsageComponent(tokenUsage),
-                ),
-                [
-                  STAGES.find((stage) => next.source.startsWith(stage)) ??
-                    "analyze",
-                ],
-              );
-            if (
-              newHistories.some(
-                (h) => h.type === "execute" && h.success === true,
+          const failure = () => {
+            throw new Error(
+              `Failed to function calling in the ${next.source} step`,
+            );
+          };
+          const last: MicroAgenticaHistory<Model> | undefined =
+            histories.at(-1);
+          if (
+            last?.type === "assistantMessage" &&
+            last.text.trim().length !== 0
+          ) {
+            const consent: string | null = await consentFunctionCall({
+              source: next.source,
+              dispatch: (e) => {
+                props.dispatch(e).catch(() => {});
+              },
+              config: props.config,
+              vendor: props.vendor,
+              assistantMessage: last.text,
+            });
+            if (consent !== null) {
+              const newHistories: MicroAgenticaHistory<Model>[] =
+                await agent.conversate(consent);
+              const newTokenUsage: IAutoBeTokenUsageJson.IComponent = agent
+                .getTokenUsage()
+                .toJSON().aggregate;
+              props
+                .usage()
+                .record(
+                  AutoBeTokenUsageComponent.minus(
+                    new AutoBeTokenUsageComponent(newTokenUsage),
+                    new AutoBeTokenUsageComponent(tokenUsage),
+                  ),
+                  [
+                    STAGES.find((stage) => next.source.startsWith(stage)) ??
+                      "analyze",
+                  ],
+                );
+              if (
+                newHistories.some(
+                  (h) => h.type === "execute" && h.success === true,
+                )
               )
-            )
-              return {
-                histories: newHistories,
-                tokenUsage: newTokenUsage,
-              };
+                return {
+                  histories: newHistories,
+                  tokenUsage: newTokenUsage,
+                };
+            }
           }
+          failure();
         }
-        failure();
-      }
-      return { histories, tokenUsage };
-    };
-    if (next.enforceFunctionCall === true) return forceRetry(execute);
-    else return execute();
-  },
-});
+        return { histories, tokenUsage };
+      };
+      if (next.enforceFunctionCall === true) return forceRetry(execute, retry);
+      else return execute();
+    },
+  };
+};
 
 const createDispatch = (props: {
   state: () => AutoBeState;
@@ -329,7 +339,7 @@ const transformAndDispatch = <
 
 const forceRetry = async <T>(
   task: () => Promise<T>,
-  count: number = 3,
+  count: number,
 ): Promise<T> => {
   let error: unknown = undefined;
   for (let i: number = 0; i < count; ++i)

package/src/orchestrate/analyze/structures/IAutoBeAnalyzeReviewApplication.ts

@@ -26,6 +26,8 @@ export interface IAutoBeAnalyzeReviewApplication {
 export namespace IAutoBeAnalyzeReviewApplication {
   export interface IProps {
     /**
+     * Step 1 (CoT: Review Phase) - Enhancement Criteria
+     * 
      * The enhancement criteria and guidelines that the agent must follow.
      *
      * This includes:
@@ -52,6 +54,8 @@ export namespace IAutoBeAnalyzeReviewApplication {
     review: string;
 
     /**
+     * Step 2 (CoT: Plan Phase) - Original Document Plan
+     * 
      * The document plan that was used to create the content.
      *
      * This helps the reviewer understand:
@@ -67,6 +71,8 @@ export namespace IAutoBeAnalyzeReviewApplication {
     plan: string;
 
     /**
+     * Step 3 (CoT: Content Phase) - Complete Document Content
+     * 
      * The actual markdown document content that incorporates review feedback.
      *
      * This field contains a COMPLETE MARKDOWN DOCUMENT that has already 

package/src/orchestrate/analyze/structures/IAutoBeAnalyzeWriteApplication.ts

@@ -15,6 +15,8 @@ export interface IAutoBeAnalyzeWriteApplication {
 export namespace IAutoBeAnalyzeWriteApplication {
   export interface IProps {
     /**
+     * Step 1 (CoT: Plan Phase) - Document Planning Structure
+     * 
      * The document planning structure that outlines what needs to be written.
      *
      * This includes:
@@ -40,6 +42,8 @@ export namespace IAutoBeAnalyzeWriteApplication {
     plan: string;
 
     /**
+     * Step 2 (CoT: Write Phase) - Document Content Creation
+     * 
      * The initial content or context for the document being written.
      *
      * This may include:

package/src/orchestrate/interface/histories/transformInterfaceAuthorizationsHistories.ts

@@ -1,5 +1,5 @@
 import { IAgenticaHistoryJson } from "@agentica/core";
-import { AutoBeAnalyzeRole } from "@autobe/interface";
+import { AutoBeAnalyzeHistory, AutoBeAnalyzeRole } from "@autobe/interface";
 import { StringUtil } from "@autobe/utils";
 import { v7 } from "uuid";
 
@@ -13,6 +13,7 @@ export const transformInterfaceAuthorizationsHistories = (
 ): Array<
   IAgenticaHistoryJson.IAssistantMessage | IAgenticaHistoryJson.ISystemMessage
 > => {
+  const analyze: AutoBeAnalyzeHistory = state.analyze!;
   return [
     {
       type: "systemMessage",
@@ -21,6 +22,23 @@ export const transformInterfaceAuthorizationsHistories = (
       text: AutoBeSystemPromptConstant.INTERFACE_AUTHORIZATION,
     },
     ...transformInterfaceAssetHistories(state),
+    {
+      type: "systemMessage",
+      id: v7(),
+      created_at: new Date().toISOString(),
+      text: StringUtil.trim`
+        ## Service Prefix
+        - Original: ${analyze.prefix}
+        - PascalCase for DTOs: ${analyze.prefix
+          .split(/[-_]/)
+          .map((p) => p.charAt(0).toUpperCase() + p.slice(1))
+          .join("")}
+        - Expected DTO pattern: I${analyze.prefix
+          .split(/[-_]/)
+          .map((p) => p.charAt(0).toUpperCase() + p.slice(1))
+          .join("")}{EntityName}
+      `,
+    },
     {
       type: "assistantMessage",
       id: v7(),

package/src/orchestrate/interface/histories/transformInterfaceEndpointsReviewHistories.ts

@@ -0,0 +1,39 @@
+import { IAgenticaHistoryJson } from "@agentica/core";
+import { AutoBeOpenApi } from "@autobe/interface";
+import { v4 } from "uuid";
+
+import { AutoBeSystemPromptConstant } from "../../../constants/AutoBeSystemPromptConstant";
+import { AutoBeState } from "../../../context/AutoBeState";
+import { transformInterfaceAssetHistories } from "./transformInterfaceAssetHistories";
+
+export const transformInterfaceEndpointsReviewHistories = (
+  state: AutoBeState,
+  endpoints: AutoBeOpenApi.IEndpoint[],
+): Array<
+  IAgenticaHistoryJson.IAssistantMessage | IAgenticaHistoryJson.ISystemMessage
+> => [
+  {
+    type: "systemMessage",
+    id: v4(),
+    created_at: new Date().toISOString(),
+    text: AutoBeSystemPromptConstant.INTERFACE_ENDPOINT,
+  },
+  ...transformInterfaceAssetHistories(state),
+  {
+    id: v4(),
+    type: "assistantMessage",
+    text: [
+      "Below are endpoints generated by your request.",
+      "```json",
+      JSON.stringify(endpoints),
+      "```",
+    ].join("\n"),
+    created_at: new Date().toISOString(),
+  },
+  {
+    id: v4(),
+    type: "systemMessage",
+    text: AutoBeSystemPromptConstant.INTERFACE_ENDPOINTS_REVIEW,
+    created_at: new Date().toISOString(),
+  },
+];

package/src/orchestrate/interface/histories/transformInterfaceSchemasReviewHistories.ts

@@ -10,10 +10,7 @@ import { transformInterfaceAssetHistories } from "./transformInterfaceAssetHisto
 export const transformInterfaceSchemasReviewHistories = (
   state: AutoBeState,
   operations: AutoBeOpenApi.IOperation[],
-  schemaDescriptive: Record<
-    string,
-    AutoBeOpenApi.IJsonSchemaDescriptive<AutoBeOpenApi.IJsonSchema>
-  >,
+  schemaDescriptive: Record<string, AutoBeOpenApi.IJsonSchemaDescriptive>,
 ): Array<
   IAgenticaHistoryJson.IAssistantMessage | IAgenticaHistoryJson.ISystemMessage
 > => {

package/src/orchestrate/interface/orchestrateInterface.ts

@@ -20,6 +20,7 @@ import { orchestrateInterfaceEndpoints } from "./orchestrateInterfaceEndpoints";
 import { orchestrateInterfaceGroups } from "./orchestrateInterfaceGroups";
 import { orchestrateInterfaceOperations } from "./orchestrateInterfaceOperations";
 import { orchestrateInterfaceSchemas } from "./orchestrateInterfaceSchemas";
+import { orchestrateInterfaceSchemasReview } from "./orchestrateInterfaceSchemasReview";
 
 export const orchestrateInterface =
   <Model extends ILlmSchema.Model>(ctx: AutoBeContext<Model>) =>
@@ -94,10 +95,20 @@ export const orchestrateInterface =
         schemas: await orchestrateInterfaceSchemas(ctx, operations),
       },
     };
-    Object.assign(
-      document.components.schemas,
-      await orchestrateInterfaceComplement(ctx, document),
-    );
+
+    const complementedSchemas: Record<
+      string,
+      AutoBeOpenApi.IJsonSchemaDescriptive
+    > = await orchestrateInterfaceComplement(ctx, document);
+    Object.assign(document.components.schemas, complementedSchemas);
+
+    const schemas: Record<string, AutoBeOpenApi.IJsonSchemaDescriptive> =
+      await orchestrateInterfaceSchemasReview(
+        ctx,
+        operations,
+        document.components.schemas,
+      );
+    Object.assign(document.components.schemas, schemas);
 
     // DO COMPILE
     return ctx.dispatch({

package/src/orchestrate/interface/orchestrateInterfaceAuthorizations.ts

@@ -61,7 +61,7 @@ async function process<Model extends ILlmSchema.Model>(
     histories: transformInterfaceAuthorizationsHistories(ctx.state(), role),
     controller: createController({
       model: ctx.model,
-      role: role.name,
+      role,
       build: (next) => {
         pointer.value = next;
       },
@@ -87,7 +87,7 @@ async function process<Model extends ILlmSchema.Model>(
 
 function createController<Model extends ILlmSchema.Model>(props: {
   model: Model;
-  role: string;
+  role: AutoBeAnalyzeRole;
   build: (next: IAutoBeInterfaceAuthorizationsApplication.IProps) => void;
 }): IAgenticaController.IClass<Model> {
   assertSchemaModel(props.model);
@@ -99,11 +99,18 @@ function createController<Model extends ILlmSchema.Model>(props: {
       typia.validate<IAutoBeInterfaceAuthorizationsApplication.IProps>(next);
     if (result.success === false) return result;
 
+    // remove login operation for guest role
+    if (props.role.kind === "guest") {
+      result.data.operations = result.data.operations.filter(
+        (op) => op.authorizationType !== "login",
+      );
+    }
+
     const errors: IValidation.IError[] = [];
     result.data.operations.forEach((op, i) => {
       // validate authorizationRole
       if (op.authorizationRole !== null) {
-        op.authorizationRole = props.role;
+        op.authorizationRole = props.role.name;
       }
 
       // validate responseBody.typeName -> must be ~.IAuthorized
@@ -148,7 +155,8 @@ function createController<Model extends ILlmSchema.Model>(props: {
         .filter((v) => v !== null),
     );
     for (const type of typia.misc.literals<AuthorizationType>())
-      if (authorizationTypes.has(type) === false)
+      if (props.role.kind === "guest" && type === "login") continue;
+      else if (authorizationTypes.has(type) === false)
         errors.push({
           path: "$input.operations[].authorizationType",
           expected: StringUtil.trim`{
@@ -160,7 +168,7 @@ function createController<Model extends ILlmSchema.Model>(props: {
           There must be an operation that has defined AutoBeOpenApi.IOperation.authorizationType := "${type}"
           for the "${props.role}" role's authorization activity; "${type}".
 
-          However, none of the operations have the AutoBeOpenApi.IOperation.authorizationType := "${type}" 
+          However, none of the operations have the AutoBeOpenApi.IOperation.authorizationType := "${type}"
           value, so that the "${props.role}" cannot perform the authorization ${type} activity.
 
           Please make that operation at the next function calling. You have to do it.