PGVectorStore
Defined in: packages/providers/storage/postgres/src/PGVectorStore.ts:151
Provides support for writing and querying vector data in Postgres. Note: Can’t be used with data created using other Python vector store implementations
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PGVectorStore(
config):PGVectorStore
Defined in: packages/providers/storage/postgres/src/PGVectorStore.ts:164
Parameters
Section titled “Parameters”config
Section titled “config”Returns
Section titled “Returns”PGVectorStore
Overrides
Section titled “Overrides”Properties
Section titled “Properties”isEmbeddingQuery?
Section titled “isEmbeddingQuery?”
optionalisEmbeddingQuery:boolean
Defined in: packages/core/src/vector-store/index.ts:120
Inherited from
Section titled “Inherited from”BaseVectorStore.isEmbeddingQuery
storesText
Section titled “storesText”storesText:
boolean=true
Defined in: packages/providers/storage/postgres/src/PGVectorStore.ts:152
Overrides
Section titled “Overrides”Methods
Section titled “Methods”setCollection()
Section titled “setCollection()”setCollection(
coll):void
Defined in: packages/providers/storage/postgres/src/PGVectorStore.ts:199
Setter for the collection property. Using a collection allows for simple segregation of vector data, e.g. by user, source, or access-level. Leave/set blank to ignore the collection value when querying.
Parameters
Section titled “Parameters”string
Name for the collection.
Returns
Section titled “Returns”void
getCollection()
Section titled “getCollection()”getCollection():
string
Defined in: packages/providers/storage/postgres/src/PGVectorStore.ts:210
Getter for the collection property. Using a collection allows for simple segregation of vector data, e.g. by user, source, or access-level. Leave/set blank to ignore the collection value when querying.
Returns
Section titled “Returns”string
The currently-set collection value. Default is empty string.
client()
Section titled “client()”client():
Promise<IsomorphicDB>
Defined in: packages/providers/storage/postgres/src/PGVectorStore.ts:282
Connects to the database specified in environment vars. This method also checks and creates the vector extension, the destination table and indexes if not found.
Returns
Section titled “Returns”Promise<IsomorphicDB>
A connection to the database, or the error encountered while connecting/setting up.
Overrides
Section titled “Overrides”clearCollection()
Section titled “clearCollection()”clearCollection():
Promise<any[]>
Defined in: packages/providers/storage/postgres/src/PGVectorStore.ts:291
Delete all vector records for the specified collection. NOTE: Uses the collection property controlled by setCollection/getCollection.
Returns
Section titled “Returns”Promise<any[]>
The result of the delete query.
add(
embeddingResults):Promise<string[]>
Defined in: packages/providers/storage/postgres/src/PGVectorStore.ts:327
Adds vector record(s) to the table. NOTE: Uses the collection property controlled by setCollection/getCollection.
Parameters
Section titled “Parameters”embeddingResults
Section titled “embeddingResults”The Nodes to be inserted, optionally including metadata tuples.
Returns
Section titled “Returns”Promise<string[]>
A list of zero or more id values for the created records.
Overrides
Section titled “Overrides”delete()
Section titled “delete()”delete(
refDocId,deleteKwargs?):Promise<void>
Defined in: packages/providers/storage/postgres/src/PGVectorStore.ts:376
Deletes all nodes from the database that belong to the given document. NOTE: Uses the collection property controlled by setCollection/getCollection.
Parameters
Section titled “Parameters”refDocId
Section titled “refDocId”string
Reference document ID - all nodes with this ref_doc_id will be deleted.
deleteKwargs?
Section titled “deleteKwargs?”object
Required by VectorStore interface. Currently ignored.
Returns
Section titled “Returns”Promise<void>
Promise that resolves if the delete query did not throw an error.
Overrides
Section titled “Overrides”query()
Section titled “query()”query(
query,options?):Promise<VectorStoreQueryResult>
Defined in: packages/providers/storage/postgres/src/PGVectorStore.ts:511
Query the vector store for the closest matching data to the query embeddings
Parameters
Section titled “Parameters”The VectorStoreQuery to be used
options?
Section titled “options?”object
Required by VectorStore interface. Currently ignored.
Returns
Section titled “Returns”Promise<VectorStoreQueryResult>
Zero or more Document instances with data from the vector store.
Overrides
Section titled “Overrides”persist()
Section titled “persist()”persist(
persistPath):Promise<void>
Defined in: packages/providers/storage/postgres/src/PGVectorStore.ts:628
Required by VectorStore interface. Currently ignored.
Parameters
Section titled “Parameters”persistPath
Section titled “persistPath”string
Returns
Section titled “Returns”Promise<void>
Resolved Promise.
exists()
Section titled “exists()”exists(
refDocId):Promise<boolean>
Defined in: packages/providers/storage/postgres/src/PGVectorStore.ts:636
Check if any nodes exist for the given document reference ID. Used for de-duplication during ingestion.
Parameters
Section titled “Parameters”refDocId
Section titled “refDocId”string
The reference document ID to check
Returns
Section titled “Returns”Promise<boolean>
true if any nodes with this ref_doc_id exist