@promptbook/openai
Version:
Promptbook: Turn your company's scattered knowledge into AI ready books
49 lines (48 loc) • 1.46 kB
TypeScript
import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
/**
* META COLOR commitment definition
*
* The META COLOR commitment sets the agent's accent color.
* 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 COLOR #ff0000
* META COLOR #00ff00
* ```
*
* You can also specify multiple colors separated by comma:
*
* ```book
* META COLOR #ff0000, #00ff00, #0000ff
* ```
*
* @private [🪔] Maybe export the commitments through some package
*/
export declare class MetaColorCommitmentDefinition extends BaseCommitmentDefinition<'META COLOR'> {
constructor();
/**
* Short one-line description of META COLOR.
*/
get description(): string;
/**
* Icon for this commitment.
*/
get icon(): string;
/**
* Markdown documentation for META COLOR commitment.
*/
get documentation(): string;
applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
/**
* Extracts the profile color from the content
* This is used by the parsing logic
*/
extractProfileColor(content: string): string | null;
}
/**
* Note: [💞] Ignore a discrepancy between file name and entity name
*/