@llumiverse/core 0.9.0 → 0.9.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@llumiverse/core",
-    "version": "0.9.0",
+    "version": "0.9.2",
     "type": "module",
     "description": "Provide an universal API to LLMs. Support for existing LLMs can be added by writing a driver.",
     "files": [
@@ -78,4 +78,4 @@
             "async": "async.js"
         }
     }
-}
+}

package/src/Driver.ts

@@ -5,7 +5,7 @@
  */
 
 import { DefaultCompletionStream, FallbackCompletionStream } from "./CompletionStream.js";
-import { PromptFormatters } from "./formatters.js";
+import { PromptFormatters } from "./formatters/index.js";
 import {
     AIModel,
     Completion,

package/src/formatters/claude.ts

@@ -0,0 +1,85 @@
+import { JSONSchema4 } from "json-schema";
+import { PromptRole, PromptSegment } from "../index.js";
+
+export interface ClaudeMessage {
+    role: 'user' | 'assistant',
+    content: {
+        type: "image" | "text",
+        source?: string, // only set for images
+        text?: string // only set for text messages
+    }[]
+}
+
+export interface ClaudeMessagesPrompt {
+    system?: string;
+    messages: ClaudeMessage[]
+}
+
+/**
+ * A formatter user by Bedrock to format prompts for claude related models
+ */
+
+export function claudeMessages(segments: PromptSegment[], schema?: JSONSchema4): ClaudeMessagesPrompt {
+    const system: string[] = [];
+    const safety: string[] = [];
+    const messages: ClaudeMessage[] = [];
+
+    for (const msg of segments) {
+        if (msg.role === PromptRole.system) {
+            system.push(msg.content);
+        } else if (msg.role === PromptRole.safety) {
+            safety.push(msg.content);
+        } else {
+            messages.push({ content: [{ type: "text", text: msg.content }], role: msg.role });
+        }
+    }
+
+    if (schema) {
+        safety.push(`You must answer using the following JSONSchema:
+---
+${JSON.stringify(schema)}
+---`);
+    }
+
+
+    // messages must contains at least 1 item. If the prompt doesn;t contains a user message (but only system messages)
+    // we need to put the system messages in the messages array
+
+    let systemMessage = system.join('\n').trim();
+    if (messages.length === 0) {
+        if (!systemMessage) {
+            throw new Error('Prompt must contain at least one message');
+        }
+        messages.push({ content: [{ type: "text", text: systemMessage }], role: 'user' });
+        systemMessage = safety.join('\n');
+    } else if (safety.length > 0) {
+        systemMessage = systemMessage + '\n\nIMPORTANT: ' + safety.join('\n');
+    }
+
+    /*start Claude's message to amke sure it answers properly in JSON
+    if enabled, this requires to add the { to Claude's response
+    if (schema) {
+        messages.push({
+            role: "assistant",
+            content: [{ 
+                type: "text", 
+                text: "{"
+        }]});
+    }*/
+
+    // put system mesages first and safety last
+    return {
+        system: systemMessage,
+        messages
+    }
+}
+
+// export function claude(messages: PromptSegment[], schema?: JSONSchema4) {
+//     const prompt = genericColonSeparator(messages, schema, {
+//         user: "\nHuman",
+//         assistant: "\nAssistant",
+//         system: "\nHuman",
+//     });
+
+//     return "\n\n" + prompt + "\n\nAssistant:";
+// }

package/src/formatters/generic.ts

@@ -0,0 +1,34 @@
+import { JSONSchema4 } from "json-schema";
+import { PromptRole, PromptSegment } from "../index.js";
+
+export function genericColonSeparator(
+    messages: PromptSegment[],
+    schema?: JSONSchema4,
+    labels: {
+        user: string;
+        assistant: string;
+        system: string;
+    } = { user: "User", assistant: "Assistant", system: "System" }
+) {
+    const promptMessages = [];
+    for (const m of messages) {
+        if (m.role === PromptRole.user) {
+            promptMessages.push(`${labels?.user}: ${m.content.trim()}`);
+        }
+        if (m.role === PromptRole.assistant) {
+            promptMessages.push(`${labels.assistant}: ${m.content.trim()}`);
+        }
+        if (m.role === PromptRole.system) {
+            promptMessages.push(`${labels.system}: ${m.content.trim()}`);
+        }
+    }
+
+    if (schema) {
+        promptMessages.push(`${labels.system}: You must answer using the following JSONSchema:
+        ---
+        ${JSON.stringify(schema)}
+        ---`);
+    }
+
+    return promptMessages.join("\n\n");
+}

package/src/formatters/index.ts

@@ -0,0 +1,33 @@
+import { JSONSchema4 } from "json-schema";
+import { genericColonSeparator } from "./generic.js";
+import { llama2 } from "./llama2.js";
+import { openAI } from "./openai.js";
+import {
+    PromptFormats,
+    PromptSegment
+} from "../types.js";
+import { claudeMessages } from "./claude.js";
+
+export function inferFormatterFromModelName(modelName: string): PromptFormats {
+    const name = modelName.toLowerCase();
+    if (name.includes("llama")) {
+        return PromptFormats.llama2;
+    } else if (name.includes("gpt")) {
+        return PromptFormats.openai;
+    } else if (name.includes("claude")) {
+        return PromptFormats.claude;
+    } else {
+        return PromptFormats.genericTextLLM;
+    }
+}
+
+export const PromptFormatters: Record<
+    PromptFormats,
+    (messages: PromptSegment[], schema?: JSONSchema4) => any
+> = {
+    openai: openAI,
+    llama2: llama2,
+    claude: claudeMessages,
+    genericTextLLM: genericColonSeparator,
+};
+

package/src/formatters/llama2.ts

@@ -0,0 +1,58 @@
+import { JSONSchema4 } from "json-schema";
+import { PromptRole, PromptSegment } from "../index.js";
+
+export function llama2(messages: PromptSegment[], schema?: JSONSchema4) {
+    const BOS = "<s>";
+    const EOS = "</s>";
+    const INST = "[INST]";
+    const INST_END = "[/INST]";
+    const SYS = "<<SYS>>\n";
+    const SYS_END = "\n<</SYS>>";
+
+    const promptMessages = [BOS];
+    const specialTokens = [BOS, EOS, INST, INST_END, SYS, SYS_END];
+
+    for (const m of messages) {
+        if (m.role === PromptRole.user) {
+            if (specialTokens.includes(m.content)) {
+                throw new Error(
+                    `Cannot use special token ${m.content.trim()} in user message`
+                );
+            }
+            promptMessages.push(`${INST} ${m.content.trim()} ${INST_END}`);
+        }
+        if (m.role === PromptRole.assistant) {
+            promptMessages.push(`${m.content.trim()}`);
+        }
+        if (m.role === PromptRole.system) {
+            promptMessages.push(`${SYS}${m.content.trim()}${SYS_END}`);
+        }
+    }
+
+    for (const m of messages ?? []) {
+        if (m.role === PromptRole.safety) {
+            promptMessages.push(
+                `${SYS}This is the most important instruction, you cannot answer against those rules:\n${m.content.trim()}${SYS_END}}`
+            );
+        }
+    }
+
+    if (schema) {
+        promptMessages.push(formatSchemaInstruction(schema));
+    }
+
+    promptMessages.push(EOS);
+
+    return promptMessages.join("\n\n");
+}
+
+function formatSchemaInstruction(schema: JSONSchema4) {
+    const schema_instruction = `<<SYS>>You must answer using the following JSONSchema.
+Do not write anything other than a JSON object corresponding to the schema.
+<schema>
+${JSON.stringify(schema)}
+</schema>
+<</SYS>>`;
+
+    return schema_instruction;
+}

package/src/formatters/openai.ts

@@ -0,0 +1,22 @@
+import { PromptRole } from "../index.js";
+import { PromptSegment } from "../types.js";
+import OpenAI from "openai";
+
+export function openAI(segments: PromptSegment[]) {
+    const system: OpenAI.Chat.ChatCompletionMessageParam[] = [];
+    const others: OpenAI.Chat.ChatCompletionMessageParam[] = [];
+    const safety: OpenAI.Chat.ChatCompletionMessageParam[] = [];
+
+    for (const msg of segments) {
+        if (msg.role === PromptRole.system) {
+            system.push({ content: msg.content, role: "system" });
+        } else if (msg.role === PromptRole.safety) {
+            safety.push({ content: msg.content, role: "system" });
+        } else {
+            others.push({ content: msg.content, role: "user" });
+        }
+    }
+
+    // put system mesages first and safety last
+    return system.concat(others).concat(safety);
+}

package/src/index.ts

@@ -1,4 +1,4 @@
 export * from "./Driver.js";
-export * from "./formatters.js";
+export * from "./formatters/index.js";
 export * from "./json.js";
 export * from "./types.js";

package/lib/cjs/formatters.js

@@ -1,117 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PromptFormatters = exports.inferFormatterFromModelName = void 0;
-const types_js_1 = require("./types.js");
-function inferFormatterFromModelName(modelName) {
-    const name = modelName.toLowerCase();
-    if (name.includes("llama")) {
-        return types_js_1.PromptFormats.llama2;
-    }
-    else if (name.includes("gpt")) {
-        return types_js_1.PromptFormats.openai;
-    }
-    else if (name.includes("claude")) {
-        return types_js_1.PromptFormats.claude;
-    }
-    else {
-        return types_js_1.PromptFormats.genericTextLLM;
-    }
-}
-exports.inferFormatterFromModelName = inferFormatterFromModelName;
-exports.PromptFormatters = {
-    openai: openAI,
-    llama2: llama2,
-    claude: claude,
-    genericTextLLM: genericColonSeparator,
-};
-function openAI(segments) {
-    const system = [];
-    const others = [];
-    const safety = [];
-    for (const msg of segments) {
-        if (msg.role === types_js_1.PromptRole.system) {
-            system.push({ content: msg.content, role: "system" });
-        }
-        else if (msg.role === types_js_1.PromptRole.safety) {
-            safety.push({ content: msg.content, role: "system" });
-        }
-        else {
-            others.push({ content: msg.content, role: "user" });
-        }
-    }
-    // put system mesages first and safety last
-    return system.concat(others).concat(safety);
-}
-function llama2(messages, schema) {
-    const BOS = "<s>";
-    const EOS = "</s>";
-    const INST = "[INST]";
-    const INST_END = "[/INST]";
-    const SYS = "<<SYS>>\n";
-    const SYS_END = "\n<</SYS>>";
-    const promptMessages = [BOS];
-    const specialTokens = [BOS, EOS, INST, INST_END, SYS, SYS_END];
-    for (const m of messages) {
-        if (m.role === types_js_1.PromptRole.user) {
-            if (specialTokens.includes(m.content)) {
-                throw new Error(`Cannot use special token ${m.content.trim()} in user message`);
-            }
-            promptMessages.push(`${INST} ${m.content.trim()} ${INST_END}`);
-        }
-        if (m.role === types_js_1.PromptRole.assistant) {
-            promptMessages.push(`${m.content.trim()}`);
-        }
-        if (m.role === types_js_1.PromptRole.system) {
-            promptMessages.push(`${SYS}${m.content.trim()}${SYS_END}`);
-        }
-    }
-    for (const m of messages ?? []) {
-        if (m.role === types_js_1.PromptRole.safety) {
-            promptMessages.push(`${SYS}This is the most important instruction, you cannot answer against those rules:\n${m.content.trim()}${SYS_END}}`);
-        }
-    }
-    if (schema) {
-        promptMessages.push(formatSchemaInstruction(schema));
-    }
-    promptMessages.push(EOS);
-    return promptMessages.join("\n\n");
-}
-function genericColonSeparator(messages, schema, labels = { user: "User", assistant: "Assistant", system: "System" }) {
-    const promptMessages = [];
-    for (const m of messages) {
-        if (m.role === types_js_1.PromptRole.user) {
-            promptMessages.push(`${labels?.user}: ${m.content.trim()}`);
-        }
-        if (m.role === types_js_1.PromptRole.assistant) {
-            promptMessages.push(`${labels.assistant}: ${m.content.trim()}`);
-        }
-        if (m.role === types_js_1.PromptRole.system) {
-            promptMessages.push(`${labels.system}: ${m.content.trim()}`);
-        }
-    }
-    if (schema) {
-        promptMessages.push(`${labels.system}: You must answer using the following JSONSchema:
-        ---
-        ${JSON.stringify(schema)}
-        ---`);
-    }
-    return promptMessages.join("\n\n");
-}
-function claude(messages, schema) {
-    const prompt = genericColonSeparator(messages, schema, {
-        user: "\nHuman",
-        assistant: "\nAssistant",
-        system: "\nHuman",
-    });
-    return "\n\n" + prompt + "\n\nAssistant:";
-}
-function formatSchemaInstruction(schema) {
-    const schema_instruction = `<<SYS>>You must answer using the following JSONSchema.
-Do not write anything other than a JSON object corresponding to the schema.
-<schema>
-${JSON.stringify(schema)}
-</schema>
-<</SYS>>`;
-    return schema_instruction;
-}
-//# sourceMappingURL=formatters.js.map

package/lib/cjs/formatters.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"formatters.js","sourceRoot":"","sources":["../../src/formatters.ts"],"names":[],"mappings":";;;AAEA,yCAIoB;AAEpB,SAAgB,2BAA2B,CAAC,SAAiB;IACzD,MAAM,IAAI,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IACrC,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QACzB,OAAO,wBAAa,CAAC,MAAM,CAAC;IAChC,CAAC;SAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO,wBAAa,CAAC,MAAM,CAAC;IAChC,CAAC;SAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACjC,OAAO,wBAAa,CAAC,MAAM,CAAC;IAChC,CAAC;SAAM,CAAC;QACJ,OAAO,wBAAa,CAAC,cAAc,CAAC;IACxC,CAAC;AACL,CAAC;AAXD,kEAWC;AAEY,QAAA,gBAAgB,GAGzB;IACA,MAAM,EAAE,MAAM;IACd,MAAM,EAAE,MAAM;IACd,MAAM,EAAE,MAAM;IACd,cAAc,EAAE,qBAAqB;CACxC,CAAC;AAEF,SAAS,MAAM,CAAC,QAAyB;IACrC,MAAM,MAAM,GAA6C,EAAE,CAAC;IAC5D,MAAM,MAAM,GAA6C,EAAE,CAAC;IAC5D,MAAM,MAAM,GAA6C,EAAE,CAAC;IAE5D,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;QACzB,IAAI,GAAG,CAAC,IAAI,KAAK,qBAAU,CAAC,MAAM,EAAE,CAAC;YACjC,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC1D,CAAC;aAAM,IAAI,GAAG,CAAC,IAAI,KAAK,qBAAU,CAAC,MAAM,EAAE,CAAC;YACxC,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC1D,CAAC;aAAM,CAAC;YACJ,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QACxD,CAAC;IACL,CAAC;IAED,2CAA2C;IAC3C,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AAChD,CAAC;AAED,SAAS,MAAM,CAAC,QAAyB,EAAE,MAAoB;IAC3D,MAAM,GAAG,GAAG,KAAK,CAAC;IAClB,MAAM,GAAG,GAAG,MAAM,CAAC;IACnB,MAAM,IAAI,GAAG,QAAQ,CAAC;IACtB,MAAM,QAAQ,GAAG,SAAS,CAAC;IAC3B,MAAM,GAAG,GAAG,WAAW,CAAC;IACxB,MAAM,OAAO,GAAG,YAAY,CAAC;IAE7B,MAAM,cAAc,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7B,MAAM,aAAa,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IAE/D,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;QACvB,IAAI,CAAC,CAAC,IAAI,KAAK,qBAAU,CAAC,IAAI,EAAE,CAAC;YAC7B,IAAI,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;gBACpC,MAAM,IAAI,KAAK,CACX,4BAA4B,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,kBAAkB,CACjE,CAAC;YACN,CAAC;YACD,cAAc,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,QAAQ,EAAE,CAAC,CAAC;QACnE,CAAC;QACD,IAAI,CAAC,CAAC,IAAI,KAAK,qBAAU,CAAC,SAAS,EAAE,CAAC;YAClC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC/C,CAAC;QACD,IAAI,CAAC,CAAC,IAAI,KAAK,qBAAU,CAAC,MAAM,EAAE,CAAC;YAC/B,cAAc,CAAC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;QAC/D,CAAC;IACL,CAAC;IAED,KAAK,MAAM,CAAC,IAAI,QAAQ,IAAI,EAAE,EAAE,CAAC;QAC7B,IAAI,CAAC,CAAC,IAAI,KAAK,qBAAU,CAAC,MAAM,EAAE,CAAC;YAC/B,cAAc,CAAC,IAAI,CACf,GAAG,GAAG,mFAAmF,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,OAAO,GAAG,CACzH,CAAC;QACN,CAAC;IACL,CAAC;IAED,IAAI,MAAM,EAAE,CAAC;QACT,cAAc,CAAC,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC,CAAC;IACzD,CAAC;IAED,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEzB,OAAO,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACvC,CAAC;AAED,SAAS,qBAAqB,CAC1B,QAAyB,EACzB,MAAoB,EACpB,SAII,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE;IAE9D,MAAM,cAAc,GAAG,EAAE,CAAC;IAC1B,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;QACvB,IAAI,CAAC,CAAC,IAAI,KAAK,qBAAU,CAAC,IAAI,EAAE,CAAC;YAC7B,cAAc,CAAC,IAAI,CAAC,GAAG,MAAM,EAAE,IAAI,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAChE,CAAC;QACD,IAAI,CAAC,CAAC,IAAI,KAAK,qBAAU,CAAC,SAAS,EAAE,CAAC;YAClC,cAAc,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,SAAS,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpE,CAAC;QACD,IAAI,CAAC,CAAC,IAAI,KAAK,qBAAU,CAAC,MAAM,EAAE,CAAC;YAC/B,cAAc,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACjE,CAAC;IACL,CAAC;IAED,IAAI,MAAM,EAAE,CAAC;QACT,cAAc,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM;;UAElC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;YACpB,CAAC,CAAC;IACV,CAAC;IAED,OAAO,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACvC,CAAC;AAED,SAAS,MAAM,CAAC,QAAyB,EAAE,MAAoB;IAC3D,MAAM,MAAM,GAAG,qBAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE;QACnD,IAAI,EAAE,SAAS;QACf,SAAS,EAAE,aAAa;QACxB,MAAM,EAAE,SAAS;KACpB,CAAC,CAAC;IAEH,OAAO,MAAM,GAAG,MAAM,GAAG,gBAAgB,CAAC;AAC9C,CAAC;AAED,SAAS,uBAAuB,CAAC,MAAmB;IAChD,MAAM,kBAAkB,GAAG;;;EAG7B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;;SAEf,CAAC;IAEN,OAAO,kBAAkB,CAAC;AAC9B,CAAC"}

package/lib/esm/formatters.js

@@ -1,113 +0,0 @@
-import { PromptFormats, PromptRole, } from "./types.js";
-export function inferFormatterFromModelName(modelName) {
-    const name = modelName.toLowerCase();
-    if (name.includes("llama")) {
-        return PromptFormats.llama2;
-    }
-    else if (name.includes("gpt")) {
-        return PromptFormats.openai;
-    }
-    else if (name.includes("claude")) {
-        return PromptFormats.claude;
-    }
-    else {
-        return PromptFormats.genericTextLLM;
-    }
-}
-export const PromptFormatters = {
-    openai: openAI,
-    llama2: llama2,
-    claude: claude,
-    genericTextLLM: genericColonSeparator,
-};
-function openAI(segments) {
-    const system = [];
-    const others = [];
-    const safety = [];
-    for (const msg of segments) {
-        if (msg.role === PromptRole.system) {
-            system.push({ content: msg.content, role: "system" });
-        }
-        else if (msg.role === PromptRole.safety) {
-            safety.push({ content: msg.content, role: "system" });
-        }
-        else {
-            others.push({ content: msg.content, role: "user" });
-        }
-    }
-    // put system mesages first and safety last
-    return system.concat(others).concat(safety);
-}
-function llama2(messages, schema) {
-    const BOS = "<s>";
-    const EOS = "</s>";
-    const INST = "[INST]";
-    const INST_END = "[/INST]";
-    const SYS = "<<SYS>>\n";
-    const SYS_END = "\n<</SYS>>";
-    const promptMessages = [BOS];
-    const specialTokens = [BOS, EOS, INST, INST_END, SYS, SYS_END];
-    for (const m of messages) {
-        if (m.role === PromptRole.user) {
-            if (specialTokens.includes(m.content)) {
-                throw new Error(`Cannot use special token ${m.content.trim()} in user message`);
-            }
-            promptMessages.push(`${INST} ${m.content.trim()} ${INST_END}`);
-        }
-        if (m.role === PromptRole.assistant) {
-            promptMessages.push(`${m.content.trim()}`);
-        }
-        if (m.role === PromptRole.system) {
-            promptMessages.push(`${SYS}${m.content.trim()}${SYS_END}`);
-        }
-    }
-    for (const m of messages ?? []) {
-        if (m.role === PromptRole.safety) {
-            promptMessages.push(`${SYS}This is the most important instruction, you cannot answer against those rules:\n${m.content.trim()}${SYS_END}}`);
-        }
-    }
-    if (schema) {
-        promptMessages.push(formatSchemaInstruction(schema));
-    }
-    promptMessages.push(EOS);
-    return promptMessages.join("\n\n");
-}
-function genericColonSeparator(messages, schema, labels = { user: "User", assistant: "Assistant", system: "System" }) {
-    const promptMessages = [];
-    for (const m of messages) {
-        if (m.role === PromptRole.user) {
-            promptMessages.push(`${labels?.user}: ${m.content.trim()}`);
-        }
-        if (m.role === PromptRole.assistant) {
-            promptMessages.push(`${labels.assistant}: ${m.content.trim()}`);
-        }
-        if (m.role === PromptRole.system) {
-            promptMessages.push(`${labels.system}: ${m.content.trim()}`);
-        }
-    }
-    if (schema) {
-        promptMessages.push(`${labels.system}: You must answer using the following JSONSchema:
-        ---
-        ${JSON.stringify(schema)}
-        ---`);
-    }
-    return promptMessages.join("\n\n");
-}
-function claude(messages, schema) {
-    const prompt = genericColonSeparator(messages, schema, {
-        user: "\nHuman",
-        assistant: "\nAssistant",
-        system: "\nHuman",
-    });
-    return "\n\n" + prompt + "\n\nAssistant:";
-}
-function formatSchemaInstruction(schema) {
-    const schema_instruction = `<<SYS>>You must answer using the following JSONSchema.
-Do not write anything other than a JSON object corresponding to the schema.
-<schema>
-${JSON.stringify(schema)}
-</schema>
-<</SYS>>`;
-    return schema_instruction;
-}
-//# sourceMappingURL=formatters.js.map

package/lib/esm/formatters.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"formatters.js","sourceRoot":"","sources":["../../src/formatters.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,aAAa,EACb,UAAU,GAEb,MAAM,YAAY,CAAC;AAEpB,MAAM,UAAU,2BAA2B,CAAC,SAAiB;IACzD,MAAM,IAAI,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IACrC,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QACzB,OAAO,aAAa,CAAC,MAAM,CAAC;IAChC,CAAC;SAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO,aAAa,CAAC,MAAM,CAAC;IAChC,CAAC;SAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACjC,OAAO,aAAa,CAAC,MAAM,CAAC;IAChC,CAAC;SAAM,CAAC;QACJ,OAAO,aAAa,CAAC,cAAc,CAAC;IACxC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,MAAM,gBAAgB,GAGzB;IACA,MAAM,EAAE,MAAM;IACd,MAAM,EAAE,MAAM;IACd,MAAM,EAAE,MAAM;IACd,cAAc,EAAE,qBAAqB;CACxC,CAAC;AAEF,SAAS,MAAM,CAAC,QAAyB;IACrC,MAAM,MAAM,GAA6C,EAAE,CAAC;IAC5D,MAAM,MAAM,GAA6C,EAAE,CAAC;IAC5D,MAAM,MAAM,GAA6C,EAAE,CAAC;IAE5D,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;QACzB,IAAI,GAAG,CAAC,IAAI,KAAK,UAAU,CAAC,MAAM,EAAE,CAAC;YACjC,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC1D,CAAC;aAAM,IAAI,GAAG,CAAC,IAAI,KAAK,UAAU,CAAC,MAAM,EAAE,CAAC;YACxC,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC1D,CAAC;aAAM,CAAC;YACJ,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QACxD,CAAC;IACL,CAAC;IAED,2CAA2C;IAC3C,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AAChD,CAAC;AAED,SAAS,MAAM,CAAC,QAAyB,EAAE,MAAoB;IAC3D,MAAM,GAAG,GAAG,KAAK,CAAC;IAClB,MAAM,GAAG,GAAG,MAAM,CAAC;IACnB,MAAM,IAAI,GAAG,QAAQ,CAAC;IACtB,MAAM,QAAQ,GAAG,SAAS,CAAC;IAC3B,MAAM,GAAG,GAAG,WAAW,CAAC;IACxB,MAAM,OAAO,GAAG,YAAY,CAAC;IAE7B,MAAM,cAAc,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7B,MAAM,aAAa,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IAE/D,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;QACvB,IAAI,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,EAAE,CAAC;YAC7B,IAAI,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;gBACpC,MAAM,IAAI,KAAK,CACX,4BAA4B,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,kBAAkB,CACjE,CAAC;YACN,CAAC;YACD,cAAc,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,QAAQ,EAAE,CAAC,CAAC;QACnE,CAAC;QACD,IAAI,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,SAAS,EAAE,CAAC;YAClC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC/C,CAAC;QACD,IAAI,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,MAAM,EAAE,CAAC;YAC/B,cAAc,CAAC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;QAC/D,CAAC;IACL,CAAC;IAED,KAAK,MAAM,CAAC,IAAI,QAAQ,IAAI,EAAE,EAAE,CAAC;QAC7B,IAAI,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,MAAM,EAAE,CAAC;YAC/B,cAAc,CAAC,IAAI,CACf,GAAG,GAAG,mFAAmF,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,OAAO,GAAG,CACzH,CAAC;QACN,CAAC;IACL,CAAC;IAED,IAAI,MAAM,EAAE,CAAC;QACT,cAAc,CAAC,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC,CAAC;IACzD,CAAC;IAED,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEzB,OAAO,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACvC,CAAC;AAED,SAAS,qBAAqB,CAC1B,QAAyB,EACzB,MAAoB,EACpB,SAII,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE;IAE9D,MAAM,cAAc,GAAG,EAAE,CAAC;IAC1B,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;QACvB,IAAI,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,EAAE,CAAC;YAC7B,cAAc,CAAC,IAAI,CAAC,GAAG,MAAM,EAAE,IAAI,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAChE,CAAC;QACD,IAAI,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,SAAS,EAAE,CAAC;YAClC,cAAc,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,SAAS,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpE,CAAC;QACD,IAAI,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,MAAM,EAAE,CAAC;YAC/B,cAAc,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACjE,CAAC;IACL,CAAC;IAED,IAAI,MAAM,EAAE,CAAC;QACT,cAAc,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM;;UAElC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;YACpB,CAAC,CAAC;IACV,CAAC;IAED,OAAO,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACvC,CAAC;AAED,SAAS,MAAM,CAAC,QAAyB,EAAE,MAAoB;IAC3D,MAAM,MAAM,GAAG,qBAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE;QACnD,IAAI,EAAE,SAAS;QACf,SAAS,EAAE,aAAa;QACxB,MAAM,EAAE,SAAS;KACpB,CAAC,CAAC;IAEH,OAAO,MAAM,GAAG,MAAM,GAAG,gBAAgB,CAAC;AAC9C,CAAC;AAED,SAAS,uBAAuB,CAAC,MAAmB;IAChD,MAAM,kBAAkB,GAAG;;;EAG7B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;;SAEf,CAAC;IAEN,OAAO,kBAAkB,CAAC;AAC9B,CAAC"}

package/lib/types/formatters.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"formatters.d.ts","sourceRoot":"","sources":["../../src/formatters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,EACH,aAAa,EAEb,aAAa,EAChB,MAAM,YAAY,CAAC;AAEpB,wBAAgB,2BAA2B,CAAC,SAAS,EAAE,MAAM,GAAG,aAAa,CAW5E;AAED,eAAO,MAAM,gBAAgB,EAAE,MAAM,CACjC,aAAa,EACb,CAAC,QAAQ,EAAE,aAAa,EAAE,EAAE,MAAM,CAAC,EAAE,WAAW,KAAK,GAAG,CAM3D,CAAC"}

package/src/formatters.ts

@@ -1,147 +0,0 @@
-import { JSONSchema4 } from "json-schema";
-import OpenAI from "openai";
-import {
-    PromptFormats,
-    PromptRole,
-    PromptSegment,
-} from "./types.js";
-
-export function inferFormatterFromModelName(modelName: string): PromptFormats {
-    const name = modelName.toLowerCase();
-    if (name.includes("llama")) {
-        return PromptFormats.llama2;
-    } else if (name.includes("gpt")) {
-        return PromptFormats.openai;
-    } else if (name.includes("claude")) {
-        return PromptFormats.claude;
-    } else {
-        return PromptFormats.genericTextLLM;
-    }
-}
-
-export const PromptFormatters: Record<
-    PromptFormats,
-    (messages: PromptSegment[], schema?: JSONSchema4) => any
-> = {
-    openai: openAI,
-    llama2: llama2,
-    claude: claude,
-    genericTextLLM: genericColonSeparator,
-};
-
-function openAI(segments: PromptSegment[]) {
-    const system: OpenAI.Chat.ChatCompletionMessageParam[] = [];
-    const others: OpenAI.Chat.ChatCompletionMessageParam[] = [];
-    const safety: OpenAI.Chat.ChatCompletionMessageParam[] = [];
-
-    for (const msg of segments) {
-        if (msg.role === PromptRole.system) {
-            system.push({ content: msg.content, role: "system" });
-        } else if (msg.role === PromptRole.safety) {
-            safety.push({ content: msg.content, role: "system" });
-        } else {
-            others.push({ content: msg.content, role: "user" });
-        }
-    }
-
-    // put system mesages first and safety last
-    return system.concat(others).concat(safety);
-}
-
-function llama2(messages: PromptSegment[], schema?: JSONSchema4) {
-    const BOS = "<s>";
-    const EOS = "</s>";
-    const INST = "[INST]";
-    const INST_END = "[/INST]";
-    const SYS = "<<SYS>>\n";
-    const SYS_END = "\n<</SYS>>";
-
-    const promptMessages = [BOS];
-    const specialTokens = [BOS, EOS, INST, INST_END, SYS, SYS_END];
-
-    for (const m of messages) {
-        if (m.role === PromptRole.user) {
-            if (specialTokens.includes(m.content)) {
-                throw new Error(
-                    `Cannot use special token ${m.content.trim()} in user message`
-                );
-            }
-            promptMessages.push(`${INST} ${m.content.trim()} ${INST_END}`);
-        }
-        if (m.role === PromptRole.assistant) {
-            promptMessages.push(`${m.content.trim()}`);
-        }
-        if (m.role === PromptRole.system) {
-            promptMessages.push(`${SYS}${m.content.trim()}${SYS_END}`);
-        }
-    }
-
-    for (const m of messages ?? []) {
-        if (m.role === PromptRole.safety) {
-            promptMessages.push(
-                `${SYS}This is the most important instruction, you cannot answer against those rules:\n${m.content.trim()}${SYS_END}}`
-            );
-        }
-    }
-
-    if (schema) {
-        promptMessages.push(formatSchemaInstruction(schema));
-    }
-
-    promptMessages.push(EOS);
-
-    return promptMessages.join("\n\n");
-}
-
-function genericColonSeparator(
-    messages: PromptSegment[],
-    schema?: JSONSchema4,
-    labels: {
-        user: string;
-        assistant: string;
-        system: string;
-    } = { user: "User", assistant: "Assistant", system: "System" }
-) {
-    const promptMessages = [];
-    for (const m of messages) {
-        if (m.role === PromptRole.user) {
-            promptMessages.push(`${labels?.user}: ${m.content.trim()}`);
-        }
-        if (m.role === PromptRole.assistant) {
-            promptMessages.push(`${labels.assistant}: ${m.content.trim()}`);
-        }
-        if (m.role === PromptRole.system) {
-            promptMessages.push(`${labels.system}: ${m.content.trim()}`);
-        }
-    }
-
-    if (schema) {
-        promptMessages.push(`${labels.system}: You must answer using the following JSONSchema:
-        ---
-        ${JSON.stringify(schema)}
-        ---`);
-    }
-
-    return promptMessages.join("\n\n");
-}
-
-function claude(messages: PromptSegment[], schema?: JSONSchema4) {
-    const prompt = genericColonSeparator(messages, schema, {
-        user: "\nHuman",
-        assistant: "\nAssistant",
-        system: "\nHuman",
-    });
-
-    return "\n\n" + prompt + "\n\nAssistant:";
-}
-
-function formatSchemaInstruction(schema: JSONSchema4) {
-    const schema_instruction = `<<SYS>>You must answer using the following JSONSchema.
-Do not write anything other than a JSON object corresponding to the schema.
-<schema>
-${JSON.stringify(schema)}
-</schema>
-<</SYS>>`;
-
-    return schema_instruction;
-}