@promptbook/browser/esm/typings/src/commitments/DICTIONARY/DICTIONARY.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';
/**
 * DICTIONARY commitment definition
 *
 * The DICTIONARY commitment defines specific terms and their meanings that the agent should use correctly
 * in its reasoning and responses. This ensures consistent terminology usage.
 *
 * Key features:
 * - Multiple DICTIONARY commitments are automatically merged into one
 * - Content is placed in a dedicated section of the system message
 * - Terms and definitions are stored in metadata.DICTIONARY for debugging
 * - Agent should use the defined terms correctly in responses
 *
 * Example usage in agent source:
 *
 * ```book
 * Legal Assistant
 *
 * PERSONA You are a knowledgeable legal assistant
 * DICTIONARY Misdemeanor is a minor wrongdoing or criminal offense
 * DICTIONARY Felony is a serious crime usually punishable by imprisonment for more than one year
 * DICTIONARY Tort is a civil wrong that causes harm or loss to another person, leading to legal liability
 * ```
 *
 * @private [🪔] Maybe export the commitments through some package
 */
export declare class DictionaryCommitmentDefinition extends BaseCommitmentDefinition<'DICTIONARY'> {
    constructor();
    /**
     * Short one-line description of DICTIONARY.
     */
    get description(): string;
    /**
     * Icon for this commitment.
     */
    get icon(): string;
    /**
     * Markdown documentation for DICTIONARY commitment.
     */
    get documentation(): string;
    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
}
/**
 * Note: [💞] Ignore a discrepancy between file name and entity name
 */