Skip to content

Commit 1a81f26

Browse files
committed
docs update
1 parent 2ff30f9 commit 1a81f26

3 files changed

Lines changed: 15 additions & 15 deletions

File tree

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@
2525
- [Installation](#installation)
2626
- [Usage](#usage)
2727
- [Running Couchbase](#running-couchbase)
28-
- [CouchbaseSearchDocumentStore (FTS-based)](#couchbasesearchdocumentstore-fts-based)
29-
- [CouchbaseQueryDocumentStore (GSI-based)](#couchbasequerydocumentstore-gsi-based)
28+
- [CouchbaseSearchDocumentStore (Search-based)](#couchbasesearchdocumentstore-search-based)
29+
- [CouchbaseQueryDocumentStore (Query-based)](#couchbasequerydocumentstore-query-based)
3030
- [More Examples](#more-examples)
3131
- [License](#license)
3232

@@ -49,7 +49,7 @@ by [deepset](https://www.deepset.ai). Couchbase supports three types of [vector
4949

5050
The library provides two document store implementations:
5151

52-
- **`CouchbaseSearchDocumentStore`** - Uses Couchbase Search Vector Index (FTS-based)
52+
- **`CouchbaseSearchDocumentStore`** - Uses Couchbase Search Vector Index (Search-based)
5353
- **`CouchbaseQueryDocumentStore`** - Uses Hyperscale Vector Index or Composite Vector Index
5454

5555
You can start working with these implementations by importing from the `couchbase_haystack` package:
@@ -74,15 +74,15 @@ Both document stores store Documents as JSON documents in Couchbase. Embeddings
7474

7575
Couchbase supports three types of vector indexes. This library currently supports two of them:
7676

77-
| Feature | CouchbaseSearchDocumentStore (FTS) | CouchbaseQueryDocumentStore (Hyperscale) | CouchbaseQueryDocumentStore (Composite) |
77+
| Feature | CouchbaseSearchDocumentStore (Search) | CouchbaseQueryDocumentStore (Hyperscale) | CouchbaseQueryDocumentStore (Composite) |
7878
|---------|-----------------------------------|-------------------------------------------|----------------------------------------------|
7979
| **Index Type** | Search Vector Index | Hyperscale Vector Index | Composite Vector Index |
8080
| **First Available** | Couchbase 7.6 | Couchbase 8.0 | Couchbase 8.0 |
8181
| **Dataset Size** | Up to ~100 million docs | Tens of millions to billions | Tens of millions to billions |
8282
| **Best For** | Hybrid searches (vector + text + geo) | Pure vector searches at scale | Filtered vector searches |
83-
| **Strengths** | - Full-text search integration<br>- Geospatial search<br>- Familiar FTS indexes | - High performance for pure vector searches<br>- Low memory footprint<br>- Best for huge datasets<br>- Concurrent updates & searches | - Scalar filters before vector search<br>- Efficient for selective queries<br>- Compliance use cases |
83+
| **Strengths** | - Full-text search integration<br>- Geospatial search<br>- Familiar Search indexes | - High performance for pure vector searches<br>- Low memory footprint<br>- Best for huge datasets<br>- Concurrent updates & searches | - Scalar filters before vector search<br>- Efficient for selective queries<br>- Compliance use cases |
8484
| **Use Cases** | - E-commerce product search<br>- Travel recommendations<br>- Real estate searches | - Chatbot context (RAG)<br>- Reverse image search<br>- Anomaly detection | - Content recommendations with filters<br>- Job searches<br>- Supply chain management |
85-
| **Search Type** | Vector + FTS + Geospatial | ANN (Approximate Nearest Neighbor) or KNN | ANN or KNN|
85+
| **Search Type** | Vector + Full-Text + Geospatial | ANN (Approximate Nearest Neighbor) or KNN | ANN or KNN|
8686
| **Filtering** | Search query filters | SQL++ WHERE clause | SQL++ WHERE clause|
8787

8888
### When to Use Each
@@ -140,7 +140,7 @@ In this example, the container is started using Couchbase Server version `7.6.2`
140140
> **Note:**
141141
> Assuming you have a Docker container running, navigate to <http://localhost:8091> to open the Couchbase Web Console and explore your data.
142142
143-
### CouchbaseSearchDocumentStore (FTS-based)
143+
### CouchbaseSearchDocumentStore (Search-based)
144144

145145
```text
146146
+-----------------------------+
@@ -160,7 +160,7 @@ In this example, the container is started using Couchbase Server version `7.6.2`
160160
| | +--------+--------+ |
161161
| | | Search service | |
162162
| | +-----------------+ |
163-
+----------------------->| | FTS | |
163+
+----------------------->| | Search | |
164164
query_embeddings | | Vector Index | |
165165
| | (for embedding) | |
166166
| +-----------------+ |
@@ -314,7 +314,7 @@ indexing_pipeline.run({"embedder": {"documents": documents}})
314314

315315
#### Retrieving Documents with CouchbaseSearchEmbeddingRetriever
316316

317-
`CouchbaseSearchEmbeddingRetriever` component can be used to retrieve documents from Couchbase by querying the FTS vector index using an embedded query. Below is a pipeline which finds documents using query embedding:
317+
`CouchbaseSearchEmbeddingRetriever` component can be used to retrieve documents from Couchbase by querying the Search vector index using an embedded query. Below is a pipeline which finds documents using query embedding:
318318

319319
```python
320320
from typing import List
@@ -377,7 +377,7 @@ documents: List[Document] = result["retriever"]["documents"]
377377

378378
---
379379

380-
### CouchbaseQueryDocumentStore (GSI-based)
380+
### CouchbaseQueryDocumentStore (Query-based)
381381

382382
The `CouchbaseQueryDocumentStore` supports both **Hyperscale Vector Index** and **Composite Vector Index** types, depending on the underlying indexes you have set up in Couchbase.
383383

@@ -450,7 +450,7 @@ document_store_hyperscale = CouchbaseQueryDocumentStore(
450450
)
451451
```
452452

453-
> **Note:** You need to create the appropriate GSI index manually in Couchbase before performing vector search. See the [Couchbase documentation](https://docs.couchbase.com/server/current/n1ql/n1ql-language-reference/createindex.html) for index creation details.
453+
> **Note:** You need to create the appropriate Hyperscale Vector Index or Composite Vector Index manually in Couchbase before performing vector search. See the [Couchbase documentation](https://docs.couchbase.com/server/current/n1ql/n1ql-language-reference/createindex.html) for index creation details.
454454
455455
#### Indexing Documents with CouchbaseQueryDocumentStore
456456

@@ -604,15 +604,15 @@ result_custom = pipeline.run(
604604

605605
You can find more examples in the [examples](examples) directory:
606606

607-
#### Search-based (FTS) Examples
607+
#### Search-based Examples
608608

609609
- [examples/search/indexing_pipeline.py](examples/search/indexing_pipeline.py) - Indexing documents using `CouchbaseSearchDocumentStore`
610610
- [examples/search/rag_pipeline.py](examples/search/rag_pipeline.py) - RAG pipeline using `CouchbaseSearchEmbeddingRetriever` with [HuggingFaceAPIGenerator](https://docs.haystack.deepset.ai/v2.20/docs/huggingfacetgigenerator)
611611

612-
#### GSI-based Examples
612+
#### Query-based Examples
613613

614-
- [examples/gsi/indexing_pipeline.py](examples/gsi/indexing_pipeline.py) - Indexing documents using `CouchbaseQueryDocumentStore` with Hyperscale or Composite indexes
615-
- [examples/gsi/rag_pipeline.py](examples/gsi/rag_pipeline.py) - RAG pipeline using `CouchbaseQueryEmbeddingRetriever` for high-performance vector retrieval
614+
- [examples/query/indexing_pipeline.py](examples/query/indexing_pipeline.py) - Indexing documents using `CouchbaseQueryDocumentStore` with Hyperscale or Composite indexes
615+
- [examples/query/rag_pipeline.py](examples/query/rag_pipeline.py) - RAG pipeline using `CouchbaseQueryEmbeddingRetriever` for high-performance vector retrieval
616616

617617
## License
618618

0 commit comments

Comments
 (0)