@promptbook/remote-client
Version:
Promptbook: Turn your company's scattered knowledge into AI ready books
34 lines (33 loc) • 1.22 kB
TypeScript
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;
/**
* Markdown documentation for GOAL commitment.
*/
get documentation(): string;
applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
}
/**
* Note: [💞] Ignore a discrepancy between file name and entity name
*/