RDoc-3280 Update information about similarity threshold in vector search

Author: Danielle9897

Documentation/7.0/Raven.Documentation.Pages/ai-integration/vector-search/vector-search-using-dynamic-query.dotnet.markdown

@@ -131,12 +131,14 @@
 
 * **Minimum similarity**  
   You can specify the minimum similarity to use when searching for related vectors.  
-  Can be a value between `0.0f` and `1.0f`.  
-  A value closer to `1.0f` requires higher similarity between vectors,  
-  while a value closer to `0.0f` allows for less similarity.
+  The value can be between `0.0f` and `1.0f`.  
+    * A value closer to `1.0f` requires higher similarity between vectors,  
+      while a value closer to `0.0f` allows for less similarity.
+    * **Important**: To filter out less relevant results when performing vector search queries,  
+      it is recommended to explicitly specify the minimum similarity level at query time.
 
     If not specified, the default value is taken from the following configuration key:
-    [Indexing.Corax.VectorSearch.DefaultMinimumSimilarity ](../../server/configuration/indexing-configuration#indexing.corax.vectorsearch.defaultnumberofcandidatesforquerying).
+    [Indexing.Corax.VectorSearch.DefaultMinimumSimilarity](../../server/configuration/indexing-configuration#indexing.corax.vectorsearch.defaultnumberofcandidatesforquerying).
 
 * **Number of candidates**  
   You can specify the maximum number of vectors that RavenDB will return from a graph search.  
@@ -555,9 +557,7 @@ where vector.search(TagsEmbeddedAsSingle, $queryVector, 0.85, 10)
 from "Products"
 // The filtering condition:
 where (PricePerUnit > $minPrice)
-// The vector search here will execute with the default similarity (0.75f)
-// and the default NumberOfCandidates (16)
-and (vector.search(embedding.text(Name), $searchTerm))
+and (vector.search(embedding.text(Name), $searchTerm, 0.75, 16))
 { "minPrice" : 35.0, "searchTerm" : "italian food" }
   {CODE-TAB-BLOCK/}
   {CODE-TABS/}
@@ -571,7 +571,7 @@ and (vector.search(embedding.text(Name), $searchTerm))
   A larger _NumberOfCandidates_ increases the pool of documents considered,
   improving the chances of finding results that match both the vector search and the filter condition.
 
-* For example, in the above query, the vector search executes with the default params: Similarity `0.75f` and NumberOfCandidates `16`.
+* For example, in the above query, the vector search executes with: Similarity `0.75f` and NumberOfCandidates `16`.
   Running this query on RavenDB's sample data returns **2** documents. 
 
 * However, if you increase _NumberOfCandidates_, the query will retrieve more candidate documents before applying the filtering condition.
@@ -581,8 +581,8 @@ and (vector.search(embedding.text(Name), $searchTerm))
     {CODE-TAB-BLOCK:sql:RQL}
 from "Products"
 where (PricePerUnit > $minPrice)
-// Run vector search with default similarity and NumberOfCandidates 25
-and (vector.search(embedding.text(Name), $searchTerm, null, 25))
+// Run vector search with similarity 0.75 and NumberOfCandidates 25
+and (vector.search(embedding.text(Name), $searchTerm, 0.75, 25))
 { "minPrice" : 35.0, "searchTerm" : "italian food" }
     {CODE-TAB-BLOCK/}
     {CODE-TABS/}

Documentation/7.0/Raven.Documentation.Pages/server/configuration/indexing-configuration.markdown

@@ -556,7 +556,7 @@ when a static index is requested to index a complex JSON object.
 ---
 
 - **Type**: `float`
-- **Default**: `0.75f`
+- **Default**: `0f`
 - **Scope**: Server-wide, or per database, or per index
 
 {PANEL/}

Documentation/7.0/Samples/csharp/Raven.Documentation.Samples/AiIntegration/VectorSearch/VectorSearchUsingDynamicQuery.cs

@@ -34,7 +34,7 @@ public async Task Examples()
                             // Call 'ByText' 
                             // Provide the term for the similarity comparison
                             searchTerm => searchTerm.ByText("italian food"),
-                            // Optionally, specify the minimum similarity level
+                            // It is recommended to specify the minimum similarity level
                             0.82f,
                             // Optionally, specify the number of candidates for the search
                             20)
@@ -188,7 +188,7 @@ where vector.search(embedding.text(Name), $searchTerm, 0.82, 20)")
                             // Provide the vector for the similarity comparison
                             queryVector => queryVector.ByEmbedding(
                                 new RavenVector<float>(new float[] { 6.599999904632568f, 7.699999809265137f })),
-                            // Optionally, specify the minimum similarity level
+                            // It is recommended to specify the minimum similarity level
                             0.85f,
                             // Optionally, specify the number of candidates for the search
                             10)
@@ -417,7 +417,8 @@ where exact(vector.search(embedding.text(Name), $searchTerm))")
                          // Perform a vector search:
                         .VectorSearch(
                             field => field.WithText(x => x.Name),
-                            searchTerm => searchTerm.ByText("italian food"))
+                            searchTerm => searchTerm.ByText("italian food"),
+                            0.75f, 16)
                         .Customize(x => x.WaitForNonStaleResults())
                         .ToList();
                     #endregion
@@ -430,7 +431,8 @@ where exact(vector.search(embedding.text(Name), $searchTerm))")
                         .Where(x => x.PricePerUnit > 35)
                         .VectorSearch(
                             field => field.WithText(x => x.Name),
-                            searchTerm => searchTerm.ByText("italian food"))
+                            searchTerm => searchTerm.ByText("italian food"),
+                            0.75f, 16)
                         .Customize(x => x.WaitForNonStaleResults())
                         .ToListAsync();
                     #endregion
@@ -443,7 +445,8 @@ where exact(vector.search(embedding.text(Name), $searchTerm))")
                         .DocumentQuery<Product>()
                         .VectorSearch(
                             field => field.WithText(x => x.Name),
-                            searchTerm => searchTerm.ByText("italian food"))
+                            searchTerm => searchTerm.ByText("italian food"),
+                            0.75f, 16)
                         .WhereGreaterThan(x => x.PricePerUnit, 35)
                         .WaitForNonStaleResults()
                         .ToList();
@@ -457,7 +460,8 @@ where exact(vector.search(embedding.text(Name), $searchTerm))")
                         .AsyncDocumentQuery<Product>()
                         .VectorSearch(
                             field => field.WithText(x => x.Name),
-                            searchTerm => searchTerm.ByText("italian food"))
+                            searchTerm => searchTerm.ByText("italian food"),
+                            0.75f, 16)
                         .WhereGreaterThan(x => x.PricePerUnit, 35)
                         .WaitForNonStaleResults()
                         .ToListAsync();
@@ -470,7 +474,7 @@ where exact(vector.search(embedding.text(Name), $searchTerm))")
                     var similarProducts = session.Advanced
                         .RawQuery<Product>(@"
                             from 'Products'
-                            where (PricePerUnit > $minPrice) and (vector.search(embedding.text(Name), $searchTerm))")
+                            where (PricePerUnit > $minPrice) and (vector.search(embedding.text(Name), $searchTerm, 0.75, 16))")
                         .AddParameter("minPrice", 35.0)
                         .AddParameter("searchTerm", "italian food")
                         .WaitForNonStaleResults()
@@ -484,7 +488,7 @@ where exact(vector.search(embedding.text(Name), $searchTerm))")
                     var similarProducts = await asyncSession.Advanced
                         .AsyncRawQuery<Product>(@"
                             from 'Products'
-                            where (PricePerUnit > $minPrice) and (vector.search(embedding.text(Name), $searchTerm))")
+                            where (PricePerUnit > $minPrice) and (vector.search(embedding.text(Name), $searchTerm, 0.75, 16))")
                         .AddParameter("minPrice", 35.0)
                         .AddParameter("searchTerm", "italian food")
                         .WaitForNonStaleResults()
@@ -717,7 +721,7 @@ where vector.search(embedding.f32_i1(TagsEmbeddedAsSingle), $queryVector)")
                             // Call 'ByText' 
                             // Provide the search term for the similarity comparison
                             searchTerm => searchTerm.ByText("candy"),
-                            // Optionally, specify the minimum similarity level
+                            // It is recommended to specify the minimum similarity level
                             0.75f)
                         .Customize(x => x.WaitForNonStaleResults())
                         .ToList();