wingbot 3.72.1 → 3.73.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wingbot",
-  "version": "3.72.1",
+  "version": "3.73.0",
   "description": "Enterprise Messaging Bot Conversation Engine",
   "main": "index.js",
   "type": "commonjs",
@@ -58,9 +58,7 @@
     "compress-json": "^3.0.0",
     "deep-extend": "^0.6.0",
     "form-data": "^4.0.0",
-    "graphql": "^16.11.0",
-    "graphql-depth-limit": "^1.1.0",
-    "graphql-query-complexity": "^1.1.0",
+    "graphql": "^16.8.1",
     "jsonwebtoken": "^9.0.2",
     "node-fetch": "^2.6.7",
     "path-to-regexp": "^6.3.0",

package/src/BotAppSender.js

@@ -41,12 +41,12 @@ class BotAppSender extends ReturnSender {
     /**
      *
      * @param {SenderOptions} options
-     * @param {string} senderId
+     * @param {string} userId
      * @param {object} incommingMessage
      * @param {ChatLogStorage} logger - console like logger
      */
-    constructor (options, senderId, incommingMessage, logger = null) {
-        super(options, senderId, incommingMessage, logger);
+    constructor (options, userId, incommingMessage, logger = null) {
+        super(options, userId, incommingMessage, logger);
 
         this.waits = true;
 
@@ -98,16 +98,14 @@ class BotAppSender extends ReturnSender {
      * @param {Buffer} data
      * @param {string} contentType
      * @param {string} fileName
-     * @param {string} [senderId]
      * @returns {Promise<UploadResult>}
      */
-    async upload (data, contentType, fileName, senderId = this._senderId) {
+    async upload (data, contentType, fileName) {
         const formData = new FormData();
 
         const nonce = Math.floor(Math.random() * Number.MAX_SAFE_INTEGER).toString(36).padEnd(11, '0');
 
         formData.append('nonce', nonce);
-        formData.append('senderId', senderId || '');
         formData.append('f0', data, { filename: fileName, contentType });
 
         const [token, agent] = await Promise.all([

package/src/LLM.js

@@ -110,6 +110,7 @@ const Ai = require('./Ai');
  * @typedef {object} PromptInfo
  * @prop {LLMMessage[]} prompt
  * @prop {LLMMessage} result
+ * @prop {VectorSearchResult} [vectorSearchResult]
  */
 
 /**
@@ -122,6 +123,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
  */
@@ -233,7 +248,7 @@ class LLM {
 
         const prompt = session.toArray(true);
         const result = await this._provider.requestChat(prompt, opts);
-        this._logPrompt(prompt, result);
+        this.logPrompt(prompt, result);
         return result;
     }
 
@@ -241,11 +256,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/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

@@ -8,7 +8,6 @@ const WingbotApiConnector = require('./WingbotApiConnector');
 // @ts-ignore
 const packageJson = require('../../package.json');
 const headersToAuditMeta = require('../utils/headersToAuditMeta');
-const gqlRules = require('./gqlRules');
 
 const DEFAULT_GROUPS = ['botEditor', 'botAdmin', 'appToken'];
 const KEYS_URL = 'https://api.wingbot.ai/keys';
@@ -28,15 +27,6 @@ const DEFAULT_CACHE = 86400000; // 24 hours
 /** @typedef {import('../CallbackAuditLog')} AuditLog */
 /** @typedef {import('graphql')} GqlLib */
 
-/**
- * @typedef {object} Logger
- * @prop {Function} log
- * @prop {Function} error
- */
-
-/**
- * Experimental chatbot API
- */
 class GraphApi {
 
     /**
@@ -48,11 +38,8 @@ class GraphApi {
      * @param {string[]} [options.groups] - list of allowed bot groups
      * @param {boolean} [options.useBundledGql] - uses library bundled graphql definition
      * @param {AuditLog} [options.auditLog]
-     * @param {boolean} [options.isProduction]
-     * @param {boolean} [options.hideVerboseErrors]
-     * @param {Logger} [log=console]
      */
-    constructor (apis, options, log = console) {
+    constructor (apis, options) {
         this._root = {
             version () {
                 return packageJson.version;
@@ -75,13 +62,6 @@ class GraphApi {
             }
         };
 
-        this._log = log;
-        this._options = {
-            hideVerboseErrors: true,
-            isProduction: true,
-            ...options
-        };
-
         Object.assign(opts, options);
 
         apis.forEach((api) => Object.assign(this._root, api));
@@ -169,19 +149,6 @@ class GraphApi {
 
         const schema = await this._schema();
 
-        const { isProduction = true, hideVerboseErrors } = this._options;
-        const ast = this._gql.parse(body.query);
-        const errors = this._gql.validate(
-            schema,
-            ast,
-            gqlRules(body.variables, isProduction, hideVerboseErrors, this._log)
-        );
-
-        if (errors.length > 0) {
-            this._log.error('GQL failed', errors);
-            return { errors };
-        }
-
         const ctx = {
             token,
             groups: this._defaultGroups,

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);

package/src/graphApi/gqlRules.js

@@ -1,87 +0,0 @@
-/* eslint-disable global-require */
-/**
- * @author David Menger
- */
-'use strict';
-
-/** @typedef {import('graphql').ValidationRule} ValidationRule */
-
-/**
- * @typedef {object} Logger
- * @prop {Function} log
- * @prop {Function} error
- */
-
-/**
- *
- * @param {object} variables
- * @param {boolean} isProduction
- * @param {boolean} hideVerboseErrors
- * @param {Logger} [log=console]
- * @returns {ValidationRule[]}
- */
-function gqlRules (variables, isProduction, hideVerboseErrors, log = console) {
-    // OPTIMIZATION FOR LAMBDA PERFORMANCE
-    const { GraphQLError, NoSchemaIntrospectionCustomRule } = require('graphql');
-    const { createComplexityRule, simpleEstimator } = require('graphql-query-complexity');
-    const depthLimit = require('graphql-depth-limit');
-
-    return [
-        ...(hideVerboseErrors ? [NoSchemaIntrospectionCustomRule] : []),
-        depthLimit(10),
-        createComplexityRule({
-            // The maximum allowed query complexity, queries above this threshold will be rejected
-            maximumComplexity: 1000,
-
-            // The query variables. This is needed because the variables are not available
-            // in the visitor of the graphql-js library
-            variables,
-
-            // The context object for the request (optional)
-            context: {},
-
-            // The maximum number of query nodes to evaluate (fields, fragments, composite types).
-            // If a query contains more than the specified number of nodes, the complexity rule will
-            // throw an error, regardless of the complexity of the query.
-            //
-            // Default: 10_000
-            maxQueryNodes: 10000,
-
-            // Optional callback function to retrieve the determined query complexity
-            // Will be invoked whether the query is rejected or not
-            // This can be used for logging or to implement rate limiting
-            onComplete: (complexity) => {
-                if (!isProduction) {
-                    log.log('Determined query complexity: ', complexity);
-                }
-            },
-
-            // Optional function to create a custom error
-            createError: (max, actual) => {
-                const msg = `GQL Query too complex: ${actual}. Maximum allowed: ${max}`;
-
-                if (hideVerboseErrors) {
-                    log.error(msg);
-                    return new GraphQLError('');
-                }
-                log.log(msg);
-                return new GraphQLError(`Query is too complex: ${actual}. Maximum allowed complexity: ${max}`);
-            },
-
-            // Add any number of estimators. The estimators are invoked in order, the first
-            // numeric value that is being returned by an estimator is used as the field complexity.
-            // If no estimator returns a value, an exception is raised.
-            estimators: [
-                // Add more estimators here...
-
-                // This will assign each field a complexity of 1 if no other estimator
-                // returned a value.
-                simpleEstimator({
-                    defaultComplexity: 1
-                })
-            ]
-        })
-    ];
-}
-
-module.exports = gqlRules;