ai-utils.js/vector-index/VectorIndexTextChunkStore.d.ts

Build AI applications, chatbots, and agents with JavaScript and TypeScript.

import { TextEmbeddingModel, TextEmbeddingModelSettings } from "../model-function/embed-text/TextEmbeddingModel.js";
import { Run } from "../run/Run.js";
import { TextChunk } from "../text-chunk/TextChunk.js";
import { TextChunkRetrieverSettings } from "../text-chunk/retrieve-text-chunks/TextChunkRetriever.js";
import { VectorIndex } from "./VectorIndex.js";
import { FunctionOptions } from "../model-function/FunctionOptions.js";
export declare class VectorIndexTextChunkStore<CHUNK extends TextChunk, INDEX, MODEL extends TextEmbeddingModel<unknown, TextEmbeddingModelSettings>> {
    private readonly _index;
    private readonly generateId;
    private readonly embeddingModel;
    private readonly queryFunctionId?;
    private readonly upsertFunctionId?;
    constructor({ index, generateId, embeddingModel, queryFunctionId, upsertFunctionId, }: {
        index: VectorIndex<CHUNK, INDEX>;
        generateId?: () => string;
        embeddingModel: MODEL;
        queryFunctionId?: string;
        upsertFunctionId?: string;
    });
    upsertChunk({ id, chunk, }: {
        id?: string;
        keyText: string;
        chunk: CHUNK;
    }, options?: {
        run?: Run;
    }): Promise<void>;
    upsertManyChunks({ ids, chunks, }: {
        ids?: Array<string | undefined>;
        chunks: CHUNK[];
    }, options?: {
        run?: Run;
    }): Promise<void>;
    retrieveSimilarTextChunks(queryText: string, options?: FunctionOptions<TextChunkRetrieverSettings> | undefined): Promise<CHUNK[]>;
    get index(): INDEX;
}