1- # Memory Bank Client
1+ # Semantic Search Client
22
3- A powerful Rust library for managing semantic memory contexts with vector embeddings, enabling advanced semantic search capabilities across text and code.
3+ Rust library for managing semantic memory contexts with vector embeddings, enabling semantic search capabilities across text and code.
44
5- [ ![ Crate] ( https://img.shields.io/crates/v/memory_bank_client .svg )] ( https://crates.io/crates/memory_bank_client )
6- [ ![ Documentation] ( https://docs.rs/memory_bank_client /badge.svg )] ( https://docs.rs/memory_bank_client )
5+ [ ![ Crate] ( https://img.shields.io/crates/v/semantic_search_client .svg )] ( https://crates.io/crates/semantic_search_client )
6+ [ ![ Documentation] ( https://docs.rs/semantic_search_client /badge.svg )] ( https://docs.rs/semantic_search_client )
77
88## Features
99
@@ -23,18 +23,18 @@ Add this to your `Cargo.toml`:
2323
2424``` toml
2525[dependencies ]
26- memory_bank_client = " 0.1.0"
26+ semantic_search_client = " 0.1.0"
2727```
2828
2929## Quick Start
3030
3131``` rust
32- use memory_bank_client :: {MemoryBankClient , Result };
32+ use semantic_search_client :: {SemanticSearchClient , Result };
3333use std :: path :: Path ;
3434
3535fn main () -> Result <()> {
3636 // Create a new memory bank client with default settings
37- let mut client = MemoryBankClient :: new_with_default_dir ()? ;
37+ let mut client = SemanticSearchClient :: new_with_default_dir ()? ;
3838
3939 // Add a context from a directory
4040 let context_id = client . add_context_from_path (
@@ -107,14 +107,14 @@ Text is converted to vector embeddings using state-of-the-art embedding models:
107107
108108``` rust
109109// With default directory (~/.memory_bank)
110- let client = MemoryBankClient :: new_with_default_dir ()? ;
110+ let client = SemanticSearchClient :: new_with_default_dir ()? ;
111111
112112// With custom directory
113- let client = MemoryBankClient :: new (" /path/to/storage" )? ;
113+ let client = SemanticSearchClient :: new (" /path/to/storage" )? ;
114114
115115// With specific embedding type
116- use memory_bank_client :: embedding :: EmbeddingType ;
117- let client = MemoryBankClient :: new_with_embedding_type (EmbeddingType :: Candle )? ;
116+ use semantic_search_client :: embedding :: EmbeddingType ;
117+ let client = SemanticSearchClient :: new_with_embedding_type (EmbeddingType :: Candle )? ;
118118```
119119
120120### Adding Contexts
@@ -217,14 +217,14 @@ The library supports different embedding backends:
217217
218218``` rust
219219// Use Candle (works on all platforms)
220- let client = MemoryBankClient :: with_embedding_type (
220+ let client = SemanticSearchClient :: with_embedding_type (
221221 " /path/to/storage" ,
222222 EmbeddingType :: Candle ,
223223)? ;
224224
225225// Use ONNX (macOS and Windows only)
226226#[cfg(any(target_os = " macos" , target_os = " windows" ))]
227- let client = MemoryBankClient :: with_embedding_type (
227+ let client = SemanticSearchClient :: with_embedding_type (
228228 " /path/to/storage" ,
229229 EmbeddingType :: Onnx ,
230230)? ;
@@ -244,7 +244,7 @@ rayon::ThreadPoolBuilder::new()
244244 . unwrap ();
245245
246246// The client will use the configured thread pool
247- let client = MemoryBankClient :: new_with_default_dir ()? ;
247+ let client = SemanticSearchClient :: new_with_default_dir ()? ;
248248```
249249
250250## Performance Considerations
@@ -265,10 +265,10 @@ let client = MemoryBankClient::new_with_default_dir()?;
265265The library uses a custom error type ` MemoryBankError ` that implements the standard ` Error ` trait:
266266
267267``` rust
268- use memory_bank_client :: {MemoryBankClient , MemoryBankError , Result };
268+ use semantic_search_client :: {SemanticSearchClient , MemoryBankError , Result };
269269
270270fn process () -> Result <()> {
271- let client = MemoryBankClient :: new_with_default_dir ()? ;
271+ let client = SemanticSearchClient :: new_with_default_dir ()? ;
272272
273273 // Handle specific error types
274274 match client . search_context (" invalid-id" , " query" , 5 ) {
0 commit comments