Skip to content

Commit bec396b

Browse files
committed
docs update
1 parent 98228b5 commit bec396b

2 files changed

Lines changed: 15 additions & 15 deletions

File tree

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ The library provides two document store implementations:
5757
- Use case: E-commerce, travel recommendations with complex search requirements
5858

5959
2. **`CouchbaseQueryDocumentStore`** - Uses Couchbase Global Secondary Index (GSI) with vector support
60-
- Supports both **Hyperscale Vector Index (BHIVE)** and **Composite Vector Index**
60+
- Supports both **Hyperscale Vector Index** and **Composite Vector Index**
6161
- Best for: Pure vector searches or filtered vector searches at massive scale
6262
- Dataset size: Tens of millions to billions of documents
6363
- Use case: Content recommendations, chatbots, anomaly detection, job searches
@@ -74,7 +74,7 @@ In addition to the document stores, the library includes the following [retrieve
7474

7575
- **`CouchbaseSearchEmbeddingRetriever`** - Works with `CouchbaseSearchDocumentStore` to perform hybrid searches combining vector similarity with full-text and geospatial queries.
7676

77-
- **`CouchbaseQueryEmbeddingRetriever`** - Works with `CouchbaseQueryDocumentStore` to perform high-performance vector similarity searches using GSI indexes (BHIVE or Composite).
77+
- **`CouchbaseQueryEmbeddingRetriever`** - Works with `CouchbaseQueryDocumentStore` to perform vector similarity searches using Hyperscale or Composite indexes.
7878

7979
The `couchbase-haystack` library uses the [Couchbase Python SDK](https://docs.couchbase.com/python-sdk/current/hello-world/start-using-sdk.html).
8080

@@ -84,9 +84,9 @@ Both document stores store Documents as JSON documents in Couchbase. Embeddings
8484

8585
Couchbase supports three types of vector indexes. This library currently supports two of them:
8686

87-
| Feature | CouchbaseSearchDocumentStore (FTS) | CouchbaseQueryDocumentStore (GSI - BHIVE) | CouchbaseQueryDocumentStore (GSI - Composite) |
87+
| Feature | CouchbaseSearchDocumentStore (FTS) | CouchbaseQueryDocumentStore (Hyperscale) | CouchbaseQueryDocumentStore (Composite) |
8888
|---------|-----------------------------------|-------------------------------------------|----------------------------------------------|
89-
| **Index Type** | Search Vector Index | Hyperscale Vector Index (BHIVE) | Composite Vector Index |
89+
| **Index Type** | Search Vector Index | Hyperscale Vector Index | Composite Vector Index |
9090
| **First Available** | Couchbase 7.6 | Couchbase 8.0 | Couchbase 8.0 |
9191
| **Dataset Size** | Up to ~100 million docs | Tens of millions to billions | Tens of millions to billions |
9292
| **Best For** | Hybrid searches (vector + text + geo) | Pure vector searches at scale | Filtered vector searches |
@@ -102,7 +102,7 @@ Couchbase supports three types of vector indexes. This library currently support
102102
- Your dataset is under 100 million documents
103103
- You want hybrid search capabilities in a single query
104104

105-
- **Use `CouchbaseQueryDocumentStore` with BHIVE (ANN search)** when:
105+
- **Use `CouchbaseQueryDocumentStore` with Hyperscale Index** when:
106106
- You need pure vector similarity searches at massive scale
107107
- You want the lowest memory footprint and best performance
108108
- Your application needs concurrent updates and searches
@@ -161,7 +161,7 @@ The `CouchbaseSearchDocumentStore` uses Couchbase's Search Service with FTS (Ful
161161
| |
162162
| +----------------+ |
163163
| | Data service | |
164-
write_documents | +----------------+ |
164+
write_documents | +----------------+ |
165165
+------------------------+----->| properties | |
166166
| | | | |
167167
+---------+--------------------+ | | embedding | |
@@ -391,7 +391,7 @@ documents: List[Document] = result["retriever"]["documents"]
391391

392392
### CouchbaseQueryDocumentStore (GSI-based)
393393

394-
The `CouchbaseQueryDocumentStore` uses Couchbase Global Secondary Index (GSI) for high-performance vector search at massive scale. Supports both **Hyperscale Vector Index (BHIVE)** and **Composite Vector Index** using SQL++ queries.
394+
The `CouchbaseQueryDocumentStore` uses Couchbase Global Secondary Index (GSI) for high-performance vector search at massive scale. Supports both **Hyperscale Vector Index** and **Composite Vector Index** using SQL++ queries.
395395

396396
```text
397397
+-----------------------------+
@@ -400,7 +400,7 @@ The `CouchbaseQueryDocumentStore` uses Couchbase Global Secondary Index (GSI) fo
400400
| |
401401
| +----------------+ |
402402
| | Data service | |
403-
write_documents | +----------------+ |
403+
write_documents | +----------------+ |
404404
+------------------------+----->| properties | |
405405
| | | | |
406406
+---------+--------------------+ | | embedding | |
@@ -411,8 +411,8 @@ The `CouchbaseQueryDocumentStore` uses Couchbase Global Secondary Index (GSI) fo
411411
| | +--------+--------+ |
412412
| | | Index service | |
413413
| | +-----------------+ |
414-
+----------------------->| | GSI | |
415-
query_embeddings | | BHIVE/Composite| |
414+
+----------------------->| | Hyperscale | |
415+
query_embeddings | | /Composite | |
416416
| | (for embedding) | |
417417
| +-----------------+ |
418418
| |
@@ -422,7 +422,7 @@ The `CouchbaseQueryDocumentStore` uses Couchbase Global Secondary Index (GSI) fo
422422
#### Key Features
423423

424424
- **Two Index Types Supported:**
425-
- **Hyperscale Vector Index (BHIVE)**: Optimized for pure vector searches, scales to billions of documents
425+
- **Hyperscale Vector Index**: Optimized for pure vector searches, scales to billions of documents
426426
- **Composite Vector Index**: Combines scalar and vector indexing for filtered searches
427427

428428
- **Search Types:**
@@ -443,8 +443,8 @@ from haystack.utils.auth import Secret
443443
from couchbase.n1ql import QueryScanConsistency
444444
from datetime import timedelta
445445

446-
# Example 1: Using BHIVE (Hyperscale Vector Index) for pure vector search
447-
document_store_bhive = CouchbaseQueryDocumentStore(
446+
# Example 1: Using (Hyperscale Vector Index) for pure vector search
447+
document_store_hyperscale = CouchbaseQueryDocumentStore(
448448
cluster_connection_string=Secret.from_env_var("CB_CONNECTION_STRING"),
449449
authenticator=CouchbasePasswordAuthenticator(
450450
username=Secret.from_env_var("CB_USERNAME"),
@@ -639,7 +639,7 @@ You can find more examples in the [examples](examples) directory:
639639

640640
#### GSI-based Examples
641641

642-
- [examples/gsi/indexing_pipeline.py](examples/gsi/indexing_pipeline.py) - Indexing documents using `CouchbaseQueryDocumentStore` with BHIVE or Composite indexes
642+
- [examples/gsi/indexing_pipeline.py](examples/gsi/indexing_pipeline.py) - Indexing documents using `CouchbaseQueryDocumentStore` with Hyperscale or Composite indexes
643643
- [examples/gsi/rag_pipeline.py](examples/gsi/rag_pipeline.py) - RAG pipeline using `CouchbaseQueryEmbeddingRetriever` for high-performance vector retrieval
644644

645645
## License

src/couchbase_haystack/components/retrievers/embedding_retriever.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ def run(
140140
class CouchbaseQueryEmbeddingRetriever:
141141
"""Retrieves documents from the CouchbaseQueryDocumentStore using vector similarity search.
142142
143-
Works with both Hyperscale Vector Index (BHIVE) and Composite Vector Index.
143+
Works with both Hyperscale Vector Index and Composite Vector Index.
144144
Supports ANN (approximate) and KNN (exact) search with various similarity metrics.
145145
See CouchbaseQueryDocumentStore for more details.
146146

0 commit comments

Comments
 (0)