File size: 32,712 Bytes
e706de2 |
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 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 |
# Messages & Types
**Part 1: Foundation - Lesson 2**
> Structuring conversation data for AI agents
## Overview
In Lesson 1, you learned about Runnables - the foundation of composability. Now we'll explore how to structure the *data* that flows through these Runnables, specifically for conversational AI systems.
Messages are the lingua franca of AI agents. They provide a standardized way to represent conversations, tool calls, system instructions, and more. By the end of this lesson, you'll understand why proper message typing is crucial for building reliable agents.
You will see tools in use. Everything about tools will be explained in depth in the 3. main part of this tutorial.
## Why Does This Matter?
### The Problem: Unstructured Conversations
Imagine building a chatbot without message types:
```javascript
// Bad: Everything is just strings
const conversation = [
"You are a helpful assistant",
"What's the weather?",
"The weather is sunny",
"Thanks!"
];
// Questions:
// - Which messages are from the user?
// - Which are from the AI?
// - Which is the system instruction?
// - How do we handle tool calls?
// - What about metadata like timestamps?
```
This quickly becomes unmaintainable. You can't tell who said what, when, or why.
### The Solution: Typed Messages
```javascript
// Good: Structured message types
const conversation = [
new SystemMessage("You are a helpful assistant"),
new HumanMessage("What's the weather?"),
new AIMessage("The weather is sunny"),
new HumanMessage("Thanks!")
];
// Now we can:
// - Filter by message type
// - Format differently for display
// - Track metadata automatically
// - Handle tool calls properly
// - Validate conversation structure
```
## Learning Objectives
By the end of this lesson, you will:
- β
Understand the four core message types
- β
Implement a robust message class hierarchy
- β
Add metadata and timestamps automatically
- β
Format messages for LLM consumption
- β
Build a conversation history manager
- β
Handle special message types (tool calls, function results)
## Core Message Types
Every conversational AI system needs these four fundamental message types:
### 1. SystemMessage
**Purpose**: Instructions that shape the AI's behavior
**Characteristics**:
- Always at the start of conversations
- Not visible to end users
- Defines the AI's role, personality, constraints
- Typically set by developers, not users
**Example**:
```javascript
new SystemMessage(
`You are a helpful Python programming tutor.
Explain concepts clearly with code examples.
Always encourage learning.`
)
```
**When to use**:
- Setting AI personality
- Defining response format
- Adding constraints or rules
- Providing context
### 2. HumanMessage
**Purpose**: Input from the user/human
**Characteristics**:
- User questions, commands, or statements
- What the AI should respond to
- Can contain multiple paragraphs
- May include context or files
**Example**:
```javascript
new HumanMessage(
"How do I reverse a string in Python?"
)
```
**When to use**:
- User input in chatbots
- Queries to agents
- Commands to execute
### 3. AIMessage
**Purpose**: Responses from the AI/assistant
**Characteristics**:
- The AI's text responses
- Can include reasoning, answers, questions
- May contain tool calls (function requests)
- Generated by the LLM
**Example**:
```javascript
new AIMessage(
"Here's how to reverse a string in Python:\n\n" +
"```python\ntext = 'hello'\nreversed_text = text[::-1]\n```"
)
```
**When to use**:
- LLM responses
- Agent outputs
- Generated text
### 4. ToolMessage
**Purpose**: Results from tool/function execution
**Characteristics**:
- Returns data from external functions
- Links back to the AI's tool call
- Often structured data (JSON)
- Input for AI's next response
**Example**:
```javascript
new ToolMessage(
JSON.stringify({ temperature: 72, condition: "sunny" }),
"get_weather" // tool name
)
```
**When to use**:
- Returning function results to the AI
- Providing external data
- Completing tool calls
## Message Flow in Conversations
Here's how messages typically flow in an agent conversation:
```
1. System β "You are a helpful assistant with access to a calculator"
2. Human β "What's 123 * 456?"
3. AI β [Calls calculator tool with 123, 456]
4. Tool β [Returns 56088]
5. AI β "The result of 123 * 456 is 56,088"
6. Human β "Thanks!"
7. AI β "You're welcome!"
```
## Implementation
Let's build our message system from the ground up.
### Step 1: Base Message Class
Every message type will inherit from this base:
**Location:** `src/core/message.js`
```javascript
/**
* BaseMessage - Foundation for all message types
*
* Contains common functionality:
* - Content storage
* - Metadata tracking
* - Timestamps
* - Serialization
*/
export class BaseMessage {
constructor(content, additionalKwargs = {}) {
this.content = content;
this.additionalKwargs = additionalKwargs;
this.timestamp = Date.now();
this.id = this.generateId();
}
/**
* Generate unique ID for this message
*/
generateId() {
return `msg_${this.timestamp}_${Math.random().toString(36).substr(2, 9)}`;
}
/**
* Get the message type (overridden in subclasses)
*/
get type() {
throw new Error('Subclass must implement type getter');
}
/**
* Convert to JSON for storage/transmission
*/
toJSON() {
return {
id: this.id,
type: this.type,
content: this.content,
timestamp: this.timestamp,
...this.additionalKwargs
};
}
/**
* Create message from JSON
*/
static fromJSON(json) {
const MessageClass = MESSAGE_TYPES[json.type];
if (!MessageClass) {
throw new Error(`Unknown message type: ${json.type}`);
}
const message = new MessageClass(json.content, json.additionalKwargs);
message.id = json.id;
message.timestamp = json.timestamp;
return message;
}
/**
* Format for display
*/
toString() {
const date = new Date(this.timestamp).toLocaleTimeString();
return `[${date}] ${this.type}: ${this.content}`;
}
}
```
**Key design decisions**:
- β
`content` is always a string (or can be converted to one)
- β
`additionalKwargs` allows extension without changing the API
- β
`timestamp` is added automatically for tracking
- β
`id` ensures we can reference specific messages
- β
`toJSON()` / `fromJSON()` enable persistence
### Step 2: System Message
**Location:** `src/core/message.js`
```javascript
/**
* SystemMessage - Instructions for the AI
*
* Sets the context, role, and constraints for the assistant.
* Typically appears at the start of conversations.
*/
export class SystemMessage extends BaseMessage {
constructor(content, additionalKwargs = {}) {
super(content, additionalKwargs);
}
get type() {
return 'system';
}
/**
* System messages often need special formatting
*/
toPromptFormat() {
return {
role: 'system',
content: this.content
};
}
}
```
**Usage**:
```javascript
const systemMsg = new SystemMessage(
"You are a expert Python programmer. Be concise."
);
console.log(systemMsg.type); // "system"
console.log(systemMsg.content); // "You are a expert..."
```
### Step 3: Human Message
**Location:** `src/core/message.js`
```javascript
/**
* HumanMessage - User input
*
* Represents messages from the human/user.
* The primary input the AI responds to.
*/
export class HumanMessage extends BaseMessage {
constructor(content, additionalKwargs = {}) {
super(content, additionalKwargs);
}
get type() {
return 'human';
}
toPromptFormat() {
return {
role: 'user',
content: this.content
};
}
}
```
**Usage**:
```javascript
const humanMsg = new HumanMessage("What's the capital of France?");
console.log(humanMsg.type); // "human"
```
### Step 4: AI Message (with Tool Calls)
**Location:** `src/core/message.js`
```javascript
/**
* AIMessage - Assistant responses
*
* Represents messages from the AI assistant.
* Can include tool calls for function execution.
*/
export class AIMessage extends BaseMessage {
constructor(content, additionalKwargs = {}) {
super(content, additionalKwargs);
// Tool calls are requests to execute functions
this.toolCalls = additionalKwargs.toolCalls || [];
}
get type() {
return 'ai';
}
/**
* Check if this message requests tool execution
*/
hasToolCalls() {
return this.toolCalls.length > 0;
}
/**
* Get specific tool call by index
*/
getToolCall(index = 0) {
return this.toolCalls[index];
}
toPromptFormat() {
const formatted = {
role: 'assistant',
content: this.content
};
if (this.hasToolCalls()) {
formatted.tool_calls = this.toolCalls;
}
return formatted;
}
}
```
**Usage**:
```javascript
// Simple response
const aiMsg1 = new AIMessage("The capital of France is Paris.");
// Response with tool call
const aiMsg2 = new AIMessage("Let me calculate that for you.", {
toolCalls: [{
id: 'call_123',
type: 'function',
function: {
name: 'calculator',
arguments: JSON.stringify({ operation: 'multiply', a: 5, b: 3 })
}
}]
});
console.log(aiMsg2.hasToolCalls()); // true
```
### Step 5: Tool Message
**Location:** `src/core/message.js`
```javascript
/**
* ToolMessage - Tool execution results
*
* Contains the output from executing a tool/function.
* Sent back to the AI to inform its next response.
*/
export class ToolMessage extends BaseMessage {
constructor(content, toolCallId, additionalKwargs = {}) {
super(content, additionalKwargs);
this.toolCallId = toolCallId;
}
get type() {
return 'tool';
}
toPromptFormat() {
return {
role: 'tool',
content: this.content,
tool_call_id: this.toolCallId
};
}
}
```
**Usage**:
```javascript
const toolMsg = new ToolMessage(
JSON.stringify({ result: 15 }),
'call_123' // Links back to the AI's tool call
);
console.log(toolMsg.type); // "tool"
console.log(toolMsg.toolCallId); // "call_123"
```
### Step 6: Message Type Registry
To support `fromJSON()`, we need a registry:
```javascript
/**
* Registry mapping type strings to message classes
*/
export const MESSAGE_TYPES = {
'system': SystemMessage,
'human': HumanMessage,
'ai': AIMessage,
'tool': ToolMessage
};
```
## Complete Implementation
Here's everything together:
```javascript
/**
* Message System - Typed conversation data structures
*
* @module core/message
*/
/**
* BaseMessage - Foundation for all message types
*/
export class BaseMessage {
constructor(content, additionalKwargs = {}) {
if (content === undefined || content === null) {
throw new Error('Message content cannot be undefined or null');
}
this.content = String(content); // Ensure string
this.additionalKwargs = additionalKwargs;
this.timestamp = Date.now();
this.id = this.generateId();
}
generateId() {
return `msg_${this.timestamp}_${Math.random().toString(36).substr(2, 9)}`;
}
get type() {
throw new Error('Subclass must implement type getter');
}
toJSON() {
return {
id: this.id,
type: this.type,
content: this.content,
timestamp: this.timestamp,
...this.additionalKwargs
};
}
static fromJSON(json) {
const MessageClass = MESSAGE_TYPES[json.type];
if (!MessageClass) {
throw new Error(`Unknown message type: ${json.type}`);
}
const message = new MessageClass(json.content, json.additionalKwargs);
message.id = json.id;
message.timestamp = json.timestamp;
return message;
}
toString() {
const date = new Date(this.timestamp).toLocaleTimeString();
return `[${date}] ${this.type.toUpperCase()}: ${this.content}`;
}
/**
* Format for LLM consumption
*/
toPromptFormat() {
throw new Error('Subclass must implement toPromptFormat()');
}
}
/**
* SystemMessage - AI instructions and context
*/
export class SystemMessage extends BaseMessage {
get type() {
return 'system';
}
toPromptFormat() {
return {
role: 'system',
content: this.content
};
}
}
/**
* HumanMessage - User input
*/
export class HumanMessage extends BaseMessage {
get type() {
return 'human';
}
toPromptFormat() {
return {
role: 'user',
content: this.content
};
}
}
/**
* AIMessage - Assistant responses
*/
export class AIMessage extends BaseMessage {
constructor(content, additionalKwargs = {}) {
super(content, additionalKwargs);
this.toolCalls = additionalKwargs.toolCalls || [];
}
get type() {
return 'ai';
}
hasToolCalls() {
return this.toolCalls.length > 0;
}
getToolCall(index = 0) {
return this.toolCalls[index];
}
toPromptFormat() {
const formatted = {
role: 'assistant',
content: this.content
};
if (this.hasToolCalls()) {
formatted.tool_calls = this.toolCalls;
}
return formatted;
}
}
/**
* ToolMessage - Function execution results
*/
export class ToolMessage extends BaseMessage {
constructor(content, toolCallId, additionalKwargs = {}) {
super(content, additionalKwargs);
this.toolCallId = toolCallId;
}
get type() {
return 'tool';
}
toPromptFormat() {
return {
role: 'tool',
content: this.content,
tool_call_id: this.toolCallId
};
}
}
/**
* Message type registry
*/
export const MESSAGE_TYPES = {
'system': SystemMessage,
'human': HumanMessage,
'ai': AIMessage,
'tool': ToolMessage
};
export default {
BaseMessage,
SystemMessage,
HumanMessage,
AIMessage,
ToolMessage,
MESSAGE_TYPES
};
```
## Real-World Examples
### Example 1: Simple Conversation
```javascript
const conversation = [
new SystemMessage("You are a helpful math tutor."),
new HumanMessage("What's 5 + 3?"),
new AIMessage("5 + 3 equals 8."),
new HumanMessage("Thanks!"),
new AIMessage("You're welcome!")
];
// Display conversation
conversation.forEach(msg => {
console.log(msg.toString());
});
// Output:
// [10:30:45] SYSTEM: You are a helpful math tutor.
// [10:30:46] HUMAN: What's 5 + 3?
// [10:30:47] AI: 5 + 3 equals 8.
// [10:30:48] HUMAN: Thanks!
// [10:30:49] AI: You're welcome!
```
### Example 2: Tool Call Flow
```javascript
// User asks a question requiring calculation
const messages = [
new SystemMessage("You are an assistant with access to a calculator."),
new HumanMessage("What's 1234 * 5678?")
];
// AI decides to use calculator
const aiWithToolCall = new AIMessage(
"I'll calculate that for you.",
{
toolCalls: [{
id: 'call_abc123',
type: 'function',
function: {
name: 'calculator',
arguments: JSON.stringify({
operation: 'multiply',
a: 1234,
b: 5678
})
}
}]
}
);
messages.push(aiWithToolCall);
// Tool executes and returns result
const toolResult = new ToolMessage(
JSON.stringify({ result: 7006652 }),
'call_abc123'
);
messages.push(toolResult);
// AI incorporates result in final response
const finalResponse = new AIMessage(
"The result of 1234 Γ 5678 is 7,006,652."
);
messages.push(finalResponse);
console.log('Has tool calls?', aiWithToolCall.hasToolCalls()); // true
console.log('Tool call:', aiWithToolCall.getToolCall(0));
```
### Example 3: Conversation Persistence
```javascript
// Save conversation to JSON
const conversation = [
new SystemMessage("You are helpful."),
new HumanMessage("Hello!"),
new AIMessage("Hi there!")
];
const json = conversation.map(msg => msg.toJSON());
const saved = JSON.stringify(json, null, 2);
console.log('Saved:', saved);
// Later: Load conversation from JSON
const loaded = JSON.parse(saved);
const restored = loaded.map(msgData => BaseMessage.fromJSON(msgData));
console.log('Restored:', restored.length, 'messages');
restored.forEach(msg => console.log(msg.toString()));
```
### Example 4: Filtering Messages
```javascript
const history = [
new SystemMessage("You are helpful."),
new HumanMessage("Hi"),
new AIMessage("Hello!"),
new HumanMessage("How are you?"),
new AIMessage("I'm doing well!")
];
// Get only human messages
const humanMessages = history.filter(msg => msg.type === 'human');
console.log('Human said:', humanMessages.map(m => m.content));
// Get only AI messages
const aiMessages = history.filter(msg => msg.type === 'ai');
console.log('AI said:', aiMessages.map(m => m.content));
// Get last N messages (sliding window)
const lastThree = history.slice(-3);
console.log('Recent:', lastThree.map(m => m.toString()));
```
### Example 5: Custom Metadata
```javascript
// Add custom metadata to messages
const userMsg = new HumanMessage("Hello!", {
userId: 'user_123',
sessionId: 'sess_456',
language: 'en'
});
const aiMsg = new AIMessage("Hi there!", {
model: 'llama-3.1',
temperature: 0.7,
tokens: 150
});
console.log('User metadata:', userMsg.additionalKwargs);
console.log('AI metadata:', aiMsg.additionalKwargs);
// Metadata is preserved in JSON
const json = userMsg.toJSON();
console.log(json.userId); // 'user_123'
```
## Advanced Patterns
### Pattern 1: Message Builder
For complex message construction:
```javascript
class MessageBuilder {
constructor() {
this.messages = [];
}
system(content) {
this.messages.push(new SystemMessage(content));
return this; // Chainable
}
human(content, metadata = {}) {
this.messages.push(new HumanMessage(content, metadata));
return this;
}
ai(content, metadata = {}) {
this.messages.push(new AIMessage(content, metadata));
return this;
}
build() {
return this.messages;
}
}
// Usage
const conversation = new MessageBuilder()
.system("You are helpful.")
.human("Hello!")
.ai("Hi there!")
.human("How are you?")
.ai("I'm great!")
.build();
```
### Pattern 2: Conversation History Manager
```javascript
class ConversationHistory {
constructor(maxMessages = 100) {
this.messages = [];
this.maxMessages = maxMessages;
}
add(message) {
this.messages.push(message);
// Keep only last N messages (sliding window)
if (this.messages.length > this.maxMessages) {
// Always keep system message if it exists
const systemMsg = this.messages.find(m => m.type === 'system');
const recentMessages = this.messages.slice(-this.maxMessages + 1);
this.messages = systemMsg
? [systemMsg, ...recentMessages.filter(m => m.type !== 'system')]
: recentMessages;
}
}
getAll() {
return [...this.messages]; // Return copy
}
getLast(n = 1) {
return this.messages.slice(-n);
}
getByType(type) {
return this.messages.filter(msg => msg.type === type);
}
clear() {
// Keep system message
const systemMsg = this.messages.find(m => m.type === 'system');
this.messages = systemMsg ? [systemMsg] : [];
}
toPromptFormat() {
return this.messages.map(msg => msg.toPromptFormat());
}
save() {
return JSON.stringify(this.messages.map(m => m.toJSON()));
}
static load(json) {
const data = JSON.parse(json);
const history = new ConversationHistory();
history.messages = data.map(msgData => BaseMessage.fromJSON(msgData));
return history;
}
}
// Usage
const history = new ConversationHistory(maxMessages: 50);
history.add(new SystemMessage("You are helpful."));
history.add(new HumanMessage("Hi"));
history.add(new AIMessage("Hello!"));
console.log('Total messages:', history.getAll().length);
console.log('Last message:', history.getLast()[0].content);
// Format for LLM
const formatted = history.toPromptFormat();
// [{ role: 'system', content: '...' }, { role: 'user', content: '...' }, ...]
```
### Pattern 3: Message Validation
```javascript
class MessageValidator {
static validate(message) {
const errors = [];
// Check content
if (!message.content || message.content.trim().length === 0) {
errors.push('Message content cannot be empty');
}
// Check type
if (!MESSAGE_TYPES[message.type]) {
errors.push(`Invalid message type: ${message.type}`);
}
// Check tool messages have tool call ID
if (message.type === 'tool' && !message.toolCallId) {
errors.push('Tool messages must have a toolCallId');
}
return {
valid: errors.length === 0,
errors
};
}
static validateConversation(messages) {
const errors = [];
// First message should be system message (recommended)
if (messages.length > 0 && messages[0].type !== 'system') {
errors.push('Conversation should start with a system message');
}
// Tool messages should follow AI messages with tool calls
for (let i = 1; i < messages.length; i++) {
const prev = messages[i - 1];
const curr = messages[i];
if (curr.type === 'tool') {
if (prev.type !== 'ai' || !prev.hasToolCalls()) {
errors.push(
`Tool message at index ${i} should follow AI message with tool calls`
);
}
}
}
return {
valid: errors.length === 0,
errors
};
}
}
// Usage
const msg = new HumanMessage("Hello!");
const result = MessageValidator.validate(msg);
console.log('Valid?', result.valid);
console.log('Errors:', result.errors);
```
### Pattern 4: Message Formatting Utilities
```javascript
class MessageFormatter {
/**
* Format messages for display in UI
*/
static toDisplayFormat(messages) {
return messages.map(msg => {
const time = new Date(msg.timestamp).toLocaleTimeString();
const icon = this.getIcon(msg.type);
return {
id: msg.id,
icon,
time,
type: msg.type,
content: msg.content,
sender: this.getSenderName(msg.type)
};
});
}
static getIcon(type) {
const icons = {
'system': 'βοΈ',
'human': 'π€',
'ai': 'π€',
'tool': 'π οΈ'
};
return icons[type] || 'π¬';
}
static getSenderName(type) {
const names = {
'system': 'System',
'human': 'You',
'ai': 'Assistant',
'tool': 'Tool'
};
return names[type] || 'Unknown';
}
/**
* Format messages for LLM (OpenAI-style)
*/
static toOpenAIFormat(messages) {
return messages.map(msg => {
const formatted = msg.toPromptFormat();
// Map our types to OpenAI's expected roles
const roleMap = {
'human': 'user',
'ai': 'assistant',
'system': 'system',
'tool': 'tool'
};
formatted.role = roleMap[msg.type] || msg.type;
return formatted;
});
}
/**
* Create markdown representation
*/
static toMarkdown(messages) {
return messages.map(msg => {
const sender = this.getSenderName(msg.type);
const time = new Date(msg.timestamp).toLocaleString();
return `**${sender}** (${time})\n\n${msg.content}\n\n---\n`;
}).join('\n');
}
}
// Usage
const messages = [
new SystemMessage("You are helpful."),
new HumanMessage("Hi"),
new AIMessage("Hello!")
];
console.log('Display format:', MessageFormatter.toDisplayFormat(messages));
console.log('OpenAI format:', MessageFormatter.toOpenAIFormat(messages));
console.log('Markdown:', MessageFormatter.toMarkdown(messages));
```
## Integration with LLMs
Messages need to be formatted for the LLM. Here's how different models expect them:
### OpenAI-Style Format
```javascript
function formatForOpenAI(messages) {
return messages.map(msg => ({
role: msg.type === 'human' ? 'user' : msg.type,
content: msg.content
}));
}
```
### Llama-Style Format (with chat template)
```javascript
function formatForLlama(messages) {
// Llama uses special tokens
let formatted = '';
for (const msg of messages) {
if (msg.type === 'system') {
formatted += `<<SYS>>\n${msg.content}\n<</SYS>>\n\n`;
} else if (msg.type === 'human') {
formatted += `[INST] ${msg.content} [/INST]`;
} else if (msg.type === 'ai') {
formatted += `${msg.content}`;
}
}
return formatted;
}
```
### Our Flexible Approach
```javascript
class MessageFormatter {
static format(messages, style = 'openai') {
const formatters = {
'openai': this.formatOpenAI,
'llama': this.formatLlama,
'raw': this.formatRaw
};
const formatter = formatters[style];
if (!formatter) {
throw new Error(`Unknown format style: ${style}`);
}
return formatter(messages);
}
}
```
## Debugging Tips
### Tip 1: Pretty Print Conversations
```javascript
function printConversation(messages) {
console.log('\n=== Conversation ===\n');
messages.forEach((msg, idx) => {
console.log(`${idx + 1}. ${msg.toString()}`);
});
console.log('\n===================\n');
}
```
### Tip 2: Visualize Message Flow
```javascript
function visualizeFlow(messages) {
const flow = messages.map(msg => {
const icon = msg.type === 'human' ? 'β' : 'β';
return `${icon} ${msg.type}: ${msg.content.substring(0, 50)}...`;
});
console.log('\nMessage Flow:');
flow.forEach(line => console.log(line));
}
```
### Tip 3: Inspect Metadata
```javascript
function inspectMetadata(message) {
console.log('Message Details:');
console.log('- ID:', message.id);
console.log('- Type:', message.type);
console.log('- Timestamp:', new Date(message.timestamp).toISOString());
console.log('- Content length:', message.content.length);
console.log('- Metadata:', message.additionalKwargs);
if (message.type === 'ai' && message.hasToolCalls()) {
console.log('- Tool calls:', message.toolCalls.length);
}
}
```
## Common Mistakes
### β Mistake 1: Wrong Message Order
```javascript
// Bad: AI message before human input
const bad = [
new AIMessage("Hello!"),
new HumanMessage("Hi")
];
```
**Fix**: Always respond TO something
```javascript
const good = [
new HumanMessage("Hi"),
new AIMessage("Hello!")
];
```
### β Mistake 2: Forgetting System Message
```javascript
// Bad: No context for the AI
const bad = [
new HumanMessage("Write code")
];
```
**Fix**: Always set context
```javascript
const good = [
new SystemMessage("You are a coding assistant."),
new HumanMessage("Write code")
];
```
### β Mistake 3: Not Linking Tool Messages
```javascript
// Bad: Tool message without proper ID
const bad = new ToolMessage("result", undefined);
```
**Fix**: Always link to the tool call
```javascript
const toolCallId = aiMessage.getToolCall(0).id;
const good = new ToolMessage("result", toolCallId);
```
### β Mistake 4: Modifying Message Content
```javascript
// Bad: Changing message after creation
const msg = new HumanMessage("Hello");
msg.content = "Hi"; // Don't do this!
```
**Fix**: Create a new message
```javascript
const newMsg = new HumanMessage("Hi");
```
## Mental Model
Think of messages as a timeline:
```
Time β
ββββββββββββββββββββββββββββββββββββββββ
βοΈ System: "You are helpful"
β
ββ Human: "What's 2+2?"
β
ββ AI: "Let me calculate..."
β ββ [Tool Call: calculator(2, 2)]
β
ββ Tool: "4"
β
ββ AI: "2+2 equals 4"
```
Each message is immutable - once created, it represents a moment in time.
## Exercises
Practice what you've learned!
### Exercise 5: Build a Message Formatter
Create a function that formats messages for console display with colors and icons.
**Requirements**:
- Different colors for each message type
- Icons for visual distinction
- Timestamp display
- Content truncation for long messages
**Starter code**: `exercises/02-message-formatter.js`
### Exercise 6: Implement Conversation Validation
Build a validator that checks conversation structure.
**Rules to check**:
- System message should be first (if present)
- Tool messages must follow AI messages with tool calls
- No empty messages
- Alternating human/AI after system message
**Starter code**: `exercises/02-conversation-validator.js`
### Exercise 7: Create a Chat History Manager
Build a class that manages conversation history with:
- Add messages
- Get last N messages
- Filter by type
- Save/load from JSON
- Sliding window (max messages)
**Starter code**: `exercises/02-chat-history.js`
### Exercise 8: Tool Call Flow
Simulate a complete tool call flow:
1. Human asks a question requiring a tool
2. AI responds with a tool call
3. Tool executes and returns result
4. AI incorporates result in response
**Starter code**: `exercises/02-tool-flow.js`
## Summary
Congratulations! You now understand message types and why they're crucial for AI agents.
### Key Takeaways
1. **Four core types**: System, Human, AI, Tool
2. **Structured data**: Messages have types, timestamps, IDs, metadata
3. **Immutability**: Messages represent moments in time
4. **Tool calls**: AI messages can request function execution
5. **Serialization**: Messages can be saved/loaded as JSON
### Why This Matters
- β
**Clarity**: Know who said what, when
- β
**Debugging**: Track conversation flow easily
- β
**Persistence**: Save and restore conversations
- β
**Validation**: Ensure proper structure
- β
**Formatting**: Adapt to different LLM formats
### Building Blocks
Messages are the data structure that flows through Runnables:
```javascript
// Messages flow through Runnables
const conversation = [
new SystemMessage("You are helpful"),
new HumanMessage("Hello")
];
// Runnables process messages
const response = await chatModel.invoke(conversation);
// Returns: AIMessage("Hi there!")
```
## Next Steps
In the next lesson, we'll wrap **node-llama-cpp** as a Runnable that works with our message types!
**Preview**: You'll learn:
- Loading local LLMs
- Converting messages to prompts
- Streaming responses
- Managing model context
β‘οΈ [Continue to Lesson 3: The LLM Wrapper](03-llm-wrapper.md)
## Additional Resources
- [OpenAI Chat Format Documentation](https://platform.openai.com/docs/guides/chat)
- [Anthropic Messages API](https://docs.anthropic.com/claude/reference/messages_post)
- [JSON Schema for Validation](https://json-schema.org/)
## Questions & Discussion
**Q: Why not just use strings?**
A: Strings don't capture metadata, can't distinguish between types, and make debugging harder. Typed messages provide structure and context.
**Q: Can I add custom message types?**
A: Yes! Extend `BaseMessage` and register in `MESSAGE_TYPES`:
```javascript
class CustomMessage extends BaseMessage {
get type() { return 'custom'; }
}
MESSAGE_TYPES['custom'] = CustomMessage;
```
**Q: How do I handle multi-modal content (images)?**
A: Store in `additionalKwargs`:
```javascript
new HumanMessage("What's in this image?", {
images: ['data:image/png;base64,...']
})
```
**Q: Should I validate every message?**
A: For production, yes. For development, optional but helpful for catching bugs early.
---
**Built with β€οΈ for learners who want to understand AI agents deeply**
[β Previous: Runnable](01-runnable.md) | [Tutorial Index](../README.md) | [Next: LLM Wrapper β](03-llm-wrapper.md) |