Class PrismaVectorStore<TModel, TModelName, TSelectModel, TFilterModel>

A specific implementation of the VectorStore class that is designed to work with Prisma. It provides methods for adding models, documents, and vectors, as well as for performing similarity searches.

Type Parameters

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

Hierarchy

VectorStore
- PrismaVectorStore

Constructors

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: Embeddings
- 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>
Overrides VectorStore.constructor
- Defined in docs/api_refs/langchain/src/vectorstores/prisma.ts:131

Properties

FilterType

FilterType: string | object

contentColumn

contentColumn: keyof TModel & string

embeddings

embeddings: Embeddings

idColumn

idColumn: keyof TModel & string

`Optional` filter

filter?: TFilterModel

`Static` ContentColumn

ContentColumn: typeof ContentColumnSymbol = ContentColumnSymbol

`Static` IdColumn

IdColumn: typeof IdColumnSymbol = IdColumnSymbol

`Protected` Prisma

Prisma: PrismaNamespace

`Protected` db

db: PrismaClient

`Protected` selectColumns

selectColumns: string[]

`Protected` tableName

tableName: string

`Protected` vectorColumnName

vectorColumnName: string

Methods

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.
Overrides VectorStore.addDocuments
- Defined in docs/api_refs/langchain/src/vectorstores/prisma.ts:277

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.
- Defined in docs/api_refs/langchain/src/vectorstores/prisma.ts:261

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.
Overrides VectorStore.addVectors
- Defined in docs/api_refs/langchain/src/vectorstores/prisma.ts:291

asRetriever

asRetriever(kOrFields?, filter?, callbacks?, tags?, metadata?, verbose?): VectorStoreRetriever<PrismaVectorStore<TModel, TModelName, TSelectModel, TFilterModel>>
Parameters
- Optional kOrFields: number | Partial<VectorStoreRetrieverInput<PrismaVectorStore<TModel, TModelName, TSelectModel, TFilterModel>>>
- Optional filter: string | object
- Optional callbacks: Callbacks
- Optional tags: string[]
- Optional metadata: Record<string, unknown>
- Optional verbose: boolean
Returns VectorStoreRetriever<PrismaVectorStore<TModel, TModelName, TSelectModel, TFilterModel>>
Inherited from VectorStore.asRetriever
- Defined in docs/api_refs/langchain/src/vectorstores/base.ts:252

buildSqlFilterStr

buildSqlFilterStr(filter?): null | Sql
Parameters
- Optional filter: TFilterModel
Returns null | Sql
- Defined in docs/api_refs/langchain/src/vectorstores/prisma.ts:407

delete

delete(_params?): Promise<void>
Parameters
- Optional _params: Record<string, any>
Returns Promise<void>
Inherited from VectorStore.delete
- Defined in docs/api_refs/langchain/src/vectorstores/base.ts:170

similaritySearch

similaritySearch(query, k?, _filter?, _callbacks?): 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 | string | object = undefined
  
  The filter to apply to the results.
- _callbacks: undefined | Callbacks = undefined
  
  The callbacks to use during the search.
Returns Promise<Document<SimilarityModel<TModel, TSelectModel>>[]>
A promise that resolves with the search results.
Overrides VectorStore.similaritySearch
- Defined in docs/api_refs/langchain/src/vectorstores/prisma.ts:317

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.
Overrides VectorStore.similaritySearchVectorWithScore
- Defined in docs/api_refs/langchain/src/vectorstores/prisma.ts:357

similaritySearchWithScore

similaritySearchWithScore(query, k?, filter?, _callbacks?): Promise<[Document<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.
- _callbacks: undefined | Callbacks = undefined
  
  The callbacks to use during the search.
Returns Promise<[Document<Record<string, any>>, number][]>
A promise that resolves with the search results and their scores.
Overrides VectorStore.similaritySearchWithScore
- Defined in docs/api_refs/langchain/src/vectorstores/prisma.ts:340

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from VectorStore.toJSON
- Defined in docs/api_refs/langchain/src/load/serializable.ts:148

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from VectorStore.toJSONNotImplemented
- Defined in docs/api_refs/langchain/src/load/serializable.ts:222

`Optional` maxMarginalRelevanceSearch

maxMarginalRelevanceSearch(query, options, _callbacks): Promise<Document<Record<string, any>>[]>
Return documents selected using the maximal marginal relevance. Maximal marginal relevance optimizes for similarity to the query AND diversity among selected documents.
Parameters
- query: string
  
  Text to look up documents similar to.
- options: MaxMarginalRelevanceSearchOptions<string | object>
- _callbacks: undefined | Callbacks
Returns Promise<Document<Record<string, any>>[]>
- List of documents selected by maximal marginal relevance.
Inherited from VectorStore.maxMarginalRelevanceSearch
- Defined in docs/api_refs/langchain/src/vectorstores/base.ts:223

`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: Embeddings
  
  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.
Overrides VectorStore.fromDocuments
- Defined in docs/api_refs/langchain/src/vectorstores/prisma.ts:464

`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: Embeddings
  
  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.
Overrides VectorStore.fromTexts
- Defined in docs/api_refs/langchain/src/vectorstores/prisma.ts:432

`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: Embeddings
      
      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: Embeddings
      
      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: Embeddings
      
      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>
- Defined in docs/api_refs/langchain/src/vectorstores/prisma.ts:176

Class PrismaVectorStore<TModel, TModelName, TSelectModel, TFilterModel>

Type Parameters

TModel extends Record<string, unknown>

TModelName extends string

TSelectModel extends ModelColumns<TModel>

TFilterModel extends PrismaSqlFilter<TModel>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

TModel extends Record<string, unknown>

TModelName extends string

TSelectModel extends ModelColumns<TModel>

TFilterModel extends PrismaSqlFilter<TModel>

Parameters

embeddings: Embeddings

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>

Properties

FilterType

contentColumn

embeddings

idColumn

Optional filter

Static ContentColumn

Static IdColumn

Protected Prisma

Protected db

Protected selectColumns

Protected tableName

Protected vectorColumnName

Methods

addDocuments

Parameters

documents: Document<TModel>[]

Returns Promise<void>

addModels

Parameters

models: TModel[]

Returns Promise<void>

addVectors

Parameters

vectors: number[][]

documents: Document<TModel>[]

Returns Promise<void>

asRetriever

Parameters

Optional kOrFields: number | Partial<VectorStoreRetrieverInput<PrismaVectorStore<TModel, TModelName, TSelectModel, TFilterModel>>>

Optional filter: string | object

Optional callbacks: Callbacks

Optional tags: string[]

Optional metadata: Record<string, unknown>

Optional verbose: boolean

Returns VectorStoreRetriever<PrismaVectorStore<TModel, TModelName, TSelectModel, TFilterModel>>

buildSqlFilterStr

Parameters

Optional filter: TFilterModel

Returns null | Sql

delete

Parameters

Optional _params: Record<string, any>

Returns Promise<void>

similaritySearch

Parameters

query: string

k: number = 4

_filter: undefined | string | object = undefined

_callbacks: undefined | Callbacks = undefined

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

similaritySearchVectorWithScore

config: {
columns: TSelectModel;
db: PrismaClient;
prisma: PrismaNamespace;
tableName: TModelName;
vectorColumnName: string;
filter?: TFilterModel;
}

`Optional` filter?: TFilterModel

`Optional` filter

`Static` ContentColumn

`Static` IdColumn

`Protected` Prisma

`Protected` db

`Protected` selectColumns

`Protected` tableName

`Protected` vectorColumnName

`Optional` kOrFields: number | Partial<VectorStoreRetrieverInput<PrismaVectorStore<TModel, TModelName, TSelectModel, TFilterModel>>>

`Optional` filter: string | object

`Optional` callbacks: Callbacks

`Optional` tags: string[]

`Optional` metadata: Record<string, unknown>

`Optional` verbose: boolean

`Optional` filter: TFilterModel

`Optional` _params: Record<string, any>

`Optional` filter: TFilterModel

`Optional` k: number

`Optional` filter: TFilterModel

`Optional` maxMarginalRelevanceSearch

`Static` fromDocuments

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

`Static` fromTexts

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

`Static` withModel

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

`Optional` filter?: TFilters