Make type signatures more consistent (#46)

not-pizza · Dec 26, 2024 · 25b1062 · 25b1062
1 parent c0b35e6
commit 25b1062
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -69,16 +69,16 @@ victor.clear_db().await.unwrap();
 victor
     .add_many(
         vec!["Pineapple", "Rocks"], // documents
-        vec!["PizzaToppings"],      // tags (only used for filtering)
+        vec!["Pizza Toppings"],     // tags (only used for filtering)
     )
     .await;
 
-victor.add("Cheese pizza", vec![]).await; // Add another entry with no tags
+victor.add("Cheese pizza", vec!["Pizza Flavors"]).await; // Add another entry with no tags
 
-// read the 10 closest results from victor that are tagged with "tags"
+// read the 10 closest results from victor that are tagged with "Pizza Toppings"
 // (only 2 will be returned because we only inserted two embeddings)
 let nearest = victor
-    .search("Hawaiian pizza", vec!["PizzaToppings"], 10)
+    .search("Hawaiian pizza", vec!["Pizza Toppings"], 10)
     .await
     .first()
     .unwrap()

diff --git a/examples/in_memory.rs b/examples/in_memory.rs
@@ -9,16 +9,16 @@ async fn main() {
     victor
         .add_many(
             vec!["Pineapple", "Rocks"], // documents
-            vec!["PizzaToppings"],      // tags (only used for filtering)
+            vec!["Pizza Toppings"],     // tags (only used for filtering)
         )
         .await;
 
-    victor.add("Cheese pizza", vec![]).await; // Add another entry with no tags
+    victor.add("Cheese pizza", vec!["Pizza Flavors"]).await; // Add another entry with no tags
 
-    // read the 10 closest results from victor that are tagged with "tags"
+    // read the 10 closest results from victor that are tagged with "Pizza Toppings"
     // (only 2 will be returned because we only inserted two embeddings)
     let nearest = victor
-        .search("Hawaiian pizza", vec!["PizzaToppings"], 10)
+        .search("Hawaiian pizza", vec!["Pizza Toppings"], 10)
         .await
         .first()
         .unwrap()

diff --git a/examples/native_filesystem.rs b/examples/native_filesystem.rs
@@ -12,16 +12,16 @@ async fn main() {
     victor
         .add_many(
             vec!["Pineapple", "Rocks"], // documents
-            vec!["PizzaToppings"],      // tags (only used for filtering)
+            vec!["Pizza Toppings"],     // tags (only used for filtering)
         )
         .await;
 
-    victor.add("Cheese pizza", vec![]).await; // Add another entry with no tags
+    victor.add("Cheese pizza", vec!["Pizza Flavors"]).await; // Add another entry with no tags
 
-    // read the 10 closest results from victor that are tagged with "tags"
+    // read the 10 closest results from victor that are tagged with "Pizza Toppings"
     // (only 2 will be returned because we only inserted two embeddings)
     let nearest = victor
-        .search("Hawaiian pizza", vec!["PizzaToppings"], 10)
+        .search("Hawaiian pizza", vec!["Pizza Toppings"], 10)
         .await
         .first()
         .unwrap()

diff --git a/src/db.rs b/src/db.rs
@@ -102,7 +102,7 @@ impl<D: DirectoryHandle> Victor<D> {
     /// Embedding will be generated for the document.
     /// When adding many documents, it is more efficient to use `add_many`.
     #[cfg(not(target_arch = "wasm32"))]
-    pub async fn add(&mut self, content: impl Into<String>, tags: Vec<String>) {
+    pub async fn add(&mut self, content: impl Into<String>, tags: Vec<impl Into<String>>) {
         self.add_many(vec![content], tags).await;
     }