@autobe/agent 0.0.0 → 0.3.9

package/src/analyze/CreateReviewerAgent.ts

@@ -0,0 +1,126 @@
+import { MicroAgentica } from "@agentica/core";
+import { ILlmSchema } from "@samchon/openapi";
+
+import { AutoBeContext } from "../context/AutoBeContext";
+
+export const createReviewerAgent = <Model extends ILlmSchema.Model>(
+  ctx: AutoBeContext<Model>,
+  input: ICreateReviewerAgentInput,
+) => {
+  // All links specified in the markdown are drawn in advance and provided to LLM.
+  const markdownFiles = Array.from(
+    new Set(
+      Object.values(input.currentFiles).flatMap((content) => {
+        const fileExtensions = ["md"];
+
+        const regex = /\[[^\]]*\]\(([^)]+)\)/g;
+
+        const fileLinks = [...content.matchAll(regex)]
+          .map((match) => match[1])
+          .filter((link) => {
+            const ext = link.split(".").pop()?.toLowerCase();
+            return ext && fileExtensions.includes(ext);
+          });
+
+        return fileLinks;
+      }),
+    ),
+  );
+
+  return new MicroAgentica({
+    model: ctx.model,
+    vendor: ctx.vendor,
+    controllers: [],
+    config: {
+      systemPrompt: {
+        common: () => {
+          return [
+            "You are an excellent requirements analyst & reviewer agent.",
+            "",
+            `The reviewer's role is to ensure that this document contains sufficient information before it is delivered to developers`,
+            `These are all the links that are currently referenced in the markdown. Please make sure to refer to them and don't forget to create the corresponding files.`,
+            "Also, you should not create files that are not specified in the table of contents.",
+            "If you request the creation of a file that is not specified in the table of contents, instruct them to modify the table of contents first.",
+            "If the user specifies the exact number of pages, please follow it precisely.",
+            "",
+            "You should not write your own writing in any case, but only direct the modifications.",
+            "Also, reviewers are independent beings, and should never be instructed.",
+            "Your words should be instructions that must be followed, not recommendations.",
+            "",
+            `user said, "${input.query}"`,
+            "user requests will take precedence over the other system prompts below unless they are a security concern.",
+            "",
+            "If there are any changes that need to be made, please provide detailed instructions.",
+            "Just give clear and concise instructions, but don't say anything unnecessary.",
+            "",
+            "If you feel that the current level of analysis is sufficient, please do not make any further requests and notify us that it is complete.",
+            "",
+            "It is recommended to ask the planner to write a longer document (more than 1,000 letters) until it gives sufficient utility value.",
+            "However, even if the length of the document is less than 1,000 letters, pass it if the quality is compliant.",
+            "When increasing the volume of a document, explain to the planner how many letters the document currently has and how many more should be increased.",
+            "Rather than simply telling them to increase the text, it is better to count the number of tables of contents compared to the existing text and instruct them to double the amount if they want to double the amount.",
+            "When you add something about the table of contents, please clearly state the name of the table of contents.",
+            "",
+            "If the planner agent asks a question, the reviewer should answer on behalf of the user.",
+            "Please do not ask any questions.",
+            "Just give orders.",
+            "",
+            "If you have a hyperlink that is not yet complete, even if the document is of good quality, the document is considered incomplete.",
+            "You should also ask for the rest of the document to be created.",
+            "At this time, the document should be newly created with the name attached to the link, not modified.",
+            "<CurrentFiles>",
+            JSON.stringify(
+              Object.entries(input.currentFiles)
+                .slice(-2)
+                .map(([filename, content]) => {
+                  return {
+                    filename,
+                    content,
+                    content_length: content.length,
+                  };
+                }),
+              null,
+              2,
+            ),
+            "</CurrentFiles>",
+            "",
+            `These are all the links that are currently referenced in the markdown. Please make sure to refer to them and don't forget to create the corresponding files.`,
+            `<Linked Files>`,
+            markdownFiles.map((filename) => {
+              const isChecked = Object.keys(input.currentFiles).includes(
+                filename,
+              );
+              return `- [${isChecked}] ${filename}`;
+            }),
+            `</Linked Files>`,
+            "",
+            "Write a long document, but keep your answer short.",
+            "The planner agent can only create and modify one document at a time, so do not ask to create or modify multiple documents at a time.",
+            "If you say the document is complete, the planner will finish writing the document.",
+            "If only one document has been written out of several that need to be completed, do not simply state that it is complete—also provide instructions for what should be done next.",
+            "For example, if you say, “The document internal_bulletin_board_service_plan.md has already been written with over 1,000 characters. Its quality is sufficient, so mark it as complete without any further requests,” then the planner will respond with “Got it!” and stop writing—even if there are still remaining documents.",
+            "Be cautious: the planner will try to avoid work by interpreting your words in a way that lets them do less.",
+            "The correct response from you should be:",
+            "\“The document's quality is sufficient, so mark it as complete without any further requests. Now, proceed to write the next document immediately.\”",
+            "When requesting the next document to be written, you must include both the document title and a brief description of its content.",
+          ].join("\n");
+        },
+      },
+    },
+    tokenUsage: ctx.usage(),
+  });
+};
+
+export interface ICreateReviewerAgentInput {
+  /**
+   * Indicates the initial utterance of the user. Identify the purpose of your
+   * documentation for better review.
+   */
+  query: string;
+
+  /**
+   * Hand over the title and name of the file that has been created so far to
+   * the list.
+   */
+  currentFiles: Record<string, string>;
+}

package/src/analyze/Planning.ts

@@ -0,0 +1,75 @@
+type Filename = string;
+type FileContent = string;
+
+export interface IPlanning {
+  /**
+   * Generate markdown file. if there is already created file, overwrite it.
+   *
+   * @param input.reason Describe briefly why you made this document, and if you
+   *   have any plans for the next one.
+   * @param input.filename Filename to generate or overwrite.
+   * @param input.markdown Markdown file content. Only write the content of the
+   *   file. Do not include any questions.
+   */
+  createOrUpdateFile(input: {
+    reason: string;
+    filename: `${string}.md`;
+    markdown: string;
+  }): Promise<void>;
+
+  /**
+   * Read markdown file content.
+   *
+   * @param input.filename Filename to read.
+   */
+  // readFile(input: { filename: `${string}.md` }): Promise<string>;
+
+  /**
+   * Remove markdown file.
+   *
+   * @param input.name Filename to remove
+   */
+  removeFile(input: { filename: `${string}.md` }): Promise<void>;
+
+  /**
+   * If you decide that you no longer need any reviews, or if the reviewer
+   * refuses to do so, call abort. This is a function to end document creation
+   * and review, and to respond to users.
+   *
+   * When there is content you are unsure about and need to ask the user a
+   * question, abort the process and ask the user directly. The reason for
+   * aborting should be included as the content of the question.
+   *
+   * @param input.reason Should contain the reason for the abort.
+   */
+  abort(input: { reason: string }): "OK";
+}
+
+export class Planning implements IPlanning {
+  constructor(private readonly fileMap: Record<Filename, FileContent> = {}) {}
+
+  async createOrUpdateFile(input: {
+    reason: string;
+    filename: `${string}.md`;
+    markdown: string;
+  }): Promise<void> {
+    this.fileMap[input.filename] = input.markdown;
+  }
+
+  // async readFile(input: { filename: `${string}.md` }): Promise<string> {
+  //   return this.fileMap[input.filename];
+  // }
+
+  async removeFile(input: { filename: `${string}.md` }): Promise<void> {
+    delete this.fileMap[input.filename];
+  }
+
+  abort(_input: { reason: string }): "OK" {
+    return "OK";
+  }
+
+  /** @ignore */
+  allFiles(): Record<string, string> {
+    return this.fileMap;
+  }
+}