wingbot 3.73.15 → 3.74.1

package/.github/workflows/deploy.yml

@@ -3,14 +3,13 @@ name: Push
 on:
   push:
     branches:
-      - master
-      - production
+      - "**"
+
 permissions:
   contents: write
 jobs:
-
-  test-and-build-gatsby:
-    name: test-and-deploy-documentation
+  test:
+    name: test
     runs-on: ubuntu-latest
 
     strategy:
@@ -18,79 +17,105 @@ jobs:
         node-version: [20.x]
 
     steps:
-
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Node.js ${{ matrix.node-version }} setup
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
-          cache: 'npm'
+          cache: "npm"
+          registry-url: https://npm.pkg.github.com
+          scope: "@wingbotai"
 
       - name: Npm install
-        run: npm install && cd documentation && npm install --legacy-peer-deps && cd ..
+        run: npm i
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.WINGBOT_PCKG_READ_PAT }}
 
       - name: Test
         run: npm run test
 
-      - name: Rewrite gatsby confing inside smoothdoc
-        run: cp documentation/smooth-doc-gatsby-config.js documentation/node_modules/smooth-doc/gatsby-config.js
-
-      - name: Generate mdx documentation files
-        run: node bin/makeApiDoc
-
-      - name: Build documentation website with gatsby
-        run: cd documentation && npm run build
-
-      - name: Deploy documentation to github pages
-        uses: JamesIves/github-pages-deploy-action@v4
-        with:
-          folder: documentation/public # The folder the action should deploy.
-
-  # deploy:
-  #   name: deploy
+  # build-docs:
+  #   name: build docs
   #   needs: test
   #   runs-on: ubuntu-latest
 
+  #   if: github.ref != 'refs/heads/master'
+
   #   strategy:
   #     matrix:
-  #       node-version: [12.x]
+  #       node-version: [20.x]
 
   #   steps:
+  #     - name: Checkout
+  #       uses: actions/checkout@v4
+
+  #     - name: Node.js ${{ matrix.node-version }} setup
+  #       uses: actions/setup-node@v4
+  #       with:
+  #         node-version: ${{ matrix.node-version }}
+  #         cache: "npm"
+  #         registry-url: https://npm.pkg.github.com
+  #         scope: '@wingbotai'
 
-  #     - name: Set ENV to staging
-  #       if: github.ref == 'refs/heads/master'
-  #       run: echo "WB_ENV=staging" >> $GITHUB_ENV
+  #     - name: Npm install
+  #       run: npm i
+  #       env:
+  #         NODE_AUTH_TOKEN: ${{ secrets.WINGBOT_PCKG_READ_PAT }}
+
+  #     - name: Npm install docs
+  #       run: cd documentation && npm install --legacy-peer-deps && cd ..
+
+  #     - name: Rewrite gatsby confing inside smoothdoc
+  #       run: cp documentation/smooth-doc-gatsby-config.js documentation/node_modules/smooth-doc/gatsby-config.js
+
+  #     - name: Generate mdx documentation files
+  #       run: node bin/makeApiDoc
+
+  #     - name: Build documentation website with gatsby
+  #       run: cd documentation && npm run build
+
+  # build-and-deploy-docs:
+  #   name: build and deploy docs
+  #   runs-on: ubuntu-latest
 
-  #     - name: Set ENV to production
-  #       if: github.ref == 'refs/heads/production'
-  #       run: echo "WB_ENV=production" >> $GITHUB_ENV
+  #   if: github.ref == 'refs/heads/master'
 
+  #   strategy:
+  #     matrix:
+  #       node-version: [20.x]
+
+  #   steps:
   #     - name: Checkout
-  #       uses: actions/checkout@v2
+  #       uses: actions/checkout@v4
 
   #     - name: Node.js ${{ matrix.node-version }} setup
-  #       uses: actions/setup-node@v2
+  #       uses: actions/setup-node@v4
   #       with:
   #         node-version: ${{ matrix.node-version }}
-  #         cache: 'npm'
+  #         cache: "npm"
+  #         registry-url: https://npm.pkg.github.com
+  #         scope: '@wingbotai'
 
   #     - name: Npm install
-  #       run: npm ci
+  #       run: npm i
+  #       env:
+  #         NODE_AUTH_TOKEN: ${{ secrets.WINGBOT_PCKG_READ_PAT }}
 
-  #     - name: AWS setup
-  #       uses: aws-actions/configure-aws-credentials@v1
-  #       with:
-  #         aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
-  #         aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-  #         aws-region: eu-central-1
+  #     - name: Npm install docs
+  #       run: cd documentation && npm install --legacy-peer-deps && cd ..
+
+  #     - name: Rewrite gatsby confing inside smoothdoc
+  #       run: cp documentation/smooth-doc-gatsby-config.js documentation/node_modules/smooth-doc/gatsby-config.js
 
-  #     - name: Serverless install
-  #       run: sudo npm i -g serverless@2.x
+  #     - name: Generate mdx documentation files
+  #       run: node bin/makeApiDoc
 
-  #     - name: Build
-  #       run: npm run build:${{ env.WB_ENV }}
+  #     - name: Build documentation website with gatsby
+  #       run: cd documentation && npm run build
 
-  #     - name: Deploy to the ${{ env.WB_ENV }}
-  #       run: sls deploy -s ${{ env.WB_ENV }}
+  #     - name: Deploy documentation to github pages
+  #       uses: JamesIves/github-pages-deploy-action@v4
+  #       with:
+  #         folder: documentation/public # The folder the action should deploy.

package/index.js

@@ -66,6 +66,9 @@ const { fuzzy } = require('./src/fuzzy');
 const prepareFuzzyIndex = require('./src/fuzzy/prepareFuzzyIndex');
 const factoryFuzzySearch = require('./src/fuzzy/factoryFuzzySearch');
 const LLM = require('./src/LLM');
+const LLMSession = require('./src/LLMSession');
+const LLMTool = require('./src/LLMTool');
+const LLMType = require('./src/LLMType');
 
 module.exports = {
 
@@ -156,5 +159,8 @@ module.exports = {
     textBodyFromTranscript,
     transcriptFromHistory,
 
-    LLM
+    LLM,
+    LLMSession,
+    LLMTool,
+    LLMType
 };

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "wingbot",
-  "version": "3.73.15",
+  "version": "3.74.1",
   "description": "Enterprise Messaging Bot Conversation Engine",
   "main": "index.js",
   "type": "commonjs",
   "scripts": {
+    "start": "node --trace-uncaught --stack-trace-limit=50 ./chat/www.js",
     "tsd:update": "jsdoc -t ./node_modules/tsd-jsdoc/dist/ -r ./src",
     "doc:gql": "graphql-markdown ./src/graphApi/schema.gql > doc/api/graphqlSchema.md",
     "doc": "npm run doc:gql && node ./bin/makeApiDoc.js && cpy ./CHANGELOG.md ./doc && gitbook install ./doc && gitbook build ./doc && rimraf -rf ./docs && rimraf --rf ./doc/CHANGELOG.md && move-cli ./doc/_book ./docs",
@@ -38,6 +39,7 @@
   "homepage": "https://github.com/wingbot.ai/wingbot#readme",
   "devDependencies": {
     "@types/mocha": "^10.0.10",
+    "@wingbotai/wingbot-ai-orchestrator": "^2.13.3",
     "cpy-cli": "^5.0.0",
     "eslint": "^8.56.0",
     "eslint-config-airbnb": "^19.0.4",
@@ -46,9 +48,12 @@
     "eslint-plugin-jsx-a11y": "^6.8.0",
     "eslint-plugin-mocha": "^10.2.0",
     "eslint-plugin-react": "^7.33.2",
+    "express": "^4.22.1",
     "graphql-markdown": "^7.0.0",
+    "js-yaml": "^4.1.1",
     "jsdoc-to-markdown": "^8.0.0",
     "mocha": "^10.2.0",
+    "mongodb-memory-server": "^11.0.1",
     "nyc": "^15.1.0",
     "rimraf": "^5.0.5",
     "sinon": "^17.0.1"

package/src/BuildRouter.js

@@ -395,7 +395,12 @@ class BuildRouter extends Router {
                 if (!snapshot) {
                     snapshot = await this.loadBot();
                 }
-                this.buildWithSnapshot(snapshot.blocks);
+                this.buildWithSnapshot(
+                    snapshot.blocks,
+                    undefined,
+                    undefined,
+                    snapshot.deployedConfiguration
+                );
             } catch (e) {
                 if (this._configTs > 0 && !snapshot) {
                     // mute
@@ -437,7 +442,12 @@ class BuildRouter extends Router {
             // wait for running request
             await Promise.all(this._runningReqs);
 
-            this.buildWithSnapshot(snapshot.blocks, snapshot.timestamp, snapshot.lastmod);
+            this.buildWithSnapshot(
+                snapshot.blocks,
+                snapshot.timestamp,
+                snapshot.lastmod,
+                snapshot.deployedConfiguration
+            );
         } catch (e) {
             await configStorage.invalidateConfig();
             throw e;
@@ -528,9 +538,20 @@ class BuildRouter extends Router {
         blocks.forEach((b) => this._validateBlock(b, action));
     }
 
-    buildWithSnapshot (blocks, setConfigTimestamp = Number.MAX_SAFE_INTEGER, lastmod = '-') {
+    buildWithSnapshot (blocks, setConfigTimestamp = Number.MAX_SAFE_INTEGER, lastmod = '-', deployedConfiguration = null) {
         this._validateBlocks(blocks);
 
+        if (deployedConfiguration && typeof deployedConfiguration === 'object') {
+            if (this._configuration instanceof Promise) {
+                this._configuration = this._configuration
+                    .then((c) => Object.assign(c || /** @type {C} */ ({}), deployedConfiguration));
+            } else {
+                const cfg = this._configuration || /** @type {C} */ ({});
+                Object.assign(cfg, deployedConfiguration);
+                this._configuration = cfg;
+            }
+        }
+
         Object.assign(this._resolvedContext, {
             blocks,
             nestedBlocksByStaticId: null

package/src/ChatGpt.js

@@ -14,6 +14,8 @@ const LLM = require('./LLM');
 /** @typedef {import('./Responder').QuickReply} QuickReply */
 /** @typedef {import('./LLM').LLMMessage} LLMMessage */
 /** @typedef {import('./LLM').LLMProviderOptions} LLMProviderOptions */
+/** @typedef {import('./LLMSession').ToolFunction} ToolFunction */
+/** @typedef {import('./LLMSession').JsonSchemaProp} SimpleJsonSchema */
 
 /**
  * @typedef {object} Transcript
@@ -33,15 +35,26 @@ const LLM = require('./LLM');
 
 /** @typedef {'gpt-3.5-turbo'|'gpt-4'|'gpt-4-32k'|'gpt-3.5-turbo-16k'|string} ChatGPTModel */
 
+/**
+ * @typedef {object} ForcedFn
+ * @prop {'function'|string} type
+ * @prop {string} name
+ */
+
 /**
  * @typedef {object} DefaultRequestOptions
  * @prop {ChatGPTModel} [model]
- * @prop {'node'|'low'|'medium'|'high'} [reasoningEffort]
+ * @prop {'none'|'low'|'medium'|'high'} [reasoningEffort]
  * @prop {number} [presencePenalty=0.0]
  * @prop {number} [requestTokens]
  * @prop {number} [tokensLimit]
  * @prop {number} [temperature=1.0]
  * @prop {number} [transcriptLength=-5]
+ * @prop {boolean} [parallelToolCalls]
+ * @prop {'auto'|'required'|ForcedFn|string} [toolChoice]
+ * @prop {'none'|'low'|'medium'|'high'|string} [reasoningEffort]
+ * @prop {'low'|'medium'|'high'|string} [verbosity]
+ * @prop {'text'|SimpleJsonSchema} [responseFormat]
  */
 
 /**
@@ -59,6 +72,7 @@ const LLM = require('./LLM');
  * @typedef {object} Message
  * @prop {'system'|'user'|'assistant'|string} role
  * @prop {string} content
+ * @prop {GptToolCall[]} [tool_calls]
  */
 
 /**
@@ -66,7 +80,6 @@ const LLM = require('./LLM');
  * @prop {'stop'|'length'|'tool_calls'|'content_filter'|null} finish_reason
  * @prop {number} index
  * @prop {Message} message
- * @prop {GptToolCall[]} [tool_calls]
  */
 
 /**
@@ -188,7 +201,7 @@ class ChatGpt {
 
         this._defaultUser = defaultUser;
 
-        /** @type {Required<DefaultRequestOptions>} */
+        /** @type {DefaultRequestOptions} */
         this._options = {
             requestTokens: null,
             tokensLimit: null,
@@ -255,20 +268,23 @@ class ChatGpt {
     /**
      * @param {LLMMessage[]} prompt
      * @param {LLMProviderOptions} [options]
+     * @param {ToolFunction[]} [tools=[]]
      * @returns {Promise<LLMMessage>}
      */
-    async requestChat (prompt, options) {
-        const choice = await this._request(prompt, options);
+    async requestChat (prompt, options, tools = []) {
+        const choice = await this._request(prompt, options, tools);
 
-        const { finish_reason: finishReason, message, tool_calls: toolCalls = [] } = choice;
+        const { finish_reason: finishReason, message } = choice;
 
         return {
             finishReason,
-            toolCalls: toolCalls.map(({ id, function: { name, arguments: args } }) => ({
-                id,
-                name,
-                args
-            })),
+            toolCalls: (message.tool_calls || [])
+                .map(({ id, type, function: { name, arguments: args } }) => ({
+                    id,
+                    type,
+                    name,
+                    args
+                })),
             ...message
         };
     }
@@ -276,11 +292,11 @@ class ChatGpt {
     /**
      *
      * @param {LLMMessage[]} chat
-     * @param {RequestOptions} requestOptions
-     * @param {string} user
+     * @param {LLMProviderOptions} requestOptions
+     * @param {ToolFunction[]} [tools=[]]
      * @returns {Promise<ChatGPTChoice>}
      */
-    async _request (chat, requestOptions, user = null) {
+    async _request (chat, requestOptions, tools = []) {
         const {
             requestTokens,
             tokensLimit,
@@ -288,13 +304,40 @@ class ChatGpt {
             presencePenalty,
             temperature,
             reasoningEffort,
-            functions = []
+            functions = [],
+            toolChoice,
+            parallelToolCalls,
+            verbosity,
+            responseFormat
         } = {
             ...this._options,
             ...requestOptions
         };
 
-        let messages = chat;
+        let messages = chat.map((msg) => {
+            const { toolCallId, toolCalls, ...rest } = msg;
+            if (toolCalls) {
+                return {
+                    ...rest,
+                    tool_calls: toolCalls.map((tc) => ({
+                        id: tc.id,
+                        type: tc.type || 'function',
+                        function: {
+                            name: tc.name,
+                            arguments: tc.args
+                        }
+                    }))
+                };
+            }
+            if (toolCallId) {
+                return {
+                    tool_call_id: toolCallId,
+                    ...rest
+                };
+            }
+
+            return msg;
+        });
 
         let body;
         try {
@@ -304,7 +347,7 @@ class ChatGpt {
                     if (m.role === LLM.ROLE_USER) {
                         lastUserIndex = i;
                     }
-                    return (m.content ? 0 : m.content.length) + total;
+                    return (m.content ? m.content.length : 0) + total;
                 }, 0);
 
             if (tokensLimit !== null && totalTokens > tokensLimit) {
@@ -321,22 +364,66 @@ class ChatGpt {
                 });
             }
 
+            let rf;
+
+            if (typeof responseFormat === 'object' && responseFormat) {
+                const { name = 'output', ...schema } = responseFormat;
+                rf = {
+                    type: 'json_schema',
+                    json_schema: {
+                        name,
+                        schema
+                    }
+                };
+            } else if (typeof responseFormat === 'string') {
+                rf = { type: responseFormat };
+            }
+
+            let tc;
+
+            if (typeof toolChoice === 'string') {
+                tc = toolChoice;
+            } else if (typeof toolChoice === 'object' && toolChoice) {
+                tc = {
+                    type: toolChoice.type || 'function',
+                    function: {
+                        name: toolChoice.name
+                    }
+                };
+            }
+
             body = {
                 model,
                 frequency_penalty: 0,
                 presence_penalty: presencePenalty,
-                ...(requestTokens ? { max_completion_tokens: requestTokens } : {}),
+                ...(requestTokens ? {
+                    max_completion_tokens: requestTokens
+                } : {}),
                 ...(reasoningEffort ? {
                     reasoning: { effort: reasoningEffort }
                 } : {}),
+                ...(typeof parallelToolCalls === 'boolean' ? {
+                    parallel_tool_calls: parallelToolCalls
+                } : {}),
+                ...(rf ? {
+                    response_format: rf
+                } : {}),
+                ...(tc ? {
+                    tool_choice: tc
+                } : {}),
+                ...(verbosity ? {
+                    verbosity
+                } : {}),
                 temperature,
-                messages
+                messages,
+                tools: tools.map((tool) => ({
+                    type: 'function',
+                    function: tool
+                }))
+                // prompt_cache_key
+                // prompt_cache_retention in-memory" or "24h"
             };
 
-            if (user) {
-                Object.assign(body, { user });
-            }
-
             if (functions.length) {
                 Object.assign(body, { functions });
             }
@@ -387,10 +474,9 @@ class ChatGpt {
      * @param {string} [system]
      * @param {Transcript[]} [transcript]
      * @param {RequestOptions} [requestOptions]
-     * @param {string|Request} [user]
      * @returns {Promise<ChatGPTChoice>}
      */
-    async request (content, system = null, transcript = [], requestOptions = {}, user = null) {
+    async request (content, system = null, transcript = [], requestOptions = {}) {
 
         /** @type {Message[]} */
         const messages = [
@@ -399,16 +485,7 @@ class ChatGpt {
             { role: 'user', content }
         ];
 
-        let useUser;
-        if (typeof user === 'string') {
-            useUser = user;
-        } else if (user) {
-            useUser = `${user.pageId}|${user.senderId}`;
-        } else if (this._defaultUser) {
-            useUser = this._defaultUser;
-        }
-
-        return this._request(messages, requestOptions, useUser);
+        return this._request(messages, requestOptions);
     }
 
     /**