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

    Interface BriyahConfigOptions

    interface BriyahConfigOptions {
        allowUserAuthoredTools?: boolean;
        dataPath?: string;
        envOverrides?: Record<string, string>;
        logging?: LoggingOptions;
        markupRate?: number;
        startingBalance?: number;
        tools?: NativeToolDefinition[];
        userServiceCacheTimeoutMinutes?: number;
    }
    Index
    allowUserAuthoredTools? dataPath? envOverrides? logging? markupRate? startingBalance? tools? userServiceCacheTimeoutMinutes?
    allowUserAuthoredTools?: boolean

    Allow end users to author and execute their own JS-string tools (stored in their data directory and run in-process). Native tools are unaffected. Leave off for untrusted, multi-user hosts. Default: false. Also settable via the ALLOW_USER_AUTHORED_TOOLS environment variable.

    dataPath?: string

    Base directory for Briyah data storage Defaults to './briyah-data' relative to process.cwd()

    envOverrides?: Record<string, string>

    Override environment variables Useful for testing or multi-instance configurations

    logging?: LoggingOptions

    File logging configuration. Defaults to enabled, writing to {dataPath}/logs/briyah.log

    markupRate?: number

    Default markup rate multiplier applied to output costs Defaults to value in process.env.DEFAULT_MARKUP_RATE

    startingBalance?: number

    Starting balance for new users Defaults to value in process.env.STARTING_BALANCE

    tools?: NativeToolDefinition[]

    Native tools to register up front. Equivalent to calling Briyah.registerTool for each after construction.

    userServiceCacheTimeoutMinutes?: number

    Timeout in minutes for cached user services Defaults to 30 minutes

    Settings
    Member Visibility

    On This Page
    Properties