remote::pgvector

Description

PGVector is a remote vector database provider for OGX. It allows you to store and query vectors directly in memory. That means you'll get fast and efficient vector retrieval.

Features

• Easy to use
• Fully integrated with OGX

There are three implementations of search for PGVectoIndex available:

1. Vector Search:

• How it works:
  • Uses PostgreSQL's vector extension (pgvector) to perform similarity search
  • Compares query embeddings against stored embeddings using Cosine distance or other distance metrics
  • Eg. SQL query: SELECT document, embedding <=> %s::vector AS distance FROM table ORDER BY distance

-Characteristics:

• Semantic understanding - finds documents similar in meaning even if they don't share keywords
• Works with high-dimensional vector embeddings (typically 768, 1024, or higher dimensions)
• Best for: Finding conceptually related content, handling synonyms, cross-language search
• By default, OGX creates a HNSW (Hierarchical Navigable Small Worlds) index on a column "embedding" in a vector store table enabling production-ready, performant and scalable vector search for large datasets out of the box.

2. Keyword Search

• How it works:

  • Uses PostgreSQL's full-text search capabilities with tsvector and ts_rank
  • Converts text to searchable tokens using to_tsvector('english', text). Default language is English.
  • Eg. SQL query: SELECT document, ts_rank(tokenized_content, plainto_tsquery('english', %s)) AS score

• Characteristics:

  • Lexical matching - finds exact keyword matches and variations
  • Uses GIN (Generalized Inverted Index) for fast text search performance
  • Scoring: Uses PostgreSQL's ts_rank function for relevance scoring
  • Best for: Exact term matching, proper names, technical terms, Boolean-style queries

3. Hybrid Search

• How it works:

  • Combines both vector and keyword search results
  • Runs both searches independently, then merges results using configurable reranking

• Two reranking strategies available:

  • Reciprocal Rank Fusion (RRF) - (default: 60.0)
  • Weighted Average - (default: 0.5)

• Characteristics:

  • Best of both worlds: semantic understanding + exact matching
  • Documents appearing in both searches get boosted scores
  • Configurable balance between semantic and lexical matching
  • Best for: General-purpose search where you want both precision and recall

4. Database Schema

The PGVector implementation stores data optimized for all three search types: CREATE TABLE vector_store_xxx ( id TEXT PRIMARY KEY, document JSONB, -- Original document embedding vector(dimension), -- For vector search content_text TEXT, -- Raw text content tokenized_content TSVECTOR -- For keyword search );

Usage

To use PGVector in your OGX project, follow these steps:

1. Install the necessary dependencies.
2. Configure your OGX project to use pgvector. (e.g. remote::pgvector).
3. Start storing and querying vectors.

This is an example how you can set up your environment for using PGVector (you can use either Podman or Docker)

1. Export PGVector environment variables:

export PGVECTOR_DB=testvectordb
export PGVECTOR_HOST=localhost
export PGVECTOR_PORT=5432
export PGVECTOR_USER=user
export PGVECTOR_PASSWORD=password

2. Pull pgvector image with that tag you want:

Via Podman:

podman pull pgvector/pgvector:0.8.1-pg18-trixie

Via Docker:

docker pull pgvector/pgvector:0.8.1-pg18-trixie

3. Run container with PGVector:

Via Podman

podman run -d   --name pgvector   -e POSTGRES_PASSWORD=password   -e POSTGRES_USER=user   -e POSTGRES_DB=testvectordb   -p 5432:5432   -v pgvector_data:/var/lib/postgresql   pgvector/pgvector:0.8.1-pg18-trixie

Via Docker

docker run -d   --name pgvector   -e POSTGRES_PASSWORD=password   -e POSTGRES_USER=user   -e POSTGRES_DB=testvectordb   -p 5432:5432   -v pgvector_data:/var/lib/postgresql   pgvector/pgvector:0.8.1-pg18-trixie

Documentation

See PGVector's documentation for more details about PGVector in general.

Configuration

Field	Type	Required	Default	Description
host	str | None	No	localhost
port	int | None	No	5432
db	str | None	No	postgres
user	str | None	No	postgres
password	SecretStr | None	No
distance_metric	Literal[COSINE, L2, L1, INNER_PRODUCT] | None	No	COSINE	PGVector distance metric used for vector search in PGVectorIndex
vector_index	PGVectorHNSWVectorIndex | PGVectorIVFFlatVectorIndex | None	No	type=<PGVectorIndexType.HNSW: 'HNSW'> m=16 ef_construction=64 ef_search=40	PGVector vector index used for Approximate Nearest Neighbor (ANN) search
pool_min_size	int	No	4	Minimum number of connections in the asyncpg pool
pool_max_size	int	No	20	Maximum number of connections in the asyncpg pool
statement_cache_size	int	No	512	Size of the prepared statement cache per connection
command_timeout	float	No	30.0	Timeout in seconds for individual SQL statements
persistence	KVStoreReference | None	No		Config for KV store backend (SQLite only for now)
persistence.namespace	str	No		Key prefix for KVStore backends
persistence.backend	str	No		Name of backend from storage.backends
metadata_store	SqlStoreReference | None	No		SQL store reference for tenant-isolated vector store metadata
metadata_store.table_name	str	No		Name of the table to use for the SqlStore
metadata_store.backend	str	No		Name of backend from storage.backends

Sample Configuration

host: ${env.PGVECTOR_HOST:=localhost}
port: ${env.PGVECTOR_PORT:=5432}
db: ${env.PGVECTOR_DB}
user: ${env.PGVECTOR_USER}
password: ${env.PGVECTOR_PASSWORD}
distance_metric: COSINE
vector_index:
  type: HNSW
  m: 16
  ef_construction: 64
  ef_search: 40
persistence:
  namespace: vector_io::pgvector
  backend: kv_default