@promptbook/remote-server/esm/src/commitments/GOAL/GOAL.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';
/**
 * GOAL commitment definition
 *
 * The GOAL commitment defines the main goal which should be achieved by the AI assistant.
 * There can be multiple goals. Later goals are more important than earlier goals.
 *
 * Example usage in agent source:
 *
 * ```book
 * GOAL Help users understand complex technical concepts
 * GOAL Provide accurate and up-to-date information
 * GOAL Always prioritize user safety and ethical guidelines
 * ```
 *
 * @private [🪔] Maybe export the commitments through some package
 */
export declare class GoalCommitmentDefinition extends BaseCommitmentDefinition<'GOAL' | 'GOALS'> {
    constructor(type?: 'GOAL' | 'GOALS');
    /**
     * Short one-line description of GOAL.
     */
    get description(): string;
    /**
     * Marks GOAL as one of the priority commitments surfaced first in catalogues.
     */
    get isImportant(): boolean;
    /**
     * Icon for this commitment.
     */
    get icon(): string;
    /**
     * Markdown documentation for GOAL commitment.
     */
    get documentation(): string;
    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
}