@promptbook/utils/esm/typings/src/commitments/USE_EMAIL/USE_EMAIL.d.ts

Promptbook: Turn your company's scattered knowledge into AI ready books

import { string_javascript_name } from '../../_packages/types.index';
import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
import { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
/**
 * USE EMAIL commitment definition
 *
 * The `USE EMAIL` commitment enables the agent to send emails.
 *
 * Example usage in agent source:
 *
 * ```book
 * USE EMAIL
 * USE EMAIL Write always formal and polite emails, always greet.
 * ```
 *
 * @private [🪔] Maybe export the commitments through some package
 */
export declare class UseEmailCommitmentDefinition extends BaseCommitmentDefinition<'USE EMAIL'> {
    constructor();
    get requiresContent(): boolean;
    /**
     * Short one-line description of USE EMAIL.
     */
    get description(): string;
    /**
     * Icon for this commitment.
     */
    get icon(): string;
    /**
     * Markdown documentation for USE EMAIL commitment.
     */
    get documentation(): string;
    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
    /**
     * Gets human-readable titles for tool functions provided by this commitment.
     */
    getToolTitles(): Record<string_javascript_name, string>;
    /**
     * Gets the `send_email` tool function implementation.
     * Note: This is a placeholder - the actual implementation is provided by the agent server.
     */
    getToolFunctions(): Record<string_javascript_name, ToolFunction>;
}
/**
 * Note: [💞] Ignore a discrepancy between file name and entity name
 */