Skip to content

Commit a9111dd

Browse files
committed
doc: add instalation guide and scores from BM25 x TSVector
1 parent 6cb1b92 commit a9111dd

File tree

1 file changed

+22
-10
lines changed
  • llama-index-integrations/vector_stores/llama-index-vector-store-paradedb

1 file changed

+22
-10
lines changed

llama-index-integrations/vector_stores/llama-index-vector-store-paradedb/README.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,17 @@
33
This module adds full ParadeDB integration enabling hybrid search with BM25 and vector similarity (HNSW) in PostgreSQL.
44

55
---
6+
# Testing Setup
67

7-
## Quick Setup
8+
## Installation
89

9-
---
10+
First, install the package:
11+
12+
```bash
13+
pip install llama-index-vector-stores-paradedb
14+
```
15+
16+
## Database Setup
1017

1118
### 1. **Setup example**
1219

@@ -77,14 +84,19 @@ def get_vector_store(table_name: str = "pgvector") -> ParadeDBVectorStore:
7784

7885
---
7986

80-
### Disclaimer
81-
82-
This integration was based on the Postgres Vector Store implementation:
83-
84-
**version = "0.5.5"**
85-
87+
### Results
8688

87-
However, **`customize_query_fn`** and other Postgres-specific query customization features are **not supported** in this ParadeDB version, as the focus here is on BM25 and hybrid retrieval.
89+
The following results demonstrate the difference between BM25 and TSVECTOR ranking methods:
8890

89-
Feel free to contribute and extend this module further.
91+
| Method | Rank | Node ID | Score |
92+
|--------|------|---------|--------|
93+
| TSVECTOR | Top1 | ccc | 0.060793 |
94+
| TSVECTOR | Top2 | ddd | 0.060793 |
95+
| BM25 | Top1 | ddd | 0.678537 |
96+
| BM25 | Top2 | ccc | 0.507418 |
9097

98+
**Key observations**:
99+
- BM25 produces higher similarity scores overall
100+
- BM25 shows more differentiation between results (0.678 vs 0.507)
101+
- TSVECTOR gives equal scores to both results (0.060793)
102+
- BM25 ranks 'ddd' higher than 'ccc', while TSVECTOR treats them equally

0 commit comments

Comments
 (0)