Class CodeIndex

lib/CodeIndex.d.ts:55–135

 * The current projects source code index.
 */
export declare class CodeIndex {
    private readonly _folderPath;
    private _config?;
    private _keys?;
    private _index?;
    /**
     * Creates a new 'CodeIndex' instance.
     * @param folderPath Optional. The path to the folder containing the index. Defaults to '.codepilot'.
     */
    constructor(folderPath?: string);
    /**
     * Gets the current code index configuration.
     */
    get config(): CodeIndexConfig | undefined;
    /**
     * Gets the path to the folder containing the index.
     */
    get folderPath(): string;
    /**
     * Gets the current OpenAI keys.
     */
    get keys(): OpenAIKeys | undefined;
    /**
     * Adds sources and extensions to the index.
     * @param config The configuration containing the sources and extensions to add.
     */
    add(config: Partial<CodeIndexConfig>): Promise<void>;
    /**
     * Creates a new code index.
     * @param keys OpenAI keys to use.
     * @param config Source code index configuration.
     */
    create(keys: OpenAIKeys, config: CodeIndexConfig): Promise<void>;
    /**
     * Deletes the current code index.
     */
    delete(): Promise<void>;
    /**
     * Returns whether a `vectra.keys` file exists for the index.
     */
    hasKeys(): Promise<boolean>;
    /**
     * Returns true if the index has been created.
     */
    isCreated(): Promise<boolean>;
    /**
     * Loads the current code index.
     */
    load(): Promise<LocalDocumentIndex>;
    /**
     * Queries the code index.
     * @param query Text to query the index with.
     * @param options Optional. Options to use when querying the index.
     * @returns Found documents.
     */
    query(query: string, options?: DocumentQueryOptions): Promise<LocalDocumentResult[]>;
    /**
     * Rebuilds the code index.