@promptbook/utils
Version:
Promptbook: Create persistent AI agents that turn your company's scattered knowledge into action
34 lines (33 loc) • 1.25 kB
TypeScript
import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
/**
* `WRITING RULES` commitment definition.
*
* The `WRITING RULES`/`WRITING RULE` commitment adds constraints that apply strictly to writing style
* and presentation rather than task-solving behavior.
*
* Example usage in agent source:
*
* ```book
* WRITING RULES Keep every response under 120 words
* WRITING RULE Always end the message with an emoji
* ```
*
* @private [🪔] Maybe export the commitments through some package
*/
export declare class WritingRulesCommitmentDefinition extends BaseCommitmentDefinition<'WRITING RULES' | 'WRITING RULE'> {
constructor(type?: 'WRITING RULES' | 'WRITING RULE');
/**
* Short one-line description of `WRITING RULES`/`WRITING RULE`.
*/
get description(): string;
/**
* Icon for `WRITING RULES`/`WRITING RULE`.
*/
get icon(): string;
/**
* Markdown documentation for `WRITING RULES`/`WRITING RULE` commitment.
*/
get documentation(): string;
applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
}