Add search_params: {} to client.entities.search() (#23)

* Add search_params: {} to client.entities.search()

* revert

Author: andreibondarev

CHANGELOG.md

@@ -1,5 +1,8 @@
 ## [Unreleased]
 
+## [0.10.4] - 2024-11-14
+- `client.entities.search()` now accepts `search_params: {}`
+
 ## [0.10.3] - 2024-10-01
 - Milvus::Client constructor accepts customer logger: to be passed in
 - Added Alias management

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    milvus (0.10.3)
+    milvus (0.10.4)
       faraday (>= 2.0.1, < 3)
 
 GEM

README.md

@@ -187,7 +187,15 @@ client.entities.search(
   collection_name: "example_collection",
   anns_field: "vectors",
   data: [embedding],
-  filter: "id in [450847466900987454]"
+  # filter: "id in [450847466900987454]",
+  search_params: {
+    # Other accepted values: "COSINE" or "IP"
+    # NOTE: metric_type must be the same as metric type used when index was created
+    metric_type: "L2",
+    params: {
+      radius: 0.1, range_filter: 0.8
+    }
+  },
 )
 ```
 ```ruby

lib/milvus/entities.rb

@@ -123,10 +123,13 @@ def search(
       collection_name:,
       data:,
       anns_field:,
+      filter: nil,
       limit: nil,
-      output_fields: [],
       offset: nil,
-      filter: nil
+      grouping_field: nil,
+      output_fields: [],
+      search_params: {},
+      partition_names: []
     )
       response = client.connection.post("#{PATH}/search") do |req|
         params = {
@@ -138,6 +141,10 @@ def search(
         params[:outputFields] = output_fields if output_fields.any?
         params[:offset] = offset if offset
         params[:filter] = filter if filter
+        params[:searchParams] = search_params if search_params.any?
+        params[:partitionNames] = partition_names if partition_names.any?
+        params[:groupingField] = groupingField if grouping_field
+
         req.body = params
       end
       response.body.empty? ? true : response.body

lib/milvus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Milvus
-  VERSION = "0.10.3"
+  VERSION = "0.10.4"
 end