qdrant-ruby 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0207e687f622cdcf258c493bb8b75c783c9847574abe41fcf4489f93ba40752c
-  data.tar.gz: 48df2d6de390314ff6d6b18f2d155d118c81c417d8f21c2032ce2681094945b8
+  metadata.gz: 6899d046fe093cba0a8f390313bba21f2febb5319984fa516b99d2d3a825af17
+  data.tar.gz: e99fb180f6d3adca5f91133d5b88869a11fb5b004147c3ddb0987428b479713d
 SHA512:
-  metadata.gz: 65b92ac01bc6346e03f1a4ce928292a5ce4ed0eff4fc36083199b2d6db3b096a9b9a9ca2e07de0d2936490e83b338c3ce0d2d70bafd60a8617aa20aa438c43c5
-  data.tar.gz: f301dd5bc6d3014af75ee6ae9916937b2324ab7abd444199b3c7ba843c8192ad1c610fb827183894e597c61552e81695d1b78f8674353c541521485213296439
+  metadata.gz: 619eb3d6fa73efb8bc57351418c6db3824f9b2fa416911be4555278944489d29cebf9892f26c23ff7406b631450a992059e8c84f05f64845a3d45799f9844fe5
+  data.tar.gz: c336aa478ac184ce7c70543bd5faaa15ce3d3340a77862ef3d0ccbbcfbe80430348ca0977f83591ace3309d18d108140e3e7e304e3d037c81711fec1939a35f9

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.11.0] - 2026-10-21
+- Fix `collections.restore_snapshot` to use PUT (POST always returned 404)
+- Fix `clusters.remove_peer` to call `DELETE /cluster/peer/{peer_id}` instead of `POST /cluster/recover`
+- `client.aliases` no longer caches the first response
+- `points.list` now requires `ids:` (the API always required it)
+- Deprecation warnings for `points.search`, `batch_search`, `recommend`, `batch_recommend` (use `points.query`), the lock API and `init_from:` (both removed in Qdrant 1.16)
+- README: fix inaccurate examples and remove the nonexistent `backups` section
+
 ## [0.10.0] - 2026-08-12
 - Drop Faraday dependency
 

data/Gemfile

@@ -8,4 +8,4 @@ gemspec
 gem "rake", "~> 13.4"
 
 gem "rspec", "~> 3.13"
-gem "standard", "~> 1.56.0"
+gem "standard", "~> 1.57.0"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    qdrant-ruby (0.10.0)
+    qdrant-ruby (0.11.0)
       logger
 
 GEM
@@ -13,12 +13,12 @@ GEM
     coderay (1.1.3)
     diff-lcs (1.6.2)
     io-console (0.9.2)
-    json (2.21.2)
+    json (3.1.0)
     language_server-protocol (3.17.0.6)
     lint_roller (1.1.0)
     logger (1.7.0)
     method_source (1.1.0)
-    parallel (2.1.0)
+    parallel (2.3.0)
     parser (3.3.12.0)
       ast (~> 2.4.1)
       racc
@@ -33,7 +33,7 @@ GEM
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.4.2)
-    regexp_parser (2.12.0)
+    regexp_parser (2.13.1)
     reline (0.7.0)
       io-console (~> 0.5)
     rspec (3.13.2)
@@ -49,8 +49,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.7)
-    rubocop (1.88.2)
-      json (~> 2.3)
+    rubocop (1.91.0)
+      json (>= 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
       parallel (>= 1.10)
@@ -68,10 +68,10 @@ GEM
       rubocop (>= 1.75.0, < 2.0)
       rubocop-ast (>= 1.47.1, < 2.0)
     ruby-progressbar (1.13.0)
-    standard (1.56.0)
+    standard (1.57.0)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.88.0)
+      rubocop (~> 1.91.0)
       standard-custom (~> 1.0.0)
       standard-performance (~> 1.8)
     standard-custom (1.0.2)
@@ -80,9 +80,9 @@ GEM
     standard-performance (1.9.0)
       lint_roller (~> 1.1)
       rubocop-performance (~> 1.26.0)
-    unicode-display_width (3.2.0)
-      unicode-emoji (~> 4.1)
-    unicode-emoji (4.2.0)
+    unicode-display_width (3.3.0)
+      unicode-emoji (~> 4.3)
+    unicode-emoji (4.3.0)
 
 PLATFORMS
   arm64-darwin-23
@@ -96,7 +96,7 @@ DEPENDENCIES
   qdrant-ruby!
   rake (~> 13.4)
   rspec (~> 3.13)
-  standard (~> 1.56.0)
+  standard (~> 1.57.0)
 
 BUNDLED WITH
    2.5.3

data/README.md

@@ -52,6 +52,7 @@ client.collections.get(collection_name: "string")
 client.collections.create(
     collection_name: "string",     # required
     vectors: {},                   # required
+    sparse_vectors: nil,
     shard_number: nil,
     replication_factor: nil,
     write_consistency_factor: nil,
@@ -59,7 +60,6 @@ client.collections.create(
     hnsw_config: nil,
     wal_config: nil,
     optimizers_config: nil,
-    init_from: nil,
     quantization_config: nil
 )
 
@@ -73,11 +73,14 @@ client.collections.update(
 # Drop collection and all associated data
 client.collections.delete(collection_name: "string")
 
-# Get list of all aliases (for a collection)
+# Get list of all aliases for a collection
 client.collections.aliases(
-    collection_name: "string" # optional
+    collection_name: "string" # required
 )
 
+# Get list of all aliases across all collections
+client.aliases
+
 # Update aliases of the collections
 client.collections.update_aliases(
     actions: [{
@@ -101,9 +104,7 @@ client.collections.create_index(
 # Delete field index for collection
 client.collections.delete_index(
     collection_name: "string", # required
-    field_name: "string",      # required
-    wait: "boolean",
-    ordering: "ordering"
+    field_name: "string"       # required
 )
 
 # Get cluster information for a collection
@@ -118,8 +119,7 @@ client.collections.update_cluster(
         shard_id: "int",
         to_peer_id: "int",
         from_peer_id: "int"
-    },
-    timeout: "int"
+    }
 )
 
 # Create new snapshot for a collection
@@ -167,28 +167,57 @@ client.points.get(
 client.points.get_all(
     collection_name: "string", # required
     ids: "[int]",              # required
-    with_payload: "boolean"
-    with_vector: "boolean"
+    with_payload: "boolean",
+    with_vector: "boolean",
+    consistency: "int/string"
 )
 
-# Lists all data objects in reverse order of creation. The data will be returned as an array of objects.
+# Retrieve full information of points by ids. Same as `get_all`.
 client.points.list(
     collection_name: "string", # required
     ids: "[int/string]",       # required
     with_payload: nil,
     with_vector: nil,
     consistency: nil
-
 )
 
-# Get a single data object.
+# Insert or update points. Either `points:` or `batch:` is required.
 client.points.upsert(
     collection_name: "string", # required
-    batch: {},                 # required
+    points: [],                # record-oriented: array of point hashes
+    batch: {},                 # column-oriented: hash of parallel arrays
     wait: "boolean",
     ordering: "string"
 )
 
+# Record-oriented upsert: each point is a hash with its own id, vector and payload
+client.points.upsert(
+    collection_name: "my_collection",
+    points: [
+        {id: 1, vector: [0.9, 0.1, 0.1], payload: {color: "red"}},
+        {id: 2, vector: [0.1, 0.9, 0.1], payload: {color: "green"}},
+        {id: 3, vector: [0.1, 0.1, 0.9], payload: {color: "blue"}}
+    ]
+)
+
+# Column-oriented (batch) upsert: ids, vectors and payloads are passed as parallel arrays
+client.points.upsert(
+    collection_name: "my_collection",
+    batch: {
+        ids: [1, 2, 3],
+        vectors: [
+            [0.9, 0.1, 0.1],
+            [0.1, 0.9, 0.1],
+            [0.1, 0.1, 0.9]
+        ],
+        payloads: [
+            {color: "red"},
+            {color: "green"},
+            {color: "blue"}
+        ]
+    }
+)
+
 # Delete points
 client.points.delete(
     collection_name: "string", # required
@@ -249,6 +278,28 @@ client.points.scroll(
     consistency: "int/string"
 )
 
+# Universally query points: covers search, recommend and discover, plus hybrid and multi-stage queries
+client.points.query(
+    collection_name: "string", # required
+    query: "[float]/{}",       # a vector, a point ID, or a query object such as {recommend: {positive: [1]}}
+    using: "string",
+    prefetch: {},
+    filter: {},
+    params: {},
+    score_threshold: "float",
+    limit: "int",
+    offset: "int",
+    with_payload: "boolean",
+    with_vector: "boolean",
+    lookup_from: {},
+    shard_key: "string",
+    consistency: "int/string",
+    timeout: "int"
+)
+
+# DEPRECATED (since Qdrant 1.13): `search`, `batch_search`, `recommend` and `batch_recommend`
+# still work but are no longer documented by Qdrant and will be removed. Use `points.query` instead.
+
 # Retrieve closest points based on vector similarity and given filtering conditions
 client.points.search(
     collection_name: "string", # required
@@ -281,9 +332,9 @@ client.points.recommend(
     offset: "int",
     with_payload: "boolean",
     with_vector: "boolean",
-    score_threshold: "float"
+    score_threshold: "float",
     using: "string",
-    lookup_from: {},
+    lookup_from: {}
 )
 
 # Look for the points which are closer to stored positive examples and at the same time further to negative examples.
@@ -304,58 +355,33 @@ client.points.count(
 ### Snapshots
 ```ruby
 # Get list of snapshots of the whole storage
-client.snapshots.list(
-    collection_name: "string" # optional
-)
+client.snapshots.list
 
 # Create new snapshot of the whole storage
-client.snapshots.create(
-    collection_name: "string" # required
-)
+client.snapshots.create
 
 # Delete snapshot of the whole storage
 client.snapshots.delete(
-    collection_name: "string", # required
-    snapshot_name: "string"    # required
+    snapshot_name: "string" # required
 )
 
 # Download specified snapshot of the whole storage as a file
 client.snapshots.download(
-    collection_name: "string", # required
-    snapshot_name: "string"    # required
-    filepath: "~/Downloads/backup.txt" # required
-)
-
-
-# Get the backup
-client.backups.get(
-    backend: "filesystem",
-    id: "my-first-backup"
-)
-
-# Restore backup
-client.backups.restore(
-    backend: "filesystem",
-    id: "my-first-backup"
-)
-
-# Check the backup restore status
-client.backups.restore_status(
-    backend: "filesystem",
-    id: "my-first-backup"
+    snapshot_name: "string",                # required
+    filepath: "~/Downloads/backup.snapshot" # required
 )
 ```
 
 ### Cluster
 ```ruby
 # Get information about the current state and composition of the cluster
-client.cluster.info
+client.clusters.info
 
 # Tries to recover current peer Raft state.
-client.cluster.recover
+client.clusters.recover
 
 # Tries to remove peer from the cluster. Will return an error if peer has shards on it.
-client.cluster.remove_peer(
+client.clusters.remove_peer(
     peer_id: "int",  # required
     force: "boolean"
 )
@@ -373,12 +399,14 @@ client.metrics(
     anonymize: "boolean" # optional
 )
 
+# DEPRECATED: the lock API was removed in Qdrant 1.16. These only work against older servers.
+
 # Get lock options. If write is locked, all write operations and collection creation are forbidden
 client.locks
 
 # Set lock options. If write is locked, all write operations and collection creation are forbidden. Returns previous lock options
 client.set_lock(
-    write: "boolean" # required
+    write: "boolean", # required
     error_message: "string"
 )
 ```

data/lib/qdrant/base.rb

@@ -7,5 +7,13 @@ module Qdrant
     def initialize(client:)
       @client = client
     end
+
+    private
+
+    # Point the warning at the caller's code, skipping frames inside the gem and Forwardable.
+    def deprecation_warning(message)
+      uplevel = caller_locations.index { |loc| !loc.path.start_with?(__dir__) && !loc.path.end_with?("/forwardable.rb") }
+      warn("[DEPRECATION] Qdrant: #{message}", uplevel: uplevel + 1)
+    end
   end
 end

data/lib/qdrant/client.rb

@@ -37,7 +37,7 @@ module Qdrant
     end
 
     def aliases
-      @aliases ||= Qdrant::Aliases.new(client: self).list
+      Qdrant::Aliases.new(client: self).list
     end
 
     def collections

data/lib/qdrant/clusters.rb

@@ -21,7 +21,7 @@ module Qdrant
       peer_id:,
       force: nil
     )
-      response = client.connection.post("#{PATH}/recover") do |req|
+      response = client.connection.delete("#{PATH}/peer/#{peer_id}") do |req|
         req.params["force"] = force if force
       end
       response.body

data/lib/qdrant/collections.rb

@@ -31,6 +31,8 @@ module Qdrant
       init_from: nil,
       quantization_config: nil
     )
+      deprecation_warning("`init_from:` was removed in Qdrant 1.16 and is ignored by the server.") unless init_from.nil?
+
       response = client.connection.put("#{PATH}/#{collection_name}") do |req|
         req.body = {}
         req.body["vectors"] = vectors
@@ -176,7 +178,7 @@ module Qdrant
       priority: nil,
       wait: nil
     )
-      response = client.connection.post("#{PATH}/#{collection_name}/snapshots/recover") do |req|
+      response = client.connection.put("#{PATH}/#{collection_name}/snapshots/recover") do |req|
         req.params["wait"] = wait unless wait.nil?
 
         req.body = {

data/lib/qdrant/points.rb

@@ -4,10 +4,10 @@ module Qdrant
   class Points < Base
     PATH = "points"
 
-    # Lists all data objects in reverse order of creation. The data will be returned as an array of objects.
+    # Retrieve full information of points by ids. Same as `get_all`.
     def list(
       collection_name:,
-      ids: nil,
+      ids:,
       with_payload: nil,
       with_vector: nil,
       consistency: nil
@@ -212,6 +212,8 @@ module Qdrant
       score_threshold: nil,
       consistency: nil
     )
+      deprecation_warning("`points.search` is deprecated since Qdrant 1.13 and will be removed from the server; use `points.query` instead.")
+
       response = client.connection.post("collections/#{collection_name}/#{PATH}/search") do |req|
         req.params["consistency"] = consistency unless consistency.nil?
 
@@ -234,6 +236,8 @@ module Qdrant
       searches:,
       consistency: nil
     )
+      deprecation_warning("`points.batch_search` is deprecated since Qdrant 1.13 and will be removed from the server; use `points.query` instead.")
+
       response = client.connection.post("collections/#{collection_name}/#{PATH}/search/batch") do |req|
         req.params["consistency"] = consistency unless consistency.nil?
 
@@ -259,6 +263,8 @@ module Qdrant
       lookup_from: nil,
       consistency: nil
     )
+      deprecation_warning("`points.recommend` is deprecated since Qdrant 1.13 and will be removed from the server; use `points.query` instead.")
+
       response = client.connection.post("collections/#{collection_name}/#{PATH}/recommend") do |req|
         req.params["consistency"] = consistency unless consistency.nil?
 
@@ -284,6 +290,8 @@ module Qdrant
       searches:,
       consistency: nil
     )
+      deprecation_warning("`points.batch_recommend` is deprecated since Qdrant 1.13 and will be removed from the server; use `points.query` instead.")
+
       response = client.connection.post("collections/#{collection_name}/#{PATH}/recommend/batch") do |req|
         req.params["consistency"] = consistency unless consistency.nil?
 

data/lib/qdrant/service.rb

@@ -27,6 +27,8 @@ module Qdrant
       write:,
       error_message: nil
     )
+      deprecation_warning("the lock API was removed in Qdrant 1.16; `set_lock` only works against older servers.")
+
       response = client.connection.post("locks") do |req|
         req.body = {
           write: write
@@ -38,6 +40,8 @@ module Qdrant
 
     # Get lock options. If write is locked, all write operations and collection creation are forbidden
     def locks
+      deprecation_warning("the lock API was removed in Qdrant 1.16; `locks` only works against older servers.")
+
       response = client.connection.get("locks")
       response.body
     end

data/lib/qdrant/version.rb

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

data/script/e2e.rb

@@ -85,22 +85,22 @@ begin
   puts "e2e: point write and read round trip passed"
 
   body = ok_body!(
-    client.points.search(
+    client.points.query(
       collection_name: collection_name,
-      vector: [1.0, 0.0, 0.0],
+      query: [1.0, 0.0, 0.0],
       limit: 1,
       with_payload: true,
       with_vector: false
     ),
-    "points.search"
+    "points.query"
   )
-  hit = body.fetch("result").first
-  assert!(hit && hit["id"] == 1, "points.search did not return point 1 first")
-  assert!(hit["score"].to_f > 0.99, "points.search score was #{hit["score"].inspect}")
+  hit = body.dig("result", "points").first
+  assert!(hit && hit["id"] == 1, "points.query did not return point 1 first")
+  assert!(hit["score"].to_f > 0.99, "points.query score was #{hit["score"].inspect}")
 
   body = ok_body!(client.points.count(collection_name: collection_name, exact: true), "points.count")
   assert!(body.dig("result", "count") == 2, "points.count did not return 2")
-  puts "e2e: search and count passed"
+  puts "e2e: query and count passed"
 
   body = ok_body!(client.points.delete(collection_name: collection_name, points: [1, 2], wait: true), "points.delete")
   assert!(body.dig("result", "status") == "completed", "points.delete did not return a completed status")

metadata

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