@promptbook/browser/esm/typings/src/commitments/MESSAGE/UserMessageCommitmentDefinition.d.ts

Promptbook: Turn your company's scattered knowledge into AI ready books

import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
/**
 * USER MESSAGE commitment definition
 *
 * The USER MESSAGE commitment defines a message from the user in the conversation history.
 * It is used to pre-fill the chat with a conversation history or to provide few-shot examples.
 *
 * Example usage in agent source:
 *
 * ```book
 * USER MESSAGE Hello, I have a problem.
 * ```
 *
 * @private [🪔] Maybe export the commitments through some package
 */
export declare class UserMessageCommitmentDefinition extends BaseCommitmentDefinition<'USER MESSAGE'> {
    constructor();
    /**
     * Short one-line description of USER MESSAGE.
     */
    get description(): string;
    /**
     * Icon for this commitment.
     */
    get icon(): string;
    /**
     * Markdown documentation for USER MESSAGE commitment.
     */
    get documentation(): string;
    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
}