Optional
filterMethod to add documents to the vector store. It converts the documents into vectors, and adds them to the store.
Array of Document
instances.
Optional
options: { Optional arguments for adding documents
Optional
ids?: string[]Promise that resolves when the documents have been added.
Method to add vectors to the vector store. It converts the vectors into rows and inserts them into the database.
Array of vectors.
Array of Document
instances.
Optional
options: { Optional arguments for adding documents
Optional
ids?: string[]Promise that resolves when the vectors have been added.
Optional
kOrFields: number | Partial<VectorStoreRetrieverInput<NeonPostgres>>Optional
filter: MetadataOptional
callbacks: CallbacksOptional
tags: string[]Optional
metadata: Record<string, unknown>Optional
verbose: booleanMethod to delete documents from the vector store. It deletes the documents that match the provided ids.
Optional
deleteOptional
ids?: string[]Promise that resolves when the documents have been deleted.
Optional
maxReturn documents selected using the maximal marginal relevance. Maximal marginal relevance optimizes for similarity to the query AND diversity among selected documents.
Text to look up documents similar to.
Protected
runConstructs the SQL query for inserting rows into the specified table.
The rows of data to be inserted, consisting of values and records.
The complete SQL INSERT INTO query string.
Method to perform a similarity search in the vector store. It returns
the k
most similar documents to the query vector, along with their
similarity scores.
Query vector.
Number of most similar documents to return.
Optional
filter: MetadataOptional filter to apply to the search.
Promise that resolves with an array of tuples, each containing a Document
and its similarity score.
Static
fromStatic method to create a new NeonPostgres
instance from an
array of Document
instances. It adds the documents to the store.
Array of Document
instances.
Embeddings instance.
NeonPostgreseArgs
instance.
Promise that resolves with a new instance of NeonPostgres
.
Static
fromStatic method to create a new NeonPostgres
instance from an
array of texts and their metadata. It converts the texts into
Document
instances and adds them to the store.
Array of texts.
Array of metadata objects or a single metadata object.
Embeddings instance.
NeonPostgresArgs
instance.
Promise that resolves with a new instance of NeonPostgresArgs
.
Static
initializeStatic method to create a new NeonPostgres
instance from a
connection. It creates a table if one does not exist.
Embeddings instance.
A new instance of NeonPostgres
.
Class that provides an interface to a Neon Postgres database. It extends the
VectorStore
base class and implements methods for adding documents and vectors, performing similarity searches, and ensuring the existence of a table in the database.