Class PrismaVectorStore<TModel, TModelName, TSelectModel, TFilterModel>

constructor

• new PrismaVectorStore<
      TModel extends Record<string, unknown>,
      TModelName extends string,
      TSelectModel extends ModelColumns<TModel>,
      TFilterModel extends PrismaSqlFilter<TModel>,
  >(
      embeddings: EmbeddingsInterface,
      config: {
          columns: TSelectModel;
          columnTypes?: ColumnTypeConfig;
          db: PrismaClient;
          filter?: TFilterModel;
          prisma: PrismaNamespace;
          tableName: TModelName;
          vectorColumnName: string;
      },
  ): PrismaVectorStore<TModel, TModelName, TSelectModel, TFilterModel>

  Type Parameters

  • TModel extends Record<string, unknown>
  • TModelName extends string
  • TSelectModel extends ModelColumns<TModel>
  • TFilterModel extends PrismaSqlFilter<TModel>

  Parameters

  • embeddings: EmbeddingsInterface
  • config: {
        columns: TSelectModel;
        columnTypes?: ColumnTypeConfig;
        db: PrismaClient;
        filter?: TFilterModel;
        prisma: PrismaNamespace;
        tableName: TModelName;
        vectorColumnName: string;
    }

  Returns PrismaVectorStore<TModel, TModelName, TSelectModel, TFilterModel>

contentColumn

Optionalfilter

FilterType

idColumn

StaticContentColumn

StaticIdColumn

_vectorstoreType

• _vectorstoreType(): string

  Returns string

addDocuments

• addDocuments(documents: Document<TModel>[]): Promise<void>

  Adds the specified documents to the store.

  Parameters

  • documents: Document<TModel>[]

    The documents to add.

  Returns Promise<void>

  A promise that resolves when the documents have been added.

addModels

• addModels(models: TModel[]): Promise<void>

  Adds the specified models to the store.

  Parameters

  • models: TModel[]

    The models to add.

  Returns Promise<void>

  A promise that resolves when the models have been added.

addVectors

• addVectors(vectors: number[][], documents: Document<TModel>[]): Promise<void>

  Adds the specified vectors to the store.

  Parameters

  • vectors: number[][]

    The vectors to add.

  • documents: Document<TModel>[]

    The documents associated with the vectors.

  Returns Promise<void>

  A promise that resolves when the vectors have been added.

buildSqlFilterStr

• buildSqlFilterStr(filter?: TFilterModel): null | Sql

  Parameters

  • Optionalfilter: TFilterModel

  Returns null | Sql

similaritySearch

• similaritySearch(
      query: string,
      k?: number,
      filter?: undefined | TFilterModel,
  ): Promise<Document<SimilarityModel<TModel, TSelectModel>>[]>

  Performs a similarity search with the specified query.

  Parameters

  • query: string

    The query to use for the similarity search.

  • k: number = 4

    The number of results to return.

  • filter: undefined | TFilterModel = undefined

  Returns Promise<Document<SimilarityModel<TModel, TSelectModel>>[]>

  A promise that resolves with the search results.

similaritySearchVectorWithScore

• similaritySearchVectorWithScore(
      query: number[],
      k: number,
      filter?: TFilterModel,
  ): Promise<[Document<SimilarityModel<TModel, TSelectModel>>, number][]>

  Performs a similarity search with the specified vector and returns the results along with their scores.

  Parameters

  • query: number[]

    The vector to use for the similarity search.

  • k: number

    The number of results to return.

  • Optionalfilter: TFilterModel

    The filter to apply to the results.

  Returns Promise<[Document<SimilarityModel<TModel, TSelectModel>>, number][]>

  A promise that resolves with the search results and their scores.

similaritySearchWithScore

• similaritySearchWithScore(
      query: string,
      k?: number,
      filter?: TFilterModel,
  ): Promise<[DocumentInterface<Record<string, any>>, number][]>

  Performs a similarity search with the specified query and returns the results along with their scores.

  Parameters

  • query: string

    The query to use for the similarity search.

  • Optionalk: number

    The number of results to return.

  • Optionalfilter: TFilterModel

    The filter to apply to the results.

  Returns Promise<[DocumentInterface<Record<string, any>>, number][]>

  A promise that resolves with the search results and their scores.

StaticfromDocuments

• fromDocuments(
      docs: Document[],
      embeddings: EmbeddingsInterface,
      dbConfig: {
          columns: ModelColumns<Record<string, unknown>>;
          columnTypes?: ColumnTypeConfig;
          db: PrismaClient;
          prisma: PrismaNamespace;
          tableName: string;
          vectorColumnName: string;
      },
  ): Promise<DefaultPrismaVectorStore>

  Creates a new PrismaVectorStore from the specified documents.

  Parameters

  • docs: Document[]

    The documents to use to create the store.

  • embeddings: EmbeddingsInterface

    The embeddings to use.

  • dbConfig: {
        columns: ModelColumns<Record<string, unknown>>;
        columnTypes?: ColumnTypeConfig;
        db: PrismaClient;
        prisma: PrismaNamespace;
        tableName: string;
        vectorColumnName: string;
    }

    The database configuration.

  Returns Promise<DefaultPrismaVectorStore>

  A promise that resolves with the new PrismaVectorStore.

StaticfromTexts

• fromTexts(
      texts: string[],
      metadatas: object[],
      embeddings: EmbeddingsInterface,
      dbConfig: {
          columns: ModelColumns<Record<string, unknown>>;
          columnTypes?: ColumnTypeConfig;
          db: PrismaClient;
          prisma: PrismaNamespace;
          tableName: string;
          vectorColumnName: string;
      },
  ): Promise<DefaultPrismaVectorStore>

  Creates a new PrismaVectorStore from the specified texts.

  Parameters

  • texts: string[]

    The texts to use to create the store.

  • metadatas: object[]

    The metadata for the texts.

  • embeddings: EmbeddingsInterface

    The embeddings to use.

  • dbConfig: {
        columns: ModelColumns<Record<string, unknown>>;
        columnTypes?: ColumnTypeConfig;
        db: PrismaClient;
        prisma: PrismaNamespace;
        tableName: string;
        vectorColumnName: string;
    }

    The database configuration.

  Returns Promise<DefaultPrismaVectorStore>

  A promise that resolves with the new PrismaVectorStore.

StaticwithModel

• withModel<TModel extends Record<string, unknown>>(
      db: PrismaClient,
  ): {
      create: <
          TPrisma extends PrismaNamespace,
          TColumns extends ModelColumns<TModel>,
          TFilters extends PrismaSqlFilter<TModel>,
      >(
          embeddings: EmbeddingsInterface,
          config: {
              columns: TColumns;
              columnTypes?: ColumnTypeConfig;
              filter?: TFilters;
              prisma: TPrisma;
              tableName: keyof TPrisma["ModelName"] & string;
              vectorColumnName: string;
          },
      ) => PrismaVectorStore<TModel, ModelName, TColumns, TFilters>;
      fromDocuments: <
          TPrisma extends PrismaNamespace,
          TColumns extends ModelColumns<TModel>,
          TFilters extends PrismaSqlFilter<TModel>,
      >(
          docs: Document<TModel>[],
          embeddings: EmbeddingsInterface,
          dbConfig: {
              columns: TColumns;
              columnTypes?: ColumnTypeConfig;
              prisma: TPrisma;
              tableName: keyof TPrisma["ModelName"] & string;
              vectorColumnName: string;
          },
      ) => Promise<PrismaVectorStore<TModel, ModelName, TColumns, TFilters>>;
      fromTexts: <
          TPrisma extends PrismaNamespace,
          TColumns extends ModelColumns<TModel>,
      >(
          texts: string[],
          metadatas: TModel[],
          embeddings: EmbeddingsInterface,
          dbConfig: {
              columns: TColumns;
              columnTypes?: ColumnTypeConfig;
              prisma: TPrisma;
              tableName: keyof TPrisma["ModelName"] & string;
              vectorColumnName: string;
          },
      ) => Promise<DefaultPrismaVectorStore>;
  }

  Creates a new PrismaVectorStore with the specified model.

  Type Parameters

  • TModel extends Record<string, unknown>

  Parameters

  • db: PrismaClient

    The PrismaClient instance.

  Returns {
      create: <
          TPrisma extends PrismaNamespace,
          TColumns extends ModelColumns<TModel>,
          TFilters extends PrismaSqlFilter<TModel>,
      >(
          embeddings: EmbeddingsInterface,
          config: {
              columns: TColumns;
              columnTypes?: ColumnTypeConfig;
              filter?: TFilters;
              prisma: TPrisma;
              tableName: keyof TPrisma["ModelName"] & string;
              vectorColumnName: string;
          },
      ) => PrismaVectorStore<TModel, ModelName, TColumns, TFilters>;
      fromDocuments: <
          TPrisma extends PrismaNamespace,
          TColumns extends ModelColumns<TModel>,
          TFilters extends PrismaSqlFilter<TModel>,
      >(
          docs: Document<TModel>[],
          embeddings: EmbeddingsInterface,
          dbConfig: {
              columns: TColumns;
              columnTypes?: ColumnTypeConfig;
              prisma: TPrisma;
              tableName: keyof TPrisma["ModelName"] & string;
              vectorColumnName: string;
          },
      ) => Promise<PrismaVectorStore<TModel, ModelName, TColumns, TFilters>>;
      fromTexts: <
          TPrisma extends PrismaNamespace,
          TColumns extends ModelColumns<TModel>,
      >(
          texts: string[],
          metadatas: TModel[],
          embeddings: EmbeddingsInterface,
          dbConfig: {
              columns: TColumns;
              columnTypes?: ColumnTypeConfig;
              prisma: TPrisma;
              tableName: keyof TPrisma["ModelName"] & string;
              vectorColumnName: string;
          },
      ) => Promise<DefaultPrismaVectorStore>;
  }

  An object with create, fromTexts, and fromDocuments methods.