@promptbook/remote-client/esm/typings/src/commitments/META_IMAGE/META_IMAGE.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 IMAGE commitment definition
 *
 * The META IMAGE commitment sets the agent's avatar/profile image URL.
 * 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 IMAGE https://example.com/avatar.jpg
 * META IMAGE /assets/agent-avatar.png
 * ```
 *
 * @private [🪔] Maybe export the commitments through some package
 */
export declare class MetaImageCommitmentDefinition extends BaseCommitmentDefinition<'META IMAGE'> {
    constructor();
    /**
     * Short one-line description of META IMAGE.
     */
    get description(): string;
    /**
     * Markdown documentation for META IMAGE commitment.
     */
    get documentation(): string;
    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
    /**
     * Extracts the profile image URL from the content
     * This is used by the parsing logic
     */
    extractProfileImageUrl(content: string): string | null;
}
/**
 * Note: [💞] Ignore a discrepancy between file name and entity name
 */