@sprucelabs/sprucebot-llm 12.1.0 → 12.3.0

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

@@ -1,11 +1,24 @@
+import { Log } from '@sprucelabs/spruce-skill-utils';
 import OpenAI from 'openai';
+import { ReasoningEffort } from 'openai/resources';
 import { LlmAdapter, SendMessageOptions, SprucebotLlmBot } from '../../llm.types';
 export default class OpenAiAdapter implements LlmAdapter {
     static OpenAI: typeof OpenAI;
     private api;
-    private log;
-    protected constructor(apiKey: string);
-    static Adapter(apiKey: string): OpenAiAdapter;
+    private log?;
+    private model;
+    private memoryLimit?;
+    private reasoningEffort?;
+    protected constructor(apiKey: string, options?: OpenAiAdapterOptions);
+    static Adapter(apiKey: string, options?: OpenAiAdapterOptions): OpenAiAdapter;
     sendMessage(bot: SprucebotLlmBot, options?: SendMessageOptions): Promise<string>;
+    private getReasoningEffort;
+    setModel(model: string): void;
+    setMessageMemoryLimit(limit: number): void;
+    setReasoningEffort(effort: ReasoningEffort): void;
 }
 export declare const MESSAGE_RESPONSE_ERROR_MESSAGE = "Oh no! Something went wrong and I can't talk right now!";
+interface OpenAiAdapterOptions {
+    log?: Log;
+}
+export {};

package/build/bots/adapters/OpenAi.js

@@ -5,36 +5,51 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MESSAGE_RESPONSE_ERROR_MESSAGE = void 0;
 const schema_1 = require("@sprucelabs/schema");
-const spruce_skill_utils_1 = require("@sprucelabs/spruce-skill-utils");
 const openai_1 = __importDefault(require("openai"));
 const OpenAiMessageBuilder_1 = __importDefault(require("./OpenAiMessageBuilder"));
 class OpenAiAdapter {
-    constructor(apiKey) {
-        this.log = (0, spruce_skill_utils_1.buildLog)('SprucebotLLM::OpenAiAdapter');
+    constructor(apiKey, options) {
+        this.model = 'gpt-4o';
         (0, schema_1.assertOptions)({ apiKey }, ['apiKey']);
+        const { log } = options || {};
         this.api = new OpenAiAdapter.OpenAI({ apiKey });
+        this.log = log;
     }
-    static Adapter(apiKey) {
-        return new this(apiKey);
+    static Adapter(apiKey, options) {
+        return new this(apiKey, options);
     }
     async sendMessage(bot, options) {
-        const messageBuilder = OpenAiMessageBuilder_1.default.Builder(bot);
+        const messageBuilder = OpenAiMessageBuilder_1.default.Builder(bot, {
+            memoryLimit: this.memoryLimit,
+        });
         const messages = messageBuilder.buildMessages();
-        this.log.info('Sending message to OpenAI', JSON.stringify(messages, null, 2));
+        this.log?.info('Sending message to OpenAI', JSON.stringify(messages, null, 2));
         const params = {
             messages,
-            model: options?.model ?? 'gpt-4o',
+            model: options?.model ?? this.model,
         };
-        if (process.env.OPENAI_REASONING_EFFORT) {
-            params.reasoning_effort = process.env
-                .OPENAI_REASONING_EFFORT;
+        const reasoningEffort = this.getReasoningEffort();
+        if (reasoningEffort) {
+            params.reasoning_effort = reasoningEffort;
         }
         const response = await this.api.chat.completions.create(params);
         const message = response.choices?.[0]?.message?.content?.trim() ??
             exports.MESSAGE_RESPONSE_ERROR_MESSAGE;
-        this.log.info('Received response from OpenAI', message);
+        this.log?.info('Received response from OpenAI', message);
         return message;
     }
+    getReasoningEffort() {
+        return (this.reasoningEffort ?? process.env.OPENAI_REASONING_EFFORT);
+    }
+    setModel(model) {
+        this.model = model;
+    }
+    setMessageMemoryLimit(limit) {
+        this.memoryLimit = limit;
+    }
+    setReasoningEffort(effort) {
+        this.reasoningEffort = effort;
+    }
 }
 OpenAiAdapter.OpenAI = openai_1.default;
 exports.default = OpenAiAdapter;

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

@@ -2,8 +2,9 @@ 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;
+    private memoryLimit;
+    protected constructor(bot: SprucebotLlmBot, options?: BuildMessageOptions);
+    static Builder(bot: SprucebotLlmBot, options?: BuildMessageOptions): OpenAiMessageBuilder;
     buildMessages(): ChatCompletionMessageParam[];
     private buildChatHistoryMessages;
     private mapMessageToCompletion;
@@ -18,3 +19,7 @@ export default class OpenAiMessageBuilder {
     private buildWeAreDoneWhenMessage;
     private buildStateSchemaMessage;
 }
+interface BuildMessageOptions {
+    memoryLimit?: number;
+}
+export {};

package/build/bots/adapters/OpenAiMessageBuilder.js

@@ -2,11 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const templates_1 = require("../templates");
 class OpenAiMessageBuilder {
-    constructor(bot) {
+    constructor(bot, options) {
+        const { memoryLimit } = options ?? {};
         this.bot = bot;
+        this.memoryLimit =
+            memoryLimit ??
+                parseInt(process.env.OPENAI_MESSAGE_MEMORY_LIMIT ?? '0');
     }
-    static Builder(bot) {
-        return new this(bot);
+    static Builder(bot, options) {
+        return new this(bot, options);
     }
     buildMessages() {
         const values = this.bot.serialize();
@@ -19,9 +23,8 @@ class OpenAiMessageBuilder {
     }
     buildChatHistoryMessages(messages) {
         let messagesBeingConsidered = messages;
-        const limit = parseInt(process.env.OPENAI_MESSAGE_MEMORY_LIMIT ?? '0');
-        if (limit > 0) {
-            messagesBeingConsidered = messages.slice(Math.max(messages.length - limit, 0));
+        if (this.memoryLimit > 0) {
+            messagesBeingConsidered = messages.slice(Math.max(messages.length - this.memoryLimit, 0));
         }
         const total = messagesBeingConsidered.length;
         return messagesBeingConsidered.map((message, idx) => this.mapMessageToCompletion(message, idx === total - 1));

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

@@ -1,11 +1,24 @@
+import { Log } from '@sprucelabs/spruce-skill-utils';
 import OpenAI from 'openai';
+import { ReasoningEffort } from 'openai/resources';
 import { LlmAdapter, SendMessageOptions, SprucebotLlmBot } from '../../llm.types';
 export default class OpenAiAdapter implements LlmAdapter {
     static OpenAI: typeof OpenAI;
     private api;
-    private log;
-    protected constructor(apiKey: string);
-    static Adapter(apiKey: string): OpenAiAdapter;
+    private log?;
+    private model;
+    private memoryLimit?;
+    private reasoningEffort?;
+    protected constructor(apiKey: string, options?: OpenAiAdapterOptions);
+    static Adapter(apiKey: string, options?: OpenAiAdapterOptions): OpenAiAdapter;
     sendMessage(bot: SprucebotLlmBot, options?: SendMessageOptions): Promise<string>;
+    private getReasoningEffort;
+    setModel(model: string): void;
+    setMessageMemoryLimit(limit: number): void;
+    setReasoningEffort(effort: ReasoningEffort): void;
 }
 export declare const MESSAGE_RESPONSE_ERROR_MESSAGE = "Oh no! Something went wrong and I can't talk right now!";
+interface OpenAiAdapterOptions {
+    log?: Log;
+}
+export {};

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

@@ -8,38 +8,54 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { assertOptions } from '@sprucelabs/schema';
-import { buildLog } from '@sprucelabs/spruce-skill-utils';
 import OpenAI from 'openai';
 import OpenAiMessageBuilder from './OpenAiMessageBuilder.js';
 class OpenAiAdapter {
-    constructor(apiKey) {
-        this.log = buildLog('SprucebotLLM::OpenAiAdapter');
+    constructor(apiKey, options) {
+        this.model = 'gpt-4o';
         assertOptions({ apiKey }, ['apiKey']);
+        const { log } = options || {};
         this.api = new OpenAiAdapter.OpenAI({ apiKey });
+        this.log = log;
     }
-    static Adapter(apiKey) {
-        return new this(apiKey);
+    static Adapter(apiKey, options) {
+        return new this(apiKey, options);
     }
     sendMessage(bot, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f;
-            const messageBuilder = OpenAiMessageBuilder.Builder(bot);
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const messageBuilder = OpenAiMessageBuilder.Builder(bot, {
+                memoryLimit: this.memoryLimit,
+            });
             const messages = messageBuilder.buildMessages();
-            this.log.info('Sending message to OpenAI', JSON.stringify(messages, null, 2));
+            (_a = this.log) === null || _a === void 0 ? void 0 : _a.info('Sending message to OpenAI', JSON.stringify(messages, null, 2));
             const params = {
                 messages,
-                model: (_a = options === null || options === void 0 ? void 0 : options.model) !== null && _a !== void 0 ? _a : 'gpt-4o',
+                model: (_b = options === null || options === void 0 ? void 0 : options.model) !== null && _b !== void 0 ? _b : this.model,
             };
-            if (process.env.OPENAI_REASONING_EFFORT) {
-                params.reasoning_effort = process.env
-                    .OPENAI_REASONING_EFFORT;
+            const reasoningEffort = this.getReasoningEffort();
+            if (reasoningEffort) {
+                params.reasoning_effort = reasoningEffort;
             }
             const response = yield this.api.chat.completions.create(params);
-            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;
-            this.log.info('Received response from OpenAI', message);
+            const message = (_g = (_f = (_e = (_d = (_c = response.choices) === null || _c === void 0 ? void 0 : _c[0]) === null || _d === void 0 ? void 0 : _d.message) === null || _e === void 0 ? void 0 : _e.content) === null || _f === void 0 ? void 0 : _f.trim()) !== null && _g !== void 0 ? _g : MESSAGE_RESPONSE_ERROR_MESSAGE;
+            (_h = this.log) === null || _h === void 0 ? void 0 : _h.info('Received response from OpenAI', message);
             return message;
         });
     }
+    getReasoningEffort() {
+        var _a;
+        return ((_a = this.reasoningEffort) !== null && _a !== void 0 ? _a : process.env.OPENAI_REASONING_EFFORT);
+    }
+    setModel(model) {
+        this.model = model;
+    }
+    setMessageMemoryLimit(limit) {
+        this.memoryLimit = limit;
+    }
+    setReasoningEffort(effort) {
+        this.reasoningEffort = effort;
+    }
 }
 OpenAiAdapter.OpenAI = OpenAI;
 export default OpenAiAdapter;

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

@@ -2,8 +2,9 @@ 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;
+    private memoryLimit;
+    protected constructor(bot: SprucebotLlmBot, options?: BuildMessageOptions);
+    static Builder(bot: SprucebotLlmBot, options?: BuildMessageOptions): OpenAiMessageBuilder;
     buildMessages(): ChatCompletionMessageParam[];
     private buildChatHistoryMessages;
     private mapMessageToCompletion;
@@ -18,3 +19,7 @@ export default class OpenAiMessageBuilder {
     private buildWeAreDoneWhenMessage;
     private buildStateSchemaMessage;
 }
+interface BuildMessageOptions {
+    memoryLimit?: number;
+}
+export {};

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

@@ -1,10 +1,14 @@
 import { DONE_TOKEN, STATE_BOUNDARY } from '../templates.js';
 export default class OpenAiMessageBuilder {
-    constructor(bot) {
+    constructor(bot, options) {
+        var _a;
+        const { memoryLimit } = options !== null && options !== void 0 ? options : {};
         this.bot = bot;
+        this.memoryLimit =
+            memoryLimit !== null && memoryLimit !== void 0 ? memoryLimit : parseInt((_a = process.env.OPENAI_MESSAGE_MEMORY_LIMIT) !== null && _a !== void 0 ? _a : '0');
     }
-    static Builder(bot) {
-        return new this(bot);
+    static Builder(bot, options) {
+        return new this(bot, options);
     }
     buildMessages() {
         const values = this.bot.serialize();
@@ -16,11 +20,9 @@ export default class OpenAiMessageBuilder {
         return allMessages;
     }
     buildChatHistoryMessages(messages) {
-        var _a;
         let messagesBeingConsidered = messages;
-        const limit = parseInt((_a = process.env.OPENAI_MESSAGE_MEMORY_LIMIT) !== null && _a !== void 0 ? _a : '0');
-        if (limit > 0) {
-            messagesBeingConsidered = messages.slice(Math.max(messages.length - limit, 0));
+        if (this.memoryLimit > 0) {
+            messagesBeingConsidered = messages.slice(Math.max(messages.length - this.memoryLimit, 0));
         }
         const total = messagesBeingConsidered.length;
         return messagesBeingConsidered.map((message, idx) => this.mapMessageToCompletion(message, idx === total - 1));

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

@@ -1,5 +1,6 @@
 import { MercuryEventEmitter } from '@sprucelabs/mercury-types';
 import { Schema, SchemaValues, SelectFieldDefinition } from '@sprucelabs/schema';
+import { ReasoningEffort } from 'openai/resources';
 export interface BotOptions<StateSchema extends Schema = Schema, State extends SchemaValues<StateSchema> = SchemaValues<StateSchema>> extends Omit<PromptOptions<StateSchema, State>, 'skill'> {
     adapter: LlmAdapter;
     Class?: new (...opts: any[]) => SprucebotLlmBot<Schema, State>;
@@ -83,3 +84,4 @@ export interface SendMessageWithImage {
     imageDescription: string;
     imageBase64: string;
 }
+export type OpenAiReasoningEffort = ReasoningEffort;

package/build/llm.types.d.ts

@@ -1,5 +1,6 @@
 import { MercuryEventEmitter } from '@sprucelabs/mercury-types';
 import { Schema, SchemaValues, SelectFieldDefinition } from '@sprucelabs/schema';
+import { ReasoningEffort } from 'openai/resources';
 export interface BotOptions<StateSchema extends Schema = Schema, State extends SchemaValues<StateSchema> = SchemaValues<StateSchema>> extends Omit<PromptOptions<StateSchema, State>, 'skill'> {
     adapter: LlmAdapter;
     Class?: new (...opts: any[]) => SprucebotLlmBot<Schema, State>;
@@ -83,3 +84,4 @@ export interface SendMessageWithImage {
     imageDescription: string;
     imageBase64: string;
 }
+export type OpenAiReasoningEffort = ReasoningEffort;

package/package.json

@@ -8,7 +8,7 @@
       "eta"
     ]
   },
-  "version": "12.1.0",
+  "version": "12.3.0",
   "files": [
     "build"
   ],