@promptbook/remote-server/esm/src/commitments/SAMPLE/SAMPLE.d.ts

Promptbook: Create persistent AI agents that turn your company's scattered knowledge into action

import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
/**
 * Legacy `SAMPLE` / `EXAMPLE` commitment definition.
 *
 * It stays runtime-compatible, but authors should migrate to `WRITING SAMPLE`
 * for writing voice exemplars.
 *
 * @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;
    /**
     * Optional UI/docs-only deprecation metadata.
     */
    get deprecation(): {
        readonly message: "Use `WRITING SAMPLE` for explicit voice exemplars.";
        readonly replacedBy: readonly ["WRITING SAMPLE"];
    };
    /**
     * Icon for `SAMPLE` / `EXAMPLE`.
     */
    get icon(): string;
    /**
     * Markdown documentation for `SAMPLE` / `EXAMPLE`.
     */
    get documentation(): string;
    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
}