couchbase-examples · teetangh · Nov 18, 2025
diff --git a/README.md b/README.md
@@ -3,8 +3,10 @@
 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.
 
 Each example provides two distinct approaches:
-- **FTS (Full Text Search)**: Uses Couchbase's vector search capabilities with pre-created search indices
-- **GSI (Global Secondary Index)**: Leverages Couchbase's native SQL++ queries with vector similarity functions
+- **Search Vector Index**: Uses Couchbase's Search-based vector search capabilities with pre-created search indices (in `search_based/` directories)
+- **Hyperscale & Composite Vector Indexes**: Leverages Couchbase's native SQL++ queries with vector similarity functions (in `query_based/` directories)
+
+For guidance on choosing the right vector index for your use case, see the [Couchbase documentation](https://docs.couchbase.com/server/current/vector-search/choose-the-right-vector-index.html).
 
 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.
 
@@ -33,11 +35,11 @@ Semantic search goes beyond simple keyword matching by understanding the context
 
 ### 2. Choose Your Approach:
 
-#### For FTS (Full Text Search) Examples:
-Use the provided `{model}_index.json` index definition file in each model's `fts/` directory to create a new vector search index in your Couchbase cluster.
+#### For Search Vector Index Examples:
+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.
 
-#### For GSI (Global Secondary Index) Examples:
-No additional setup required. GSI index will be created in each model's example.
+#### For Hyperscale & Composite Vector Index Examples:
+No additional setup required. Vector indexes will be created in each model's example in the `query_based/` directory.
 
 ### 3. Run the notebook file
 
@@ -75,9 +77,9 @@ Each notebook implements a semantic search function that performs similarity sea
 
 The system implements caching functionality using `CouchbaseCache` to improve performance for repeated queries.
 
-## Couchbase Vector Search Index (FTS Approach Only)
+## Couchbase Search Vector Index (Search-based Approach Only)
 
-For FTS 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.
+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.
 
 ```json
 {

diff --git a/awsbedrock/gsi/RAG_with_Couchbase_and_Bedrock.ipynb b/awsbedrock/gsi/RAG_with_Couchbase_and_Bedrock.ipynb
diff --git a/awsbedrock/gsi/.env.sample → awsbedrock/query_based/.env.sample b/awsbedrock/gsi/.env.sample → awsbedrock/query_based/.env.sample
diff --git a/awsbedrock/query_based/RAG_with_Couchbase_and_Bedrock.ipynb b/awsbedrock/query_based/RAG_with_Couchbase_and_Bedrock.ipynb
diff --git a/awsbedrock/gsi/frontmatter.md → awsbedrock/query_based/frontmatter.md b/awsbedrock/gsi/frontmatter.md → awsbedrock/query_based/frontmatter.md
diff --git a/awsbedrock/fts/.env.sample → awsbedrock/search_based/.env.sample b/awsbedrock/fts/.env.sample → awsbedrock/search_based/.env.sample
diff --git a/.../fts/RAG_with_Couchbase_and_Bedrock.ipynb → ...ased/RAG_with_Couchbase_and_Bedrock.ipynb b/.../fts/RAG_with_Couchbase_and_Bedrock.ipynb → ...ased/RAG_with_Couchbase_and_Bedrock.ipynb
diff --git a/awsbedrock/fts/frontmatter.md → awsbedrock/search_based/frontmatter.md b/awsbedrock/fts/frontmatter.md → awsbedrock/search_based/frontmatter.md
diff --git a/azure/fts/RAG_with_Couchbase_and_AzureOpenAI.ipynb b/azure/fts/RAG_with_Couchbase_and_AzureOpenAI.ipynb
diff --git a/azure/gsi/RAG_with_Couchbase_and_AzureOpenAI.ipynb b/azure/gsi/RAG_with_Couchbase_and_AzureOpenAI.ipynb
diff --git a/azure/gsi/.env.sample → azure/query_based/.env.sample b/azure/gsi/.env.sample → azure/query_based/.env.sample
diff --git a/azure/query_based/RAG_with_Couchbase_and_AzureOpenAI.ipynb b/azure/query_based/RAG_with_Couchbase_and_AzureOpenAI.ipynb
diff --git a/azure/gsi/frontmatter.md → azure/query_based/frontmatter.md b/azure/gsi/frontmatter.md → azure/query_based/frontmatter.md
diff --git a/azure/search_based/RAG_with_Couchbase_and_AzureOpenAI.ipynb b/azure/search_based/RAG_with_Couchbase_and_AzureOpenAI.ipynb
diff --git a/azure/fts/azure_index.json → azure/search_based/azure_index.json b/azure/fts/azure_index.json → azure/search_based/azure_index.json
diff --git a/azure/fts/frontmatter.md → azure/search_based/frontmatter.md b/azure/fts/frontmatter.md → azure/search_based/frontmatter.md
diff --git a/claudeai/fts/RAG_with_Couchbase_and_Claude(by_Anthropic).ipynb b/claudeai/fts/RAG_with_Couchbase_and_Claude(by_Anthropic).ipynb
diff --git a/claudeai/gsi/RAG_with_Couchbase_and_Claude(by_Anthropic).ipynb b/claudeai/gsi/RAG_with_Couchbase_and_Claude(by_Anthropic).ipynb
diff --git a/claudeai/gsi/.env.sample → claudeai/query_based/.env.sample b/claudeai/gsi/.env.sample → claudeai/query_based/.env.sample
diff --git a/claudeai/query_based/RAG_with_Couchbase_and_Claude(by_Anthropic).ipynb b/claudeai/query_based/RAG_with_Couchbase_and_Claude(by_Anthropic).ipynb
diff --git a/claudeai/gsi/frontmatter.md → claudeai/query_based/frontmatter.md b/claudeai/gsi/frontmatter.md → claudeai/query_based/frontmatter.md
diff --git a/claudeai/fts/.env.sample → claudeai/search_based/.env.sample b/claudeai/fts/.env.sample → claudeai/search_based/.env.sample
diff --git a/claudeai/search_based/RAG_with_Couchbase_and_Claude(by_Anthropic).ipynb b/claudeai/search_based/RAG_with_Couchbase_and_Claude(by_Anthropic).ipynb
diff --git a/claudeai/fts/claude_index.json → claudeai/search_based/claude_index.json b/claudeai/fts/claude_index.json → claudeai/search_based/claude_index.json
diff --git a/claudeai/fts/frontmatter.md → claudeai/search_based/frontmatter.md b/claudeai/fts/frontmatter.md → claudeai/search_based/frontmatter.md
diff --git a/cohere/fts/RAG_with_Couchbase_and_Cohere.ipynb b/cohere/fts/RAG_with_Couchbase_and_Cohere.ipynb
diff --git a/cohere/gsi/RAG_with_Couchbase_and_Cohere.ipynb b/cohere/gsi/RAG_with_Couchbase_and_Cohere.ipynb
diff --git a/cohere/gsi/.env.sample → cohere/query_based/.env.sample b/cohere/gsi/.env.sample → cohere/query_based/.env.sample
diff --git a/cohere/query_based/RAG_with_Couchbase_and_Cohere.ipynb b/cohere/query_based/RAG_with_Couchbase_and_Cohere.ipynb
diff --git a/cohere/gsi/frontmatter.md → cohere/query_based/frontmatter.md b/cohere/gsi/frontmatter.md → cohere/query_based/frontmatter.md
diff --git a/cohere/fts/.env.sample → cohere/search_based/.env.sample b/cohere/fts/.env.sample → cohere/search_based/.env.sample
diff --git a/cohere/search_based/RAG_with_Couchbase_and_Cohere.ipynb b/cohere/search_based/RAG_with_Couchbase_and_Cohere.ipynb
diff --git a/cohere/fts/cohere_index.json → cohere/search_based/cohere_index.json b/cohere/fts/cohere_index.json → cohere/search_based/cohere_index.json
diff --git a/cohere/fts/frontmatter.md → cohere/search_based/frontmatter.md b/cohere/fts/frontmatter.md → cohere/search_based/frontmatter.md
diff --git a/crewai-short-term-memory/fts/CouchbaseStorage_Demo.ipynb b/crewai-short-term-memory/fts/CouchbaseStorage_Demo.ipynb