@saltcorn/agents 0.1.0 → 0.1.2

package/README.md

@@ -1,2 +1,10 @@
 # agents
+
 AI Agents for Saltcorn
+
+To use this plugin:
+
+1. Create an action of type Agent. Configure with system prompt and skills
+2. Create a view of type Agent chat, picking that agent in the configuration
+
+The module is currently unstable. Some skills will be moved to other modules which will have to be installed as well.

package/agent-view.js

@@ -33,6 +33,10 @@ const {
   incompleteCfgMsg,
   getCompletionArguments,
   find_tool,
+  addToContext,
+  wrapCard,
+  wrapSegment,
+  process_interaction,
 } = require("./common");
 const MarkdownIt = require("markdown-it"),
   md = new MarkdownIt();
@@ -72,6 +76,12 @@ const configuration_workflow = (req) =>
                 label: "Show previous runs",
                 type: "Bool",
               },
+              {
+                name: "placeholder",
+                label: "Placeholder",
+                type: "String",
+                default: "How can I help you?"
+              },
             ],
           });
         },
@@ -84,7 +94,7 @@ const get_state_fields = () => [];
 const run = async (
   table_id,
   viewname,
-  { action_id, show_prev_runs },
+  { action_id, show_prev_runs, placeholder },
   state,
   { res, req }
 ) => {
@@ -120,7 +130,7 @@ const run = async (
               interactMarkups.push(
                 div(
                   { class: "interaction-segment" },
-                  span({ class: "badge bg-secondary" }, "Copilot"),
+                  span({ class: "badge bg-secondary" }, action.name),
                   typeof interact.content === "string"
                     ? md.render(interact.content)
                     : interact.content
@@ -146,7 +156,7 @@ const run = async (
                             toolSkill.skill.constructor.skill_name,
                           rendered
                         ),
-                        "Copilot"
+                        action.name
                       )
                     );
                 }
@@ -156,7 +166,7 @@ const run = async (
             interactMarkups.push(
               div(
                 { class: "interaction-segment" },
-                span({ class: "badge bg-secondary" }, "Copilot"),
+                span({ class: "badge bg-secondary" }, action.name),
                 typeof interact.content === "string"
                   ? md.render(interact.content)
                   : interact.content
@@ -188,7 +198,7 @@ const run = async (
                       interact.name,
                     markupContent
                   ),
-                  "Copilot"
+                  action.name
                 )
               );
           }
@@ -220,7 +230,7 @@ const run = async (
         class: "form-control",
         name: "userinput",
         "data-fieldname": "userinput",
-        placeholder: "How can I help you?",
+        placeholder: placeholder || "How can I help you?",
         id: "inputuserinput",
         rows: "3",
         autofocus: true,
@@ -406,7 +416,9 @@ const interact = async (table_id, viewname, config, body, { req, res }) => {
       interactions: [{ role: "user", content: userinput }],
     });
   }
-  return await process_interaction(run, config, req);
+  const action = await Trigger.findOne({ id: config.action_id });
+
+  return await process_interaction(run, action.configuration, req, action.name);
 };
 
 const delprevrun = async (table_id, viewname, config, body, { req, res }) => {
@@ -420,130 +432,6 @@ const delprevrun = async (table_id, viewname, config, body, { req, res }) => {
   return;
 };
 
-const process_interaction = async (run, config, req, prevResponses = []) => {
-  const action = await Trigger.findOne({ id: config.action_id });
-  const complArgs = await getCompletionArguments(action.configuration);
-  complArgs.chat = run.context.interactions;
-  //complArgs.debugResult = true;
-  console.log("complArgs", JSON.stringify(complArgs, null, 2));
-
-  const answer = await getState().functions.llm_generate.run("", complArgs);
-  console.log("answer", answer);
-  await addToContext(run, {
-    interactions:
-      typeof answer === "object" && answer.tool_calls
-        ? [
-            {
-              role: "assistant",
-              tool_calls: answer.tool_calls,
-              content: answer.content,
-            },
-          ]
-        : [{ role: "assistant", content: answer }],
-  });
-  const responses = [];
-
-  if (typeof answer === "object" && answer.tool_calls) {
-    if (answer.content)
-      responses.push(wrapSegment(md.render(answer.content), "Copilot"));
-    //const actions = [];
-    let hasResult = false;
-    for (const tool_call of answer.tool_calls) {
-      console.log("call function", tool_call.function);
-
-      await addToContext(run, {
-        funcalls: { [tool_call.id]: tool_call.function },
-      });
-
-      const tool = find_tool(tool_call.function.name, action.configuration);
-
-      if (tool) {
-        if (tool.tool.renderToolCall) {
-          const row = JSON.parse(tool_call.function.arguments);
-          const rendered = await tool.tool.renderToolCall(row, {
-            req,
-          });
-          if (rendered)
-            responses.push(
-              wrapSegment(
-                wrapCard(
-                  tool.skill.skill_label || tool.skill.constructor.skill_name,
-                  rendered
-                ),
-                "Copilot"
-              )
-            );
-        }
-        hasResult = true;
-        const result = await tool.tool.process(
-          JSON.parse(tool_call.function.arguments)
-        );
-        if (
-          (typeof result === "object" && Object.keys(result || {}).length) ||
-          typeof result === "string"
-        ) {
-          if (tool.tool.renderToolResponse) {
-            const rendered = await tool.tool.renderToolResponse(result, {
-              req,
-            });
-            if (rendered)
-              responses.push(
-                wrapSegment(
-                  wrapCard(
-                    tool.skill.skill_label || tool.skill.constructor.skill_name,
-                    rendered
-                  ),
-                  "Copilot"
-                )
-              );
-          }
-          hasResult = true;
-        }
-        await addToContext(run, {
-          interactions: [
-            {
-              role: "tool",
-              tool_call_id: tool_call.id,
-              name: tool_call.function.name,
-              content:
-                result && typeof result !== "string"
-                  ? JSON.stringify(result)
-                  : result || "Action run",
-            },
-          ],
-        });
-      }
-    }
-    if (hasResult)
-      return await process_interaction(run, config, req, [
-        ...prevResponses,
-        ...responses,
-      ]);
-  } else responses.push(wrapSegment(md.render(answer), "Copilot"));
-
-  return {
-    json: {
-      success: "ok",
-      response: [...prevResponses, ...responses].join(""),
-      run_id: run.id,
-    },
-  };
-};
-
-const wrapSegment = (html, who) =>
-  '<div class="interaction-segment"><span class="badge bg-secondary">' +
-  who +
-  "</span>" +
-  html +
-  "</div>";
-
-const wrapCard = (title, ...inners) =>
-  span({ class: "badge bg-info ms-1" }, title) +
-  div(
-    { class: "card mb-3 bg-secondary-subtle" },
-    div({ class: "card-body" }, inners)
-  );
-
 const wrapAction = (
   inner_markup,
   viewname,
@@ -575,28 +463,6 @@ const wrapAction = (
         ) + div({ id: "postexec-" + tool_call.id })
   );
 
-const addToContext = async (run, newCtx) => {
-  if (run.addToContext) return await run.addToContext(newCtx);
-  let changed = true;
-  Object.keys(newCtx).forEach((k) => {
-    if (Array.isArray(run.context[k])) {
-      if (!Array.isArray(newCtx[k]))
-        throw new Error("Must be array to append to array");
-      run.context[k].push(...newCtx[k]);
-      changed = true;
-    } else if (typeof run.context[k] === "object") {
-      if (typeof newCtx[k] !== "object")
-        throw new Error("Must be object to append to object");
-      Object.assign(run.context[k], newCtx[k]);
-      changed = true;
-    } else {
-      run.context[k] = newCtx[k];
-      changed = true;
-    }
-  });
-  if (changed) await run.update({ context: run.context });
-};
-
 module.exports = {
   name: "Agent Chat",
   configuration_workflow,

package/common.js

@@ -1,9 +1,14 @@
 const { getState } = require("@saltcorn/data/db/state");
+const { div, span } = require("@saltcorn/markup/tags");
+const Trigger = require("@saltcorn/data/models/trigger");
+
+const MarkdownIt = require("markdown-it"),
+  md = new MarkdownIt();
 
 const get_skills = () => {
   return [
-    //require("./skills/EmbeddingRetrieval"),
     require("./skills/FTSRetrieval"),
+    require("./skills/EmbeddingRetrieval"),
     //require("./skills/AdaptiveFeedback"),
   ];
 };
@@ -37,7 +42,6 @@ const find_tool = (name, config) => {
   }
 };
 
-
 const getCompletionArguments = async (config) => {
   let tools = [];
 
@@ -55,7 +59,6 @@ const getCompletionArguments = async (config) => {
   return { tools, systemPrompt: sysPrompts.join("\n\n") };
 };
 
-
 const getCompletion = async (language, prompt) => {
   return getState().functions.llm_generate.run(prompt, {
     systemPrompt: `You are a helpful code assistant. Your language of choice is ${language}. Do not include any explanation, just generate the code block itself.`,
@@ -81,6 +84,157 @@ const incompleteCfgMsg = () => {
   }
 };
 
+const addToContext = async (run, newCtx) => {
+  if (run.addToContext) return await run.addToContext(newCtx);
+  let changed = true;
+  Object.keys(newCtx).forEach((k) => {
+    if (Array.isArray(run.context[k])) {
+      if (!Array.isArray(newCtx[k]))
+        throw new Error("Must be array to append to array");
+      run.context[k].push(...newCtx[k]);
+      changed = true;
+    } else if (typeof run.context[k] === "object") {
+      if (typeof newCtx[k] !== "object")
+        throw new Error("Must be object to append to object");
+      Object.assign(run.context[k], newCtx[k]);
+      changed = true;
+    } else {
+      run.context[k] = newCtx[k];
+      changed = true;
+    }
+  });
+  if (changed) await run.update({ context: run.context });
+};
+
+const wrapSegment = (html, who) =>
+  '<div class="interaction-segment"><span class="badge bg-secondary">' +
+  who +
+  "</span>" +
+  html +
+  "</div>";
+
+const wrapCard = (title, ...inners) =>
+  span({ class: "badge bg-info ms-1" }, title) +
+  div(
+    { class: "card mb-3 bg-secondary-subtle" },
+    div({ class: "card-body" }, inners)
+  );
+
+const process_interaction = async (
+  run,
+  config,
+  req,
+  agent_label = "Copilot",
+  prevResponses = []
+) => {
+  const complArgs = await getCompletionArguments(config);
+  complArgs.chat = run.context.interactions;
+  //complArgs.debugResult = true;
+  console.log("complArgs", JSON.stringify(complArgs, null, 2));
+
+  const answer = await getState().functions.llm_generate.run("", complArgs);
+  console.log("answer", answer);
+  await addToContext(run, {
+    interactions:
+      typeof answer === "object" && answer.tool_calls
+        ? [
+            {
+              role: "assistant",
+              tool_calls: answer.tool_calls,
+              content: answer.content,
+            },
+          ]
+        : [{ role: "assistant", content: answer }],
+  });
+  const responses = [];
+
+  if (typeof answer === "object" && answer.tool_calls) {
+    if (answer.content)
+      responses.push(wrapSegment(md.render(answer.content), agent_label));
+    //const actions = [];
+    let hasResult = false;
+    for (const tool_call of answer.tool_calls) {
+      console.log("call function", tool_call.function);
+
+      await addToContext(run, {
+        funcalls: { [tool_call.id]: tool_call.function },
+      });
+
+      const tool = find_tool(tool_call.function.name, config);
+
+      if (tool) {
+        if (tool.tool.renderToolCall) {
+          const row = JSON.parse(tool_call.function.arguments);
+          const rendered = await tool.tool.renderToolCall(row, {
+            req,
+          });
+          if (rendered)
+            responses.push(
+              wrapSegment(
+                wrapCard(
+                  tool.skill.skill_label || tool.skill.constructor.skill_name,
+                  rendered
+                ),
+                agent_label
+              )
+            );
+        }
+        hasResult = true;
+        const result = await tool.tool.process(
+          JSON.parse(tool_call.function.arguments)
+        );
+        if (
+          (typeof result === "object" && Object.keys(result || {}).length) ||
+          typeof result === "string"
+        ) {
+          if (tool.tool.renderToolResponse) {
+            const rendered = await tool.tool.renderToolResponse(result, {
+              req,
+            });
+            if (rendered)
+              responses.push(
+                wrapSegment(
+                  wrapCard(
+                    tool.skill.skill_label || tool.skill.constructor.skill_name,
+                    rendered
+                  ),
+                  agent_label
+                )
+              );
+          }
+          hasResult = true;
+        }
+        await addToContext(run, {
+          interactions: [
+            {
+              role: "tool",
+              tool_call_id: tool_call.id,
+              name: tool_call.function.name,
+              content:
+                result && typeof result !== "string"
+                  ? JSON.stringify(result)
+                  : result || "Action run",
+            },
+          ],
+        });
+      }
+    }
+    if (hasResult)
+      return await process_interaction(run, config, req, agent_label, [
+        ...prevResponses,
+        ...responses,
+      ]);
+  } else responses.push(wrapSegment(md.render(answer), agent_label));
+
+  return {
+    json: {
+      success: "ok",
+      response: [...prevResponses, ...responses].join(""),
+      run_id: run.id,
+    },
+  };
+};
+
 module.exports = {
   get_skills,
   get_skill_class,
@@ -88,5 +242,9 @@ module.exports = {
   getCompletion,
   find_tool,
   get_skill_instances,
-  getCompletionArguments
+  getCompletionArguments,
+  addToContext,
+  wrapCard,
+  wrapSegment,
+  process_interaction,
 };

package/index.js

@@ -2,7 +2,11 @@ const Workflow = require("@saltcorn/data/models/workflow");
 const Form = require("@saltcorn/data/models/form");
 const FieldRepeat = require("@saltcorn/data/models/fieldrepeat");
 const { features } = require("@saltcorn/data/db/state");
-const { get_skills, getCompletionArguments } = require("./common");
+const {
+  get_skills,
+  getCompletionArguments,
+  process_interaction,
+} = require("./common");
 const { applyAsync } = require("@saltcorn/data/utils");
 const WorkflowRun = require("@saltcorn/data/models/workflow_run");
 const { interpolate } = require("@saltcorn/data/utils");
@@ -68,7 +72,7 @@ module.exports = {
           }),
         ];
       },
-      run: async ({ configuration, user, row, trigger_id, ...rest }) => {
+      run: async ({ configuration, user, row, trigger_id, req, ...rest }) => {
         const userinput = interpolate(configuration.prompt, row, user);
         const run = await WorkflowRun.create({
           status: "Running",
@@ -80,11 +84,7 @@ module.exports = {
             funcalls: {},
           },
         });
-        const complArgs = await getCompletionArguments(configuration);
-        const answer = await getState().functions.llm_generate.run(
-          "",
-          complArgs
-        );
+        return await process_interaction(run, configuration, req);
       },
     },
   },
@@ -93,8 +93,9 @@ module.exports = {
 /* 
 TODO
 
--embedding retrieval
--run as action
--view: set placeholder, labels
+-embedding retrieval test
+-promote triggers to skills (optional user confirm)
+-sql access
+-memory
 
 */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saltcorn/agents",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "AI agents for Saltcorn",
   "main": "index.js",
   "dependencies": {

package/skills/EmbeddingRetrieval.js

@@ -25,7 +25,11 @@ class RetrievalByEmbedding {
         table.name
       }${
         table.description ? ` (${table.description})` : ""
-      } for documents related to a search phrase or a question`;
+      } for documents related to a search phrase or a question.${
+        this.add_sys_prompt
+          ? ` Additional information for the ${this.toolName} tool: ${this.add_sys_prompt}`
+          : ""
+      }`;
     }
   }
 
@@ -33,7 +37,6 @@ class RetrievalByEmbedding {
     const allTables = await Table.find();
     const tableOpts = [];
     const relation_opts = {};
-    const list_view_opts = {};
     for (const table of allTables) {
       table.fields
         .filter((f) => f.type?.name === "PGVector")
@@ -44,8 +47,6 @@ class RetrievalByEmbedding {
             .filter((f) => f.is_fkey)
             .map((f) => f.name);
           relation_opts[relNm] = ["", ...fkeys];
-          
-          list_view_opts[relNm] = []
         });
     }
     return [
@@ -73,20 +74,22 @@ class RetrievalByEmbedding {
         required: true,
         attributes: { calcOptions: ["vec_field", relation_opts] },
       },
-       {
-        name: "list_view",
-        label: "List view",
+      {
+        name: "hidden_fields",
+        label: "Hide fields",
         type: "String",
-        attributes: {
-          calcOptions: ["vec_field", list_view_opts],
-        },
+        sublabel: "Comma-separated list of fields to hide from the prompt",
       },
       {
-        name: "contents_expr",
-        label: "Contents string",
+        name: "limit",
+        label: "Limit",
+        sublabel: "Max number of rows to find",
+        type: "String",
+      },
+      {
+        name: "add_sys_prompt",
+        label: "Additional prompt",
         type: "String",
-        sublabel:
-          "Use handlebars (<code>{{ }}</code>) to access fields in the retrieved rows",
       },
     ];
   }
@@ -103,28 +106,51 @@ class RetrievalByEmbedding {
       : table0;
     return {
       type: "function",
-      process({ phrase_or_question }) {
-        return {
-          response: "There are no documents related to: " + phrase_or_question,
-        };
-      },
-      renderToolResponse: async ({ response, rows }, { req }) => {
-        if (rows) {
-          const view = View.findOne({ name: this.list_view });
-
-          if (view) {
-            const viewRes = await view.run(
-              {
-                [table_docs.pk_name]: {
-                  in: rows.map((r) => r[table_docs.pk_name]),
-                },
-              },
-              { req }
-            );
-            return viewRes;
-          } else return "";
+      process: async ({ phrase_or_question }) => {
+        const [table_name, field_name] = this.vec_field.split(".");
+        const table = Table.findOne({ name: table_name });
+        if (!table)
+          throw new Error(
+            `Table ${table_name} not found in vector_similarity_search action`
+          );
+        const embedF = getState().functions.llm_embedding;
+        const opts = {};
+        const qembed = await embedF.run(phrase_or_question, opts);
+        const selLimit = +(this.limit || 10);
+        const rows = await table.getRows(
+          {},
+          {
+            orderBy: {
+              operator: "nearL2",
+              field: field_name,
+              target: JSON.stringify(qembed),
+            },
+            limit: this.doc_relation ? 5 * selLimit : selLimit,
+          }
+        );
+        rows.forEach((r) => {
+          delete r[field_name];
+        });
+        if (!rows.length)
+          return {
+            response:
+              "There are no documents related to: " + phrase_or_question,
+          };
+        else if (!this.doc_relation) return { rows };
+        else {
+          const relField = table.getField(this.doc_relation);
+          const relTable = Table.findOne(relField.reftable_name);
+          const ids = [];
+          rows.forEach((vrow) => {
+            if (ids.length < selLimit) ids.push(vrow[this.doc_relation]);
+          });
+          const docsUnsorted = await relTable.getRows({ id: { in: ids } });
+          //ensure order
+          const docs = ids
+            .map((id) => docsUnsorted.find((d) => d.id == id))
+            .filter(Boolean);
+          return { rows: docs };
         }
-        return div({ class: "border border-success p-2 m-2" }, response);
       },
       function: {
         name: this.toolName,

package/skills/FTSRetrieval.js

@@ -23,7 +23,13 @@ class RetrievalByFullTextSearch {
 
   systemPrompt() {
     if (this.mode === "Tool")
-      return `Use the ${this.toolName} tool to search the ${this.table_name} database by a search phrase which will locate rows where any field match that query`;
+      return `Use the ${this.toolName} tool to search the ${
+        this.table_name
+      } database by a search phrase which will locate rows where any field match that query.${
+        this.add_sys_prompt
+          ? ` Additional information for the ${this.toolName} tool: ${this.add_sys_prompt}`
+          : ""
+      }`;
   }
 
   static async configFields() {
@@ -68,6 +74,11 @@ class RetrievalByFullTextSearch {
         type: "String",
         sublabel: "Comma-separated list of fields to hide from the prompt",
       },
+      {
+        name: "add_sys_prompt",
+        label: "Additional prompt",
+        type: "String",
+      },
       /*{
         name: "contents_expr",
         label: "Contents string",