Documentation
    Preparing search index...

    Interface ApiServerOptions

    Options for createApiServer.

    interface ApiServerOptions {
        config: JeevesWatcherConfig;
        configPath: string;
        descriptor: {
            configFileName: string;
            configSchema: ZodType<unknown, unknown>;
            customCliCommands?: $InferOuterFunctionType<
                ZodTuple<
                    readonly [ZodCustom<Command<[], {}, {}>, Command<[], {}, {}>>],
                    null,
                >,
                ZodVoid,
            >;
            customMerge?: $InferOuterFunctionType<
                ZodTuple<
                    readonly [
                        ZodRecord<ZodString, ZodUnknown>,
                        ZodRecord<ZodString, ZodUnknown>,
                    ],
                    null,
                >,
                ZodRecord<ZodString, ZodUnknown>,
            >;
            customPluginTools?: $InferOuterFunctionType<
                ZodTuple<readonly [ZodCustom<PluginApi, PluginApi>], null>,
                ZodArray<ZodUnknown>,
            >;
            defaultPort: number;
            initTemplate: $InferOuterFunctionType<
                ZodTuple<readonly [], null>,
                ZodRecord<ZodString, ZodUnknown>,
            >;
            name: string;
            onConfigApply?: $InferOuterFunctionType<
                ZodTuple<readonly [ZodRecord<ZodString, ZodUnknown>], null>,
                ZodPromise<ZodVoid>,
            >;
            pluginPackage: string;
            run: $InferOuterFunctionType<
                ZodTuple<readonly [ZodString], null>,
                ZodPromise<ZodVoid>,
            >;
            serviceName?: string;
            servicePackage: string;
            startCommand: $InferOuterFunctionType<
                ZodTuple<readonly [ZodString], null>,
                ZodArray<ZodString>,
            >;
            version: string;
        };
        embeddingProvider: EmbeddingProvider;
        enrichmentStore?: EnrichmentStoreInterface;
        fileSystemWatcher?: FileSystemWatcher;
        getConfig?: () => JeevesWatcherConfig;
        getFileSystemWatcher?: () => FileSystemWatcher | undefined;
        gitignoreFilter?: GitignoreFilter;
        helperIntrospection?: AllHelpersIntrospection;
        initialScanTracker?: InitialScanTracker;
        issuesManager: IssuesManager;
        logger: Logger;
        processor: WatcherProcessor;
        queue: PausableQueue;
        reindexTracker?: ReindexTracker;
        sourceQueue?: SourceNotifyQueue;
        valuesManager: ValuesManager;
        vcsCoordinator?: VcsCoordinator;
        vectorStore: VectorStoreClient;
        version?: string;
        virtualRuleStore?: VirtualRuleStore;
    }
    Index
    config configPath descriptor embeddingProvider enrichmentStore? fileSystemWatcher? getConfig? getFileSystemWatcher? gitignoreFilter? helperIntrospection? initialScanTracker? issuesManager logger processor queue reindexTracker? sourceQueue? valuesManager vcsCoordinator? vectorStore version? virtualRuleStore?
    config: JeevesWatcherConfig

    The application configuration (used as initial/fallback value).

    configPath: string

    Path to the config file on disk.

    descriptor: {
        configFileName: string;
        configSchema: ZodType<unknown, unknown>;
        customCliCommands?: $InferOuterFunctionType<
            ZodTuple<
                readonly [ZodCustom<Command<[], {}, {}>, Command<[], {}, {}>>],
                null,
            >,
            ZodVoid,
        >;
        customMerge?: $InferOuterFunctionType<
            ZodTuple<
                readonly [
                    ZodRecord<ZodString, ZodUnknown>,
                    ZodRecord<ZodString, ZodUnknown>,
                ],
                null,
            >,
            ZodRecord<ZodString, ZodUnknown>,
        >;
        customPluginTools?: $InferOuterFunctionType<
            ZodTuple<readonly [ZodCustom<PluginApi, PluginApi>], null>,
            ZodArray<ZodUnknown>,
        >;
        defaultPort: number;
        initTemplate: $InferOuterFunctionType<
            ZodTuple<readonly [], null>,
            ZodRecord<ZodString, ZodUnknown>,
        >;
        name: string;
        onConfigApply?: $InferOuterFunctionType<
            ZodTuple<readonly [ZodRecord<ZodString, ZodUnknown>], null>,
            ZodPromise<ZodVoid>,
        >;
        pluginPackage: string;
        run: $InferOuterFunctionType<
            ZodTuple<readonly [ZodString], null>,
            ZodPromise<ZodVoid>,
        >;
        serviceName?: string;
        servicePackage: string;
        startCommand: $InferOuterFunctionType<
            ZodTuple<readonly [ZodString], null>,
            ZodArray<ZodString>,
        >;
        version: string;
    }

    The component descriptor (used for config-apply handler).

    embeddingProvider: EmbeddingProvider

    The embedding provider.

    enrichmentStore?: EnrichmentStoreInterface

    Optional enrichment store for persisted enrichment metadata.

    fileSystemWatcher?: FileSystemWatcher

    Filesystem watcher instance for /walk endpoint (in-memory file list).

    getConfig?: () => JeevesWatcherConfig

    Config getter for live config access after hot-reload.

    getFileSystemWatcher?: () => FileSystemWatcher | undefined

    Getter for live filesystem watcher access after hot-reload rebuilds.

    gitignoreFilter?: GitignoreFilter

    Gitignore filter for reindex path validation.

    helperIntrospection?: AllHelpersIntrospection

    Helper introspection for merged document.

    initialScanTracker?: InitialScanTracker

    Initial scan tracker for /status visibility.

    issuesManager: IssuesManager

    The issues manager.

    logger: Logger

    The logger instance.

    processor: WatcherProcessor

    The document processor: file and source operations.

    queue: PausableQueue

    Queues paused while a prune deletes points. The service passes combinePausableQueues(fileQueue, sourceQueue) (app/index.ts), so a prune quiesces both the file event queue and the source notify queue.

    reindexTracker?: ReindexTracker

    The reindex tracker (optional, created if not provided).

    sourceQueue?: SourceNotifyQueue

    Source notify queue (POST /documents); absent in file-only setups.

    valuesManager: ValuesManager

    The values manager.

    vcsCoordinator?: VcsCoordinator

    VCS coordinator for git-backed versioning API routes.

    vectorStore: VectorStoreClient

    The vector store client.

    version?: string

    Service version string for /status endpoint.

    virtualRuleStore?: VirtualRuleStore

    Virtual rule store for externally registered inference rules.

    Settings
    Member Visibility

    On This Page
    Properties