Briyah SDK - v2.0.6
    Preparing search index...

    Interface PromptFolderDefaults

    Agent settings a prompt folder declares in its defaults_config.json, used to pre-fill the create-agent form when that folder is selected.

    Every field is optional and mirrors a field on the create-agent form. A folder that ships one spares the user having to know, for instance, which seven of the seventeen 5e tools a character creator needs.

    interface PromptFolderDefaults {
        agentName?: string;
        agentNickname?: string;
        allowSearch?: boolean;
        beginInstruction?: string;
        controlledByHuman?: boolean;
        description?: string;
        documentIds?: string[];
        maxHistoryMessages?: number;
        maxOutputTokens?: number;
        privateContext?: string;
        promptCacheTTL?: number;
        reasoningEffort?: "low" | "medium" | "high";
        smallModelName?: string;
        toolNames?: string[];
        useModerator?: boolean;
    }
    Index
    agentName? agentNickname? allowSearch? beginInstruction? controlledByHuman? description? documentIds? maxHistoryMessages? maxOutputTokens? privateContext? promptCacheTTL? reasoningEffort? smallModelName? toolNames? useModerator?
    agentName?: string
    agentNickname?: string
    allowSearch?: boolean
    beginInstruction?: string
    controlledByHuman?: boolean
    description?: string
    documentIds?: string[]

    Artifact ids to offer as attachments, pre-ticked in the create-agent dialog. Ids that resolve to nothing are dropped. Attaching stays the user's choice: a document sits in the cached prefix of every call the agent makes.

    maxHistoryMessages?: number
    maxOutputTokens?: number

    Cap on a single response. 0 or absent leaves the provider's default.

    privateContext?: string
    promptCacheTTL?: number
    reasoningEffort?: "low" | "medium" | "high"
    smallModelName?: string
    toolNames?: string[]

    Names of the tools to grant. Names with no registered tool are dropped.

    useModerator?: boolean

    Settings
    Member Visibility

    On This Page
    Properties