@promptbook/remote-client
Version:
Promptbook: Turn your company's scattered knowledge into AI ready books
36 lines (35 loc) • 1.36 kB
TypeScript
import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
/**
* MESSAGE commitment definition
*
* The MESSAGE commitment contains 1:1 text of the message which AI assistant already
* sent during the conversation. Later messages are later in the conversation.
* It is similar to EXAMPLE but it is not example, it is the real message which
* AI assistant already sent.
*
* Example usage in agent source:
*
* ```book
* MESSAGE Hello! How can I help you today?
* MESSAGE I understand you're looking for information about our services.
* MESSAGE Based on your requirements, I'd recommend our premium package.
* ```
*
* @private [🪔] Maybe export the commitments through some package
*/
export declare class MessageCommitmentDefinition extends BaseCommitmentDefinition<'MESSAGE' | 'MESSAGES'> {
constructor(type?: 'MESSAGE' | 'MESSAGES');
/**
* Short one-line description of MESSAGE.
*/
get description(): string;
/**
* Markdown documentation for MESSAGE commitment.
*/
get documentation(): string;
applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
}
/**
* Note: [💞] Ignore a discrepancy between file name and entity name
*/