@promptbook/browser/esm/typings/src/commitments/META/META_DESCRIPTION.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';
/**
 * META DESCRIPTION commitment definition
 *
 * The META DESCRIPTION commitment sets the agent's meta description for the profile page.
 * This commitment is special because it doesn't affect the system message,
 * but is handled separately in the parsing logic.
 *
 * Example usage in agent source:
 *
 * ```book
 * META DESCRIPTION An AI assistant specialized in business tasks
 * ```
 *
 * @private [🪔] Maybe export the commitments through some package
 */
export declare class MetaDescriptionCommitmentDefinition extends BaseCommitmentDefinition<'META DESCRIPTION'> {
    constructor();
    /**
     * Short one-line description of META DESCRIPTION.
     */
    get description(): string;
    /**
     * Icon for this commitment.
     */
    get icon(): string;
    /**
     * Markdown documentation for META DESCRIPTION commitment.
     */
    get documentation(): string;
    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
    /**
     * Extracts the meta description from the content
     * This is used by the parsing logic
     */
    extractMetaDescription(content: string): string | null;
}
/**
 * Note: [💞] Ignore a discrepancy between file name and entity name
 */