wingbot 3.72.1 → 3.73.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wingbot",
-  "version": "3.72.1",
+  "version": "3.73.1",
   "description": "Enterprise Messaging Bot Conversation Engine",
   "main": "index.js",
   "type": "commonjs",

package/src/LLM.js

@@ -82,6 +82,11 @@ const Ai = require('./Ai');
  * @prop {string} [model]
  */
 
+/**
+ * @typedef {object} LLMLogOptions
+ * @prop {VectorSearchResult} [vectorSearchResult]
+ */
+
 /**
  * @typedef {object} LLMChatProvider
  * @prop {LLMChatProviderPrompt} requestChat
@@ -110,6 +115,7 @@ const Ai = require('./Ai');
  * @typedef {object} PromptInfo
  * @prop {LLMMessage[]} prompt
  * @prop {LLMMessage} result
+ * @prop {VectorSearchResult} [vectorSearchResult]
  */
 
 /**
@@ -122,6 +128,20 @@ const Ai = require('./Ai');
  * @prop {LogPrompt} logPrompt
  */
 
+/**
+ * @typedef {object} VectorSearchDocument
+ * @property {string} id
+ * @property {string} name
+ * @property {string} text
+ * @property {number} cosineDistance
+ * @property {boolean} excludedByCosineDistanceThreshold
+ */
+/**
+ * @typedef {object} VectorSearchResult
+ * @property {number} maximalCosineDistanceThreshold
+ * @property {number} nearestNeighbourCount
+ * @property {VectorSearchDocument[]} resultDocuments
+ */
 /**
  * @class LLM
  */
@@ -222,9 +242,10 @@ class LLM {
      *
      * @param {LLMSession} session
      * @param {LLMProviderOptions} [options={}]
+     * @param {LLMLogOptions} [logOptions]
      * @returns {Promise<LLMMessage>}
      */
-    async generate (session, options = {}) {
+    async generate (session, options = {}, logOptions = {}) {
         /** @type {LLMProviderOptions} */
         const opts = {
             ...(this._configuration.model && { model: this._configuration.model }),
@@ -233,7 +254,7 @@ class LLM {
 
         const prompt = session.toArray(true);
         const result = await this._provider.requestChat(prompt, opts);
-        this._logPrompt(prompt, result);
+        this.logPrompt(prompt, result, logOptions.vectorSearchResult);
         return result;
     }
 
@@ -241,11 +262,12 @@ class LLM {
      *
      * @param {LLMMessage[]} prompt
      * @param {LLMMessage} result
+     * @param {VectorSearchResult} [vectorSearchResult]
      */
-    _logPrompt (prompt, result) {
+    logPrompt (prompt, result, vectorSearchResult) {
         this._lastResult = result;
         this._configuration.logger.logPrompt({
-            prompt, result
+            prompt, result, vectorSearchResult
         });
     }
 

package/src/LLMSession.js

@@ -7,6 +7,7 @@ const LLM = require('./LLM');
 
 /** @typedef {import('./Responder').QuickReply} QuickReply */
 /** @typedef {import('./LLM').LLMProviderOptions} LLMProviderOptions */
+/** @typedef {import('./LLM').LLMLogOptions} LLMLogOptions */
 
 /** @typedef {'user'|'assistant'} LLMChatRole */
 /** @typedef {'system'} LLMSystemRole */
@@ -272,11 +273,12 @@ class LLMSession {
 
     /**
      *
-     * @param {LLMProviderOptions} [options={}]
+     * @param {LLMProviderOptions} [providerOptions={}]
+     * @param {LLMLogOptions} [logOptions]
      * @returns {Promise<LLMMessage<any>>}
      */
-    async generate (options = {}) {
-        const result = await this._llm.generate(this, options);
+    async generate (providerOptions = {}, logOptions = {}) {
+        const result = await this._llm.generate(this, providerOptions, logOptions);
 
         this._generatedIndex = this._chat.length;
         this._chat.push(result);

package/src/Processor.js

@@ -405,6 +405,7 @@ class Processor extends EventEmitter {
             return { status: 304 };
         }
 
+        /** @type {LLMConfiguration} */
         const llmOptions = {
             provider: new LLMMockProvider(),
             ...this.options.llm

package/src/graphApi/GraphApi.js

@@ -34,9 +34,6 @@ const DEFAULT_CACHE = 86400000; // 24 hours
  * @prop {Function} error
  */
 
-/**
- * Experimental chatbot API
- */
 class GraphApi {
 
     /**

package/src/graphApi/schema.gql

@@ -355,4 +355,4 @@ type Mutation {
 
     "subscribe with metadata"
     subscribeWithData (subscriptions: [SubscriptionData!]!): Boolean
-}
+}

package/src/testTools/PromptAssert.js

@@ -59,6 +59,18 @@ class PromptAssert {
         return this;
     }
 
+    /**
+     * Check if vector search documents contain selected string
+     *
+     * @param {string} search
+     * @returns {this}
+     */
+    vectorSearchContains (search) {
+        const documents = this._flatVectorSearchDocuments();
+        this._promptContains(search, documents, false, 'in vector search documents');
+        return this;
+    }
+
     /**
      *
      * @param {(value: LLMMessage, index: number, array: LLMMessage[]) => unknown} filter
@@ -79,6 +91,16 @@ class PromptAssert {
             .map((prompt) => prompt.result);
     }
 
+    /**
+     *
+     * @returns {LLMMessage[]}
+     */
+    _flatVectorSearchDocuments () {
+        return this._prompts
+            .flatMap((prompt) => prompt.vectorSearchResult?.resultDocuments || [])
+            .map((doc) => ({ role: 'system', content: doc.text }));
+    }
+
     _promptContains (search, messages, notContains = false, addMessage = 'No LLM message found') {
         if (messages.length === 0) {
             PromptAssert.debug(this._prompts, true);