@promptbook/templates/esm/typings/src/book-2.0/commitments/RULE/RULE.d.ts

Promptbook: Run AI apps in plain human language across multiple models and platforms

import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
/**
 * RULE commitment definition
 *
 * The RULE/RULES commitment adds behavioral constraints and guidelines that the agent must follow.
 * These are specific instructions about what the agent should or shouldn't do.
 *
 * Example usage in agent source:
 *
 * ```book
 * RULE Always ask for clarification if the user's request is ambiguous
 * RULES Never provide medical advice, always refer to healthcare professionals
 * ```
 *
 * @private [🪔] Maybe export the commitments through some package
 */
export declare class RuleCommitmentDefinition extends BaseCommitmentDefinition<'RULE' | 'RULES'> {
    constructor(type?: 'RULE' | 'RULES');
    /**
     * Short one-line description of RULE/RULES.
     */
    get description(): string;
    /**
     * Markdown documentation for RULE/RULES commitment.
     */
    get documentation(): string;
    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
}
/**
 * Singleton instances of the RULE commitment definitions
 *
 * @private [🪔] Maybe export the commitments through some package
 */
export declare const RuleCommitment: RuleCommitmentDefinition;
/**
 * Singleton instances of the RULE commitment definitions
 *
 * @private [🪔] Maybe export the commitments through some package
 */
export declare const RulesCommitment: RuleCommitmentDefinition;
/**
 * Note: [💞] Ignore a discrepancy between file name and entity name
 */