@sprucelabs/sprucebot-llm 11.1.1 → 11.1.3

package/build/bots/SprucebotLlmBotImpl.d.ts

@@ -16,6 +16,7 @@ export default class SprucebotLlmBotImpl<StateSchema extends Schema = Schema, St
     getIsDone(): boolean;
     serialize(): SerializedBot<StateSchema, State>;
     sendMessage(message: SendMessage, cb?: MessageResponseCallback): Promise<string>;
+    private _sendMessageInternal;
     private optionallyUpdateState;
     private parseResponse;
     private sendMessageToAdapter;

package/build/bots/SprucebotLlmBotImpl.js

@@ -56,6 +56,9 @@ class SprucebotLlmBotImpl extends mercury_event_emitter_1.AbstractEventEmitter {
             llmMessage.message = message.imageDescription;
             llmMessage.imageBase64 = message.imageBase64;
         }
+        return this._sendMessageInternal(llmMessage, cb);
+    }
+    async _sendMessageInternal(llmMessage, cb) {
         this.trackMessage(llmMessage);
         const { model, callbacks } = this.skill?.serialize() ?? {};
         const response = await this.sendMessageToAdapter(model);
@@ -87,15 +90,19 @@ class SprucebotLlmBotImpl extends mercury_event_emitter_1.AbstractEventEmitter {
         if (callbackResults) {
             let message;
             if (typeof callbackResults === 'string') {
-                message = `API Results: ${callbackResults}`;
+                message = {
+                    from: 'Api',
+                    message: `API Results: ${callbackResults}`,
+                };
             }
             else {
                 message = {
+                    from: 'Api',
                     imageBase64: callbackResults.imageBase64,
-                    imageDescription: `API Results: ${callbackResults.imageDescription}`,
+                    message: `API Results: ${callbackResults.imageDescription}`,
                 };
             }
-            await this.sendMessage(message, cb);
+            await this._sendMessageInternal(message, cb);
         }
         return parsedMessage;
     }

package/build/bots/adapters/OpenAiMessageBuilder.js

@@ -42,13 +42,13 @@ class OpenAiMessageBuilder {
             ];
         }
         return {
-            role: message.from === 'Me' ? 'user' : 'assistant',
+            role: message.from === 'Me' ? 'user' : 'developer',
             content,
         };
     }
     buildFirstMessage(youAre) {
         return {
-            role: 'system',
+            role: 'developer',
             content: `You are ${youAre}.`,
         };
     }
@@ -112,37 +112,37 @@ class OpenAiMessageBuilder {
         }
         const api = `<APIReference>\n\n${descriptions.join('\n\n')}</APIReference>`;
         return {
-            role: 'system',
-            content: `You have an API available to you to lookup answers. When you need the response of the function call to proceed, you can call a function using a custom markup we created that looks like this: <<FunctionName/>>. The API will respond with the results and then you can continue the conversation with your new knowledge. If the api call has parameters, call it like this: <<FunctionName>>{{parametersJsonEncoded}}<</FunctionName>>. Make sure to json encode the data and drop it between the function tags. The API is as follows (in xml format):\n\n${api}`,
+            role: 'developer',
+            content: `You have an API available to you to lookup answers. When you need the response of the function call to proceed, you can call a function using a custom markup we created that looks like this: <<FunctionName/>>. The API will respond with the results and then you can continue the conversation with your new knowledge. If the api call has parameters, call it like this: <<FunctionName>>{{parametersJsonEncoded}}<</FunctionName>>. Make sure to json encode the data and drop it between the function tags. Note: You can only make one API call at a time. The API is as follows (in xml format):\n\n${api}`,
         };
     }
     buildPleaseKeepInMindMessage(pleaseKeepInMindThat) {
         return {
-            role: 'system',
+            role: 'developer',
             content: `During this conversation, please keep the following in mind:\n\n${pleaseKeepInMindThat.map((m, idx) => `${idx + 1}. ${m}`).join('\n')}.`,
         };
     }
     buildStateMessage(state) {
         return {
-            role: 'system',
+            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}`,
         };
     }
     buildYourJobMessage(yourJob) {
         return {
-            role: 'system',
+            role: 'developer',
             content: `For this interaction, your job is ${yourJob}.`,
         };
     }
     buildWeAreDoneWhenMessage(weAreDoneWhen) {
         return {
-            role: 'system',
+            role: 'developer',
             content: `Our conversation is done when ${weAreDoneWhen}. Once you determine we are done, send me the following message so I know we're done: ${templates_1.DONE_TOKEN}`,
         };
     }
     buildStateSchemaMessage(schema) {
         return {
-            role: 'system',
+            role: 'developer',
             content: `We will be tracking state for this conversation. The following schema is what we'll use to define the shape of the state:\n\n${JSON.stringify(schema)}`,
         };
     }

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

@@ -16,6 +16,7 @@ export default class SprucebotLlmBotImpl<StateSchema extends Schema = Schema, St
     getIsDone(): boolean;
     serialize(): SerializedBot<StateSchema, State>;
     sendMessage(message: SendMessage, cb?: MessageResponseCallback): Promise<string>;
+    private _sendMessageInternal;
     private optionallyUpdateState;
     private parseResponse;
     private sendMessageToAdapter;

package/build/esm/bots/SprucebotLlmBotImpl.js

@@ -47,7 +47,6 @@ class SprucebotLlmBotImpl extends AbstractEventEmitter {
     }
     sendMessage(message, cb) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d;
             assertOptions({ message }, ['message']);
             const llmMessage = {
                 from: 'Me',
@@ -60,6 +59,12 @@ class SprucebotLlmBotImpl extends AbstractEventEmitter {
                 llmMessage.message = message.imageDescription;
                 llmMessage.imageBase64 = message.imageBase64;
             }
+            return this._sendMessageInternal(llmMessage, cb);
+        });
+    }
+    _sendMessageInternal(llmMessage, cb) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
             this.trackMessage(llmMessage);
             const { model, callbacks } = (_b = (_a = this.skill) === null || _a === void 0 ? void 0 : _a.serialize()) !== null && _b !== void 0 ? _b : {};
             const response = yield this.sendMessageToAdapter(model);
@@ -91,15 +96,19 @@ class SprucebotLlmBotImpl extends AbstractEventEmitter {
             if (callbackResults) {
                 let message;
                 if (typeof callbackResults === 'string') {
-                    message = `API Results: ${callbackResults}`;
+                    message = {
+                        from: 'Api',
+                        message: `API Results: ${callbackResults}`,
+                    };
                 }
                 else {
                     message = {
+                        from: 'Api',
                         imageBase64: callbackResults.imageBase64,
-                        imageDescription: `API Results: ${callbackResults.imageDescription}`,
+                        message: `API Results: ${callbackResults.imageDescription}`,
                     };
                 }
-                yield this.sendMessage(message, cb);
+                yield this._sendMessageInternal(message, cb);
             }
             return parsedMessage;
         });

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

@@ -41,13 +41,13 @@ export default class OpenAiMessageBuilder {
             ];
         }
         return {
-            role: message.from === 'Me' ? 'user' : 'assistant',
+            role: message.from === 'Me' ? 'user' : 'developer',
             content,
         };
     }
     buildFirstMessage(youAre) {
         return {
-            role: 'system',
+            role: 'developer',
             content: `You are ${youAre}.`,
         };
     }
@@ -111,37 +111,37 @@ export default class OpenAiMessageBuilder {
         }
         const api = `<APIReference>\n\n${descriptions.join('\n\n')}</APIReference>`;
         return {
-            role: 'system',
-            content: `You have an API available to you to lookup answers. When you need the response of the function call to proceed, you can call a function using a custom markup we created that looks like this: <<FunctionName/>>. The API will respond with the results and then you can continue the conversation with your new knowledge. If the api call has parameters, call it like this: <<FunctionName>>{{parametersJsonEncoded}}<</FunctionName>>. Make sure to json encode the data and drop it between the function tags. The API is as follows (in xml format):\n\n${api}`,
+            role: 'developer',
+            content: `You have an API available to you to lookup answers. When you need the response of the function call to proceed, you can call a function using a custom markup we created that looks like this: <<FunctionName/>>. The API will respond with the results and then you can continue the conversation with your new knowledge. If the api call has parameters, call it like this: <<FunctionName>>{{parametersJsonEncoded}}<</FunctionName>>. Make sure to json encode the data and drop it between the function tags. Note: You can only make one API call at a time. The API is as follows (in xml format):\n\n${api}`,
         };
     }
     buildPleaseKeepInMindMessage(pleaseKeepInMindThat) {
         return {
-            role: 'system',
+            role: 'developer',
             content: `During this conversation, please keep the following in mind:\n\n${pleaseKeepInMindThat.map((m, idx) => `${idx + 1}. ${m}`).join('\n')}.`,
         };
     }
     buildStateMessage(state) {
         return {
-            role: 'system',
+            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}`,
         };
     }
     buildYourJobMessage(yourJob) {
         return {
-            role: 'system',
+            role: 'developer',
             content: `For this interaction, your job is ${yourJob}.`,
         };
     }
     buildWeAreDoneWhenMessage(weAreDoneWhen) {
         return {
-            role: 'system',
+            role: 'developer',
             content: `Our conversation is done when ${weAreDoneWhen}. Once you determine we are done, send me the following message so I know we're done: ${DONE_TOKEN}`,
         };
     }
     buildStateSchemaMessage(schema) {
         return {
-            role: 'system',
+            role: 'developer',
             content: `We will be tracking state for this conversation. The following schema is what we'll use to define the shape of the state:\n\n${JSON.stringify(schema)}`,
         };
     }

package/build/esm/llm.types.d.ts

@@ -38,8 +38,9 @@ export declare const llmEventContract: {
     };
 };
 export type LlmEventContract = typeof llmEventContract;
+export type LlmMessageFrom = 'Me' | 'You' | 'Api';
 export interface LlmMessage {
-    from: 'Me' | 'You';
+    from: LlmMessageFrom;
     message: string;
     imageBase64?: string;
 }

package/build/llm.types.d.ts

@@ -38,8 +38,9 @@ export declare const llmEventContract: {
     };
 };
 export type LlmEventContract = typeof llmEventContract;
+export type LlmMessageFrom = 'Me' | 'You' | 'Api';
 export interface LlmMessage {
-    from: 'Me' | 'You';
+    from: LlmMessageFrom;
     message: string;
     imageBase64?: string;
 }

package/package.json

@@ -8,7 +8,7 @@
       "eta"
     ]
   },
-  "version": "11.1.1",
+  "version": "11.1.3",
   "files": [
     "build"
   ],