milvus 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4910e3b8c5f02ed0a56dca251ec40f7f8033c3033e45d406faa90b4b56358029
+  data.tar.gz: 61460b9e1bc168e4dfec03bddc1f010d1df465ab5b0648eac38843ba666dcb76
+SHA512:
+  metadata.gz: 12670da71fd1c578a8e040259218ac93c33fc15c8d5e27bd15fb39bbc168a397dd55a13dcce5387d76aac942131da65d22ff3cbc7a9147d2b5e761e9aef87861
+  data.tar.gz: 7e0614244bffe334bba059e59e981de0456f541a103f58df356754d5ff56546954d8c2d19d458b8cbb5ffd15817102bc6491f013823ed5498a94e6ce26c4d3a6

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-04-20
+
+- Initial release

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in milvus.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+gem "standard", "~> 1.27.0"

data/Gemfile.lock

@@ -0,0 +1,83 @@
+PATH
+  remote: .
+  specs:
+    milvus (0.9.0)
+      faraday (~> 2.7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    method_source (1.0.0)
+    parallel (1.23.0)
+    parser (3.2.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    standard (1.27.0)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (~> 1.50.2)
+      rubocop-performance (~> 1.16.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  milvus!
+  pry-byebug (~> 3.10.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  standard (~> 1.27.0)
+
+BUNDLED WITH
+   2.4.0

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,237 @@
+# Milvus
+
+<p>
+    <img alt='Milvus logo' src='https://res.cloudinary.com/crunchbase-production/image/upload/c_lpad,f_auto,q_auto:eco,dpr_1/cqpyxcuzl6gwqjjwzamt' height='50' />
+    +&nbsp;&nbsp;
+    <img alt='Ruby logo' src='https://user-images.githubusercontent.com/541665/230231593-43861278-4550-421d-a543-fd3553aac4f6.png' height='40' />
+</p>
+
+Ruby wrapper for the Milvus vector search database API
+
+![Tests status](https://github.com/andreibondarev/milvus/actions/workflows/ci.yml/badge.svg) [![Gem Version](https://badge.fury.io/rb/milvus.svg)](https://badge.fury.io/rb/milvus)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add milvus
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install milvus
+
+## Usage
+
+### Instantiating API client
+
+```ruby
+require 'milvus'
+
+client = Milvus::Client.new(
+    url: 'http://localhost:9091'
+)
+```
+
+### Using the Collections endpoints
+
+```ruby
+# Data types: "boolean", "int8", "int16", "int32", "int64", "float", "double", "string", "varchar", "binary_vector", "float_vector"
+
+# Creating a new collection schema
+client.collections.create(
+  collection_name: "book",
+  description: "Test book search",
+  auto_id: false,
+  fields: [
+    {
+      "name": "book_id",
+      "description": "book id",
+      "is_primary_key": true,
+      "autoID": false,
+      "data_type": Milvus::DATA_TYPES["int64"]
+    },
+    {
+      "name": "word_count",
+      "description": "count of words",
+      "is_primary_key": false,
+      "data_type": Milvus::DATA_TYPES["int64"]
+    },
+    {
+      "name": "book_intro",
+      "description": "embedded vector of book introduction",
+      "data_type": Milvus::DATA_TYPES["binary_vector"],
+      "is_primary_key": false,
+      "type_params": [
+        {
+          "key": "dim",
+          "value": "2"
+        }
+      ]
+    }
+  ]
+)
+```
+```ruby
+# Get the collection info
+client.collections.get(collection_name: "book")
+```
+```ruby
+# Delete the collection
+client.collections.delete(collection_name: "book")
+```
+```ruby
+# Load the collection to memory before a search or a query
+client.collections.load(collection_name: "book")
+```
+```ruby
+# Release a collection from memory after a search or a query to reduce memory usage
+client.collections.release(collection_name: "book")
+```
+
+### Inserting Data
+```ruby
+client.entities.insert(
+  collection_name: "book",
+  num_rows: 5, # Number of rows to be inserted. The number should be the same as the length of each field array.
+  fields_data: [
+    {
+      "field_name": "book_id",
+      "type": Milvus::DATA_TYPES["int64"],
+      "field": [1,2,3,4,5]
+    },
+    {
+      "field_name": "word_count",
+      "type": Milvus::DATA_TYPES["int64"],
+      "field": [1000,2000,3000,4000,5000]
+    },
+    {
+      "field_name": "book_intro",
+      "type": 101,
+      "field": [ [1,1],[2,1],[3,1],[4,1],[5,1] ]
+    }
+  ]  
+)
+```
+```ruby
+# Delete the entities with the boolean expression you created
+client.entities.delete(
+  collection_name: "book",
+  expression: "book_id in [0,1]"
+)
+```
+```ruby
+# Compact data manually
+client.entities.compact!(
+  collection_id: "book"
+)
+# => {"status"=>{}, "compactionID"=>440928616022809499}
+```
+```ruby
+# Check compaction status
+client.entities.compact_status(
+  compaction_id: 440928616022809499
+)
+# => {"status"=>{}, "state"=>2}
+```
+
+### Indices
+```ruby
+client.indices.create(
+  collection_name: "book",
+  field_name: "book_intro",
+  extra_params: [
+    { key: "metric_type", "value": "L2" },
+    { key: "index_type", "value": "IVF_FLAT" },
+    { key: "params", "value": "{\"nlist\":1024}" }
+  ]
+)
+```
+```ruby
+collection.indices.create(
+  field_name="book_name", 
+  index_name="scalar_index",
+)
+```
+```ruby
+client.indices.delete(
+  collection_name: "book",
+  field_name: "book_intro"
+)
+```
+
+### Search & Querying
+```ruby
+client.search(
+  collection_name: "book",
+  output_fields: ["book_id"], # optional
+  anns_field: "book_intro",
+  top_k: "2",
+  params: "{\"nprobe\": 10}",
+  metric_type: "L2",
+  round_decimal: "-1",
+  vectors: [ [0.1,0.2] ],
+  dsl_type: 1
+)
+```
+```ruby
+client.query(
+  collection_name: "book",
+  output_fields: ["book_id", "book_intro"],
+  expr: "book_id in [2,4,6,8]"
+)
+```
+
+### Partitions
+```ruby
+client.partitions.create(
+  "collection_name": "book",
+  "partition_name": "novel"
+)
+```
+```ruby
+client.partitions.get(
+  "collection_name": "book",
+  "partition_name": "novel"
+)
+```
+```ruby
+client.partitions.delete(
+  "collection_name": "book",
+  "partition_name": "novel"
+)
+```
+```ruby
+client.partitions.load(
+  "collection_name": "book",
+  "partition_names": ["novel"],
+  "replica_number": 1
+)
+```
+```ruby
+client.partitions.release(
+  "collection_name": "book",
+  "partition_names": ["novel"],
+  "replica_number": 1
+)
+```
+
+### Health
+```ruby
+# Live determines whether the application is alive. It can be used for Kubernetes liveness probe.
+client.health
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/andreibondarev/milvus.
+
+## License
+
+`milvus` is licensed under the Apache License, Version 2.0. View a copy of the License file.
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/milvus/base.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Milvus
+  class Base
+    attr_reader :client
+
+    def initialize(client:)
+      @client = client
+    end
+  end
+end

data/lib/milvus/client.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+module Milvus
+  class Client
+    attr_reader :url, :api_key
+
+    API_VERSION = "api/v1"
+
+    def initialize(
+      url:,
+      api_key: nil
+    )
+      @url = url
+      @api_key = api_key
+    end
+
+    def health
+      @health ||= Milvus::Health.new(client: self).get
+    end
+
+    def collections
+      @schema ||= Milvus::Collections.new(client: self)
+    end
+
+    def partitions
+      @partitions ||= Milvus::Partitions.new(client: self)
+    end
+
+    def entities
+      @entities ||= Milvus::Entities.new(client: self)
+    end
+
+    def indices
+      @indices ||= Milvus::Indices.new(client: self)
+    end
+
+    def search(...)
+      @search ||= Milvus::Search.new(client: self).post(...)
+    end
+
+    def query(...)
+      @query ||= Milvus::Query.new(client: self).post(...)
+    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 :json, content_type: /\bjson$/
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/milvus/collections.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Milvus
+  class Collections < Base
+    PATH = "collection"
+
+    # Create a Collection
+    def create(
+      collection_name:,
+      auto_id:,
+      description:,
+      fields:
+    )
+      response = client.connection.post(PATH) do |req|
+        req.body = {
+          collection_name: collection_name,
+          schema: {
+            auto_id: auto_id,
+            description: description,
+            fields: fields,
+            name: collection_name # This duplicated field is kept for historical reasons.
+          }
+        }.to_json
+      end
+      response.body.empty? ? true : response.body
+    end
+
+    # Retrieve a Collection
+    def get(collection_name:)
+      response = client.connection.get(PATH) do |req|
+        req.body = {
+          collection_name: collection_name
+        }.to_json
+      end
+      response.body
+    end
+
+    # Drop a Collection
+    def delete(collection_name:)
+      response = client.connection.delete(PATH) do |req|
+        req.body = {
+          collection_name: collection_name
+        }.to_json
+      end
+      response.body.empty? ? true : response.body
+    end
+
+    # Load the collection to memory before a search or a query
+    def load(collection_name:)
+      response = client.connection.post("#{PATH}/load") do |req|
+        req.body = {
+          collection_name: collection_name
+        }.to_json
+      end
+      response.body.empty? ? true : response.body
+    end
+
+    # Release a collection from memory after a search or a query to reduce memory usage
+    def release(collection_name:)
+      response = client.connection.delete("#{PATH}/load") do |req|
+        req.body = {
+          collection_name: collection_name
+        }.to_json
+      end
+      response.body.empty? ? true : response.body
+    end
+  end
+end

data/lib/milvus/constants.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Milvus
+  DATA_TYPES = {
+    "boolean" => 1,
+    "int8" => 2,
+    "int16" => 3,
+    "int32" => 4,
+    "int64" => 5,
+    "float" => 10,
+    "double" => 11,
+    "string" => 20,
+    "varchar" => 21,
+    "binary_vector" => 101,
+    "float_vector" => 102
+  }.freeze
+end

data/lib/milvus/entities.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Milvus
+  class Entities < Base
+    PATH = "entities"
+
+    # Insert the data to the collection.
+    def insert(
+      collection_name:,
+      fields_data:,
+      num_rows:,
+      partition_name: nil
+    )
+      response = client.connection.post(PATH) do |req|
+        req.body = {
+          collection_name: collection_name,
+          fields_data: fields_data,
+          num_rows: num_rows
+        }.to_json
+
+        req.body["partition_name"] = partition_name if partition_name
+      end
+      response.body.empty? ? true : response.body
+    end
+
+    # Delete the entities with the boolean expression you created
+    def delete(
+      collection_name:,
+      expression:
+    )
+      response = client.connection.delete(PATH) do |req|
+        req.body = {
+          collection_name: collection_name,
+          expr: expression
+        }.to_json
+      end
+      response.body.empty? ? true : response.body
+    end
+
+    # Compact data manually
+    def compact!(
+      collection_id:
+    )
+      response = client.connection.post("compaction") do |req|
+        req.body = {
+          collectionID: collection_id
+        }.to_json
+      end
+      response.body.empty? ? true : response.body
+    end
+
+    # Check compaction status
+    def compact_status(
+      compaction_id:
+    )
+      response = client.connection.get("compaction/state") do |req|
+        req.body = {
+          compactionID: compaction_id
+        }.to_json
+      end
+      response.body.empty? ? true : response.body
+    end
+  end
+end

data/lib/milvus/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Milvus
+  class Error < StandardError
+  end
+end

data/lib/milvus/health.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Milvus
+  class Health < Base
+    PATH = "health"
+
+    def get
+      response = client.connection.get(PATH.to_s)
+      response.body
+    end
+  end
+end

data/lib/milvus/indices.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Milvus
+  class Indices < Base
+    PATH = "index"
+
+    def create(
+      collection_name:,
+      field_name:,
+      extra_params:
+    )
+      response = client.connection.post(PATH) do |req|
+        req.body = {
+          collection_name: collection_name,
+          field_name: field_name,
+          extra_params: extra_params
+        }.to_json
+      end
+      response.body.empty? ? true : response.body
+    end
+
+    def delete(
+      collection_name:,
+      field_name:
+    )
+      response = client.connection.delete(PATH) do |req|
+        req.body = {
+          collection_name: collection_name,
+          field_name: field_name
+        }.to_json
+      end
+      response.body.empty? ? true : response.body
+    end
+  end
+end

data/lib/milvus/partitions.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Milvus
+  class Partitions < Base
+    PATH = "partition"
+
+    # Create a partition
+    def create(collection_name:, partition_name:)
+      response = client.connection.post(PATH) do |req|
+        req.body = {
+          collection_name: collection_name,
+          partition_name: partition_name
+        }
+      end
+      response.body.empty? ? true : response.body
+    end
+
+    # Verify if a partition exists
+    def get(collection_name:, partition_name:)
+      response = client.connection.get("#{PATH}/existence") do |req|
+        req.body = {
+          collection_name: collection_name,
+          partition_name: partition_name
+        }
+      end
+      response.body.empty? ? true : response.body
+    end
+
+    # Dropping a partition
+    def delete(collection_name:, partition_name:)
+      response = client.connection.delete(PATH) do |req|
+        req.body = {
+          collection_name: collection_name,
+          partition_name: partition_name
+        }
+      end
+      response.body.empty? ? true : response.body
+    end
+
+    # Load a Partition
+    def load(
+      collection_name:,
+      partition_names:,
+      replica_number: nil
+    )
+      response = client.connection.post("#{PATH}s/load") do |req|
+        req.body = {
+          collection_name: collection_name,
+          partition_names: partition_names
+        }
+        req.body[:replica_number] = replica_number if replica_number
+      end
+      response.body.empty? ? true : response.body
+    end
+
+    def release(
+      collection_name:,
+      partition_names:,
+      replica_number: nil
+    )
+      response = client.connection.delete("#{PATH}s/load") do |req|
+        req.body = {
+          collection_name: collection_name,
+          partition_names: partition_names
+        }
+        req.body[:replica_number] = replica_number if replica_number
+      end
+      response.body.empty? ? true : response.body
+    end
+  end
+end

data/lib/milvus/query.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Milvus
+  class Query < Base
+    PATH = "query"
+
+    def post(
+      collection_name:,
+      output_fields:,
+      expr:
+    )
+      response = client.connection.post(PATH) do |req|
+        req.body = {
+          collection_name: collection_name,
+          expr: expr
+        }
+        if output_fields
+          req.body[:output_fields] = output_fields
+        end
+      end
+      response.body.empty? ? true : response.body
+    end
+  end
+end

data/lib/milvus/search.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Milvus
+  class Search < Base
+    PATH = "search"
+
+    def post(
+      collection_name:,
+      anns_field:, top_k:, params:, metric_type:, vectors:, dsl_type:, output_fields: nil,
+      round_decimal: nil
+    )
+      response = client.connection.post(PATH) do |req|
+        req.body = {
+          collection_name: collection_name,
+          search_params: [
+            {key: "anns_field", value: anns_field},
+            {key: "topk", value: top_k},
+            {key: "params", value: params},
+            {key: "metric_type", value: metric_type}
+          ],
+          dsl_type: dsl_type,
+          vectors: vectors
+        }
+        if round_decimal
+          req.body[:search_params].push(
+            {key: "round_decimal", value: round_decimal}
+          )
+        end
+        if output_fields
+          req.body[:output_fields] = output_fields
+        end
+      end
+      response.body.empty? ? true : response.body
+    end
+  end
+end

data/lib/milvus/version.rb

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

data/lib/milvus.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "milvus/version"
+require_relative "milvus/constants"
+
+module Milvus
+  autoload :Base, "milvus/base"
+  autoload :Collections, "milvus/collections"
+  autoload :Client, "milvus/client"
+  autoload :Error, "milvus/error"
+  autoload :Entities, "milvus/entities"
+  autoload :Health, "milvus/health"
+  autoload :Indices, "milvus/indices"
+  autoload :Partitions, "milvus/partitions"
+  autoload :Search, "milvus/search"
+  autoload :Query, "milvus/query"
+end

data/sig/milvus.rbs

@@ -0,0 +1,4 @@
+module Milvus
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: milvus
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Andrei Bondarev
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+description: Ruby wrapper for the Milvus vector search database API
+email:
+- andrei.bondarev13@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/milvus.rb
+- lib/milvus/base.rb
+- lib/milvus/client.rb
+- lib/milvus/collections.rb
+- lib/milvus/constants.rb
+- lib/milvus/entities.rb
+- lib/milvus/error.rb
+- lib/milvus/health.rb
+- lib/milvus/indices.rb
+- lib/milvus/partitions.rb
+- lib/milvus/query.rb
+- lib/milvus/search.rb
+- lib/milvus/version.rb
+- sig/milvus.rbs
+homepage: https://github.com/andreibondarev/milvus
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/andreibondarev/milvus
+  source_code_uri: https://github.com/andreibondarev/milvus
+  changelog_uri: https://github.com/andreibondarev/milvus/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Ruby wrapper for the Milvus vector search database API
+test_files: []