@nocobase/plugin-ai 2.2.19 → 2.2.20

package/dist/server/ai-employees/ai-employee.js

@@ -228,12 +228,14 @@ class AIEmployee {
       providerName: service.provider,
       llmService: ((_a = service.get) == null ? void 0 : _a.call(service, "name")) || service.name
     });
+    const contextMessages = [...historyMessages, ...userMessages ?? []];
+    const knowledgeBaseContext = await this.retrieveKnowledgeBase(contextMessages);
     const chatContext = await this.aiChatConversation.getChatContext({
-      userMessages: [...historyMessages, ...userMessages ?? []],
+      userMessages: contextMessages,
       userDecisions,
       tools: resolvedTools,
       middleware,
-      getSystemPrompt: (userMessages2) => this.getSystemPrompt(userMessages2),
+      getSystemPrompt: (userMessages2) => this.getSystemPrompt(userMessages2, knowledgeBaseContext),
       formatMessages: (messages) => this.formatMessages({ messages, provider })
     });
     return {
@@ -243,7 +245,8 @@ class AIEmployee {
       provider,
       chatContext,
       config,
-      state
+      state,
+      knowledgeBaseDocuments: knowledgeBaseContext.documents
     };
   }
   async stream({
@@ -259,7 +262,7 @@ class AIEmployee {
       }
     });
     try {
-      const { providerName, llmService, model, provider, chatContext, config, state } = await this.buildChatContext({
+      const { providerName, llmService, model, provider, chatContext, config, state, knowledgeBaseDocuments } = await this.buildChatContext({
         messageId,
         userMessages,
         userDecisions
@@ -278,7 +281,8 @@ class AIEmployee {
         llmService,
         model,
         provider,
-        responseMetadata
+        responseMetadata,
+        knowledgeBaseDocuments
       });
       return true;
     } catch (err) {
@@ -428,7 +432,23 @@ class AIEmployee {
     var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z;
     const aiMessageIdMap = /* @__PURE__ */ new Map();
     const persistedAIMessageIdMap = /* @__PURE__ */ new Map();
-    const { signal, providerName, llmService, model, provider, responseMetadata, allowEmpty = false } = options;
+    const {
+      signal,
+      providerName,
+      llmService,
+      model,
+      provider,
+      responseMetadata,
+      allowEmpty = false,
+      knowledgeBaseDocuments = []
+    } = options;
+    const knowledgeBaseReferences = /* @__PURE__ */ new Map();
+    const collectKnowledgeBaseReferences = (documents) => {
+      for (const document of documents) {
+        knowledgeBaseReferences.set(String(document.id), document);
+      }
+    };
+    let lastAIMessageId;
     const reasoningState = new import_reasoning_stream_state.ReasoningStreamState();
     const stopReasoning = async (conversation) => {
       if (reasoningState.stop(conversation)) {
@@ -449,7 +469,7 @@ class AIEmployee {
           try {
             await stopAllReasoning();
             if ((gathered == null ? void 0 : gathered.type) === "ai") {
-              await this.finalizeAbortedAIMessage({
+              const result = await this.finalizeAbortedAIMessage({
                 aiMessage: gathered,
                 providerName,
                 provider,
@@ -457,6 +477,9 @@ class AIEmployee {
                 model,
                 knownMessageId: persistedAIMessageIdMap.get(gathered.id)
               });
+              if (result) {
+                lastAIMessageId = result.message.messageId;
+              }
             }
           } catch (e) {
             this.logger.error("Fail to save message after conversation abort", gathered);
@@ -480,6 +503,10 @@ class AIEmployee {
         username: this.employee.username
       };
       await this.protocol.with(aiEmployeeConversation).startStream();
+      if (knowledgeBaseDocuments.length) {
+        collectKnowledgeBaseReferences(knowledgeBaseDocuments);
+        await this.protocol.with(aiEmployeeConversation).knowledgeBaseReferences({ documents: knowledgeBaseDocuments });
+      }
       for await (const [mode, chunks] of stream) {
         if (mode === "messages") {
           const [chunk, metadata] = chunks;
@@ -536,6 +563,9 @@ class AIEmployee {
             await this.streamCached.skipped();
             aiMessageIdMap.set(currentConversation.sessionId, chunks.body.messageId);
             persistedAIMessageIdMap.set(chunks.body.id, chunks.body.messageId);
+            if (currentConversation.sessionId === this.sessionId) {
+              lastAIMessageId = chunks.body.messageId;
+            }
             const data = responseMetadata.get(chunks.body.id);
             if (data) {
               const savedMessage = await this.aiMessagesModel.findOne({
@@ -622,6 +652,13 @@ class AIEmployee {
             await this.protocol.with(currentConversation).newMessage();
           } else if (chunks.action === "afterSubAgentInvoke") {
             await this.protocol.with(currentConversation).subAgentCompleted();
+          } else if (chunks.action === "knowledgeBaseRetrieved") {
+            const { toolCallId, documents = [] } = chunks.body ?? {};
+            collectKnowledgeBaseReferences(documents);
+            await this.protocol.with({
+              ...currentConversation,
+              from: currentConversation.sessionId === this.sessionId ? this.from : "sub-agent"
+            }).knowledgeBaseReferences({ toolCallId, documents });
           }
         }
       }
@@ -641,11 +678,32 @@ class AIEmployee {
       }
     } finally {
       await abortFinalization;
+      await this.saveKnowledgeBaseReferences(lastAIMessageId, Array.from(knowledgeBaseReferences.values()));
       if (this.from === "main-agent") {
         this.ctx.res.end();
       }
     }
   }
+  async saveKnowledgeBaseReferences(messageId, documents) {
+    if (!messageId || !documents.length) {
+      return;
+    }
+    try {
+      const savedMessage = await this.aiMessagesModel.findOne({
+        where: { sessionId: this.sessionId, messageId }
+      });
+      if (!savedMessage) {
+        return;
+      }
+      const metadata = savedMessage.get("metadata") ?? {};
+      await this.aiMessagesModel.update(
+        { metadata: { ...metadata, knowledgeBaseReferences: documents } },
+        { where: { sessionId: this.sessionId, messageId } }
+      );
+    } catch (error) {
+      this.logger.error("Failed to save knowledge base references", { sessionId: this.sessionId, messageId, error });
+    }
+  }
   async handleInterruptedToolCalls(interrupt, getMessageId, onInterrupted) {
     const interruptId = interrupt == null ? void 0 : interrupt.id;
     const interruptActions = this.toInterruptActions(interrupt == null ? void 0 : interrupt.value);
@@ -721,14 +779,10 @@ Field: ${field.name}, Title: ${(_a = field.options.uiSchema) == null ? void 0 :
     }
     return message;
   }
-  async getSystemPrompt(userMessages) {
-    var _a, _b, _c, _d, _e, _f, _g, _h;
-    if (this.systemPromptMode === "none") {
-      return "";
-    }
-    const about = await (0, import_utils.parseVariables)(this.ctx, this.employee.about ?? this.employee.defaultPrompt ?? "");
-    if (this.systemPromptMode === "raw") {
-      return about;
+  async retrieveKnowledgeBase(userMessages) {
+    var _a;
+    if (this.systemPromptMode !== "default") {
+      return { documents: [] };
     }
     const employee = this.getAIEmployeeRecord();
     const knowledgeBaseManager = this.plugin.knowledgeBaseManager;
@@ -737,9 +791,37 @@ Field: ${field.name}, Title: ${(_a = field.options.uiSchema) == null ? void 0 :
     const hasAccessibleKnowledgeBase = knowledgeBaseEnabled ? await knowledgeBaseManager.hasAccessibleKnowledgeBase({ employee, roleNames }) : false;
     const knowledgeBaseAccessDenied = knowledgeBaseEnabled && !hasAccessibleKnowledgeBase;
     const knowledgeBaseOnDemand = knowledgeBaseEnabled && hasAccessibleKnowledgeBase && (0, import_ai_knowledge_base.normalizeKnowledgeBaseRetrievalStrategy)((_a = employee.knowledgeBase) == null ? void 0 : _a.retrievalStrategy) === "onDemand";
+    let prompt;
+    let documents = [];
+    if (knowledgeBaseEnabled && hasAccessibleKnowledgeBase && !knowledgeBaseOnDemand && (userMessages == null ? void 0 : userMessages.length)) {
+      const lastUserMessage = userMessages.filter((x) => x.role === "user").at(-1);
+      if (lastUserMessage) {
+        ({ prompt, documents } = await knowledgeBaseManager.retrievePrompt({
+          employee,
+          query: lastUserMessage.content.content,
+          roleNames
+        }));
+      }
+    }
+    const backgroundPrompt = (0, import_ai_knowledge_base.getKnowledgeBaseBackgroundPrompt)({
+      accessDenied: knowledgeBaseAccessDenied,
+      onDemand: knowledgeBaseOnDemand,
+      preRetrieved: Boolean(prompt)
+    });
+    return { prompt, backgroundPrompt, documents };
+  }
+  async getSystemPrompt(userMessages, knowledgeBaseContext) {
+    var _a, _b, _c, _d, _e, _f, _g;
+    if (this.systemPromptMode === "none") {
+      return "";
+    }
+    const about = await (0, import_utils.parseVariables)(this.ctx, this.employee.about ?? this.employee.defaultPrompt ?? "");
+    if (this.systemPromptMode === "raw") {
+      return about;
+    }
     const userConfig = await this.db.getRepository("usersAiEmployees").findOne({
       filter: {
-        userId: ((_b = this.ctx.auth) == null ? void 0 : _b.user.id) ?? 0,
+        userId: ((_a = this.ctx.auth) == null ? void 0 : _a.user.id) ?? 0,
         aiEmployee: this.employee.username
       }
     });
@@ -763,25 +845,9 @@ ${workContextBackground.join("\n")}`;
       background = `${background}
 ${addSystemPrompt.map((it) => it.content).join("\n")}`;
     }
-    let knowledgeBase;
-    if (knowledgeBaseEnabled && hasAccessibleKnowledgeBase && !knowledgeBaseOnDemand && (userMessages == null ? void 0 : userMessages.length)) {
-      const lastUserMessage = userMessages.filter((x) => x.role === "user").at(-1);
-      if (lastUserMessage) {
-        knowledgeBase = await knowledgeBaseManager.retrievePrompt({
-          employee,
-          query: lastUserMessage.content.content,
-          roleNames
-        });
-      }
-    }
-    const knowledgeBaseBackgroundPrompt = (0, import_ai_knowledge_base.getKnowledgeBaseBackgroundPrompt)({
-      accessDenied: knowledgeBaseAccessDenied,
-      onDemand: knowledgeBaseOnDemand,
-      preRetrieved: Boolean(knowledgeBase)
-    });
-    if (knowledgeBaseBackgroundPrompt) {
+    if (knowledgeBaseContext == null ? void 0 : knowledgeBaseContext.backgroundPrompt) {
       background = `${background}
-${knowledgeBaseBackgroundPrompt}`;
+${knowledgeBaseContext.backgroundPrompt}`;
     }
     const availableSkills = await this.getAvailableSkills();
     const availableAIEmployees = await this.getAvailableAIEmployees();
@@ -796,20 +862,20 @@ ${knowledgeBaseBackgroundPrompt}`;
       personal: userConfig == null ? void 0 : userConfig.prompt,
       environment: {
         database: this.db.sequelize.getDialect(),
-        locale: ((_d = (_c = this.ctx).getCurrentLocale) == null ? void 0 : _d.call(_c)) || "en-US",
+        locale: ((_c = (_b = this.ctx).getCurrentLocale) == null ? void 0 : _c.call(_b)) || "en-US",
         currentDateTime: getCurrentDateTimeForPrompt(
           await this.aiChatConversation.getCreatedAt(),
-          (_f = (_e = this.ctx).getCurrentLocale) == null ? void 0 : _f.call(_e),
+          (_e = (_d = this.ctx).getCurrentLocale) == null ? void 0 : _e.call(_d),
           getCurrentTimezone(this.ctx)
         ),
         timezone: getCurrentTimezone(this.ctx)
       },
-      knowledgeBase,
+      knowledgeBase: knowledgeBaseContext == null ? void 0 : knowledgeBaseContext.prompt,
       availableSkills,
       availableAIEmployees,
       webSearch: this.webSearch
     });
-    const { important } = ((_h = (_g = this.ctx.action) == null ? void 0 : _g.params) == null ? void 0 : _h.values) || {};
+    const { important } = ((_g = (_f = this.ctx.action) == null ? void 0 : _f.params) == null ? void 0 : _g.values) || {};
     if (important === "GraphRecursionError") {
       const importantPrompt = `<Important>You have already called tools multiple times and gathered sufficient information.
 First, provide a summary based on the existing information. Do not call additional tools.
@@ -1811,6 +1877,9 @@ class ChatStreamProtocol {
       subAgentCompleted: async () => {
         await write({ type: "sub_agent_completed" });
       },
+      knowledgeBaseReferences: async (body) => {
+        await write({ type: "knowledge_base_references", body });
+      },
       newMessage: async (content) => {
         await write({ type: "new_message", body: content });
       },

package/dist/server/ai-employees/ai-knowledge-base.d.ts

@@ -8,6 +8,7 @@
  */
 import { AIEmployee } from '../../collections/ai-employees';
 import type PluginAIServer from '../plugin';
+import type { KnowledgeBaseReference } from '../types';
 export declare const KNOWLEDGE_BASE_RETRIEVAL_STRATEGIES: readonly ["always", "onDemand"];
 export type KnowledgeBaseRetrievalStrategy = (typeof KNOWLEDGE_BASE_RETRIEVAL_STRATEGIES)[number];
 export declare const isKnowledgeBaseRetrievalStrategy: (value: unknown) => value is "always" | "onDemand";
@@ -28,6 +29,10 @@ export type KnowledgeBaseRetrieveOptions = {
     query: string;
     roleNames?: string[];
 };
+export type KnowledgeBaseRetrieveResult = {
+    prompt: string;
+    documents: KnowledgeBaseReference[];
+};
 export type KnowledgeBaseAccessOptions = {
     employee: AIEmployee;
     roleNames: string[];
@@ -35,7 +40,8 @@ export type KnowledgeBaseAccessOptions = {
 export declare class KnowledgeBaseManager {
     private readonly plugin;
     constructor(plugin: PluginAIServer);
-    retrievePrompt({ username, employee, query, roleNames }: KnowledgeBaseRetrieveOptions): Promise<string>;
+    retrievePrompt({ username, employee, query, roleNames, }: KnowledgeBaseRetrieveOptions): Promise<KnowledgeBaseRetrieveResult>;
+    private getDocumentReferences;
     hasAccessibleKnowledgeBase({ employee, roleNames }: KnowledgeBaseAccessOptions): Promise<boolean>;
     isEnabledKnowledgeBase(username: string): Promise<boolean>;
     isEnabledKnowledgeBase(employee: AIEmployee): Promise<boolean>;

package/dist/server/ai-employees/ai-knowledge-base.js

@@ -115,27 +115,50 @@ class KnowledgeBaseManager {
   constructor(plugin) {
     this.plugin = plugin;
   }
-  async retrievePrompt({ username, employee, query, roleNames }) {
+  async retrievePrompt({
+    username,
+    employee,
+    query,
+    roleNames
+  }) {
     employee = employee ?? (username ? await this.getEmployee(username) : null);
     if (!employee) {
-      return "Specified knowledge base not existed";
+      return { prompt: "Specified knowledge base not existed", documents: [] };
     }
     const { knowledgeBaseKeys = [], topK, score } = employee.knowledgeBase ?? {};
     const knowledgeBasePrompt = employee.knowledgeBasePrompt ?? "{knowledgeBaseData}";
     const docs = await this.plugin.features.knowledgeBase.search({ knowledgeBaseKeys, query, topK, score, roleNames });
     if (!(docs == null ? void 0 : docs.length)) {
-      return "No document match in knowledge base";
+      return { prompt: "No document match in knowledge base", documents: [] };
     }
     const knowledgeBaseData = docs.map((doc) => buildKnowledgeBaseContent(doc.content, doc.metadata)).join("\n");
     if (import_lodash.default.isEmpty(knowledgeBaseData)) {
-      return "No document match in knowledge base";
+      return { prompt: "No document match in knowledge base", documents: [] };
     }
+    const documents = await this.getDocumentReferences(docs);
     if (!(0, import_ai_employee_validation.hasKnowledgeBaseDataPlaceholder)(knowledgeBasePrompt)) {
-      return `${knowledgeBasePrompt}
+      return { prompt: `${knowledgeBasePrompt}
 
-${knowledgeBaseData}`;
+${knowledgeBaseData}`, documents };
     }
-    return import_prompts.ChatPromptTemplate.fromTemplate(knowledgeBasePrompt).format({ knowledgeBaseData });
+    const prompt = await import_prompts.ChatPromptTemplate.fromTemplate(knowledgeBasePrompt).format({ knowledgeBaseData });
+    return { prompt, documents };
+  }
+  async getDocumentReferences(docs) {
+    const knowledgeBaseFeature = this.plugin.features.knowledgeBase;
+    if (!knowledgeBaseFeature.getDocumentReferences) {
+      return [];
+    }
+    const knowledgeBaseDocsIds = import_lodash.default.uniq(
+      docs.map((doc) => {
+        var _a;
+        return (_a = doc.metadata) == null ? void 0 : _a.knowledgeBaseDocsId;
+      }).filter((id) => typeof id === "number" || typeof id === "string" && id !== "")
+    );
+    if (!knowledgeBaseDocsIds.length) {
+      return [];
+    }
+    return await knowledgeBaseFeature.getDocumentReferences(knowledgeBaseDocsIds);
   }
   async hasAccessibleKnowledgeBase({ employee, roleNames }) {
     var _a;

package/dist/server/features/knowledge-base.d.ts

@@ -6,11 +6,12 @@
  * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
-import { DocumentSegmentedWithScore, KnowledgeBase, KnowledgeBaseGroup, SearchOptions } from '../types';
+import { DocumentSegmentedWithScore, KnowledgeBase, KnowledgeBaseGroup, KnowledgeBaseReference, SearchOptions } from '../types';
 export type KnowledgeBaseAccessOptions = Pick<SearchOptions, 'knowledgeBaseKeys' | 'roleNames'>;
 export interface KnowledgeBaseFeature {
     getKnowledgeBase(knowledgeBaseKeys: string[]): Promise<KnowledgeBase[]>;
     getKnowledgeBaseGroup(knowledgeBaseKeys: string[]): Promise<KnowledgeBaseGroup[]>;
     getAccessibleKnowledgeBaseKeys(options: KnowledgeBaseAccessOptions): Promise<string[]>;
     search(options: SearchOptions): Promise<DocumentSegmentedWithScore[]>;
+    getDocumentReferences?(knowledgeBaseDocsIds: Array<number | string>): Promise<KnowledgeBaseReference[]>;
 }

package/dist/server/types/knowledge-base.type.d.ts

@@ -51,3 +51,9 @@ export type SearchOptions = {
     score?: string;
     roleNames?: string[];
 };
+export type KnowledgeBaseReference = {
+    id: number | string;
+    title: string;
+    extname: string;
+    url: string;
+};

package/package.json

@@ -6,7 +6,7 @@
   "description": "Create AI employees with diverse skills to collaborate with humans, build systems, and handle business operations.",
   "description.ru-RU": "Поддержка интеграции с AI-сервисами: предоставляются AI-узлы для рабочих процессов, расширяя возможности бизнес-обработки.",
   "description.zh-CN": "创建各种技能的 AI 员工，与人类协同，搭建系统，处理业务。",
-  "version": "2.2.19",
+  "version": "2.2.20",
   "main": "dist/server/index.js",
   "homepage": "https://docs.nocobase.com/handbook/action-ai",
   "homepage.ru-RU": "https://docs-ru.nocobase.com/handbook/action-ai",
@@ -66,5 +66,5 @@
   "keywords": [
     "AI"
   ],
-  "gitHead": "0d4e2dc07729c32533e35c8e8e16c57815d6242a"
+  "gitHead": "d9c3d45cdca9571f6cef8781e0a2d86566dce11b"
 }

package/dist/node_modules/@langchain/mistralai/node_modules/uuid/dist/bin/uuid

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-require('../uuid-bin');

package/dist/node_modules/@langchain/mistralai/node_modules/uuid/dist/commonjs-browser/index.js

@@ -1,104 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "MAX", {
-  enumerable: true,
-  get: function get() {
-    return _max.default;
-  }
-});
-Object.defineProperty(exports, "NIL", {
-  enumerable: true,
-  get: function get() {
-    return _nil.default;
-  }
-});
-Object.defineProperty(exports, "parse", {
-  enumerable: true,
-  get: function get() {
-    return _parse.default;
-  }
-});
-Object.defineProperty(exports, "stringify", {
-  enumerable: true,
-  get: function get() {
-    return _stringify.default;
-  }
-});
-Object.defineProperty(exports, "v1", {
-  enumerable: true,
-  get: function get() {
-    return _v.default;
-  }
-});
-Object.defineProperty(exports, "v1ToV6", {
-  enumerable: true,
-  get: function get() {
-    return _v1ToV.default;
-  }
-});
-Object.defineProperty(exports, "v3", {
-  enumerable: true,
-  get: function get() {
-    return _v2.default;
-  }
-});
-Object.defineProperty(exports, "v4", {
-  enumerable: true,
-  get: function get() {
-    return _v3.default;
-  }
-});
-Object.defineProperty(exports, "v5", {
-  enumerable: true,
-  get: function get() {
-    return _v4.default;
-  }
-});
-Object.defineProperty(exports, "v6", {
-  enumerable: true,
-  get: function get() {
-    return _v5.default;
-  }
-});
-Object.defineProperty(exports, "v6ToV1", {
-  enumerable: true,
-  get: function get() {
-    return _v6ToV.default;
-  }
-});
-Object.defineProperty(exports, "v7", {
-  enumerable: true,
-  get: function get() {
-    return _v6.default;
-  }
-});
-Object.defineProperty(exports, "validate", {
-  enumerable: true,
-  get: function get() {
-    return _validate.default;
-  }
-});
-Object.defineProperty(exports, "version", {
-  enumerable: true,
-  get: function get() {
-    return _version.default;
-  }
-});
-var _max = _interopRequireDefault(require("./max.js"));
-var _nil = _interopRequireDefault(require("./nil.js"));
-var _parse = _interopRequireDefault(require("./parse.js"));
-var _stringify = _interopRequireDefault(require("./stringify.js"));
-var _v = _interopRequireDefault(require("./v1.js"));
-var _v1ToV = _interopRequireDefault(require("./v1ToV6.js"));
-var _v2 = _interopRequireDefault(require("./v3.js"));
-var _v3 = _interopRequireDefault(require("./v4.js"));
-var _v4 = _interopRequireDefault(require("./v5.js"));
-var _v5 = _interopRequireDefault(require("./v6.js"));
-var _v6ToV = _interopRequireDefault(require("./v6ToV1.js"));
-var _v6 = _interopRequireDefault(require("./v7.js"));
-var _validate = _interopRequireDefault(require("./validate.js"));
-var _version = _interopRequireDefault(require("./version.js"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }

package/dist/node_modules/@langchain/mistralai/node_modules/uuid/dist/commonjs-browser/max.js

@@ -1,7 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _default = exports.default = 'ffffffff-ffff-ffff-ffff-ffffffffffff';