@promptbook/utils/esm/typings/src/utils/random/$generateBookBoilerplate.d.ts

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

import type { PartialDeep } from 'type-fest';
import type { AgentBasicInformation } from '../../book-2.0/agent-source/AgentBasicInformation';
import type { string_book } from '../../book-2.0/agent-source/string_book';
import type { string_agent_name_in_book } from '../../types/typeAliases';
type GenerateBookBoilerplateOptions = PartialDeep<Omit<AgentBasicInformation, 'parameters'>> & {
    /**
     * Name of the parent agent to inherit from
     *
     * @default 'Adam'
     */
    parentAgentName?: string_agent_name_in_book;
    /**
     * Name pool to use for generating agent name
     *
     * @default 'ENGLISH'
     */
    namePool?: string;
    /**
     * Initial rules for the agent
     */
    initialRules?: Array<string>;
};
/**
 * Generates boilerplate for a new agent book
 *
 * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
 * Note: This function is using cryptographically secure components internally
 *
 * @public exported from `@promptbook/core`
 */
export declare function $generateBookBoilerplate(options?: GenerateBookBoilerplateOptions): string_book;
export {};
/**
 * TODO: [🤶] Maybe export through `@promptbook/utils` or `@promptbook/random` package
 */