@mastra/fastembed 1.0.1 → 1.1.0

package/dist/fastembed.d.ts

@@ -0,0 +1,115 @@
+/**
+ * Forked from fastembed-js (https://github.com/Anush008/fastembed-js)
+ * Original author: Anush008 <anushshetty90@gmail.com>
+ * License: MIT (see LICENSE-fastembed in this package)
+ *
+ * The upstream project has been archived / abandoned. This fork is maintained
+ * as part of the Mastra monorepo so that @mastra/fastembed no longer depends
+ * on the unmaintained npm `fastembed` package.
+ */
+import type { PathLike } from 'node:fs';
+export declare enum ExecutionProvider {
+    CPU = "cpu",
+    CUDA = "cuda",
+    WebGL = "webgl",
+    WASM = "wasm",
+    XNNPACK = "xnnpack"
+}
+export declare enum EmbeddingModel {
+    AllMiniLML6V2 = "fast-all-MiniLM-L6-v2",
+    BGEBaseEN = "fast-bge-base-en",
+    BGEBaseENV15 = "fast-bge-base-en-v1.5",
+    BGESmallEN = "fast-bge-small-en",
+    BGESmallENV15 = "fast-bge-small-en-v1.5",
+    BGESmallZH = "fast-bge-small-zh-v1.5",
+    MLE5Large = "fast-multilingual-e5-large",
+    CUSTOM = "custom"
+}
+export declare enum SparseEmbeddingModel {
+    SpladePPEnV1 = "prithivida/Splade_PP_en_v1",
+    CUSTOM = "custom"
+}
+export type SparseVector = {
+    values: number[];
+    indices: number[];
+};
+export interface InitOptionsBase {
+    executionProviders?: ExecutionProvider[];
+    maxLength?: number;
+    cacheDir?: string;
+    showDownloadProgress?: boolean;
+}
+interface ModelInfo {
+    model: EmbeddingModel;
+    dim: number;
+    description: string;
+}
+interface SparseModelInfo {
+    model: SparseEmbeddingModel;
+    vocabSize: number;
+    description: string;
+}
+export interface InitStandardOptions extends InitOptionsBase {
+    model: Exclude<EmbeddingModel, EmbeddingModel.CUSTOM>;
+    modelAbsoluteDirPath?: undefined;
+    modelName?: string;
+}
+export interface InitCustomOptions extends InitOptionsBase {
+    model: EmbeddingModel.CUSTOM;
+    modelAbsoluteDirPath: PathLike;
+    modelName: string;
+}
+export type InitOptions = InitStandardOptions | InitCustomOptions;
+export interface InitSparseStandardOptions extends InitOptionsBase {
+    model: Exclude<SparseEmbeddingModel, SparseEmbeddingModel.CUSTOM>;
+    modelAbsoluteDirPath?: undefined;
+    modelName?: string;
+}
+export interface InitSparseCustomOptions extends InitOptionsBase {
+    model: SparseEmbeddingModel.CUSTOM;
+    modelAbsoluteDirPath: PathLike;
+    modelName: string;
+}
+export type InitSparseOptions = InitSparseStandardOptions | InitSparseCustomOptions;
+declare abstract class Embedding {
+    abstract listSupportedModels(): ModelInfo[];
+    abstract embed(texts: string[], batchSize?: number): AsyncGenerator<number[][], void, unknown>;
+    abstract passageEmbed(texts: string[], batchSize: number): AsyncGenerator<number[][], void, unknown>;
+    abstract queryEmbed(query: string): Promise<number[]>;
+}
+declare abstract class SparseEmbedding {
+    abstract listSupportedModels(): SparseModelInfo[];
+    abstract embed(texts: string[], batchSize?: number): AsyncGenerator<SparseVector[], void, unknown>;
+    abstract passageEmbed(texts: string[], batchSize: number): AsyncGenerator<SparseVector[], void, unknown>;
+    abstract queryEmbed(query: string): Promise<SparseVector>;
+}
+export declare class FlagEmbedding extends Embedding {
+    private tokenizer;
+    private session;
+    private model;
+    private constructor();
+    static init(options: InitStandardOptions): Promise<FlagEmbedding>;
+    static init(options: InitCustomOptions): Promise<FlagEmbedding>;
+    private static downloadFileFromGCS;
+    private static decompressToCache;
+    static retrieveModel(model: EmbeddingModel, cacheDir: PathLike, showDownloadProgress?: boolean): Promise<PathLike>;
+    embed(textStrings: string[], batchSize?: number): AsyncGenerator<number[][], void, unknown>;
+    passageEmbed(texts: string[], batchSize?: number): AsyncGenerator<number[][], void, unknown>;
+    queryEmbed(query: string): Promise<number[]>;
+    listSupportedModels(): ModelInfo[];
+}
+export declare class SparseTextEmbedding extends SparseEmbedding {
+    private tokenizer;
+    private session;
+    private constructor();
+    static init(options: InitSparseStandardOptions): Promise<SparseTextEmbedding>;
+    static init(options: InitSparseCustomOptions): Promise<SparseTextEmbedding>;
+    private static loadTokenizer;
+    private static retrieveModel;
+    embed(textStrings: string[], batchSize?: number): AsyncGenerator<SparseVector[], void, unknown>;
+    passageEmbed(texts: string[], batchSize?: number): AsyncGenerator<SparseVector[], void, unknown>;
+    queryEmbed(query: string): Promise<SparseVector>;
+    listSupportedModels(): SparseModelInfo[];
+}
+export {};
+//# sourceMappingURL=fastembed.d.ts.map

package/dist/fastembed.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fastembed.d.ts","sourceRoot":"","sources":["../src/fastembed.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAQxC,oBAAY,iBAAiB;IAC3B,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,KAAK,UAAU;IACf,IAAI,SAAS;IACb,OAAO,YAAY;CACpB;AAED,oBAAY,cAAc;IACxB,aAAa,0BAA0B;IACvC,SAAS,qBAAqB;IAC9B,YAAY,0BAA0B;IACtC,UAAU,sBAAsB;IAChC,aAAa,2BAA2B;IACxC,UAAU,2BAA2B;IACrC,SAAS,+BAA+B;IACxC,MAAM,WAAW;CAClB;AAED,oBAAY,oBAAoB;IAC9B,YAAY,+BAA+B;IAC3C,MAAM,WAAW;CAClB;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF,MAAM,WAAW,eAAe;IAC9B,kBAAkB,CAAC,EAAE,iBAAiB,EAAE,CAAC;IACzC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED,UAAU,SAAS;IACjB,KAAK,EAAE,cAAc,CAAC;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,UAAU,eAAe;IACvB,KAAK,EAAE,oBAAoB,CAAC;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AAmBD,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,KAAK,EAAE,OAAO,CAAC,cAAc,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IACtD,oBAAoB,CAAC,EAAE,SAAS,CAAC;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,iBAAkB,SAAQ,eAAe;IACxD,KAAK,EAAE,cAAc,CAAC,MAAM,CAAC;IAC7B,oBAAoB,EAAE,QAAQ,CAAC;IAC/B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,WAAW,GAAG,mBAAmB,GAAG,iBAAiB,CAAC;AAElE,MAAM,WAAW,yBAA0B,SAAQ,eAAe;IAChE,KAAK,EAAE,OAAO,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,MAAM,CAAC,CAAC;IAClE,oBAAoB,CAAC,EAAE,SAAS,CAAC;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,uBAAwB,SAAQ,eAAe;IAC9D,KAAK,EAAE,oBAAoB,CAAC,MAAM,CAAC;IACnC,oBAAoB,EAAE,QAAQ,CAAC;IAC/B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,iBAAiB,GAAG,yBAAyB,GAAG,uBAAuB,CAAC;AAEpF,uBAAe,SAAS;IACtB,QAAQ,CAAC,mBAAmB,IAAI,SAAS,EAAE;IAC3C,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC;IAC9F,QAAQ,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,MAAM,GAAG,cAAc,CAAC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC;IACpG,QAAQ,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;CACtD;AAED,uBAAe,eAAe;IAC5B,QAAQ,CAAC,mBAAmB,IAAI,eAAe,EAAE;IACjD,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC;IAClG,QAAQ,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,MAAM,GAAG,cAAc,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC;IACxG,QAAQ,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;CAC1D;AAwED,qBAAa,aAAc,SAAQ,SAAS;IAExC,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,KAAK;IAHf,OAAO;WAQM,IAAI,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,aAAa,CAAC;WAC1D,IAAI,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC;mBAwChD,mBAAmB;mBAiEnB,iBAAiB;WAWzB,aAAa,CACxB,KAAK,EAAE,cAAc,EACrB,QAAQ,EAAE,QAAQ,EAClB,oBAAoB,GAAE,OAAc,GACnC,OAAO,CAAC,QAAQ,CAAC;IAkBb,KAAK,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,SAAS,GAAE,MAAY;IAyD3D,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,SAAS,GAAE,MAAY;IAK/C,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAKlD,mBAAmB,IAAI,SAAS,EAAE;CAenC;AAED,qBAAa,mBAAoB,SAAQ,eAAe;IAEpD,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,OAAO;IAFjB,OAAO;WAOM,IAAI,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,mBAAmB,CAAC;WACtE,IAAI,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAyCjF,OAAO,CAAC,MAAM,CAAC,aAAa;mBAKP,aAAa;IA8C3B,KAAK,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,SAAS,GAAE,MAAY;IAmF3D,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,SAAS,GAAE,MAAY;IAI/C,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAKtD,mBAAmB,IAAI,eAAe,EAAE;CASzC"}