@sprucelabs/sprucebot-llm 5.0.688 → 6.0.0

package/build/bots/SprucebotLlmBotImpl.d.ts

@@ -1,6 +1,6 @@
 import { AbstractEventEmitter } from '@sprucelabs/mercury-event-emitter';
 import { Schema, SchemaValues } from '@sprucelabs/schema';
-import { BotOptions, LlmAdapter, LlmEventContract, LlmMessage, SerializedBot, SprucebotLlmBot, SprucebotLLmSkill } from '../llm.types';
+import { BotOptions, LlmAdapter, LlmEventContract, LlmMessage, MessageResponseCallback, SerializedBot, SprucebotLlmBot, SprucebotLLmSkill } from '../llm.types';
 export default class SprucebotLlmBotImpl<StateSchema extends Schema = Schema, State extends SchemaValues<StateSchema> = SchemaValues<StateSchema>> extends AbstractEventEmitter<LlmEventContract> implements SprucebotLlmBot<StateSchema, State> {
     static messageMemoryLimit: number;
     protected adapter: LlmAdapter;
@@ -15,7 +15,7 @@ export default class SprucebotLlmBotImpl<StateSchema extends Schema = Schema, St
     markAsDone(): void;
     getIsDone(): boolean;
     serialize(): SerializedBot<StateSchema, State>;
-    sendMessage(message: string): Promise<string>;
+    sendMessage(message: string, cb?: MessageResponseCallback): Promise<string>;
     private trackMessage;
     updateState(newState: Partial<State>): Promise<void>;
     setSkill(skill: SprucebotLLmSkill<any>): void;

package/build/bots/SprucebotLlmBotImpl.js

@@ -43,7 +43,7 @@ class SprucebotLlmBotImpl extends mercury_event_emitter_1.AbstractEventEmitter {
             skill,
         };
     }
-    async sendMessage(message) {
+    async sendMessage(message, cb) {
         (0, schema_1.assertOptions)({ message }, ['message']);
         this.trackMessage({
             from: 'Me',
@@ -55,7 +55,7 @@ class SprucebotLlmBotImpl extends mercury_event_emitter_1.AbstractEventEmitter {
             promptTemplate: serializedSkill?.promptTemplate,
         });
         const parser = ResponseParser_1.default.getInstance();
-        const { isDone, message: parsedResponse, state, } = await parser.parse(response, serializedSkill?.callbacks);
+        const { isDone, message: parsedResponse, state, callbackResults, } = await parser.parse(response, serializedSkill?.callbacks);
         this.isDone = isDone;
         if (this.stateSchema && state) {
             await this.updateState(state);
@@ -67,6 +67,10 @@ class SprucebotLlmBotImpl extends mercury_event_emitter_1.AbstractEventEmitter {
             from: 'You',
             message: parsedResponse,
         });
+        cb?.(parsedResponse);
+        if (callbackResults) {
+            await this.sendMessage(`API Results: ${callbackResults}`, cb);
+        }
         return parsedResponse;
     }
     trackMessage(m) {

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

@@ -1,8 +1,7 @@
-import { Configuration, OpenAIApi } from 'openai';
+import OpenAI from 'openai';
 import { LlmAdapter, SendMessageOptions, SprucebotLlmBot } from '../../llm.types';
 export declare class OpenAiAdapter implements LlmAdapter {
-    static Configuration: typeof Configuration;
-    static OpenAIApi: typeof OpenAIApi;
+    static OpenAI: typeof OpenAI;
     private api;
     constructor(apiKey: string);
     sendMessage(bot: SprucebotLlmBot, options?: SendMessageOptions): Promise<string>;

package/build/bots/adapters/OpenAi.js

@@ -5,30 +5,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MESSAGE_RESPONSE_ERROR_MESSAGE = exports.OpenAiAdapter = void 0;
 const schema_1 = require("@sprucelabs/schema");
-const openai_1 = require("openai");
-const PromptGenerator_1 = __importDefault(require("../PromptGenerator"));
+const openai_1 = __importDefault(require("openai"));
+const OpenAiMessageBuilder_1 = __importDefault(require("./OpenAiMessageBuilder"));
 class OpenAiAdapter {
     constructor(apiKey) {
         (0, schema_1.assertOptions)({ apiKey }, ['apiKey']);
-        const config = new OpenAiAdapter.Configuration({ apiKey });
-        this.api = new OpenAiAdapter.OpenAIApi(config);
+        this.api = new OpenAiAdapter.OpenAI({ apiKey });
     }
     async sendMessage(bot, options) {
-        const generator = PromptGenerator_1.default.Generator(bot, {
-            promptTemplate: options?.promptTemplate,
+        const messageBuilder = OpenAiMessageBuilder_1.default.Builder(bot);
+        const messages = messageBuilder.buildMessages();
+        const response = await this.api.chat.completions.create({
+            messages,
+            model: options?.model ?? 'gpt-4o',
         });
-        const prompt = await generator.generate();
-        const response = await this.api.createCompletion({
-            prompt,
-            model: options?.model ?? 'text-davinci-003',
-            max_tokens: 250,
-            stop: ['__Me__:'],
-        });
-        return (response.data.choices[0]?.text?.trim() ??
-            exports.MESSAGE_RESPONSE_ERROR_MESSAGE);
+        const message = response.choices?.[0]?.message?.content?.trim() ??
+            exports.MESSAGE_RESPONSE_ERROR_MESSAGE;
+        return message;
     }
 }
 exports.OpenAiAdapter = OpenAiAdapter;
-OpenAiAdapter.Configuration = openai_1.Configuration;
-OpenAiAdapter.OpenAIApi = openai_1.OpenAIApi;
+OpenAiAdapter.OpenAI = openai_1.default;
 exports.MESSAGE_RESPONSE_ERROR_MESSAGE = "Oh no! Something went wrong and I can't talk right now!";

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

@@ -0,0 +1,17 @@
+import { ChatCompletionMessageParam } from 'openai/resources';
+import { SprucebotLlmBot } from '../../llm.types';
+export default class OpenAiMessageBuilder {
+    private bot;
+    protected constructor(bot: SprucebotLlmBot);
+    static Builder(bot: SprucebotLlmBot): OpenAiMessageBuilder;
+    buildMessages(): ChatCompletionMessageParam[];
+    private buildChatHistoryMessages;
+    private buildFirstMessage;
+    private buildSkillMessages;
+    private buildCallbacksMessage;
+    private buildPleaseKeepInMindMessage;
+    private buildStateMessage;
+    private buildYourJobMessage;
+    private buildWeAreDoneWhenMessage;
+    private buildStateSchemaMessage;
+}

package/build/bots/adapters/OpenAiMessageBuilder.js

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const templates_1 = require("../templates");
+class OpenAiMessageBuilder {
+    constructor(bot) {
+        this.bot = bot;
+    }
+    static Builder(bot) {
+        return new this(bot);
+    }
+    buildMessages() {
+        const values = this.bot.serialize();
+        const allMessages = [
+            this.buildFirstMessage(values.youAre),
+            ...this.buildSkillMessages(values.skill),
+            ...this.buildChatHistoryMessages(values.messages),
+        ];
+        return allMessages;
+    }
+    buildChatHistoryMessages(messages) {
+        return messages.map((message) => ({
+            role: message.from === 'Me' ? 'user' : 'assistant',
+            content: message.message,
+        }));
+    }
+    buildFirstMessage(youAre) {
+        return {
+            role: 'system',
+            content: `You are ${youAre}.`,
+        };
+    }
+    buildSkillMessages(skill) {
+        if (!skill) {
+            return [];
+        }
+        const messages = [];
+        messages.push(this.buildYourJobMessage(skill.yourJobIfYouChooseToAcceptItIs));
+        if (skill.stateSchema) {
+            messages.push(this.buildStateSchemaMessage(skill.stateSchema));
+        }
+        if (skill.state) {
+            messages.push(this.buildStateMessage(skill.state));
+        }
+        if (skill.weAreDoneWhen) {
+            messages.push(this.buildWeAreDoneWhenMessage(skill.weAreDoneWhen));
+        }
+        if (skill.pleaseKeepInMindThat) {
+            messages.push(this.buildPleaseKeepInMindMessage(skill.pleaseKeepInMindThat));
+        }
+        if (skill.callbacks) {
+            messages.push(this.buildCallbacksMessage(skill.callbacks));
+        }
+        return messages;
+    }
+    buildCallbacksMessage(callbacks) {
+        const keys = Object.keys(callbacks);
+        const descriptions = [];
+        for (const key of keys) {
+            const callback = callbacks[key];
+            let definition = `<Function name="${key}">
+                <Description>For use when ${callback.useThisWhenever}</Description>`;
+            if (callback.parameters) {
+                let params = '<Parameters>';
+                for (const param of callback.parameters) {
+                    params += `
+                        <Parameter${param.isRequired ? ' required="true"' : ''}>
+                            <Name>${param.name}</Name>
+                            <Type>${param.type}</Type>
+                            ${param.description ? `<Description>${param.description}</Description>` : ''}
+                        </Parameter>`;
+                }
+                params += '</Parameters>';
+                definition += params;
+            }
+            definition += `</Function>`;
+            descriptions.push(definition);
+        }
+        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 >>parameters json encoded<</ FunctionName >>. Make sure to json encode the data and drop it between the function tags. I will respond with the api's response and you can use it going forward. The api is as follows (in xml format):\n\n${api}`,
+        };
+    }
+    buildPleaseKeepInMindMessage(pleaseKeepInMindThat) {
+        return {
+            role: 'system',
+            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',
+            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',
+            content: `For this interaction, your job is ${yourJob}.`,
+        };
+    }
+    buildWeAreDoneWhenMessage(weAreDoneWhen) {
+        return {
+            role: 'system',
+            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',
+            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)}`,
+        };
+    }
+}
+exports.default = OpenAiMessageBuilder;

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

@@ -1,12 +1,19 @@
-import { AxiosResponse } from 'axios';
-import { Configuration, CreateCompletionRequest, CreateCompletionRequestPrompt, CreateCompletionResponse, OpenAIApi } from 'openai';
-export default class SpyOpenAiApi extends OpenAIApi {
-    static config?: Configuration;
-    static lastMessage?: CreateCompletionRequestPrompt | null;
-    static lastModel?: string;
+import OpenAI from 'openai';
+import { ChatCompletion, ChatCompletionCreateParamsNonStreaming } from 'openai/resources';
+export default class SpyOpenAiApi extends OpenAI {
+    static config?: OpenAiOptions;
+    static lastSentCompletion?: ChatCompletionCreateParamsNonStreaming;
     static responseMessage: string | false;
-    constructor(config: Configuration);
-    createCompletion(createCompletionRequest: CreateCompletionRequest): Promise<Response>;
+    constructor(config: OpenAiOptions);
+    chat: {
+        completions: {
+            create: (options: ChatCompletionCreateParamsNonStreaming) => Promise<Response>;
+        };
+    };
+    private createCompletion;
+}
+type Response = ChatCompletion;
+interface OpenAiOptions {
+    apiKey: string;
 }
-type Response = AxiosResponse<CreateCompletionResponse, any>;
 export {};

package/build/bots/adapters/SpyOpenAiApi.js

@@ -1,32 +1,41 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const openai_1 = require("openai");
-class SpyOpenAiApi extends openai_1.OpenAIApi {
+const openai_1 = __importDefault(require("openai"));
+class SpyOpenAiApi extends openai_1.default {
     constructor(config) {
         super(config);
+        //@ts-ignore
+        this.chat = {
+            completions: {
+                create: this.createCompletion.bind(this),
+            },
+        };
         SpyOpenAiApi.config = config;
     }
-    async createCompletion(createCompletionRequest) {
-        SpyOpenAiApi.lastMessage = createCompletionRequest.prompt;
-        SpyOpenAiApi.lastModel = createCompletionRequest.model;
+    async createCompletion(options) {
+        SpyOpenAiApi.lastSentCompletion = options;
         const choices = [];
         if (SpyOpenAiApi.responseMessage) {
             choices.push({
-                text: SpyOpenAiApi.responseMessage,
+                finish_reason: 'stop',
+                index: 0,
+                logprobs: null,
+                message: {
+                    content: SpyOpenAiApi.responseMessage,
+                    role: 'assistant',
+                    refusal: null,
+                },
             });
         }
         return {
-            config: {},
-            headers: {},
-            status: 200,
-            statusText: 'OK',
-            data: {
-                id: 'cmpl-1',
-                model: 'text-davinci-003',
-                created: 0,
-                object: 'text_completion',
-                choices,
-            },
+            id: 'cmpl-1',
+            model: 'text-davinci-003',
+            created: 0,
+            choices,
+            object: 'chat.completion',
         };
     }
 }

package/build/chat.js

@@ -61,13 +61,12 @@ void (async () => {
     };
     const bot = bots.Bot({
         adapter,
-        skill: skills.receptionist,
+        skill: skills.callbacks,
         youAre: "a bot named Sprucebot that is in test mode. At the start of every conversation, you introduce yourself and announce that you are in test mode so I don't get confused! You are both hip and adorable. You say things like, 'Jeepers' and 'Golly' or even 'Jeezey peezy'!",
     });
     do {
         const input = await rl.question('Message > ');
-        const response = await bot.sendMessage(input);
-        console.log('>', response);
+        await bot.sendMessage(input, (message) => console.log('>', message));
     } while (!bot.getIsDone());
     console.log('Signing off...');
     rl.close();

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

@@ -1,6 +1,6 @@
 import { AbstractEventEmitter } from '@sprucelabs/mercury-event-emitter';
 import { Schema, SchemaValues } from '@sprucelabs/schema';
-import { BotOptions, LlmAdapter, LlmEventContract, LlmMessage, SerializedBot, SprucebotLlmBot, SprucebotLLmSkill } from '../llm.types';
+import { BotOptions, LlmAdapter, LlmEventContract, LlmMessage, MessageResponseCallback, SerializedBot, SprucebotLlmBot, SprucebotLLmSkill } from '../llm.types';
 export default class SprucebotLlmBotImpl<StateSchema extends Schema = Schema, State extends SchemaValues<StateSchema> = SchemaValues<StateSchema>> extends AbstractEventEmitter<LlmEventContract> implements SprucebotLlmBot<StateSchema, State> {
     static messageMemoryLimit: number;
     protected adapter: LlmAdapter;
@@ -15,7 +15,7 @@ export default class SprucebotLlmBotImpl<StateSchema extends Schema = Schema, St
     markAsDone(): void;
     getIsDone(): boolean;
     serialize(): SerializedBot<StateSchema, State>;
-    sendMessage(message: string): Promise<string>;
+    sendMessage(message: string, cb?: MessageResponseCallback): Promise<string>;
     private trackMessage;
     updateState(newState: Partial<State>): Promise<void>;
     setSkill(skill: SprucebotLLmSkill<any>): void;

package/build/esm/bots/SprucebotLlmBotImpl.js

@@ -45,7 +45,7 @@ class SprucebotLlmBotImpl extends AbstractEventEmitter {
             skill,
         };
     }
-    sendMessage(message) {
+    sendMessage(message, cb) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b;
             assertOptions({ message }, ['message']);
@@ -59,7 +59,7 @@ class SprucebotLlmBotImpl extends AbstractEventEmitter {
                 promptTemplate: serializedSkill === null || serializedSkill === void 0 ? void 0 : serializedSkill.promptTemplate,
             });
             const parser = ResponseParser.getInstance();
-            const { isDone, message: parsedResponse, state, } = yield parser.parse(response, serializedSkill === null || serializedSkill === void 0 ? void 0 : serializedSkill.callbacks);
+            const { isDone, message: parsedResponse, state, callbackResults, } = yield parser.parse(response, serializedSkill === null || serializedSkill === void 0 ? void 0 : serializedSkill.callbacks);
             this.isDone = isDone;
             if (this.stateSchema && state) {
                 yield this.updateState(state);
@@ -71,6 +71,10 @@ class SprucebotLlmBotImpl extends AbstractEventEmitter {
                 from: 'You',
                 message: parsedResponse,
             });
+            cb === null || cb === void 0 ? void 0 : cb(parsedResponse);
+            if (callbackResults) {
+                yield this.sendMessage(`API Results: ${callbackResults}`, cb);
+            }
             return parsedResponse;
         });
     }

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

@@ -1,8 +1,7 @@
-import { Configuration, OpenAIApi } from 'openai';
+import OpenAI from 'openai';
 import { LlmAdapter, SendMessageOptions, SprucebotLlmBot } from '../../llm.types';
 export declare class OpenAiAdapter implements LlmAdapter {
-    static Configuration: typeof Configuration;
-    static OpenAIApi: typeof OpenAIApi;
+    static OpenAI: typeof OpenAI;
     private api;
     constructor(apiKey: string);
     sendMessage(bot: SprucebotLlmBot, options?: SendMessageOptions): Promise<string>;

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

@@ -8,31 +8,26 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { assertOptions } from '@sprucelabs/schema';
-import { Configuration, OpenAIApi } from 'openai';
-import PromptGenerator from '../PromptGenerator.js';
+import OpenAI from 'openai';
+import OpenAiMessageBuilder from './OpenAiMessageBuilder.js';
 export class OpenAiAdapter {
     constructor(apiKey) {
         assertOptions({ apiKey }, ['apiKey']);
-        const config = new OpenAiAdapter.Configuration({ apiKey });
-        this.api = new OpenAiAdapter.OpenAIApi(config);
+        this.api = new OpenAiAdapter.OpenAI({ apiKey });
     }
     sendMessage(bot, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d;
-            const generator = PromptGenerator.Generator(bot, {
-                promptTemplate: options === null || options === void 0 ? void 0 : options.promptTemplate,
+            var _a, _b, _c, _d, _e, _f;
+            const messageBuilder = OpenAiMessageBuilder.Builder(bot);
+            const messages = messageBuilder.buildMessages();
+            const response = yield this.api.chat.completions.create({
+                messages,
+                model: (_a = options === null || options === void 0 ? void 0 : options.model) !== null && _a !== void 0 ? _a : 'gpt-4o',
             });
-            const prompt = yield generator.generate();
-            const response = yield this.api.createCompletion({
-                prompt,
-                model: (_a = options === null || options === void 0 ? void 0 : options.model) !== null && _a !== void 0 ? _a : 'text-davinci-003',
-                max_tokens: 250,
-                stop: ['__Me__:'],
-            });
-            return ((_d = (_c = (_b = response.data.choices[0]) === null || _b === void 0 ? void 0 : _b.text) === null || _c === void 0 ? void 0 : _c.trim()) !== null && _d !== void 0 ? _d : MESSAGE_RESPONSE_ERROR_MESSAGE);
+            const message = (_f = (_e = (_d = (_c = (_b = response.choices) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.message) === null || _d === void 0 ? void 0 : _d.content) === null || _e === void 0 ? void 0 : _e.trim()) !== null && _f !== void 0 ? _f : MESSAGE_RESPONSE_ERROR_MESSAGE;
+            return message;
         });
     }
 }
-OpenAiAdapter.Configuration = Configuration;
-OpenAiAdapter.OpenAIApi = OpenAIApi;
+OpenAiAdapter.OpenAI = OpenAI;
 export const MESSAGE_RESPONSE_ERROR_MESSAGE = "Oh no! Something went wrong and I can't talk right now!";

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

@@ -0,0 +1,17 @@
+import { ChatCompletionMessageParam } from 'openai/resources';
+import { SprucebotLlmBot } from '../../llm.types';
+export default class OpenAiMessageBuilder {
+    private bot;
+    protected constructor(bot: SprucebotLlmBot);
+    static Builder(bot: SprucebotLlmBot): OpenAiMessageBuilder;
+    buildMessages(): ChatCompletionMessageParam[];
+    private buildChatHistoryMessages;
+    private buildFirstMessage;
+    private buildSkillMessages;
+    private buildCallbacksMessage;
+    private buildPleaseKeepInMindMessage;
+    private buildStateMessage;
+    private buildYourJobMessage;
+    private buildWeAreDoneWhenMessage;
+    private buildStateSchemaMessage;
+}

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

@@ -0,0 +1,112 @@
+import { DONE_TOKEN, STATE_BOUNDARY } from '../templates.js';
+export default class OpenAiMessageBuilder {
+    constructor(bot) {
+        this.bot = bot;
+    }
+    static Builder(bot) {
+        return new this(bot);
+    }
+    buildMessages() {
+        const values = this.bot.serialize();
+        const allMessages = [
+            this.buildFirstMessage(values.youAre),
+            ...this.buildSkillMessages(values.skill),
+            ...this.buildChatHistoryMessages(values.messages),
+        ];
+        return allMessages;
+    }
+    buildChatHistoryMessages(messages) {
+        return messages.map((message) => ({
+            role: message.from === 'Me' ? 'user' : 'assistant',
+            content: message.message,
+        }));
+    }
+    buildFirstMessage(youAre) {
+        return {
+            role: 'system',
+            content: `You are ${youAre}.`,
+        };
+    }
+    buildSkillMessages(skill) {
+        if (!skill) {
+            return [];
+        }
+        const messages = [];
+        messages.push(this.buildYourJobMessage(skill.yourJobIfYouChooseToAcceptItIs));
+        if (skill.stateSchema) {
+            messages.push(this.buildStateSchemaMessage(skill.stateSchema));
+        }
+        if (skill.state) {
+            messages.push(this.buildStateMessage(skill.state));
+        }
+        if (skill.weAreDoneWhen) {
+            messages.push(this.buildWeAreDoneWhenMessage(skill.weAreDoneWhen));
+        }
+        if (skill.pleaseKeepInMindThat) {
+            messages.push(this.buildPleaseKeepInMindMessage(skill.pleaseKeepInMindThat));
+        }
+        if (skill.callbacks) {
+            messages.push(this.buildCallbacksMessage(skill.callbacks));
+        }
+        return messages;
+    }
+    buildCallbacksMessage(callbacks) {
+        const keys = Object.keys(callbacks);
+        const descriptions = [];
+        for (const key of keys) {
+            const callback = callbacks[key];
+            let definition = `<Function name="${key}">
+                <Description>For use when ${callback.useThisWhenever}</Description>`;
+            if (callback.parameters) {
+                let params = '<Parameters>';
+                for (const param of callback.parameters) {
+                    params += `
+                        <Parameter${param.isRequired ? ' required="true"' : ''}>
+                            <Name>${param.name}</Name>
+                            <Type>${param.type}</Type>
+                            ${param.description ? `<Description>${param.description}</Description>` : ''}
+                        </Parameter>`;
+                }
+                params += '</Parameters>';
+                definition += params;
+            }
+            definition += `</Function>`;
+            descriptions.push(definition);
+        }
+        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 >>parameters json encoded<</ FunctionName >>. Make sure to json encode the data and drop it between the function tags. I will respond with the api's response and you can use it going forward. The api is as follows (in xml format):\n\n${api}`,
+        };
+    }
+    buildPleaseKeepInMindMessage(pleaseKeepInMindThat) {
+        return {
+            role: 'system',
+            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',
+            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',
+            content: `For this interaction, your job is ${yourJob}.`,
+        };
+    }
+    buildWeAreDoneWhenMessage(weAreDoneWhen) {
+        return {
+            role: 'system',
+            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',
+            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/adapters/SpyOpenAiApi.d.ts

@@ -1,12 +1,19 @@
-import { AxiosResponse } from 'axios';
-import { Configuration, CreateCompletionRequest, CreateCompletionRequestPrompt, CreateCompletionResponse, OpenAIApi } from 'openai';
-export default class SpyOpenAiApi extends OpenAIApi {
-    static config?: Configuration;
-    static lastMessage?: CreateCompletionRequestPrompt | null;
-    static lastModel?: string;
+import OpenAI from 'openai';
+import { ChatCompletion, ChatCompletionCreateParamsNonStreaming } from 'openai/resources';
+export default class SpyOpenAiApi extends OpenAI {
+    static config?: OpenAiOptions;
+    static lastSentCompletion?: ChatCompletionCreateParamsNonStreaming;
     static responseMessage: string | false;
-    constructor(config: Configuration);
-    createCompletion(createCompletionRequest: CreateCompletionRequest): Promise<Response>;
+    constructor(config: OpenAiOptions);
+    chat: {
+        completions: {
+            create: (options: ChatCompletionCreateParamsNonStreaming) => Promise<Response>;
+        };
+    };
+    private createCompletion;
+}
+type Response = ChatCompletion;
+interface OpenAiOptions {
+    apiKey: string;
 }
-type Response = AxiosResponse<CreateCompletionResponse, any>;
 export {};

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

@@ -7,34 +7,40 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { OpenAIApi, } from 'openai';
-class SpyOpenAiApi extends OpenAIApi {
+import OpenAI from 'openai';
+class SpyOpenAiApi extends OpenAI {
     constructor(config) {
         super(config);
+        //@ts-ignore
+        this.chat = {
+            completions: {
+                create: this.createCompletion.bind(this),
+            },
+        };
         SpyOpenAiApi.config = config;
     }
-    createCompletion(createCompletionRequest) {
+    createCompletion(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            SpyOpenAiApi.lastMessage = createCompletionRequest.prompt;
-            SpyOpenAiApi.lastModel = createCompletionRequest.model;
+            SpyOpenAiApi.lastSentCompletion = options;
             const choices = [];
             if (SpyOpenAiApi.responseMessage) {
                 choices.push({
-                    text: SpyOpenAiApi.responseMessage,
+                    finish_reason: 'stop',
+                    index: 0,
+                    logprobs: null,
+                    message: {
+                        content: SpyOpenAiApi.responseMessage,
+                        role: 'assistant',
+                        refusal: null,
+                    },
                 });
             }
             return {
-                config: {},
-                headers: {},
-                status: 200,
-                statusText: 'OK',
-                data: {
-                    id: 'cmpl-1',
-                    model: 'text-davinci-003',
-                    created: 0,
-                    object: 'text_completion',
-                    choices,
-                },
+                id: 'cmpl-1',
+                model: 'text-davinci-003',
+                created: 0,
+                choices,
+                object: 'chat.completion',
             };
         });
     }

package/build/esm/bots/templates.js

@@ -1,4 +1,4 @@
-import renderPlaceholder from '../parsingResponses/renderPlaceholder.js';
+import renderLegacyPlaceholder from '../parsingResponses/renderPlaceholder.js';
 export const STATE_BOUNDARY = '*****';
 export const DONE_TOKEN = `DONE_DONE_DONE`;
 export const CALLBACK_BOUNDARY = 'xxxxx';
@@ -37,7 +37,7 @@ When asking me about a "select" field, make sure I only pick a valid choice by s
 	
 Your primary objective for this conversation is <%= it.skill.yourJobIfYouChooseToAcceptItIs %>
 <% if (it.skill.callbacks) { %>
-While we are talking, there are going to be things I don't want you to answer, but instead to respond with a placeholder in the form of ${renderPlaceholder('example')}.
+While we are talking, there are going to be things I don't want you to answer, but instead to respond with a placeholder in the form of ${renderLegacyPlaceholder('example')}.
 
 Here are the placeholders we will be using:
 

package/build/esm/chat.js

@@ -32,13 +32,12 @@ void (() => __awaiter(void 0, void 0, void 0, function* () {
     };
     const bot = bots.Bot({
         adapter,
-        skill: skills.receptionist,
+        skill: skills.callbacks,
         youAre: "a bot named Sprucebot that is in test mode. At the start of every conversation, you introduce yourself and announce that you are in test mode so I don't get confused! You are both hip and adorable. You say things like, 'Jeepers' and 'Golly' or even 'Jeezey peezy'!",
     });
     do {
         const input = yield rl.question('Message > ');
-        const response = yield bot.sendMessage(input);
-        console.log('>', response);
+        yield bot.sendMessage(input, (message) => console.log('>', message));
     } while (!bot.getIsDone());
     console.log('Signing off...');
     rl.close();

package/build/esm/examples/buildCallbackSkill.js

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 export default function buildCallbackSkill(bots) {
     return bots.Skill({
         weAreDoneWhen: 'the appointment is booked!',
-        yourJobIfYouChooseToAcceptItIs: "to be be the best appointment taker on the planet. You have a many years of experience. You are going to ask me only 2 questions for this practice run. First, you'll ask me to pick an available time. Then, you'll ask me to pick my favorite color:",
+        yourJobIfYouChooseToAcceptItIs: "to be be the best appointment taker on the planet. You have a many years of experience. You are going to ask me only 2 questions for this practice run. First, you'll ask me to pick an available time. Then, you'll ask me to pick my favorite color (make sure to call the api to see what times and colors i can choose from). After all is said and done, make sure to actually book the appointment!:",
         pleaseKeepInMindThat: [
             "getting a service is really important, so if i don't like any of the time, as to check another day or if i want to see a different provider",
         ],
@@ -35,6 +35,25 @@ export default function buildCallbackSkill(bots) {
                 }),
                 useThisWhenever: 'your are showing what colors i can pick from.',
             },
+            book: {
+                cb: (options) => __awaiter(this, void 0, void 0, function* () {
+                    console.log('BOOKING OPTIONS', options);
+                    return 'Appointment booked!';
+                }),
+                useThisWhenever: 'You are ready to book an appointment!',
+                parameters: [
+                    {
+                        name: 'time',
+                        isRequired: true,
+                        type: 'string',
+                    },
+                    {
+                        name: 'color',
+                        isRequired: true,
+                        type: 'string',
+                    },
+                ],
+            },
         },
     });
 }

package/build/esm/examples/buildProfileSkill.js

@@ -2,6 +2,7 @@ import { buildSchema } from '@sprucelabs/schema';
 export default function buildProfileSkill(bots) {
     return bots.Skill({
         yourJobIfYouChooseToAcceptItIs: 'to collect some information from me! You are a receptionist with 20 years experience and are very focused on getting answers needed to complete my profile',
+        weAreDoneWhen: 'You have all the information to complete my profile',
         stateSchema: buildSchema({
             id: 'profile',
             fields: {

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

@@ -8,7 +8,7 @@ export interface BotOptions<StateSchema extends Schema = Schema, State extends S
 export interface SprucebotLlmBot<StateSchema extends Schema = Schema, State extends SchemaValues<StateSchema> = SchemaValues<StateSchema>> extends MercuryEventEmitter<LlmEventContract> {
     markAsDone(): void;
     getIsDone(): boolean;
-    sendMessage(message: string): Promise<string>;
+    sendMessage(message: string, responseCb?: MessageResponseCallback): Promise<string>;
     serialize(): SerializedBot<StateSchema, State>;
     updateState(state: Partial<State>): Promise<void>;
     setSkill(skill: SprucebotLLmSkill<any>): void;
@@ -62,6 +62,14 @@ export interface SerializedSkill<StateSchema extends Schema = Schema, State exte
 }
 export type LlmCallbackMap = Record<string, LlmCallback>;
 export interface LlmCallback {
-    cb: () => string | Promise<string>;
+    cb: (options?: Record<string, any>) => string | Promise<string>;
     useThisWhenever: string;
+    parameters?: LlmCallbackParameter[];
 }
+export interface LlmCallbackParameter {
+    name: string;
+    type: ('string' | 'number' | 'boolean' | 'dateMs' | 'dateTimeMs') | (string & {});
+    isRequired?: boolean;
+    description?: string;
+}
+export type MessageResponseCallback = (message: string) => any;

package/build/esm/parsingResponses/ResponseParser.d.ts

@@ -4,7 +4,7 @@ export default class ResponseParser {
     static setInstance(parser: ResponseParser): void;
     static getInstance(): ResponseParser;
     parse(response: string, callbacks?: LlmCallbackMap): Promise<ParsedResponse>;
-    private invokeCallback;
+    private invokeCallbackAndDropInLegacyResults;
     private doesIncludeDoneToken;
     private parseState;
 }
@@ -12,4 +12,5 @@ export interface ParsedResponse {
     isDone: boolean;
     state?: Record<string, any>;
     message: string;
+    callbackResults?: string;
 }

package/build/esm/parsingResponses/ResponseParser.js

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { DONE_TOKEN, STATE_BOUNDARY } from '../bots/templates.js';
-import renderPlaceholder from './renderPlaceholder.js';
+import renderLegacyPlaceholder from './renderPlaceholder.js';
 class ResponseParser {
     static setInstance(parser) {
         this.instance = parser;
@@ -18,12 +18,29 @@ class ResponseParser {
     }
     parse(response, callbacks) {
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             let message = response.replace(DONE_TOKEN, '').trim();
             let state;
+            let callbackResults;
             for (const key of Object.keys(callbacks || {})) {
-                const match = message.match(renderPlaceholder(key));
+                const match = message.match(renderLegacyPlaceholder(key));
                 if (match) {
-                    message = yield this.invokeCallback(callbacks, key, message);
+                    message = yield this.invokeCallbackAndDropInLegacyResults(callbacks, key, message);
+                }
+                let simpleMatches = message.match(new RegExp(`<<\\s*${key}\\s*\/>>`, 'g'));
+                let data;
+                if (!simpleMatches) {
+                    const matchWithJson = message
+                        .matchAll(new RegExp(`<<\\s*${key}\\s*>>(.*?)<<\/\\s*${key}\\s*>>`, 'gs'))
+                        .next().value;
+                    simpleMatches = (matchWithJson === null || matchWithJson === void 0 ? void 0 : matchWithJson[0]) ? [matchWithJson === null || matchWithJson === void 0 ? void 0 : matchWithJson[0]] : null;
+                    data = (matchWithJson === null || matchWithJson === void 0 ? void 0 : matchWithJson[1])
+                        ? JSON.parse(matchWithJson === null || matchWithJson === void 0 ? void 0 : matchWithJson[1])
+                        : undefined;
+                }
+                if (simpleMatches) {
+                    callbackResults = yield ((_a = callbacks === null || callbacks === void 0 ? void 0 : callbacks[key]) === null || _a === void 0 ? void 0 : _a.cb(data));
+                    message = message.replace(simpleMatches[0], '').trim();
                 }
             }
             const { match, fullMatch } = this.parseState(message);
@@ -35,14 +52,15 @@ class ResponseParser {
                 isDone: this.doesIncludeDoneToken(response),
                 state,
                 message,
+                callbackResults,
             };
         });
     }
-    invokeCallback(callbacks, key, message) {
+    invokeCallbackAndDropInLegacyResults(callbacks, key, message) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
             const v = yield ((_a = callbacks === null || callbacks === void 0 ? void 0 : callbacks[key]) === null || _a === void 0 ? void 0 : _a.cb());
-            message = message.replace(renderPlaceholder(key), v !== null && v !== void 0 ? v : '').trim();
+            message = message.replace(renderLegacyPlaceholder(key), v !== null && v !== void 0 ? v : '').trim();
             return message;
         });
     }

package/build/esm/parsingResponses/renderPlaceholder.d.ts

@@ -1 +1 @@
-export default function renderPlaceholder(key: string): string;
+export default function renderLegacyPlaceholder(key: string): string;

package/build/esm/parsingResponses/renderPlaceholder.js

@@ -1,4 +1,4 @@
 import { CALLBACK_BOUNDARY } from '../bots/templates.js';
-export default function renderPlaceholder(key) {
+export default function renderLegacyPlaceholder(key) {
     return `${CALLBACK_BOUNDARY} ${key} ${CALLBACK_BOUNDARY}`;
 }

package/build/examples/buildCallbackSkill.js

@@ -4,7 +4,7 @@ exports.default = buildCallbackSkill;
 function buildCallbackSkill(bots) {
     return bots.Skill({
         weAreDoneWhen: 'the appointment is booked!',
-        yourJobIfYouChooseToAcceptItIs: "to be be the best appointment taker on the planet. You have a many years of experience. You are going to ask me only 2 questions for this practice run. First, you'll ask me to pick an available time. Then, you'll ask me to pick my favorite color:",
+        yourJobIfYouChooseToAcceptItIs: "to be be the best appointment taker on the planet. You have a many years of experience. You are going to ask me only 2 questions for this practice run. First, you'll ask me to pick an available time. Then, you'll ask me to pick my favorite color (make sure to call the api to see what times and colors i can choose from). After all is said and done, make sure to actually book the appointment!:",
         pleaseKeepInMindThat: [
             "getting a service is really important, so if i don't like any of the time, as to check another day or if i want to see a different provider",
         ],
@@ -29,6 +29,25 @@ function buildCallbackSkill(bots) {
                 },
                 useThisWhenever: 'your are showing what colors i can pick from.',
             },
+            book: {
+                cb: async (options) => {
+                    console.log('BOOKING OPTIONS', options);
+                    return 'Appointment booked!';
+                },
+                useThisWhenever: 'You are ready to book an appointment!',
+                parameters: [
+                    {
+                        name: 'time',
+                        isRequired: true,
+                        type: 'string',
+                    },
+                    {
+                        name: 'color',
+                        isRequired: true,
+                        type: 'string',
+                    },
+                ],
+            },
         },
     });
 }

package/build/examples/buildProfileSkill.js

@@ -5,6 +5,7 @@ const schema_1 = require("@sprucelabs/schema");
 function buildProfileSkill(bots) {
     return bots.Skill({
         yourJobIfYouChooseToAcceptItIs: 'to collect some information from me! You are a receptionist with 20 years experience and are very focused on getting answers needed to complete my profile',
+        weAreDoneWhen: 'You have all the information to complete my profile',
         stateSchema: (0, schema_1.buildSchema)({
             id: 'profile',
             fields: {

package/build/llm.types.d.ts

@@ -8,7 +8,7 @@ export interface BotOptions<StateSchema extends Schema = Schema, State extends S
 export interface SprucebotLlmBot<StateSchema extends Schema = Schema, State extends SchemaValues<StateSchema> = SchemaValues<StateSchema>> extends MercuryEventEmitter<LlmEventContract> {
     markAsDone(): void;
     getIsDone(): boolean;
-    sendMessage(message: string): Promise<string>;
+    sendMessage(message: string, responseCb?: MessageResponseCallback): Promise<string>;
     serialize(): SerializedBot<StateSchema, State>;
     updateState(state: Partial<State>): Promise<void>;
     setSkill(skill: SprucebotLLmSkill<any>): void;
@@ -62,6 +62,14 @@ export interface SerializedSkill<StateSchema extends Schema = Schema, State exte
 }
 export type LlmCallbackMap = Record<string, LlmCallback>;
 export interface LlmCallback {
-    cb: () => string | Promise<string>;
+    cb: (options?: Record<string, any>) => string | Promise<string>;
     useThisWhenever: string;
+    parameters?: LlmCallbackParameter[];
 }
+export interface LlmCallbackParameter {
+    name: string;
+    type: ('string' | 'number' | 'boolean' | 'dateMs' | 'dateTimeMs') | (string & {});
+    isRequired?: boolean;
+    description?: string;
+}
+export type MessageResponseCallback = (message: string) => any;

package/build/parsingResponses/ResponseParser.d.ts

@@ -4,7 +4,7 @@ export default class ResponseParser {
     static setInstance(parser: ResponseParser): void;
     static getInstance(): ResponseParser;
     parse(response: string, callbacks?: LlmCallbackMap): Promise<ParsedResponse>;
-    private invokeCallback;
+    private invokeCallbackAndDropInLegacyResults;
     private doesIncludeDoneToken;
     private parseState;
 }
@@ -12,4 +12,5 @@ export interface ParsedResponse {
     isDone: boolean;
     state?: Record<string, any>;
     message: string;
+    callbackResults?: string;
 }

package/build/parsingResponses/ResponseParser.js

@@ -15,10 +15,26 @@ class ResponseParser {
     async parse(response, callbacks) {
         let message = response.replace(templates_1.DONE_TOKEN, '').trim();
         let state;
+        let callbackResults;
         for (const key of Object.keys(callbacks || {})) {
             const match = message.match((0, renderPlaceholder_1.default)(key));
             if (match) {
-                message = await this.invokeCallback(callbacks, key, message);
+                message = await this.invokeCallbackAndDropInLegacyResults(callbacks, key, message);
+            }
+            let simpleMatches = message.match(new RegExp(`<<\\s*${key}\\s*\/>>`, 'g'));
+            let data;
+            if (!simpleMatches) {
+                const matchWithJson = message
+                    .matchAll(new RegExp(`<<\\s*${key}\\s*>>(.*?)<<\/\\s*${key}\\s*>>`, 'gs'))
+                    .next().value;
+                simpleMatches = matchWithJson?.[0] ? [matchWithJson?.[0]] : null;
+                data = matchWithJson?.[1]
+                    ? JSON.parse(matchWithJson?.[1])
+                    : undefined;
+            }
+            if (simpleMatches) {
+                callbackResults = await callbacks?.[key]?.cb(data);
+                message = message.replace(simpleMatches[0], '').trim();
             }
         }
         const { match, fullMatch } = this.parseState(message);
@@ -30,9 +46,10 @@ class ResponseParser {
             isDone: this.doesIncludeDoneToken(response),
             state,
             message,
+            callbackResults,
         };
     }
-    async invokeCallback(callbacks, key, message) {
+    async invokeCallbackAndDropInLegacyResults(callbacks, key, message) {
         const v = await callbacks?.[key]?.cb();
         message = message.replace((0, renderPlaceholder_1.default)(key), v ?? '').trim();
         return message;

package/build/parsingResponses/renderPlaceholder.d.ts

@@ -1 +1 @@
-export default function renderPlaceholder(key: string): string;
+export default function renderLegacyPlaceholder(key: string): string;

package/build/parsingResponses/renderPlaceholder.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = renderPlaceholder;
+exports.default = renderLegacyPlaceholder;
 const templates_1 = require("../bots/templates");
-function renderPlaceholder(key) {
+function renderLegacyPlaceholder(key) {
     return `${templates_1.CALLBACK_BOUNDARY} ${key} ${templates_1.CALLBACK_BOUNDARY}`;
 }

package/package.json

@@ -6,11 +6,10 @@
     "upgradeIgnoreList": [
       "@sprucelabs/spruce-core-schemas",
       "@sprucelabs/spruce-skill-utils",
-      "@sprucelabs/spruce-test-fixtures",
-      "openai"
+      "@sprucelabs/spruce-test-fixtures"
     ]
   },
-  "version": "5.0.688",
+  "version": "6.0.0",
   "files": [
     "build"
   ],
@@ -59,7 +58,7 @@
     "@sprucelabs/mercury-types": "^47.0.641",
     "@sprucelabs/schema": "^31.0.3",
     "eta": "^3.5.0",
-    "openai": "^3.3.0"
+    "openai": "^4.77.0"
   },
   "devDependencies": {
     "@sprucelabs/esm-postbuild": "^6.0.533",