Class PrismaVectorStore<TModel, TModelName, TSelectModel, TFilterModel>

constructor

• new PrismaVectorStore<TModel, TModelName, TSelectModel, TFilterModel>(embeddings, config): 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;
        db: PrismaClient;
        prisma: PrismaNamespace;
        tableName: TModelName;
        vectorColumnName: string;
        filter?: TFilterModel;
    }

    • columns: TSelectModel

    • db: PrismaClient

    • prisma: PrismaNamespace

    • tableName: TModelName

    • vectorColumnName: string

    • Optional filter?: TFilterModel

  Returns PrismaVectorStore<TModel, TModelName, TSelectModel, TFilterModel>

FilterType

contentColumn

idColumn

Optional filter

Static ContentColumn

Static IdColumn

addDocuments

• addDocuments(documents): 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): 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, documents): 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?): null | Sql

• Parameters

  • Optional filter: TFilterModel

  Returns null | Sql

similaritySearch

• similaritySearch(query, k?, filter?): 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, k, filter?): 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.

  • Optional filter: 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, k?, filter?): 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.

  • Optional k: number

    The number of results to return.

  • Optional filter: 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.

Static fromDocuments

• fromDocuments(docs, embeddings, dbConfig): Promise<DefaultPrismaVectorStore>

• Creates a new PrismaVectorStore from the specified documents.

  Parameters

  • docs: Document<Record<string, any>>[]

    The documents to use to create the store.

  • embeddings: EmbeddingsInterface

    The embeddings to use.

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

    The database configuration.

    • columns: ModelColumns<Record<string, unknown>>

    • db: PrismaClient

    • prisma: PrismaNamespace

    • tableName: string

    • vectorColumnName: string

  Returns Promise<DefaultPrismaVectorStore>

  A promise that resolves with the new PrismaVectorStore.

Static fromTexts

• fromTexts(texts, metadatas, embeddings, dbConfig): 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>>;
        db: PrismaClient;
        prisma: PrismaNamespace;
        tableName: string;
        vectorColumnName: string;
    }

    The database configuration.

    • columns: ModelColumns<Record<string, unknown>>

    • db: PrismaClient

    • prisma: PrismaNamespace

    • tableName: string

    • vectorColumnName: string

  Returns Promise<DefaultPrismaVectorStore>

  A promise that resolves with the new PrismaVectorStore.

Static withModel

• withModel<TModel>(db): {
      create: (<TPrisma, TColumns, TFilters>(embeddings, config) => PrismaVectorStore<TModel, ModelName, TColumns, TFilters>);
      fromDocuments: (<TPrisma, TColumns, TFilters>(docs, embeddings, dbConfig) => Promise<PrismaVectorStore<TModel, ModelName, TColumns, TFilters>>);
      fromTexts: (<TPrisma, TColumns>(texts, metadatas, embeddings, dbConfig) => 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, TColumns, TFilters>(embeddings, config) => PrismaVectorStore<TModel, ModelName, TColumns, TFilters>);
      fromDocuments: (<TPrisma, TColumns, TFilters>(docs, embeddings, dbConfig) => Promise<PrismaVectorStore<TModel, ModelName, TColumns, TFilters>>);
      fromTexts: (<TPrisma, TColumns>(texts, metadatas, embeddings, dbConfig) => Promise<DefaultPrismaVectorStore>);
  }

  An object with create, fromTexts, and fromDocuments methods.

  • create: (<TPrisma, TColumns, TFilters>(embeddings, config) => PrismaVectorStore<TModel, ModelName, TColumns, TFilters>)

    • • <TPrisma, TColumns, TFilters>(embeddings, config): PrismaVectorStore<TModel, ModelName, TColumns, TFilters>

      • Type Parameters

        • TPrisma extends PrismaNamespace

        • TColumns extends ModelColumns<TModel>

        • TFilters extends PrismaSqlFilter<TModel>

        Parameters

        • embeddings: EmbeddingsInterface

        • config: {
              columns: TColumns;
              prisma: TPrisma;
              tableName: keyof TPrisma["ModelName"] & string;
              vectorColumnName: string;
              filter?: TFilters;
          }

          • columns: TColumns

          • prisma: TPrisma

          • tableName: keyof TPrisma["ModelName"] & string

          • vectorColumnName: string

          • Optional filter?: TFilters

        Returns PrismaVectorStore<TModel, ModelName, TColumns, TFilters>

  • fromDocuments: (<TPrisma, TColumns, TFilters>(docs, embeddings, dbConfig) => Promise<PrismaVectorStore<TModel, ModelName, TColumns, TFilters>>)

    • • <TPrisma, TColumns, TFilters>(docs, embeddings, dbConfig): Promise<PrismaVectorStore<TModel, ModelName, TColumns, TFilters>>

      • Type Parameters

        • TPrisma extends PrismaNamespace

        • TColumns extends ModelColumns<TModel>

        • TFilters extends PrismaSqlFilter<TModel>

        Parameters

        • docs: Document<TModel>[]

        • embeddings: EmbeddingsInterface

        • dbConfig: {
              columns: TColumns;
              prisma: TPrisma;
              tableName: keyof TPrisma["ModelName"] & string;
              vectorColumnName: string;
          }

          • columns: TColumns

          • prisma: TPrisma

          • tableName: keyof TPrisma["ModelName"] & string

          • vectorColumnName: string

        Returns Promise<PrismaVectorStore<TModel, ModelName, TColumns, TFilters>>

  • fromTexts: (<TPrisma, TColumns>(texts, metadatas, embeddings, dbConfig) => Promise<DefaultPrismaVectorStore>)

    • • <TPrisma, TColumns>(texts, metadatas, embeddings, dbConfig): Promise<DefaultPrismaVectorStore>

      • Type Parameters

        • TPrisma extends PrismaNamespace

        • TColumns extends ModelColumns<TModel>

        Parameters

        • texts: string[]

        • metadatas: TModel[]

        • embeddings: EmbeddingsInterface

        • dbConfig: {
              columns: TColumns;
              prisma: TPrisma;
              tableName: keyof TPrisma["ModelName"] & string;
              vectorColumnName: string;
          }

          • columns: TColumns

          • prisma: TPrisma

          • tableName: keyof TPrisma["ModelName"] & string

          • vectorColumnName: string

        Returns Promise<DefaultPrismaVectorStore>