@sprucelabs/sprucebot-llm 11.2.0 → 11.3.1

package/build/bots/adapters/OpenAiMessageBuilder.d.ts

@@ -2,13 +2,12 @@ import { ChatCompletionMessageParam } from 'openai/resources';
 import { SprucebotLlmBot } from '../../llm.types';
 export default class OpenAiMessageBuilder {
     private bot;
-    private imagesFound;
-    private totalImages;
     protected constructor(bot: SprucebotLlmBot);
     static Builder(bot: SprucebotLlmBot): OpenAiMessageBuilder;
     buildMessages(): ChatCompletionMessageParam[];
     private buildChatHistoryMessages;
     private mapMessageToCompletion;
+    private maxCharsOfPastMessages;
     private shouldRememberImages;
     private buildFirstMessage;
     private buildSkillMessages;

package/build/bots/adapters/OpenAiMessageBuilder.js

@@ -3,8 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const templates_1 = require("../templates");
 class OpenAiMessageBuilder {
     constructor(bot) {
-        this.imagesFound = 0;
-        this.totalImages = 0;
         this.bot = bot;
     }
     static Builder(bot) {
@@ -25,11 +23,10 @@ class OpenAiMessageBuilder {
         if (limit > 0) {
             messagesBeingConsidered = messages.slice(Math.max(messages.length - limit, 0));
         }
-        this.totalImages = messagesBeingConsidered.filter((m) => m.imageBase64).length;
-        this.imagesFound = 0;
-        return messagesBeingConsidered.map((message) => this.mapMessageToCompletion(message));
+        const total = messagesBeingConsidered.length;
+        return messagesBeingConsidered.map((message, idx) => this.mapMessageToCompletion(message, idx === total - 1));
     }
-    mapMessageToCompletion(message) {
+    mapMessageToCompletion(message, isLast) {
         let content = message.message;
         let role = message.from === 'Me'
             ? 'user'
@@ -38,9 +35,7 @@ class OpenAiMessageBuilder {
                 : 'developer';
         if (message.imageBase64) {
             role = 'user';
-            this.imagesFound++;
-            const shouldBeIncluded = this.shouldRememberImages() ||
-                this.imagesFound === this.totalImages;
+            const shouldBeIncluded = this.shouldRememberImages() || isLast;
             content = [
                 {
                     type: 'text',
@@ -59,11 +54,23 @@ class OpenAiMessageBuilder {
                     },
             ];
         }
+        const shouldTruncate = typeof content === 'string' &&
+            !isLast &&
+            this.maxCharsOfPastMessages() > 0 &&
+            content.length > this.maxCharsOfPastMessages();
+        if (shouldTruncate) {
+            content = `[omitted due to length]`;
+        }
         return {
             role,
             content,
         };
     }
+    maxCharsOfPastMessages() {
+        return process.env.OPENAI_PAST_MESSAGE_MAX_CHARS
+            ? parseInt(process.env.OPENAI_PAST_MESSAGE_MAX_CHARS ?? '1000', 10)
+            : -1;
+    }
     shouldRememberImages() {
         return process.env.OPENAI_SHOULD_REMEMBER_IMAGES !== 'false';
     }
@@ -146,7 +153,7 @@ class OpenAiMessageBuilder {
     buildStateMessage(state) {
         return {
             role: 'developer',
-            content: `The current state of this conversation is:\n\n${JSON.stringify(state)}. As the state is being updated, send it back to me in json format (something in can JSON.parse()) at the end of each response (it's not meant for reading, but for parsing, so don't call it out, but send it as we progress), surrounded by a boundary, like this: ${templates_1.STATE_BOUNDARY} { "fieldName": "fieldValue" } ${templates_1.STATE_BOUNDARY}`,
+            content: `The current state of this conversation is:\n\n${JSON.stringify(state)}. As the state is being updated, send it back to me in json format (something in can JSON.parse()) at the end of each response (it's not meant for reading, but for parsing, so don't call it out, but send it as we progress), surrounded by the State Boundary (${templates_1.STATE_BOUNDARY}), like this:\n\n${templates_1.STATE_BOUNDARY} { "fieldName": "fieldValue" } ${templates_1.STATE_BOUNDARY}`,
         };
     }
     buildYourJobMessage(yourJob) {

package/build/bots/templates.d.ts

@@ -1,4 +1,4 @@
-export declare const STATE_BOUNDARY = "*****";
+export declare const STATE_BOUNDARY = "*** STATE BOUNDARY ***";
 export declare const DONE_TOKEN = "DONE_DONE_DONE";
 export declare const CALLBACK_BOUNDARY = "xxxxx";
 export declare const PROMPT_TEMPLATE: string;

package/build/bots/templates.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PROMPT_TEMPLATE = exports.CALLBACK_BOUNDARY = exports.DONE_TOKEN = exports.STATE_BOUNDARY = void 0;
 const renderPlaceholder_1 = __importDefault(require("../parsingResponses/renderPlaceholder"));
-exports.STATE_BOUNDARY = '*****';
+exports.STATE_BOUNDARY = '*** STATE BOUNDARY ***';
 exports.DONE_TOKEN = `DONE_DONE_DONE`;
 exports.CALLBACK_BOUNDARY = 'xxxxx';
 exports.PROMPT_TEMPLATE = `You are <%= it.youAre %>

package/build/errors/SpruceError.js

@@ -14,10 +14,14 @@ class SpruceError extends error_1.default {
                 message = `You must create a bot and set it using 'SprucebotLlmFactory.setInstance(bot)' before you can get an instance of it.`;
                 break;
             case 'INVALID_CALLBACK':
-                message = `The callback you tried to invoke (${options.matchedCallback}) is not valid. Valid callbacks are:\n${options.validCallbacks.map((name, idx) => `${idx + 1}: ${name}`).join('\n')}`;
+                message = `The callback you tried to invoke (${options.matchedCallback}) is not valid. Make sure you have the syntax correct and are calling a valid callback:\n${options.validCallbacks.map((name, idx) => `${idx + 1}: ${name}`).join('\n')}`;
                 break;
             case 'CALLBACK_ERROR':
-                message = 'A Callback error just happened!';
+                message =
+                    'The callback threw an error! Please check the details and try again.';
+                if (options.originalError) {
+                    message += `\n\nOriginal Error: ${options.originalError.message}`;
+                }
                 break;
             default:
                 message = super.friendlyMessage();

package/build/esm/bots/adapters/OpenAiMessageBuilder.d.ts

@@ -2,13 +2,12 @@ import { ChatCompletionMessageParam } from 'openai/resources';
 import { SprucebotLlmBot } from '../../llm.types';
 export default class OpenAiMessageBuilder {
     private bot;
-    private imagesFound;
-    private totalImages;
     protected constructor(bot: SprucebotLlmBot);
     static Builder(bot: SprucebotLlmBot): OpenAiMessageBuilder;
     buildMessages(): ChatCompletionMessageParam[];
     private buildChatHistoryMessages;
     private mapMessageToCompletion;
+    private maxCharsOfPastMessages;
     private shouldRememberImages;
     private buildFirstMessage;
     private buildSkillMessages;

package/build/esm/bots/adapters/OpenAiMessageBuilder.js

@@ -1,8 +1,6 @@
 import { DONE_TOKEN, STATE_BOUNDARY } from '../templates.js';
 export default class OpenAiMessageBuilder {
     constructor(bot) {
-        this.imagesFound = 0;
-        this.totalImages = 0;
         this.bot = bot;
     }
     static Builder(bot) {
@@ -24,11 +22,10 @@ export default class OpenAiMessageBuilder {
         if (limit > 0) {
             messagesBeingConsidered = messages.slice(Math.max(messages.length - limit, 0));
         }
-        this.totalImages = messagesBeingConsidered.filter((m) => m.imageBase64).length;
-        this.imagesFound = 0;
-        return messagesBeingConsidered.map((message) => this.mapMessageToCompletion(message));
+        const total = messagesBeingConsidered.length;
+        return messagesBeingConsidered.map((message, idx) => this.mapMessageToCompletion(message, idx === total - 1));
     }
-    mapMessageToCompletion(message) {
+    mapMessageToCompletion(message, isLast) {
         let content = message.message;
         let role = message.from === 'Me'
             ? 'user'
@@ -37,9 +34,7 @@ export default class OpenAiMessageBuilder {
                 : 'developer';
         if (message.imageBase64) {
             role = 'user';
-            this.imagesFound++;
-            const shouldBeIncluded = this.shouldRememberImages() ||
-                this.imagesFound === this.totalImages;
+            const shouldBeIncluded = this.shouldRememberImages() || isLast;
             content = [
                 {
                     type: 'text',
@@ -58,11 +53,24 @@ export default class OpenAiMessageBuilder {
                     },
             ];
         }
+        const shouldTruncate = typeof content === 'string' &&
+            !isLast &&
+            this.maxCharsOfPastMessages() > 0 &&
+            content.length > this.maxCharsOfPastMessages();
+        if (shouldTruncate) {
+            content = `[omitted due to length]`;
+        }
         return {
             role,
             content,
         };
     }
+    maxCharsOfPastMessages() {
+        var _a;
+        return process.env.OPENAI_PAST_MESSAGE_MAX_CHARS
+            ? parseInt((_a = process.env.OPENAI_PAST_MESSAGE_MAX_CHARS) !== null && _a !== void 0 ? _a : '1000', 10)
+            : -1;
+    }
     shouldRememberImages() {
         return process.env.OPENAI_SHOULD_REMEMBER_IMAGES !== 'false';
     }
@@ -145,7 +153,7 @@ export default class OpenAiMessageBuilder {
     buildStateMessage(state) {
         return {
             role: 'developer',
-            content: `The current state of this conversation is:\n\n${JSON.stringify(state)}. As the state is being updated, send it back to me in json format (something in can JSON.parse()) at the end of each response (it's not meant for reading, but for parsing, so don't call it out, but send it as we progress), surrounded by a boundary, like this: ${STATE_BOUNDARY} { "fieldName": "fieldValue" } ${STATE_BOUNDARY}`,
+            content: `The current state of this conversation is:\n\n${JSON.stringify(state)}. As the state is being updated, send it back to me in json format (something in can JSON.parse()) at the end of each response (it's not meant for reading, but for parsing, so don't call it out, but send it as we progress), surrounded by the State Boundary (${STATE_BOUNDARY}), like this:\n\n${STATE_BOUNDARY} { "fieldName": "fieldValue" } ${STATE_BOUNDARY}`,
         };
     }
     buildYourJobMessage(yourJob) {

package/build/esm/bots/templates.d.ts

@@ -1,4 +1,4 @@
-export declare const STATE_BOUNDARY = "*****";
+export declare const STATE_BOUNDARY = "*** STATE BOUNDARY ***";
 export declare const DONE_TOKEN = "DONE_DONE_DONE";
 export declare const CALLBACK_BOUNDARY = "xxxxx";
 export declare const PROMPT_TEMPLATE: string;

package/build/esm/bots/templates.js

@@ -1,5 +1,5 @@
 import renderPlaceholder from '../parsingResponses/renderPlaceholder.js';
-export const STATE_BOUNDARY = '*****';
+export const STATE_BOUNDARY = '*** STATE BOUNDARY ***';
 export const DONE_TOKEN = `DONE_DONE_DONE`;
 export const CALLBACK_BOUNDARY = 'xxxxx';
 export const PROMPT_TEMPLATE = `You are <%= it.youAre %>

package/build/esm/errors/SpruceError.js

@@ -9,10 +9,14 @@ export default class SpruceError extends BaseSpruceError {
                 message = `You must create a bot and set it using 'SprucebotLlmFactory.setInstance(bot)' before you can get an instance of it.`;
                 break;
             case 'INVALID_CALLBACK':
-                message = `The callback you tried to invoke (${options.matchedCallback}) is not valid. Valid callbacks are:\n${options.validCallbacks.map((name, idx) => `${idx + 1}: ${name}`).join('\n')}`;
+                message = `The callback you tried to invoke (${options.matchedCallback}) is not valid. Make sure you have the syntax correct and are calling a valid callback:\n${options.validCallbacks.map((name, idx) => `${idx + 1}: ${name}`).join('\n')}`;
                 break;
             case 'CALLBACK_ERROR':
-                message = 'A Callback error just happened!';
+                message =
+                    'The callback threw an error! Please check the details and try again.';
+                if (options.originalError) {
+                    message += `\n\nOriginal Error: ${options.originalError.message}`;
+                }
                 break;
             default:
                 message = super.friendlyMessage();

package/package.json

@@ -8,7 +8,7 @@
       "eta"
     ]
   },
-  "version": "11.2.0",
+  "version": "11.3.1",
   "files": [
     "build"
   ],