milvus 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4333b7321ee1e40f8f390692f6e25ce991837cd6b51bf6dfb4eef48fcfc826e9
-  data.tar.gz: c84d6a7f8be503c0009676a0d659d43bc5e443442f49a9bc6d96824da5904579
+  metadata.gz: 0a4dd23dd2d85a1a231214808ee57ece287c47fde46084f726831dc47e7aaed7
+  data.tar.gz: 52bca3e02f864a52c5c85c9f1aa725a16641fedaafb4b5ed8a7c6964664b9fe8
 SHA512:
-  metadata.gz: 2fffcbee8f0596ab3b65d12992a6323518a1a9ee1cb5c6c5d8437bbabcfa123acc8c777a189932fdc1be1b9b283c14f449e29dab27dc6b23d5c0dc7f333c3a42
-  data.tar.gz: a6d589ffa1c4e2b1e95eb74d1a089727a51adfdd265e852db52bf0558baeceb3f8e78b3fd53133efffce212c683bc38a5dc54bb5b0cc6662e32c74180ca7b4db
+  metadata.gz: 3c60bf9de09afaebc7cf0382529b07440680f50ed5f94c8ededb416f8cf29ddbaa7183527235c5daa12ce37412ca9b2b822e0b871d70fb67101ab291eb62c305
+  data.tar.gz: 7b5b2b34f19ee53b33e025f6e9c170584fcf4b86c647e79c6acf519b0a3560e3b68f02fbcc60bdaafd27e41165704cf07dfdc1f4a52ddee198327ca7f8cd0278

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## [Unreleased]
 
+## [0.10.1] - 2024-07-04 🇺🇸
+- Fixes and improvements to the gem.
+
 ## [0.10.0] - 2024-07-04 🇺🇸
 - BREAKING: Switched the gem to use newer V2 API with different endpoints and corresponding endpoints.
 

data/Gemfile.lock

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

data/README.md

@@ -47,17 +47,15 @@ client = Milvus::Client.new(
 ### Using the Collections endpoints
 ```ruby
 # Check if the collection exists.
-client.collections.has(collection_name: "book")
+client.collections.has(collection_name: "example_collection")
 ```
-
 ```ruby
 # Rename a collection.
-client.collections.rename(collection_name: "book", new_collection_name: "note")
+client.collections.rename(collection_name: "example_collection", new_collection_name: "example_collection")
 ```
-
 ```ruby
 # Get collection stats
-client.collections.get_stats(collection_name: "book")
+client.collections.get_stats(collection_name: "example_collection")
 ```
 
 ```ruby
@@ -65,30 +63,27 @@ client.collections.get_stats(collection_name: "book")
 
 # Creating a new collection schema
 client.collections.create(
-  collection_name: "book",
-  description: "Test book search",
-  auto_id: false,
+  collection_name: "example_collection",
+  auto_id: true,
   fields: [
     {
-      "fieldName": "book_id",
-      "description": "book id",
-      "isPrimary": true,
-      "autoID": false,
-      "dataType": "Int64"
+      fieldName: "book_id",
+      isPrimary: true,
+      autoID: false,
+      dataType: "Int64"
     },
     {
-      "fieldName": "word_count",
-      "description": "count of words",
-      "isPrimary": false,
-      "dataType": "Int64"
+      fieldName: "content",
+      dataType: "VarChar",
+      elementTypeParams: {
+        max_length: "512"
+      }
     },
     {
-      "fieldName": "book_intro",
-      "description": "embedded vector of book introduction",
-      "dataType": "FloatVector",
-      "isPrimary": false,
-      "elementTypeParams": {
-        "dim": "2"
+      fieldName: "vector",
+      dataType: "FloatVector",
+      elementTypeParams: {
+        dim: 1536
       }
     }
   ]
@@ -96,15 +91,19 @@ client.collections.create(
 ```
 ```ruby
 # Descrbie the collection
-client.collections.describe(collection_name: "book")
+client.collections.describe(collection_name: "example_collection")
 ```
 ```ruby
 # Drop the collection
-client.collections.drop(collection_name: "book")
+client.collections.drop(collection_name: "example_collection")
 ```
 ```ruby
 # Load the collection to memory before a search or a query
-client.collections.load(collection_name: "book")
+client.collections.load(collection_name: "example_collection")
+```
+```ruby
+# Load status of a specific collection.
+client.collections.get_load_state(collection_name: "example_collection")
 ```
 ```ruby
 # List all collections in the specified database.
@@ -112,64 +111,49 @@ client.collections.list
 ```
 ```ruby
 # Release a collection from memory after a search or a query to reduce memory usage
-client.collections.release(collection_name: "book")
+client.collections.release(collection_name: "example_collection")
 ```
 
 ### 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] ]
-    }
+  collection_name: "example_collection",
+  data: [
+    { id: 1, content: "The quick brown fox jumps over the lazy dog", vector: ([0.1]*1536) },
+    { id: 2, content: "Lorem ipsum dolor sit amet, consectetur adipiscing elit", vector: ([0.2]*1536) },
+    { id: 3, content: "Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua", vector: ([0.3]*1536) }
   ]  
 )
 ```
 ```ruby
 # Delete the entities with the boolean expression you created
 client.entities.delete(
-  collection_name: "book",
+  collection_name: "example_collection",
   expression: "book_id in [0,1]"
 )
 ```
 ```ruby
-# Compact data manually
-client.entities.compact!(
-  collection_id: "book"
-)
-# => {"status"=>{}, "compactionID"=>440928616022809499}
+# Inserts new records into the database or updates existing ones.
+client.entities.upsert()
 ```
 ```ruby
-# Check compaction status
-client.entities.compact_status(
-  compaction_id: 440928616022809499
-)
-# => {"status"=>{}, "state"=>2}
+# Get specific entities by their IDs
+client.entities.get()
 ```
 
 ### Indexes
 ```ruby
 # Create an index
-index_params = {
-  fieldName: "example_field",
-  indexType: "IVF_FLAT",
-  metricType: "L2",
-  params: { nlist: 100 }
-}
+index_params = [
+  {
+    metricType: "L2",
+    fieldName: "vector",
+    indexName: "vector_idx",
+    indexConfig: {
+      index_type: "AUTOINDEX"
+    }
+  }
+]
 
 client.indexes.create(
   collection_name: "example_collection",
@@ -200,7 +184,7 @@ client.indexes.drop(
 ### Search, Querying & Hybrid Search
 ```ruby
 client.entities.search(
-  collection_name: "recipes",
+  collection_name: "example_collection",
   anns_field: "vectors",
   data: [embedding],
   filter: "id in [450847466900987454]"
@@ -208,13 +192,13 @@ client.entities.search(
 ```
 ```ruby
 client.entities.query(
-  collection_name: "recipes",
+  collection_name: "example_collection",
   filter: "id in [450847466900987455, 450847466900987454]"
 )
 ```
 ```ruby
 client.entities.hybrid_search(
-  collection_name: "recipes",
+  collection_name: "example_collection",
   search: [{
     filter: "id in [450847466900987455]",
     data: [embedding],

data/lib/milvus/collections.rb

@@ -12,7 +12,7 @@ module Milvus
       response = client.connection.post("#{PATH}/has") do |req|
         req.body = {
           collectionName: collection_name
-        }.to_json
+        }
       end
       response.body
     end
@@ -40,7 +40,7 @@ module Milvus
       response = client.connection.post("#{PATH}/get_stats") do |req|
         req.body = {
           collectionName: collection_name
-        }.to_json
+        }
       end
       response.body
     end
@@ -55,7 +55,6 @@ module Milvus
     def create(
       collection_name:,
       auto_id:,
-      description:,
       fields:
     )
       response = client.connection.post("#{PATH}/create") do |req|
@@ -63,11 +62,10 @@ module Milvus
           collectionName: collection_name,
           schema: {
             autoId: 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
@@ -80,7 +78,7 @@ module Milvus
       response = client.connection.post("#{PATH}/describe") do |req|
         req.body = {
           collectionName: collection_name
-        }.to_json
+        }
       end
       response.body
     end
@@ -103,7 +101,7 @@ module Milvus
       response = client.connection.post("#{PATH}/drop") do |req|
         req.body = {
           collectionName: collection_name
-        }.to_json
+        }
       end
       response.body.empty? ? true : response.body
     end
@@ -142,7 +140,7 @@ module Milvus
       response = client.connection.post("#{PATH}/release") do |req|
         req.body = {
           collectionName: collection_name
-        }.to_json
+        }
       end
       response.body.empty? ? true : response.body
     end

data/lib/milvus/constants.rb

@@ -2,22 +2,21 @@
 
 module Milvus
   # https://milvus.io/api-reference/pymilvus/v2.4.x/MilvusClient/Collections/DataType.md
-  DATA_TYPES = {
-    "boolean" => 1,
-    "int8" => 2,
-    "int16" => 3,
-    "int32" => 4,
-    "int64" => 5,
-    "float" => 10,
-    "double" => 11,
-    "string" => 20,
-    "varchar" => 21,
-    "array" => 22,
-    "json" => 23,
-    "binary_vector" => 100,
-    "float_vector" => 101,
-    "float16_vector" => 102,
-    "bfloat16_vector" => 103,
-    "sparse_float_vector" => 104
-  }.freeze
+  DATA_TYPES = [
+    "Boolean",
+    "Int8",
+    "Int16",
+    "Int32",
+    "Int64",
+    "Float",
+    "Double",
+    "VarChar",
+    "Array",
+    "Json",
+    "BinaryVector",
+    "FloatVector",
+    "Float16Vector",
+    "BFloat16Vector",
+    "SparseFloatVector"
+  ].freeze
 end

data/lib/milvus/entities.rb

@@ -21,7 +21,6 @@ module Milvus
           collectionName: collection_name,
           data: data
         }
-
         req.body[:partitionName] = partition_name if partition_name
       end
       response.body.empty? ? true : response.body
@@ -40,7 +39,7 @@ module Milvus
         req.body = {
           collectionName: collection_name,
           filter: filter
-        }.to_json
+        }
       end
       response.body.empty? ? true : response.body
     end
@@ -84,7 +83,6 @@ module Milvus
           collectionName: collection_name,
           data: data
         }
-
         req.body[:partitionName] = partition_name if partition_name
       end
       response.body.empty? ? true : response.body

data/lib/milvus/indexes.rb

@@ -17,7 +17,7 @@ module Milvus
         req.body = {
           collectionName: collection_name,
           indexParams: index_params
-        }.to_json
+        }
       end
       response.body.empty? ? true : response.body
     end
@@ -35,7 +35,7 @@ module Milvus
         req.body = {
           collectionName: collection_name,
           indexName: index_name
-        }.to_json
+        }
       end
       response.body.empty? ? true : response.body
     end
@@ -53,7 +53,7 @@ module Milvus
         req.body = {
           collectionName: collection_name,
           indexName: index_name
-        }.to_json
+        }
       end
       response.body.empty? ? true : response.body
     end
@@ -68,7 +68,7 @@ module Milvus
       response = client.connection.post("#{PATH}/list") do |req|
         req.body = {
           collectionName: collection_name
-        }.to_json
+        }
       end
       response.body.empty? ? true : response.body
     end

data/lib/milvus/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: milvus
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Andrei Bondarev