Spaces:
Running
Running
File size: 37,038 Bytes
4342d5f |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 |
import crypto from 'node:crypto';
import { getConfigValue, tryParse } from './util.js';
const PROMPT_PLACEHOLDER = getConfigValue('promptPlaceholder', 'Let\'s get started.');
/**
* @typedef {object} PromptNames
* @property {string} charName Character name
* @property {string} userName User name
* @property {string[]} groupNames Group member names
* @property {function(string): boolean} startsWithGroupName Check if a message starts with a group name
*/
/**
* Extracts the character name, user name, and group member names from the request.
* @param {import('express').Request} request Express request object
* @returns {PromptNames} Prompt names
*/
export function getPromptNames(request) {
return {
charName: String(request.body.char_name || ''),
userName: String(request.body.user_name || ''),
groupNames: Array.isArray(request.body.group_names) ? request.body.group_names.map(String) : [],
startsWithGroupName: function (message) {
return this.groupNames.some(name => message.startsWith(`${name}: `));
},
};
}
/**
* Convert a prompt from the ChatML objects to the format used by Claude.
* Mainly deprecated. Only used for counting tokens.
* @param {object[]} messages Array of messages
* @param {boolean} addAssistantPostfix Add Assistant postfix.
* @param {string} addAssistantPrefill Add Assistant prefill after the assistant postfix.
* @param {boolean} withSysPromptSupport Indicates if the Claude model supports the system prompt format.
* @param {boolean} useSystemPrompt Indicates if the system prompt format should be used.
* @param {boolean} excludePrefixes Exlude Human/Assistant prefixes.
* @param {string} addSysHumanMsg Add Human message between system prompt and assistant.
* @returns {string} Prompt for Claude
* @copyright Prompt Conversion script taken from RisuAI by kwaroran (GPLv3).
*/
export function convertClaudePrompt(messages, addAssistantPostfix, addAssistantPrefill, withSysPromptSupport, useSystemPrompt, addSysHumanMsg, excludePrefixes) {
//Prepare messages for claude.
//When 'Exclude Human/Assistant prefixes' checked, setting messages role to the 'system'(last message is exception).
if (messages.length > 0) {
messages.forEach((m) => {
if (!m.content) {
m.content = '';
}
if (m.tool_calls) {
m.content += JSON.stringify(m.tool_calls);
}
});
if (excludePrefixes) {
messages.slice(0, -1).forEach(message => message.role = 'system');
} else {
messages[0].role = 'system';
}
//Add the assistant's message to the end of messages.
if (addAssistantPostfix) {
messages.push({
role: 'assistant',
content: addAssistantPrefill || '',
});
}
// Find the index of the first message with an assistant role and check for a "'user' role/Human:" before it.
let hasUser = false;
const firstAssistantIndex = messages.findIndex((message, i) => {
if (i >= 0 && (message.role === 'user' || message.content.includes('\n\nHuman: '))) {
hasUser = true;
}
return message.role === 'assistant' && i > 0;
});
// When 2.1+ and 'Use system prompt' checked, switches to the system prompt format by setting the first message's role to the 'system'.
// Inserts the human's message before the first the assistant one, if there are no such message or prefix found.
if (withSysPromptSupport && useSystemPrompt) {
messages[0].role = 'system';
if (firstAssistantIndex > 0 && addSysHumanMsg && !hasUser) {
messages.splice(firstAssistantIndex, 0, {
role: 'user',
content: addSysHumanMsg,
});
}
} else {
// Otherwise, use the default message format by setting the first message's role to 'user'(compatible with all claude models including 2.1.)
messages[0].role = 'user';
// Fix messages order for default message format when(messages > Context Size) by merging two messages with "\n\nHuman: " prefixes into one, before the first Assistant's message.
if (firstAssistantIndex > 0 && !excludePrefixes) {
messages[firstAssistantIndex - 1].role = firstAssistantIndex - 1 !== 0 && messages[firstAssistantIndex - 1].role === 'user' ? 'FixHumMsg' : messages[firstAssistantIndex - 1].role;
}
}
}
// Convert messages to the prompt.
let requestPrompt = messages.map((v, i) => {
// Set prefix according to the role. Also, when "Exclude Human/Assistant prefixes" is checked, names are added via the system prefix.
let prefix = {
'assistant': '\n\nAssistant: ',
'user': '\n\nHuman: ',
'system': i === 0 ? '' : v.name === 'example_assistant' ? '\n\nA: ' : v.name === 'example_user' ? '\n\nH: ' : excludePrefixes && v.name ? `\n\n${v.name}: ` : '\n\n',
'FixHumMsg': '\n\nFirst message: ',
}[v.role] ?? '';
// Claude doesn't support message names, so we'll just add them to the message content.
return `${prefix}${v.name && v.role !== 'system' ? `${v.name}: ` : ''}${v.content}`;
}).join('');
return requestPrompt;
}
/**
* Convert ChatML objects into working with Anthropic's new Messaging API.
* @param {object[]} messages Array of messages
* @param {string} prefillString User determined prefill string
* @param {boolean} useSysPrompt See if we want to use a system prompt
* @param {boolean} useTools See if we want to use tools
* @param {PromptNames} names Prompt names
* @returns {{messages: object[], systemPrompt: object[]}} Prompt for Anthropic
*/
export function convertClaudeMessages(messages, prefillString, useSysPrompt, useTools, names) {
let systemPrompt = [];
if (useSysPrompt) {
// Collect all the system messages up until the first instance of a non-system message, and then remove them from the messages array.
let i;
for (i = 0; i < messages.length; i++) {
if (messages[i].role !== 'system') {
break;
}
// Append example names if not already done by the frontend (e.g. for group chats).
if (names.userName && messages[i].name === 'example_user') {
if (!messages[i].content.startsWith(`${names.userName}: `)) {
messages[i].content = `${names.userName}: ${messages[i].content}`;
}
}
if (names.charName && messages[i].name === 'example_assistant') {
if (!messages[i].content.startsWith(`${names.charName}: `) && !names.startsWithGroupName(messages[i].content)) {
messages[i].content = `${names.charName}: ${messages[i].content}`;
}
}
systemPrompt.push({ type: 'text', text: messages[i].content });
}
messages.splice(0, i);
// Check if the first message in the array is of type user, if not, interject with humanMsgFix or a blank message.
// Also prevents erroring out if the messages array is empty.
if (messages.length === 0) {
messages.unshift({
role: 'user',
content: PROMPT_PLACEHOLDER,
});
}
}
// Now replace all further messages that have the role 'system' with the role 'user'. (or all if we're not using one)
const parse = (str) => typeof str === 'string' ? JSON.parse(str) : str;
messages.forEach((message) => {
if (message.role === 'assistant' && message.tool_calls) {
message.content = message.tool_calls.map((tc) => ({
type: 'tool_use',
id: tc.id,
name: tc.function.name,
input: parse(tc.function.arguments),
}));
}
if (message.role === 'tool') {
message.role = 'user';
message.content = [{
type: 'tool_result',
tool_use_id: message.tool_call_id,
content: message.content,
}];
}
if (message.role === 'system') {
if (names.userName && message.name === 'example_user') {
if (!message.content.startsWith(`${names.userName}: `)) {
message.content = `${names.userName}: ${message.content}`;
}
}
if (names.charName && message.name === 'example_assistant') {
if (!message.content.startsWith(`${names.charName}: `) && !names.startsWithGroupName(message.content)) {
message.content = `${names.charName}: ${message.content}`;
}
}
message.role = 'user';
// Delete name here so it doesn't get added later
delete message.name;
}
// Convert everything to an array of it would be easier to work with
if (typeof message.content === 'string') {
// Take care of name properties since claude messages don't support them
if (message.name) {
message.content = `${message.name}: ${message.content}`;
}
message.content = [{ type: 'text', text: message.content }];
} else if (Array.isArray(message.content)) {
message.content = message.content.map((content) => {
if (content.type === 'image_url') {
const imageEntry = content?.image_url;
const imageData = imageEntry?.url;
const mimeType = imageData?.split(';')?.[0].split(':')?.[1];
const base64Data = imageData?.split(',')?.[1];
return {
type: 'image',
source: {
type: 'base64',
media_type: mimeType,
data: base64Data,
},
};
}
if (content.type === 'text') {
if (message.name) {
content.text = `${message.name}: ${content.text}`;
}
// If the text is empty, replace it with a zero-width space
return { type: 'text', text: content.text || '\u200b' };
}
return content;
});
}
// Remove offending properties
delete message.name;
delete message.tool_calls;
delete message.tool_call_id;
});
// Images in assistant messages should be moved to the next user message
for (let i = 0; i < messages.length; i++) {
if (messages[i].role === 'assistant' && messages[i].content.some(c => c.type === 'image')) {
// Find the next user message
let j = i + 1;
while (j < messages.length && messages[j].role !== 'user') {
j++;
}
// Move the images
if (j >= messages.length) {
// If there is no user message after the assistant message, add a new one
messages.splice(i + 1, 0, { role: 'user', content: [] });
}
messages[j].content.push(...messages[i].content.filter(c => c.type === 'image'));
messages[i].content = messages[i].content.filter(c => c.type !== 'image');
}
}
// Shouldn't be conditional anymore, messages api expects the last role to be user unless we're explicitly prefilling
if (prefillString) {
messages.push({
role: 'assistant',
// Dangling whitespace are not allowed for prefilling
content: [{ type: 'text', text: prefillString.trimEnd() }],
});
}
// Since the messaging endpoint only supports user assistant roles in turns, we have to merge messages with the same role if they follow eachother
// Also handle multi-modality, holy slop.
let mergedMessages = [];
messages.forEach((message) => {
if (mergedMessages.length > 0 && mergedMessages[mergedMessages.length - 1].role === message.role) {
mergedMessages[mergedMessages.length - 1].content.push(...message.content);
} else {
mergedMessages.push(message);
}
});
if (!useTools) {
mergedMessages.forEach((message) => {
message.content.forEach((content) => {
if (content.type === 'tool_use') {
content.type = 'text';
content.text = JSON.stringify(content.input);
delete content.id;
delete content.name;
delete content.input;
}
if (content.type === 'tool_result') {
content.type = 'text';
content.text = content.content;
delete content.tool_use_id;
delete content.content;
}
});
});
}
return { messages: mergedMessages, systemPrompt: systemPrompt };
}
/**
* Convert a prompt from the ChatML objects to the format used by Cohere.
* @param {object[]} messages Array of messages
* @param {PromptNames} names Prompt names
* @returns {{chatHistory: object[]}} Prompt for Cohere
*/
export function convertCohereMessages(messages, names) {
if (messages.length === 0) {
messages.unshift({
role: 'user',
content: PROMPT_PLACEHOLDER,
});
}
messages.forEach((msg, index) => {
// Tool calls require an assistent primer
if (Array.isArray(msg.tool_calls)) {
if (index > 0 && messages[index - 1].role === 'assistant') {
msg.content = messages[index - 1].content;
messages.splice(index - 1, 1);
} else {
msg.content = `I'm going to call a tool for that: ${msg.tool_calls.map(tc => tc?.function?.name).join(', ')}`;
}
}
// No names support (who would've thought)
if (msg.name) {
if (msg.role == 'system' && msg.name == 'example_assistant') {
if (names.charName && !msg.content.startsWith(`${names.charName}: `) && !names.startsWithGroupName(msg.content)) {
msg.content = `${names.charName}: ${msg.content}`;
}
}
if (msg.role == 'system' && msg.name == 'example_user') {
if (names.userName && !msg.content.startsWith(`${names.userName}: `)) {
msg.content = `${names.userName}: ${msg.content}`;
}
}
if (msg.role !== 'system' && !msg.content.startsWith(`${msg.name}: `)) {
msg.content = `${msg.name}: ${msg.content}`;
}
delete msg.name;
}
});
// A prompt should end with a user/tool message
if (messages.length && !['user', 'tool'].includes(messages[messages.length - 1].role)) {
messages[messages.length - 1].role = 'user';
}
return { chatHistory: messages };
}
/**
* Convert a prompt from the ChatML objects to the format used by Google MakerSuite models.
* @param {object[]} messages Array of messages
* @param {string} model Model name
* @param {boolean} useSysPrompt Use system prompt
* @param {PromptNames} names Prompt names
* @returns {{contents: *[], system_instruction: {parts: {text: string}}}} Prompt for Google MakerSuite models
*/
export function convertGooglePrompt(messages, model, useSysPrompt, names) {
const visionSupportedModels = [
'gemini-2.0-pro-exp',
'gemini-2.0-pro-exp-02-05',
'gemini-2.0-flash-lite-preview',
'gemini-2.0-flash-lite-preview-02-05',
'gemini-2.0-flash',
'gemini-2.0-flash-001',
'gemini-2.0-flash-thinking-exp',
'gemini-2.0-flash-thinking-exp-01-21',
'gemini-2.0-flash-thinking-exp-1219',
'gemini-2.0-flash-exp',
'gemini-2.0-flash-exp-image-generation',
'gemini-1.5-flash',
'gemini-1.5-flash-latest',
'gemini-1.5-flash-001',
'gemini-1.5-flash-002',
'gemini-1.5-flash-exp-0827',
'gemini-1.5-flash-8b',
'gemini-1.5-flash-8b-exp-0827',
'gemini-1.5-flash-8b-exp-0924',
'gemini-exp-1114',
'gemini-exp-1121',
'gemini-exp-1206',
'gemini-1.5-pro',
'gemini-1.5-pro-latest',
'gemini-1.5-pro-001',
'gemini-1.5-pro-002',
'gemini-1.5-pro-exp-0801',
'gemini-1.5-pro-exp-0827',
];
const isMultimodal = visionSupportedModels.includes(model);
let sys_prompt = '';
if (useSysPrompt) {
while (messages.length > 1 && messages[0].role === 'system') {
// Append example names if not already done by the frontend (e.g. for group chats).
if (names.userName && messages[0].name === 'example_user') {
if (!messages[0].content.startsWith(`${names.userName}: `)) {
messages[0].content = `${names.userName}: ${messages[0].content}`;
}
}
if (names.charName && messages[0].name === 'example_assistant') {
if (!messages[0].content.startsWith(`${names.charName}: `) && !names.startsWithGroupName(messages[0].content)) {
messages[0].content = `${names.charName}: ${messages[0].content}`;
}
}
sys_prompt += `${messages[0].content}\n\n`;
messages.shift();
}
}
const system_instruction = { parts: { text: sys_prompt.trim() } };
const toolNameMap = {};
const contents = [];
messages.forEach((message, index) => {
// fix the roles
if (message.role === 'system' || message.role === 'tool') {
message.role = 'user';
} else if (message.role === 'assistant') {
message.role = 'model';
}
// Convert the content to an array of parts
if (!Array.isArray(message.content)) {
const content = (() => {
const hasToolCalls = Array.isArray(message.tool_calls) && message.tool_calls.length > 0;
const hasToolCallId = typeof message.tool_call_id === 'string' && message.tool_call_id.length > 0;
if (hasToolCalls) {
return { type: 'tool_calls', tool_calls: message.tool_calls };
}
if (hasToolCallId) {
return { type: 'tool_call_id', tool_call_id: message.tool_call_id, content: String(message.content ?? '') };
}
return { type: 'text', text: String(message.content ?? '') };
})();
message.content = [content];
}
// similar story as claude
if (message.name) {
message.content.forEach((part) => {
if (part.type !== 'text') {
return;
}
if (message.name === 'example_user') {
if (names.userName && !part.text.startsWith(`${names.userName}: `)) {
part.text = `${names.userName}: ${part.text}`;
}
} else if (message.name === 'example_assistant') {
if (names.charName && !part.text.startsWith(`${names.charName}: `) && !names.startsWithGroupName(part.text)) {
part.text = `${names.charName}: ${part.text}`;
}
} else {
if (!part.text.startsWith(`${message.name}: `)) {
part.text = `${message.name}: ${part.text}`;
}
}
});
delete message.name;
}
//create the prompt parts
const parts = [];
message.content.forEach((part) => {
if (part.type === 'text') {
parts.push({ text: part.text });
} else if (part.type === 'tool_call_id') {
const name = toolNameMap[part.tool_call_id] ?? 'unknown';
parts.push({
functionResponse: {
name: name,
response: { name: name, content: part.content },
},
});
} else if (part.type === 'tool_calls') {
part.tool_calls.forEach((toolCall) => {
parts.push({
functionCall: {
name: toolCall.function.name,
args: tryParse(toolCall.function.arguments) ?? toolCall.function.arguments,
},
});
toolNameMap[toolCall.id] = toolCall.function.name;
});
} else if (part.type === 'image_url' && isMultimodal) {
const mimeType = part.image_url.url.split(';')[0].split(':')[1];
const base64Data = part.image_url.url.split(',')[1];
parts.push({
inlineData: {
mimeType: mimeType,
data: base64Data,
},
});
}
});
// merge consecutive messages with the same role
if (index > 0 && message.role === contents[contents.length - 1].role) {
parts.forEach((part) => {
if (part.text) {
contents[contents.length - 1].parts[0].text += '\n\n' + part.text;
}
if (part.inlineData || part.functionCall || part.functionResponse) {
contents[contents.length - 1].parts.push(part);
}
});
} else {
contents.push({
role: message.role,
parts: parts,
});
}
});
return { contents: contents, system_instruction: system_instruction };
}
/**
* Convert AI21 prompt. Classic: system message squash, user/assistant message merge.
* @param {object[]} messages Array of messages
* @param {PromptNames} names Prompt names
* @returns {object[]} Prompt for AI21
*/
export function convertAI21Messages(messages, names) {
if (!Array.isArray(messages)) {
return [];
}
// Collect all the system messages up until the first instance of a non-system message, and then remove them from the messages array.
let i = 0, systemPrompt = '';
for (i = 0; i < messages.length; i++) {
if (messages[i].role !== 'system') {
break;
}
// Append example names if not already done by the frontend (e.g. for group chats).
if (names.userName && messages[i].name === 'example_user') {
if (!messages[i].content.startsWith(`${names.userName}: `)) {
messages[i].content = `${names.userName}: ${messages[i].content}`;
}
}
if (names.charName && messages[i].name === 'example_assistant') {
if (!messages[i].content.startsWith(`${names.charName}: `) && !names.startsWithGroupName(messages[i].content)) {
messages[i].content = `${names.charName}: ${messages[i].content}`;
}
}
systemPrompt += `${messages[i].content}\n\n`;
}
messages.splice(0, i);
// Prevent erroring out if the messages array is empty.
if (messages.length === 0) {
messages.unshift({
role: 'user',
content: PROMPT_PLACEHOLDER,
});
}
if (systemPrompt) {
messages.unshift({
role: 'system',
content: systemPrompt.trim(),
});
}
// Doesn't support completion names, so prepend if not already done by the frontend (e.g. for group chats).
messages.forEach(msg => {
if ('name' in msg) {
if (msg.role !== 'system' && !msg.content.startsWith(`${msg.name}: `)) {
msg.content = `${msg.name}: ${msg.content}`;
}
delete msg.name;
}
});
// Since the messaging endpoint only supports alternating turns, we have to merge messages with the same role if they follow each other
let mergedMessages = [];
messages.forEach((message) => {
if (mergedMessages.length > 0 && mergedMessages[mergedMessages.length - 1].role === message.role) {
mergedMessages[mergedMessages.length - 1].content += '\n\n' + message.content;
} else {
mergedMessages.push(message);
}
});
return mergedMessages;
}
/**
* Convert a prompt from the ChatML objects to the format used by MistralAI.
* @param {object[]} messages Array of messages
* @param {PromptNames} names Prompt names
* @returns {object[]} Prompt for MistralAI
*/
export function convertMistralMessages(messages, names) {
if (!Array.isArray(messages)) {
return [];
}
// Make the last assistant message a prefill
const prefixEnabled = getConfigValue('mistral.enablePrefix', false, 'boolean');
const lastMsg = messages[messages.length - 1];
if (prefixEnabled && messages.length > 0 && lastMsg?.role === 'assistant') {
lastMsg.prefix = true;
}
const sanitizeToolId = (id) => crypto.createHash('sha512').update(id).digest('hex').slice(0, 9);
// Doesn't support completion names, so prepend if not already done by the frontend (e.g. for group chats).
messages.forEach(msg => {
if ('tool_calls' in msg && Array.isArray(msg.tool_calls)) {
msg.tool_calls.forEach(tool => {
tool.id = sanitizeToolId(tool.id);
});
}
if ('tool_call_id' in msg && msg.role === 'tool') {
msg.tool_call_id = sanitizeToolId(msg.tool_call_id);
}
if (msg.role === 'system' && msg.name === 'example_assistant') {
if (names.charName && !msg.content.startsWith(`${names.charName}: `) && !names.startsWithGroupName(msg.content)) {
msg.content = `${names.charName}: ${msg.content}`;
}
delete msg.name;
}
if (msg.role === 'system' && msg.name === 'example_user') {
if (names.userName && !msg.content.startsWith(`${names.userName}: `)) {
msg.content = `${names.userName}: ${msg.content}`;
}
delete msg.name;
}
if (msg.name && msg.role !== 'system' && !msg.content.startsWith(`${msg.name}: `)) {
msg.content = `${msg.name}: ${msg.content}`;
delete msg.name;
}
});
// If user role message immediately follows a tool message, append it to the last user message
const fixToolMessages = () => {
let rerun = true;
while (rerun) {
rerun = false;
messages.forEach((message, i) => {
if (i === messages.length - 1) {
return;
}
if (message.role === 'tool' && messages[i + 1].role === 'user') {
const lastUserMessage = messages.slice(0, i).findLastIndex(m => m.role === 'user' && m.content);
if (lastUserMessage !== -1) {
messages[lastUserMessage].content += '\n\n' + messages[i + 1].content;
messages.splice(i + 1, 1);
rerun = true;
}
}
});
}
};
fixToolMessages();
// If system role message immediately follows an assistant message, change its role to user
for (let i = 0; i < messages.length - 1; i++) {
if (messages[i].role === 'assistant' && messages[i + 1].role === 'system') {
messages[i + 1].role = 'user';
}
}
return messages;
}
/**
* Merge messages with the same consecutive role, removing names if they exist.
* @param {any[]} messages Messages to merge
* @param {PromptNames} names Prompt names
* @param {boolean} strict Enable strict mode: only allow one system message at the start, force user first message
* @param {boolean} placeholders Add user placeholders to the messages in strict mode
* @returns {any[]} Merged messages
*/
export function mergeMessages(messages, names, strict, placeholders) {
let mergedMessages = [];
/** @type {Map<string,object>} */
const contentTokens = new Map();
// Remove names from the messages
messages.forEach((message) => {
if (!message.content) {
message.content = '';
}
// Flatten contents and replace image URLs with random tokens
if (Array.isArray(message.content)) {
const text = message.content.map((content) => {
if (content.type === 'text') {
return content.text;
}
// Could be extended with other non-text types
if (content.type === 'image_url') {
const token = crypto.randomBytes(32).toString('base64');
contentTokens.set(token, content);
return token;
}
return '';
}).join('\n\n');
message.content = text;
}
if (message.role === 'system' && message.name === 'example_assistant') {
if (names.charName && !message.content.startsWith(`${names.charName}: `) && !names.startsWithGroupName(message.content)) {
message.content = `${names.charName}: ${message.content}`;
}
}
if (message.role === 'system' && message.name === 'example_user') {
if (names.userName && !message.content.startsWith(`${names.userName}: `)) {
message.content = `${names.userName}: ${message.content}`;
}
}
if (message.name && message.role !== 'system') {
if (!message.content.startsWith(`${message.name}: `)) {
message.content = `${message.name}: ${message.content}`;
}
}
if (message.role === 'tool') {
message.role = 'user';
}
delete message.name;
delete message.tool_calls;
delete message.tool_call_id;
});
// Squash consecutive messages with the same role
messages.forEach((message) => {
if (mergedMessages.length > 0 && mergedMessages[mergedMessages.length - 1].role === message.role && message.content) {
mergedMessages[mergedMessages.length - 1].content += '\n\n' + message.content;
} else {
mergedMessages.push(message);
}
});
// Prevent erroring out if the mergedMessages array is empty.
if (mergedMessages.length === 0) {
mergedMessages.unshift({
role: 'user',
content: PROMPT_PLACEHOLDER,
});
}
// Check for content tokens and replace them with the actual content objects
if (contentTokens.size > 0) {
mergedMessages.forEach((message) => {
const hasValidToken = Array.from(contentTokens.keys()).some(token => message.content.includes(token));
if (hasValidToken) {
const splitContent = message.content.split('\n\n');
const mergedContent = [];
splitContent.forEach((content) => {
if (contentTokens.has(content)) {
mergedContent.push(contentTokens.get(content));
} else {
if (mergedContent.length > 0 && mergedContent[mergedContent.length - 1].type === 'text') {
mergedContent[mergedContent.length - 1].text += `\n\n${content}`;
} else {
mergedContent.push({ type: 'text', text: content });
}
}
});
message.content = mergedContent;
}
});
}
if (strict) {
for (let i = 0; i < mergedMessages.length; i++) {
// Force mid-prompt system messages to be user messages
if (i > 0 && mergedMessages[i].role === 'system') {
mergedMessages[i].role = 'user';
}
}
if (mergedMessages.length && placeholders) {
if (mergedMessages[0].role === 'system' && (mergedMessages.length === 1 || mergedMessages[1].role !== 'user')) {
mergedMessages.splice(1, 0, { role: 'user', content: PROMPT_PLACEHOLDER });
}
else if (mergedMessages[0].role !== 'system' && mergedMessages[0].role !== 'user') {
mergedMessages.unshift({ role: 'user', content: PROMPT_PLACEHOLDER });
}
}
return mergeMessages(mergedMessages, names, false, placeholders);
}
return mergedMessages;
}
/**
* Convert a prompt from the ChatML objects to the format used by Text Completion API.
* @param {object[]} messages Array of messages
* @returns {string} Prompt for Text Completion API
*/
export function convertTextCompletionPrompt(messages) {
if (typeof messages === 'string') {
return messages;
}
const messageStrings = [];
messages.forEach(m => {
if (m.role === 'system' && m.name === undefined) {
messageStrings.push('System: ' + m.content);
}
else if (m.role === 'system' && m.name !== undefined) {
messageStrings.push(m.name + ': ' + m.content);
}
else {
messageStrings.push(m.role + ': ' + m.content);
}
});
return messageStrings.join('\n') + '\nassistant:';
}
export function cachingAtDepthForClaude(messages, cachingAtDepth) {
let passedThePrefill = false;
let depth = 0;
let previousRoleName = '';
for (let i = messages.length - 1; i >= 0; i--) {
if (!passedThePrefill && messages[i].role === 'assistant') {
continue;
}
passedThePrefill = true;
if (messages[i].role !== previousRoleName) {
if (depth === cachingAtDepth || depth === cachingAtDepth + 2) {
const content = messages[i].content;
content[content.length - 1].cache_control = { type: 'ephemeral' };
}
if (depth === cachingAtDepth + 2) {
break;
}
depth += 1;
previousRoleName = messages[i].role;
}
}
}
/**
* Append cache_control headers to an OpenRouter request at depth. Directly modifies the
* messages array.
* @param {object[]} messages Array of messages
* @param {number} cachingAtDepth Depth at which caching is supposed to occur
*/
export function cachingAtDepthForOpenRouterClaude(messages, cachingAtDepth) {
//caching the prefill is a terrible idea in general
let passedThePrefill = false;
//depth here is the number of message role switches
let depth = 0;
let previousRoleName = '';
for (let i = messages.length - 1; i >= 0; i--) {
if (!passedThePrefill && messages[i].role === 'assistant') {
continue;
}
passedThePrefill = true;
if (messages[i].role !== previousRoleName) {
if (depth === cachingAtDepth || depth === cachingAtDepth + 2) {
const content = messages[i].content;
if (typeof content === 'string') {
messages[i].content = [{
type: 'text',
text: content,
cache_control: { type: 'ephemeral' },
}];
} else {
const contentPartCount = content.length;
content[contentPartCount - 1].cache_control = {
type: 'ephemeral',
};
}
}
if (depth === cachingAtDepth + 2) {
break;
}
depth += 1;
previousRoleName = messages[i].role;
}
}
}
/**
* Calculate the budget tokens for a given reasoning effort.
* @param {number} maxTokens Maximum tokens
* @param {string} reasoningEffort Reasoning effort
* @param {boolean} stream If streaming is enabled
* @returns {number} Budget tokens
*/
export function calculateBudgetTokens(maxTokens, reasoningEffort, stream) {
let budgetTokens = 0;
switch (reasoningEffort) {
case 'low':
budgetTokens = Math.floor(maxTokens * 0.1);
break;
case 'medium':
budgetTokens = Math.floor(maxTokens * 0.25);
break;
case 'high':
budgetTokens = Math.floor(maxTokens * 0.5);
break;
}
budgetTokens = Math.max(budgetTokens, 1024);
if (!stream) {
budgetTokens = Math.min(budgetTokens, 21333);
}
return budgetTokens;
}
|