Class VercelPostgres

Class that provides an interface to a Vercel Postgres vector database. It extends the VectorStore base class and implements methods for adding documents and vectors and performing similarity searches.

Hierarchy

VectorStore
- VercelPostgres

Properties

FilterType

FilterType: Metadata

client

client: VercelPoolClient

contentColumnName

contentColumnName: string

embeddings

embeddings: Embeddings

idColumnName

idColumnName: string

metadataColumnName

metadataColumnName: string

pool

pool: VercelPool

tableName

tableName: string

vectorColumnName

vectorColumnName: string

`Optional` filter

filter?: Metadata

Methods

addDocuments

addDocuments(documents, options?): Promise<string[]>
Method to add documents to the vector store. It converts the documents into vectors, and adds them to the store.
Parameters
- documents: Document<Record<string, any>>[]
  
  Array of Document instances.
- Optional options: {
  ids?: string[];
  }
  - Optional ids?: string[]
Returns Promise<string[]>
Promise that resolves when the documents have been added.
Overrides VectorStore.addDocuments
- Defined in docs/api_refs/langchain/src/vectorstores/vercel_postgres.ts:122

addVectors

addVectors(vectors, documents, options?): Promise<string[]>
Method to add vectors to the vector store. It converts the vectors into rows and inserts them into the database.
Parameters
- vectors: number[][]
  
  Array of vectors.
- documents: Document<Record<string, any>>[]
  
  Array of Document instances.
- Optional options: {
  ids?: string[];
  }
  - Optional ids?: string[]
Returns Promise<string[]>
Promise that resolves when the vectors have been added.
Overrides VectorStore.addVectors
- Defined in docs/api_refs/langchain/src/vectorstores/vercel_postgres.ts:193

asRetriever

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

delete

delete(params): Promise<void>
Parameters
- params: {
  deleteAll?: boolean;
  ids?: string[];
  }
  - Optional deleteAll?: boolean
  - Optional ids?: string[]
Returns Promise<void>
Overrides VectorStore.delete
- Defined in docs/api_refs/langchain/src/vectorstores/vercel_postgres.ts:302

end

end(): Promise<void>
Closes all the clients in the pool and terminates the pool.

Returns Promise<void>
Promise that resolves when all clients are closed and the pool is terminated.
- Defined in docs/api_refs/langchain/src/vectorstores/vercel_postgres.ts:391

ensureTableInDatabase

ensureTableInDatabase(): Promise<void>
Method to ensure the existence of the table in the database. It creates the table if it does not already exist.

Returns Promise<void>
Promise that resolves when the table has been ensured.
- Defined in docs/api_refs/langchain/src/vectorstores/vercel_postgres.ts:321

similaritySearch

similaritySearch(query, k?, filter?, _callbacks?): Promise<Document<Record<string, any>>[]>
Parameters
- query: string
- k: number = 4
- filter: undefined | Metadata = undefined
- _callbacks: undefined | Callbacks = undefined
Returns Promise<Document<Record<string, any>>[]>
Inherited from VectorStore.similaritySearch
- Defined in docs/api_refs/langchain/src/vectorstores/base.ts:180

similaritySearchVectorWithScore

similaritySearchVectorWithScore(query, k, filter?): Promise<[Document<Record<string, any>>, number][]>
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.
Parameters
- query: number[]
  
  Query vector.
- k: number
  
  Number of most similar documents to return.
- Optional filter: Metadata
  
  Optional filter to apply to the search.
Returns Promise<[Document<Record<string, any>>, number][]>
Promise that resolves with an array of tuples, each containing a Document and its similarity score.
Overrides VectorStore.similaritySearchVectorWithScore
- Defined in docs/api_refs/langchain/src/vectorstores/vercel_postgres.ts:246

similaritySearchWithScore

similaritySearchWithScore(query, k?, filter?, _callbacks?): Promise<[Document<Record<string, any>>, number][]>
Parameters
- query: string
- k: number = 4
- filter: undefined | Metadata = undefined
- _callbacks: undefined | Callbacks = undefined
Returns Promise<[Document<Record<string, any>>, number][]>
Inherited from VectorStore.similaritySearchWithScore
- Defined in docs/api_refs/langchain/src/vectorstores/base.ts:195

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<Metadata>
- _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<VercelPostgres>
Static method to create a new VercelPostgres instance from an array of Document instances. It adds the documents to the store.
Parameters
- docs: Document<Record<string, any>>[]
  
  Array of Document instances.
- embeddings: Embeddings
  
  Embeddings instance.
- Optional dbConfig: Partial<VercelPostgresFields> & {
  postgresConnectionOptions?: VercelPostgresPoolConfig;
  }
Returns Promise<VercelPostgres>
Promise that resolves with a new instance of VercelPostgres.
Overrides VectorStore.fromDocuments
- Defined in docs/api_refs/langchain/src/vectorstores/vercel_postgres.ts:373

`Static` fromTexts

fromTexts(texts, metadatas, embeddings, dbConfig?): Promise<VercelPostgres>
Static method to create a new VercelPostgres instance from an array of texts and their metadata. It converts the texts into Document instances and adds them to the store.
Parameters
- texts: string[]
  
  Array of texts.
- metadatas: object | object[]
  
  Array of metadata objects or a single metadata object.
- embeddings: Embeddings
  
  Embeddings instance.
- Optional dbConfig: Partial<VercelPostgresFields> & {
  postgresConnectionOptions?: VercelPostgresPoolConfig;
  }
Returns Promise<VercelPostgres>
Promise that resolves with a new instance of VercelPostgres.
Overrides VectorStore.fromTexts
- Defined in docs/api_refs/langchain/src/vectorstores/vercel_postgres.ts:343

`Static` initialize

initialize(embeddings, config?): Promise<VercelPostgres>
Static method to create a new VercelPostgres instance from a connection. It creates a table if one does not exist, and calls connect to return a new instance of VercelPostgres.
Parameters
- embeddings: Embeddings
  
  Embeddings instance.
- Optional config: Partial<VercelPostgresFields> & {
  postgresConnectionOptions?: VercelPostgresPoolConfig;
  }
Returns Promise<VercelPostgres>
A new instance of VercelPostgres.
- Defined in docs/api_refs/langchain/src/vectorstores/vercel_postgres.ts:92

`Protected` generatePlaceholderForRowAt

generatePlaceholderForRowAt(row, index): string
Generates the SQL placeholders for a specific row at the provided index.
Parameters
- row: (string | Record<string, any>)[]
- index: number
  
  The index of the row for which placeholders need to be generated.
Returns string
The SQL placeholders for the row values.
- Defined in docs/api_refs/langchain/src/vectorstores/vercel_postgres.ts:141

`Protected` runInsertQuery

runInsertQuery(rows, useIdColumn): Promise<QueryResult<any>>
Constructs the SQL query for inserting rows into the specified table.
Parameters
- rows: (string | Record<string, any>)[][]
  
  The rows of data to be inserted, consisting of values and records.
- useIdColumn: boolean
Returns Promise<QueryResult<any>>
The complete SQL INSERT INTO query string.
- Defined in docs/api_refs/langchain/src/vectorstores/vercel_postgres.ts:157

Class VercelPostgres

Hierarchy

Index

Properties

Methods

Properties

FilterType

client

contentColumnName

embeddings

idColumnName

metadataColumnName

pool

tableName

vectorColumnName

Optional filter

Methods

addDocuments

Parameters

documents: Document<Record<string, any>>[]

Optional options: { ids?: string[]; }

Optional ids?: string[]

Returns Promise<string[]>

addVectors

Parameters

vectors: number[][]

documents: Document<Record<string, any>>[]

Optional options: { ids?: string[]; }

Optional ids?: string[]

Returns Promise<string[]>

asRetriever

Parameters

Optional kOrFields: number | Partial<VectorStoreRetrieverInput<VercelPostgres>>

Optional filter: Metadata

Optional callbacks: Callbacks

Optional tags: string[]

Optional metadata: Record<string, unknown>

Optional verbose: boolean

Returns VectorStoreRetriever<VercelPostgres>

delete

Parameters

params: { deleteAll?: boolean; ids?: string[]; }

Optional deleteAll?: boolean

Optional ids?: string[]

Returns Promise<void>

end

Returns Promise<void>

ensureTableInDatabase

Returns Promise<void>

similaritySearch

Parameters

query: string

k: number = 4

filter: undefined | Metadata = undefined

_callbacks: undefined | Callbacks = undefined

Returns Promise<Document<Record<string, any>>[]>

similaritySearchVectorWithScore

Parameters

query: number[]

k: number

Optional filter: Metadata

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

similaritySearchWithScore

Parameters

query: string

k: number = 4

filter: undefined | Metadata = undefined

_callbacks: undefined | Callbacks = undefined

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

toJSON

Returns Serialized

toJSONNotImplemented

Returns SerializedNotImplemented

Optional maxMarginalRelevanceSearch

Parameters

query: string

options: MaxMarginalRelevanceSearchOptions<Metadata>

_callbacks: undefined | Callbacks

Returns Promise<Document<Record<string, any>>[]>

Static fromDocuments

`Optional` filter

`Optional` options: {
ids?: string[];
}

`Optional` ids?: string[]

`Optional` options: {
ids?: string[];
}

`Optional` ids?: string[]

`Optional` kOrFields: number | Partial<VectorStoreRetrieverInput<VercelPostgres>>

`Optional` filter: Metadata

`Optional` callbacks: Callbacks

`Optional` tags: string[]

`Optional` metadata: Record<string, unknown>

`Optional` verbose: boolean

params: {
deleteAll?: boolean;
ids?: string[];
}

`Optional` deleteAll?: boolean

`Optional` ids?: string[]

`Optional` filter: Metadata

`Optional` maxMarginalRelevanceSearch

`Static` fromDocuments

`Optional` dbConfig: Partial<VercelPostgresFields> & {
postgresConnectionOptions?: VercelPostgresPoolConfig;
}

`Static` fromTexts

`Optional` dbConfig: Partial<VercelPostgresFields> & {
postgresConnectionOptions?: VercelPostgresPoolConfig;
}

`Static` initialize

`Optional` config: Partial<VercelPostgresFields> & {
postgresConnectionOptions?: VercelPostgresPoolConfig;
}

`Protected` generatePlaceholderForRowAt

`Protected` runInsertQuery