Class VercelPostgres

FilterType

client

contentColumnName

idColumnName

metadataColumnName

pool

tableName

vectorColumnName

Optional filter

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.

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.

delete

• delete(params): Promise<void>

• Parameters

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

    • Optional deleteAll?: boolean

    • Optional ids?: string[]

  Returns Promise<void>

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.

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.

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.

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: EmbeddingsInterface

    Embeddings instance.

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

  Returns Promise<VercelPostgres>

  Promise that resolves with a new instance of VercelPostgres.

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: EmbeddingsInterface

    Embeddings instance.

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

  Returns Promise<VercelPostgres>

  Promise that resolves with a new instance of VercelPostgres.

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: EmbeddingsInterface

    Embeddings instance.

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

  Returns Promise<VercelPostgres>

  A new instance of VercelPostgres.