@promptbook/browser 0.103.0-52 → 0.103.0-53

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (24) hide show
  1. package/esm/index.es.js +135 -1
  2. package/esm/index.es.js.map +1 -1
  3. package/esm/typings/servers.d.ts +8 -1
  4. package/esm/typings/src/_packages/components.index.d.ts +2 -0
  5. package/esm/typings/src/_packages/core.index.d.ts +6 -0
  6. package/esm/typings/src/_packages/types.index.d.ts +2 -0
  7. package/esm/typings/src/_packages/utils.index.d.ts +2 -0
  8. package/esm/typings/src/book-2.0/agent-source/AgentModelRequirements.d.ts +7 -0
  9. package/esm/typings/src/book-components/Chat/Chat/ChatProps.d.ts +4 -0
  10. package/esm/typings/src/book-components/_common/HamburgerMenu/HamburgerMenu.d.ts +12 -0
  11. package/esm/typings/src/book-components/icons/MicIcon.d.ts +8 -0
  12. package/esm/typings/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabase.d.ts +17 -0
  13. package/esm/typings/src/commitments/MESSAGE/AgentMessageCommitmentDefinition.d.ts +28 -0
  14. package/esm/typings/src/commitments/MESSAGE/UserMessageCommitmentDefinition.d.ts +28 -0
  15. package/esm/typings/src/commitments/index.d.ts +20 -1
  16. package/esm/typings/src/execution/LlmExecutionTools.d.ts +9 -0
  17. package/esm/typings/src/llm-providers/agent/AgentLlmExecutionTools.d.ts +2 -1
  18. package/esm/typings/src/llm-providers/agent/RemoteAgent.d.ts +10 -1
  19. package/esm/typings/src/utils/normalization/normalizeMessageText.d.ts +9 -0
  20. package/esm/typings/src/utils/normalization/normalizeMessageText.test.d.ts +1 -0
  21. package/esm/typings/src/version.d.ts +1 -1
  22. package/package.json +2 -2
  23. package/umd/index.umd.js +135 -1
  24. package/umd/index.umd.js.map +1 -1
@@ -45,6 +45,7 @@ import type { MessageButton } from '../book-components/Chat/utils/parseMessageBu
45
45
  import { parseMessageButtons } from '../book-components/Chat/utils/parseMessageButtons';
46
46
  import { ArrowIcon } from '../book-components/icons/ArrowIcon';
47
47
  import { AttachmentIcon } from '../book-components/icons/AttachmentIcon';
48
+ import { MicIcon } from '../book-components/icons/MicIcon';
48
49
  import { PauseIcon } from '../book-components/icons/PauseIcon';
49
50
  import { PlayIcon } from '../book-components/icons/PlayIcon';
50
51
  import { ResetIcon } from '../book-components/icons/ResetIcon';
@@ -104,6 +105,7 @@ export type { MessageButton };
104
105
  export { parseMessageButtons };
105
106
  export { ArrowIcon };
106
107
  export { AttachmentIcon };
108
+ export { MicIcon };
107
109
  export { PauseIcon };
108
110
  export { PlayIcon };
109
111
  export { ResetIcon };
@@ -25,6 +25,8 @@ import { getCommitmentDefinition } from '../commitments/index';
25
25
  import { getAllCommitmentDefinitions } from '../commitments/index';
26
26
  import { getAllCommitmentTypes } from '../commitments/index';
27
27
  import { isCommitmentSupported } from '../commitments/index';
28
+ import type { GroupedCommitmentDefinition } from '../commitments/index';
29
+ import { getGroupedCommitmentDefinitions } from '../commitments/index';
28
30
  import { NAME } from '../config';
29
31
  import { ADMIN_EMAIL } from '../config';
30
32
  import { ADMIN_GITHUB_NAME } from '../config';
@@ -190,6 +192,7 @@ import { TaskTypes } from '../types/TaskType';
190
192
  import { aboutPromptbookInformation } from '../utils/misc/aboutPromptbookInformation';
191
193
  import { $generateBookBoilerplate } from '../utils/random/$generateBookBoilerplate';
192
194
  import { REMOTE_SERVER_URLS } from '../../servers';
195
+ import { AUTO_FEDERATED_AGENT_SERVER_URLS } from '../../servers';
193
196
  export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
194
197
  export { computeAgentHash };
195
198
  export { createAgentModelRequirements };
@@ -217,6 +220,8 @@ export { getCommitmentDefinition };
217
220
  export { getAllCommitmentDefinitions };
218
221
  export { getAllCommitmentTypes };
219
222
  export { isCommitmentSupported };
223
+ export type { GroupedCommitmentDefinition };
224
+ export { getGroupedCommitmentDefinitions };
220
225
  export { NAME };
221
226
  export { ADMIN_EMAIL };
222
227
  export { ADMIN_GITHUB_NAME };
@@ -382,3 +387,4 @@ export { TaskTypes };
382
387
  export { aboutPromptbookInformation };
383
388
  export { $generateBookBoilerplate };
384
389
  export { REMOTE_SERVER_URLS };
390
+ export { AUTO_FEDERATED_AGENT_SERVER_URLS };
@@ -57,6 +57,7 @@ import type { InstrumentCommand } from '../commands/X_INSTRUMENT/InstrumentComma
57
57
  import type { BookCommitment } from '../commitments/_base/BookCommitment';
58
58
  import type { CommitmentDefinition } from '../commitments/_base/CommitmentDefinition';
59
59
  import type { ParsedCommitment } from '../commitments/_base/ParsedCommitment';
60
+ import type { GroupedCommitmentDefinition } from '../commitments/index';
60
61
  import type { PrettifyOptions } from '../conversion/prettify/PrettifyOptions';
61
62
  import type { renderPipelineMermaidOptions } from '../conversion/prettify/renderPipelineMermaidOptions';
62
63
  import type { CallbackInterfaceToolsOptions } from '../dialogs/callback/CallbackInterfaceToolsOptions';
@@ -414,6 +415,7 @@ export type { InstrumentCommand };
414
415
  export type { BookCommitment };
415
416
  export type { CommitmentDefinition };
416
417
  export type { ParsedCommitment };
418
+ export type { GroupedCommitmentDefinition };
417
419
  export type { PrettifyOptions };
418
420
  export type { renderPipelineMermaidOptions };
419
421
  export type { CallbackInterfaceToolsOptions };
@@ -40,6 +40,7 @@ import { nameToUriPart } from '../utils/normalization/nameToUriPart';
40
40
  import { nameToUriParts } from '../utils/normalization/nameToUriParts';
41
41
  import type { string_kebab_case } from '../utils/normalization/normalize-to-kebab-case';
42
42
  import { normalizeToKebabCase } from '../utils/normalization/normalize-to-kebab-case';
43
+ import { normalizeMessageText } from '../utils/normalization/normalizeMessageText';
43
44
  import type { string_camelCase } from '../utils/normalization/normalizeTo_camelCase';
44
45
  import { normalizeTo_camelCase } from '../utils/normalization/normalizeTo_camelCase';
45
46
  import type { string_PascalCase } from '../utils/normalization/normalizeTo_PascalCase';
@@ -127,6 +128,7 @@ export { nameToUriPart };
127
128
  export { nameToUriParts };
128
129
  export type { string_kebab_case };
129
130
  export { normalizeToKebabCase };
131
+ export { normalizeMessageText };
130
132
  export type { string_camelCase };
131
133
  export { normalizeTo_camelCase };
132
134
  export type { string_PascalCase };
@@ -22,6 +22,13 @@ export type AgentModelRequirements = {
22
22
  * Optional list of knowledge source links that the agent can use
23
23
  */
24
24
  readonly knowledgeSources?: ReadonlyArray<string_knowledge_source_link>;
25
+ /**
26
+ * List of sample conversations (question/answer pairs)
27
+ */
28
+ readonly samples?: ReadonlyArray<{
29
+ question: string;
30
+ answer: string;
31
+ }>;
25
32
  /**
26
33
  * Temperature for the agent's responses, controlling randomness
27
34
  */
@@ -44,6 +44,10 @@ export type ChatProps = {
44
44
  * Determines whether the voice recognition button is rendered
45
45
  */
46
46
  readonly isVoiceRecognitionButtonShown?: boolean;
47
+ /**
48
+ * Optional callback to trigger voice input
49
+ */
50
+ onVoiceInput?(): void;
47
51
  /**
48
52
  * The language code to use for voice recognition
49
53
  */
@@ -0,0 +1,12 @@
1
+ type HamburgerMenuProps = {
2
+ isOpen: boolean;
3
+ onClick?: () => void;
4
+ className?: string;
5
+ };
6
+ /**
7
+ * @@@
8
+ *
9
+ * @private Internal component
10
+ */
11
+ export declare function HamburgerMenu({ isOpen, onClick, className }: HamburgerMenuProps): import("react/jsx-runtime").JSX.Element;
12
+ export {};
@@ -0,0 +1,8 @@
1
+ /**
2
+ * Shows simple microphone icon
3
+ *
4
+ * @public exported from `@promptbook/components`
5
+ */
6
+ export declare const MicIcon: ({ size }: {
7
+ size: number;
8
+ }) => import("react/jsx-runtime").JSX.Element;
@@ -43,6 +43,23 @@ export declare class AgentCollectionInSupabase {
43
43
  * Deletes an agent from the collection
44
44
  */
45
45
  deleteAgent(agentName: string_agent_name): Promise<void>;
46
+ /**
47
+ * List history of an agent
48
+ */
49
+ listAgentHistory(agentName: string_agent_name): Promise<ReadonlyArray<{
50
+ id: number;
51
+ createdAt: string;
52
+ agentHash: string;
53
+ promptbookEngineVersion: string;
54
+ }>>;
55
+ /**
56
+ * List agents that are in history but not in the active agents list
57
+ */
58
+ listDeletedAgents(): Promise<ReadonlyArray<string_agent_name>>;
59
+ /**
60
+ * Restore an agent from history
61
+ */
62
+ restoreAgent(historyId: number): Promise<void>;
46
63
  /**
47
64
  * Get the Supabase table name with prefix
48
65
  *
@@ -0,0 +1,28 @@
1
+ import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
2
+ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
3
+ /**
4
+ * AGENT MESSAGE commitment definition
5
+ *
6
+ * The AGENT MESSAGE commitment defines a message from the agent in the conversation history.
7
+ * It is used to pre-fill the chat with a conversation history or to provide few-shot examples.
8
+ *
9
+ * Example usage in agent source:
10
+ *
11
+ * ```book
12
+ * AGENT MESSAGE What seems to be the issue?
13
+ * ```
14
+ *
15
+ * @private [🪔] Maybe export the commitments through some package
16
+ */
17
+ export declare class AgentMessageCommitmentDefinition extends BaseCommitmentDefinition<'AGENT MESSAGE'> {
18
+ constructor();
19
+ /**
20
+ * Short one-line description of AGENT MESSAGE.
21
+ */
22
+ get description(): string;
23
+ /**
24
+ * Markdown documentation for AGENT MESSAGE commitment.
25
+ */
26
+ get documentation(): string;
27
+ applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
28
+ }
@@ -0,0 +1,28 @@
1
+ import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
2
+ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
3
+ /**
4
+ * USER MESSAGE commitment definition
5
+ *
6
+ * The USER MESSAGE commitment defines a message from the user in the conversation history.
7
+ * It is used to pre-fill the chat with a conversation history or to provide few-shot examples.
8
+ *
9
+ * Example usage in agent source:
10
+ *
11
+ * ```book
12
+ * USER MESSAGE Hello, I have a problem.
13
+ * ```
14
+ *
15
+ * @private [🪔] Maybe export the commitments through some package
16
+ */
17
+ export declare class UserMessageCommitmentDefinition extends BaseCommitmentDefinition<'USER MESSAGE'> {
18
+ constructor();
19
+ /**
20
+ * Short one-line description of USER MESSAGE.
21
+ */
22
+ get description(): string;
23
+ /**
24
+ * Markdown documentation for USER MESSAGE commitment.
25
+ */
26
+ get documentation(): string;
27
+ applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
28
+ }
@@ -6,8 +6,10 @@ import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
6
6
  import { GoalCommitmentDefinition } from './GOAL/GOAL';
7
7
  import { KnowledgeCommitmentDefinition } from './KNOWLEDGE/KNOWLEDGE';
8
8
  import { MemoryCommitmentDefinition } from './MEMORY/MEMORY';
9
+ import { AgentMessageCommitmentDefinition } from './MESSAGE/AgentMessageCommitmentDefinition';
9
10
  import { InitialMessageCommitmentDefinition } from './MESSAGE/InitialMessageCommitmentDefinition';
10
11
  import { MessageCommitmentDefinition } from './MESSAGE/MESSAGE';
12
+ import { UserMessageCommitmentDefinition } from './MESSAGE/UserMessageCommitmentDefinition';
11
13
  import { MetaCommitmentDefinition } from './META/META';
12
14
  import { MetaColorCommitmentDefinition } from './META_COLOR/META_COLOR';
13
15
  import { MetaImageCommitmentDefinition } from './META_IMAGE/META_IMAGE';
@@ -26,7 +28,7 @@ import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplemented
26
28
  *
27
29
  * @private Use functions to access commitments instead of this array directly
28
30
  */
29
- export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
31
+ export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
30
32
  /**
31
33
  * Gets a commitment definition by its type
32
34
  * @param type The commitment type to look up
@@ -57,6 +59,23 @@ export declare function getAllCommitmentTypes(): ReadonlyArray<BookCommitment>;
57
59
  * @public exported from `@promptbook/core`
58
60
  */
59
61
  export declare function isCommitmentSupported(type: BookCommitment): boolean;
62
+ /**
63
+ * Grouped commitment definition
64
+ *
65
+ * @public exported from `@promptbook/core`
66
+ */
67
+ export type GroupedCommitmentDefinition = {
68
+ primary: CommitmentDefinition;
69
+ aliases: string[];
70
+ };
71
+ /**
72
+ * Gets all commitment definitions grouped by their aliases
73
+ *
74
+ * @returns Array of grouped commitment definitions
75
+ *
76
+ * @public exported from `@promptbook/core`
77
+ */
78
+ export declare function getGroupedCommitmentDefinitions(): ReadonlyArray<GroupedCommitmentDefinition>;
60
79
  /**
61
80
  * TODO: [🧠] Maybe create through standardized $register
62
81
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -57,6 +57,15 @@ export type LlmExecutionTools = {
57
57
  * Calls a chat model with streaming
58
58
  */
59
59
  callChatModelStream?(prompt: Prompt, onProgress: (chunk: ChatPromptResult) => void): Promise<ChatPromptResult>;
60
+ /**
61
+ * Calls a voice chat model
62
+ */
63
+ callVoiceChatModel?(audio: Blob, prompt: Prompt): Promise<{
64
+ text: string;
65
+ audio: Blob;
66
+ userMessage?: string;
67
+ agentMessage?: string;
68
+ }>;
60
69
  /**
61
70
  * Calls a completion model
62
71
  */
@@ -1,4 +1,5 @@
1
1
  import type { Promisable } from 'type-fest';
2
+ import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
2
3
  import type { string_book } from '../../book-2.0/agent-source/string_book';
3
4
  import type { ChatParticipant } from '../../book-components/Chat/types/ChatParticipant';
4
5
  import type { AvailableModel } from '../../execution/AvailableModel';
@@ -54,7 +55,7 @@ export declare class AgentLlmExecutionTools implements LlmExecutionTools {
54
55
  /**
55
56
  * Get cached or create agent model requirements
56
57
  */
57
- private getAgentModelRequirements;
58
+ protected getAgentModelRequirements(): Promise<AgentModelRequirements>;
58
59
  get title(): string_title & string_markdown_text;
59
60
  get description(): string_markdown;
60
61
  get profile(): ChatParticipant | undefined;
@@ -23,6 +23,7 @@ export declare class RemoteAgent extends Agent {
23
23
  private agentUrl;
24
24
  private _remoteAgentName;
25
25
  private _remoteAgentHash;
26
+ private _isVoiceCallingEnabled;
26
27
  private constructor();
27
28
  get agentName(): string_agent_name;
28
29
  get agentHash(): string_agent_hash;
@@ -31,8 +32,16 @@ export declare class RemoteAgent extends Agent {
31
32
  */
32
33
  callChatModel(prompt: Prompt): Promise<ChatPromptResult>;
33
34
  /**
34
- * Calls the agent on agents remote server with streaming
35
+ * Calls the agent on agents remote server with voice
36
+ * [✨✷] Only available when voice calling is enabled on the server
37
+ * Returns undefined if voice calling is disabled
35
38
  */
39
+ get callVoiceChatModel(): ((audio: Blob, prompt: Prompt) => Promise<{
40
+ text: string;
41
+ audio: Blob;
42
+ userMessage?: string;
43
+ agentMessage?: string;
44
+ }>) | undefined;
36
45
  callChatModelStream(prompt: Prompt, onProgress: (chunk: ChatPromptResult) => void): Promise<ChatPromptResult>;
37
46
  }
38
47
  /**
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Normalizes message text for comparison
3
+ *
4
+ * @param text The message text to normalize
5
+ * @returns The normalized message text
6
+ *
7
+ * @public exported from `@promptbook/utils`
8
+ */
9
+ export declare function normalizeMessageText(text: string): string;
@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
15
15
  export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
16
16
  /**
17
17
  * Represents the version string of the Promptbook engine.
18
- * It follows semantic versioning (e.g., `0.103.0-51`).
18
+ * It follows semantic versioning (e.g., `0.103.0-52`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/browser",
3
- "version": "0.103.0-52",
3
+ "version": "0.103.0-53",
4
4
  "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -94,7 +94,7 @@
94
94
  "module": "./esm/index.es.js",
95
95
  "typings": "./esm/typings/src/_packages/browser.index.d.ts",
96
96
  "peerDependencies": {
97
- "@promptbook/core": "0.103.0-52"
97
+ "@promptbook/core": "0.103.0-53"
98
98
  },
99
99
  "dependencies": {
100
100
  "crypto": "1.0.1",
package/umd/index.umd.js CHANGED
@@ -23,7 +23,7 @@
23
23
  * @generated
24
24
  * @see https://github.com/webgptorg/promptbook
25
25
  */
26
- const PROMPTBOOK_ENGINE_VERSION = '0.103.0-52';
26
+ const PROMPTBOOK_ENGINE_VERSION = '0.103.0-53';
27
27
  /**
28
28
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
29
29
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -3328,6 +3328,77 @@
3328
3328
  * Note: [💞] Ignore a discrepancy between file name and entity name
3329
3329
  */
3330
3330
 
3331
+ /**
3332
+ * AGENT MESSAGE commitment definition
3333
+ *
3334
+ * The AGENT MESSAGE commitment defines a message from the agent in the conversation history.
3335
+ * It is used to pre-fill the chat with a conversation history or to provide few-shot examples.
3336
+ *
3337
+ * Example usage in agent source:
3338
+ *
3339
+ * ```book
3340
+ * AGENT MESSAGE What seems to be the issue?
3341
+ * ```
3342
+ *
3343
+ * @private [🪔] Maybe export the commitments through some package
3344
+ */
3345
+ class AgentMessageCommitmentDefinition extends BaseCommitmentDefinition {
3346
+ constructor() {
3347
+ super('AGENT MESSAGE');
3348
+ }
3349
+ /**
3350
+ * Short one-line description of AGENT MESSAGE.
3351
+ */
3352
+ get description() {
3353
+ return 'Defines a **message from the agent** in the conversation history.';
3354
+ }
3355
+ /**
3356
+ * Markdown documentation for AGENT MESSAGE commitment.
3357
+ */
3358
+ get documentation() {
3359
+ return spaceTrim.spaceTrim(`
3360
+ # ${this.type}
3361
+
3362
+ Defines a message from the agent in the conversation history. This is used to pre-fill the chat with a conversation history or to provide few-shot examples.
3363
+
3364
+ ## Key aspects
3365
+
3366
+ - Represents a message sent by the agent.
3367
+ - Used for setting up conversation context.
3368
+ - Can be used in conjunction with USER MESSAGE.
3369
+
3370
+ ## Examples
3371
+
3372
+ \`\`\`book
3373
+ Conversation History
3374
+
3375
+ USER MESSAGE Hello, I have a problem.
3376
+ AGENT MESSAGE What seems to be the issue?
3377
+ USER MESSAGE My computer is not starting.
3378
+ \`\`\`
3379
+ `);
3380
+ }
3381
+ applyToAgentModelRequirements(requirements, content) {
3382
+ // AGENT MESSAGE is for UI display purposes / conversation history construction
3383
+ // and typically doesn't need to be added to the system prompt or model requirements directly.
3384
+ // It is extracted separately for the chat interface.
3385
+ var _a;
3386
+ const pendingUserMessage = (_a = requirements.metadata) === null || _a === void 0 ? void 0 : _a.pendingUserMessage;
3387
+ if (pendingUserMessage) {
3388
+ const newSample = { question: pendingUserMessage, answer: content };
3389
+ const newSamples = [...(requirements.samples || []), newSample];
3390
+ const newMetadata = { ...requirements.metadata };
3391
+ delete newMetadata.pendingUserMessage;
3392
+ return {
3393
+ ...requirements,
3394
+ samples: newSamples,
3395
+ metadata: newMetadata,
3396
+ };
3397
+ }
3398
+ return requirements;
3399
+ }
3400
+ }
3401
+
3331
3402
  /**
3332
3403
  * INITIAL MESSAGE commitment definition
3333
3404
  *
@@ -3492,6 +3563,67 @@
3492
3563
  * Note: [💞] Ignore a discrepancy between file name and entity name
3493
3564
  */
3494
3565
 
3566
+ /**
3567
+ * USER MESSAGE commitment definition
3568
+ *
3569
+ * The USER MESSAGE commitment defines a message from the user in the conversation history.
3570
+ * It is used to pre-fill the chat with a conversation history or to provide few-shot examples.
3571
+ *
3572
+ * Example usage in agent source:
3573
+ *
3574
+ * ```book
3575
+ * USER MESSAGE Hello, I have a problem.
3576
+ * ```
3577
+ *
3578
+ * @private [🪔] Maybe export the commitments through some package
3579
+ */
3580
+ class UserMessageCommitmentDefinition extends BaseCommitmentDefinition {
3581
+ constructor() {
3582
+ super('USER MESSAGE');
3583
+ }
3584
+ /**
3585
+ * Short one-line description of USER MESSAGE.
3586
+ */
3587
+ get description() {
3588
+ return 'Defines a **message from the user** in the conversation history.';
3589
+ }
3590
+ /**
3591
+ * Markdown documentation for USER MESSAGE commitment.
3592
+ */
3593
+ get documentation() {
3594
+ return spaceTrim.spaceTrim(`
3595
+ # ${this.type}
3596
+
3597
+ Defines a message from the user in the conversation history. This is used to pre-fill the chat with a conversation history or to provide few-shot examples.
3598
+
3599
+ ## Key aspects
3600
+
3601
+ - Represents a message sent by the user.
3602
+ - Used for setting up conversation context.
3603
+ - Can be used in conjunction with AGENT MESSAGE.
3604
+
3605
+ ## Examples
3606
+
3607
+ \`\`\`book
3608
+ Conversation History
3609
+
3610
+ USER MESSAGE Hello, I have a problem.
3611
+ AGENT MESSAGE What seems to be the issue?
3612
+ USER MESSAGE My computer is not starting.
3613
+ \`\`\`
3614
+ `);
3615
+ }
3616
+ applyToAgentModelRequirements(requirements, content) {
3617
+ return {
3618
+ ...requirements,
3619
+ metadata: {
3620
+ ...requirements.metadata,
3621
+ pendingUserMessage: content,
3622
+ },
3623
+ };
3624
+ }
3625
+ }
3626
+
3495
3627
  /**
3496
3628
  * META commitment definition
3497
3629
  *
@@ -4705,6 +4837,8 @@
4705
4837
  new GoalCommitmentDefinition('GOAL'),
4706
4838
  new GoalCommitmentDefinition('GOALS'),
4707
4839
  new InitialMessageCommitmentDefinition(),
4840
+ new UserMessageCommitmentDefinition(),
4841
+ new AgentMessageCommitmentDefinition(),
4708
4842
  new MessageCommitmentDefinition('MESSAGE'),
4709
4843
  new MessageCommitmentDefinition('MESSAGES'),
4710
4844
  new ScenarioCommitmentDefinition('SCENARIO'),