Skip to content

Commit eaaa298

Browse files
Refactor README section headers for consistency
Updated section headers to use consistent formatting and improved clarity in the README.
1 parent 79d2f3e commit eaaa298

1 file changed

Lines changed: 18 additions & 18 deletions

File tree

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Semantic Search with Couchbase Vector Store and LLM Integration
1+
# Semantic Search with Couchbase Vector Store and LLM Integration
22

33
This repository demonstrates how to build a powerful semantic search engine using Couchbase as the backend database, combined with various AI-powered embedding and language model providers such as OpenAI, Azure OpenAI, Anthropic (Claude), Cohere, Hugging Face, Jina AI, Mistral AI, and Voyage AI.
44

@@ -8,45 +8,45 @@ Each example provides two distinct approaches:
88

99
Semantic search goes beyond simple keyword matching by understanding the context and meaning behind the words in a query, making it essential for applications that require intelligent information retrieval.
1010

11-
### Features
11+
## Features
1212

1313
- **Multiple Embedding Models**: Support for embeddings from OpenAI, Azure OpenAI, Anthropic (Claude), Cohere, Hugging Face, Jina AI, Mistral AI, and Voyage AI.
1414
- **Couchbase Vector Store**: Utilizes Couchbase's vector storage capabilities for efficient similarity search.
1515
- **Retrieval-Augmented Generation (RAG)**: Integrates with advanced language models like GPT-4 for generating contextually relevant responses.
1616
- **Scalable and Flexible**: Easy to switch between different embedding models and adjust the index structure accordingly.
1717
- **Caching Mechanism**: Implements `CouchbaseCache` for improved performance on repeated queries.
1818

19-
### Prerequisites
19+
## Prerequisites
2020

2121
- Python 3.8+
22-
- Couchbase Cluster (Self Managed or Capella) version 7.6+ with [Search Service](https://docs.couchbase.com/server/current/search/search.html)
22+
- Couchbase Cluster (Self Managed or Capella) version 8.0+ with [Search Service](https://docs.couchbase.com/server/current/search/search.html)
2323

2424
- API keys for the respective AI providers (e.g., OpenAI, Azure OpenAI, Anthropic, Cohere, etc.)
2525

26-
### Setup
26+
## Setup
2727

28-
#### 1. Clone the repository:
28+
### 1. Clone the repository:
2929
```bash
3030
git clone https://github.com/your-username/vector-search-cookbook.git
3131
cd vector-search-cookbook
3232
```
3333

34-
#### 2. Choose Your Approach:
34+
### 2. Choose Your Approach:
3535

36-
##### For Search Vector Index Examples:
36+
#### For Search Vector Index Examples:
3737
Use the provided `{model}_index.json` index definition file in each model's `search_based/` directory to create a new vector search index in your Couchbase cluster.
3838

39-
##### For Hyperscale Vector Index, Composite Vector Index Examples:
39+
#### For Hyperscale Vector Index, Composite Vector Index Examples:
4040
No additional setup required. Hyperscale and Composite Vector Indexes will be created in each model's example.
4141

42-
#### 3. Run the notebook file
42+
### 3. Run the notebook file
4343

4444
You can either run the notebook file on [Google Colab](https://colab.research.google.com/) or run it on your system by setting up the Python environment.
4545

4646

47-
### Components
47+
## Components
4848

49-
#### 1. Multiple Embedding Models
49+
### 1. Multiple Embedding Models
5050

5151
The system supports embeddings from various AI providers:
5252

@@ -59,23 +59,23 @@ The system supports embeddings from various AI providers:
5959
* Mistral AI
6060
* Voyage AI
6161

62-
#### 2. Couchbase Vector Store
62+
### 2. Couchbase Vector Store
6363

6464
Couchbase is used to store document embeddings and metadata. The index structure allows for efficient retrieval across different embedding types.
6565

66-
#### 3. Retrieval-Augmented Generation (RAG)
66+
### 3. Retrieval-Augmented Generation (RAG)
6767

6868
The RAG pipeline integrates with language models like GPT-4 to generate contextually relevant answers based on retrieved documents.
6969

70-
#### 4. Semantic Search
70+
### 4. Semantic Search
7171

72-
Each notebook implements a semantic search function that performs similarity searche using the appropriate embedding type and retrieves the top-k most similar documents.
72+
Each notebook implements a semantic search function that performs similarity search using the appropriate embedding type and retrieves the top-k most similar documents.
7373

74-
#### 5. Caching
74+
### 5. Caching
7575

7676
The system implements caching functionality using `CouchbaseCache` to improve performance for repeated queries.
7777

78-
### Couchbase Search Vector Index
78+
## Couchbase Search Vector Index
7979

8080
For Search Vector Index examples, you'll need to create a vector search index using the provided JSON configuration files. For more information on creating a vector search index, please follow the [instructions](https://docs.couchbase.com/cloud/vector-search/create-vector-search-index-ui.html). The following is an example for Azure OpenAI Model.
8181

0 commit comments

Comments
 (0)