@sprucelabs/sprucebot-llm 5.0.687 → 5.0.689

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,24 @@ 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() ??
+        return (response.choices?.[0]?.message?.content?.trim() ??
             exports.MESSAGE_RESPONSE_ERROR_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. To use it, respond with a message in handlebars format like this: {{ FunctionName }} and I'll respond with the response of the api call in my next message. If the api call has parameters, call it like this: {{ FunctionName parameter1="value1" parameter2="value2" }}. It'll work the same way. After I 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,7 +61,7 @@ void (async () => {
     };
     const bot = bots.Bot({
         adapter,
-        skill: skills.receptionist,
+        skill: skills.profile,
         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 {

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,25 @@ 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);
+            return ((_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);
         });
     }
 }
-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. To use it, respond with a message in handlebars format like this: {{ FunctionName }} and I'll respond with the response of the api call in my next message. If the api call has parameters, call it like this: {{ FunctionName parameter1="value1" parameter2="value2" }}. It'll work the same way. After I 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/chat.js

@@ -32,7 +32,7 @@ void (() => __awaiter(void 0, void 0, void 0, function* () {
     };
     const bot = bots.Bot({
         adapter,
-        skill: skills.receptionist,
+        skill: skills.profile,
         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 {

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

@@ -64,4 +64,11 @@ export type LlmCallbackMap = Record<string, LlmCallback>;
 export interface LlmCallback {
     cb: () => string | Promise<string>;
     useThisWhenever: string;
+    parameters?: LlmCallbackParameter[];
+}
+export interface LlmCallbackParameter {
+    name: string;
+    type: ('string' | 'number' | 'boolean' | 'dateMs' | 'dateTimeMs') | (string & {});
+    isRequired?: boolean;
+    description?: 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

@@ -64,4 +64,11 @@ export type LlmCallbackMap = Record<string, LlmCallback>;
 export interface LlmCallback {
     cb: () => string | Promise<string>;
     useThisWhenever: string;
+    parameters?: LlmCallbackParameter[];
+}
+export interface LlmCallbackParameter {
+    name: string;
+    type: ('string' | 'number' | 'boolean' | 'dateMs' | 'dateTimeMs') | (string & {});
+    isRequired?: boolean;
+    description?: string;
 }

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.687",
+  "version": "5.0.689",
   "files": [
     "build"
   ],
@@ -55,11 +54,11 @@
   },
   "dependencies": {
     "@sprucelabs/error": "^6.0.556",
-    "@sprucelabs/mercury-event-emitter": "^42.0.659",
+    "@sprucelabs/mercury-event-emitter": "^42.0.660",
     "@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",