milvus 0.10.2 → 0.10.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c38f7235b815b1f48dd2d61e445b99ca675f974d1dddeba02796bf02e353fdd1
-  data.tar.gz: 4af6a551675f63cb17ee6f2c80a8ca000ea98ff028eeefa71f9593061ac04969
+  metadata.gz: 3a102d183738bf441d38553fc3943694001a7ecb982eb901f29ee79c4469c2ee
+  data.tar.gz: cb74c717b5a8e3139008898f49564a1310d31dd769f6a7d46df1d0ffa2319c2e
 SHA512:
-  metadata.gz: 37d2666740b3e9df096e5f8b024a72fff37b60c53810f8dcbd5f0b14c4a008060d5cad78109664b74d7e2e76d21c8559cbb6c079b046032acd09491c5a3c3109
-  data.tar.gz: 7c10d887561876c02e6f869807b01c339b2412137e3cefb584ce5451da815eafec06f5c4ea83bbd231862b9742aad08d711566a2660193016b9eb809eca7798b
+  metadata.gz: a7a999cfca2e7e1b4b07409d3d84cca940feb6a7a18d1648f780414c5d9f5d1c9cdf9fd199c93daddae7986b923cfafc0add8e7ca325dc69c94310115de19bc4
+  data.tar.gz: 97cb86b1f045c9cb19cad3a42d827bd1eafff9e7036970c2b6ce3cc6e457fba519afbb1ba68bf4c7f40b90d4e64c0a41e0bd75a8954dd87dd59603f5cad33c89

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [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
+
 ## [0.10.2] - 2024-07-28
 - Added Roles management
 - Added Users management

data/Gemfile.lock

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

data/README.md

@@ -22,11 +22,6 @@ Available for paid consulting engagements! [Email me](mailto:andrei@sourcelabs.i
 ## API Docs
 https://docs.zilliz.com/reference/restful/data-plane-v2
 
-## TODOs
-- [X] Support for [User endpoints](https://docs.zilliz.com/reference/restful/user-operations-v2)
-- [X] Support for [Role endpoints](https://docs.zilliz.com/reference/restful/role-operations-v2)
-- [ ] Support for [Alias endpoints](https://docs.zilliz.com/reference/restful/alias-operations-v2)
-
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -134,7 +129,7 @@ client.entities.insert(
 # Delete the entities with the boolean expression you created
 client.entities.delete(
   collection_name: "example_collection",
-  expression: "book_id in [0,1]"
+  filter: "book_id in [0,1]"
 )
 ```
 ```ruby
@@ -192,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
@@ -311,6 +314,27 @@ client.users.grant_role(user_name: 'user_name', role_name: 'admin')
 # Revoke role from the user 
 client.users.revoke_role(user_name: 'user_name', role_name: 'admin')
 ```
+### Aliases
+```ruby
+# Lists all existing collection aliases in the specified database
+client.aliases.list
+```
+```ruby
+# Describes the details of a specific alias
+client.aliases.describe
+```
+```ruby
+# Reassigns the alias of one collection to another.
+client.aliases.alter
+```
+```ruby
+# Drops a specified alias
+client.aliases.drop
+```
+```ruby
+# Creates an alias for an existing collection
+client.aliases.create
+```
 
 ## Development
 
@@ -320,7 +344,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Development with Docker
 
-Run `docker compose run --rm ruby_app bash` and install required gems (`bundle install`). It will give you a fully working development environment with Milvius services and gem's code.
+Run `docker compose run --rm ruby_app bash` and install required gems (`bundle install`). It will give you a fully working development environment with Milvus services and gem's code.
 
 For example inside docker container run `bin/console` and inside the ruby console:
 ```ruby

data/lib/milvus/aliases.rb

@@ -0,0 +1,78 @@
+# https://docs.zilliz.com/reference/restful/alias-operations-v2
+
+module Milvus
+  class Aliases < Base
+    PATH = "aliases"
+
+    # Lists available roles on the server
+    #
+    # @return [Hash] The response from the server
+    def list
+      response = client.connection.post("#{PATH}/list") do |req|
+        req.body = {}
+      end
+
+      response.body
+    end
+
+    # Describes the details of a specific alias
+    #
+    # @param alias_name [String] The name of the alias to describe
+    # @return [Hash] The response from the server
+    def describe(alias_name:)
+      response = client.connection.post("#{PATH}/describe") do |req|
+        req.body = {
+          aliasName: alias_name
+        }
+      end
+
+      response.body
+    end
+
+    # Reassigns the alias of one collection to another
+    #
+    # @param alias_name [String] The alias of the collection
+    # @param collection_name [String] The name of the target collection to reassign an alias to
+    # @return [Hash] The response from the server
+    def alter(alias_name:, collection_name:)
+      response = client.connection.post("#{PATH}/alter") do |req|
+        req.body = {
+          aliasName: alias_name,
+          collectionName: collection_name
+        }
+      end
+
+      response.body
+    end
+
+    # This operation drops a specified alias
+    #
+    # @param alias_name [String] The alias to drop
+    # @return [Hash] The response from the server
+    def drop(alias_name:)
+      response = client.connection.post("#{PATH}/drop") do |req|
+        req.body = {
+          aliasName: alias_name
+        }
+      end
+
+      response.body
+    end
+
+    # This operation creates an alias for an existing collection. A collection can have multiple aliases, while an alias can be associated with only one collection.
+    #
+    # @param alias_name [String] The alias of the collection
+    # @param collection_name [String] The name of the target collection to reassign an alias to
+    # @return [Hash] The response from the server
+    def create(alias_name:, collection_name:)
+      response = client.connection.post("#{PATH}/create") do |req|
+        req.body = {
+          aliasName: alias_name,
+          collectionName: collection_name
+        }
+      end
+
+      response.body
+    end
+  end
+end

data/lib/milvus/client.rb

@@ -4,13 +4,22 @@ require "faraday"
 
 module Milvus
   class Client
-    attr_reader :url, :api_key
+    attr_reader :url, :api_key, :adapter, :raise_error, :logger
 
     API_VERSION = "v2/vectordb"
 
-    def initialize(url:, api_key: nil)
+    def initialize(
+      url:,
+      api_key: nil,
+      adapter: Faraday.default_adapter,
+      raise_error: false,
+      logger: nil
+    )
       @url = url
       @api_key = api_key
+      @adapter = adapter
+      @raise_error = raise_error
+      @logger = logger || Logger.new($stdout)
     end
 
     def collections
@@ -37,14 +46,20 @@ module Milvus
       @users ||= Milvus::Users.new(client: self)
     end
 
+    def aliases
+      @aliases ||= Milvus::Aliases.new(client: self)
+    end
+
     def connection
       @connection ||= Faraday.new(url: "#{url}/#{API_VERSION}/") do |faraday|
         if api_key
           faraday.request :authorization, :Bearer, api_key
         end
         faraday.request :json
+        faraday.response :logger, logger, {headers: true, bodies: true, errors: true}
+        faraday.response :raise_error if raise_error
         faraday.response :json, content_type: /\bjson$/
-        faraday.adapter Faraday.default_adapter
+        faraday.adapter adapter
       end
     end
   end

data/lib/milvus/entities.rb

@@ -123,10 +123,13 @@ module Milvus
       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 @@ module Milvus
         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

data/lib/milvus/version.rb

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

data/lib/milvus.rb

@@ -13,4 +13,5 @@ module Milvus
   autoload :Partitions, "milvus/partitions"
   autoload :Roles, "milvus/roles"
   autoload :Users, "milvus/users"
+  autoload :Aliases, "milvus/aliases"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: milvus
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.10.4
 platform: ruby
 authors:
 - Andrei Bondarev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-28 00:00:00.000000000 Z
+date: 2024-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -62,6 +62,7 @@ files:
 - Rakefile
 - docker-compose.yml
 - lib/milvus.rb
+- lib/milvus/aliases.rb
 - lib/milvus/base.rb
 - lib/milvus/client.rb
 - lib/milvus/collections.rb
@@ -96,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
+rubygems_version: 3.5.20
 signing_key:
 specification_version: 4
 summary: Ruby wrapper for the Milvus vector search database API