@promptbook/vercel/esm/typings/src/commitments/SAMPLE/SAMPLE.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';
/**
 * SAMPLE commitment definition
 *
 * The SAMPLE/EXAMPLE commitment provides examples of how the agent should respond
 * or behave in certain situations. These examples help guide the agent's responses.
 *
 * Example usage in agent source:
 *
 * ```book
 * SAMPLE When asked about pricing, respond: "Our basic plan starts at $10/month..."
 * EXAMPLE For code questions, always include working code snippets
 * ```
 *
 * @private [🪔] Maybe export the commitments through some package
 */
export declare class SampleCommitmentDefinition extends BaseCommitmentDefinition<'SAMPLE' | 'EXAMPLE'> {
    constructor(type?: 'SAMPLE' | 'EXAMPLE');
    /**
     * Short one-line description of SAMPLE/EXAMPLE.
     */
    get description(): string;
    /**
     * Markdown documentation for SAMPLE/EXAMPLE commitment.
     */
    get documentation(): string;
    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
}
/**
 * Note: [💞] Ignore a discrepancy between file name and entity name
 */