turbopuffer-ruby 0.2.0.pre.alpha.2 → 0.2.0.pre.alpha.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb7be5124356c0bcd637642e5f56b96e428889dc4e134a9bc880f868ebc17b24
-  data.tar.gz: 1309991cd8b0b822fa5fa3d6f67fb8c7790199ffb6101424ee6bfce87f49cf31
+  metadata.gz: 1f1fb1336c9388a530172358ada2e2883b25463ae15575216f14711e628f0651
+  data.tar.gz: 461943b677f38feb4b327ac315c1ecce8997336992235329402e762baa7070f8
 SHA512:
-  metadata.gz: 7dbbc536240fd62400665f437c48c26539e540cfe273616587b69efbeee213aa050ffbf0d3c4e237e026212638a828c3e87d3778ff7b2084af5572ec5d33730a
-  data.tar.gz: bce84da11da7e137f08860c9c782e9a4648b00b4d41e18eb1e58d643707a7f4c939cc92858aeaa89a41485fc137e9d4675cedd6402e7252a9b901520ecacf757
+  metadata.gz: af9ab90abd3318e3578092c4247962f45df06cd06c67cf3ae8690361638dddaa8571096cf080c54c381ea666aeee08eba3029162b35fab45e672cecb5a7edac6
+  data.tar.gz: 1dacf25a64e4c91e670e607e3732386c2a3ba043d0671c938918e59301cceda0dc6c3a0309f98714ad9e29db2705226a6c19ee4626c49c45f0152c54d7aef848

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.2.0-alpha.3 (2025-07-22)
+
+Full Changelog: [v0.2.0-alpha.2...v0.2.0-alpha.3](https://github.com/turbopuffer/turbopuffer-ruby/compare/v0.2.0-alpha.2...v0.2.0-alpha.3)
+
+### Bug Fixes
+
+* allow modifying Row objects in place ([269929a](https://github.com/turbopuffer/turbopuffer-ruby/commit/269929aace3a3b69a5db972d1382a01080f0c70a))
+* improve the README example ([84793e6](https://github.com/turbopuffer/turbopuffer-ruby/commit/84793e649a8b45d3e7c0826c90899a3b25220190))
+* **internal:** tests should use normalized property names ([a2bfe81](https://github.com/turbopuffer/turbopuffer-ruby/commit/a2bfe81c3149796e0d2fed0e54db8e6deacef03b))
+
+
+### Chores
+
+* **internal:** version bump ([9ac2013](https://github.com/turbopuffer/turbopuffer-ruby/commit/9ac201321f311c97923ed9c667d88d1b9c4221f0))
+
 ## 0.2.0-alpha.2 (2025-07-21)
 
 Full Changelog: [v0.2.0-alpha.1...v0.2.0-alpha.2](https://github.com/turbopuffer/turbopuffer-ruby/compare/v0.2.0-alpha.1...v0.2.0-alpha.2)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "turbopuffer-ruby", "~> 0.2.0.pre.alpha.2"
+gem "turbopuffer-ruby", "~> 0.2.0.pre.alpha.3"
 ```
 
 <!-- x-release-please-end -->
@@ -27,19 +27,39 @@ gem "turbopuffer-ruby", "~> 0.2.0.pre.alpha.2"
 ```ruby
 require "bundler/setup"
 require "turbopuffer"
+require "json"
 
-turbopuffer = Turbopuffer::Client.new(
-  api_key: ENV["TURBOPUFFER_API_KEY"] # This is the default and can be omitted
+tpuf = Turbopuffer::Client.new(
+  # API tokens are created in the dashboard: https://turbopuffer.com/dashboard
+  api_key: ENV["TURBOPUFFER_API_KEY"],
+  # Pick the right region: https://turbopuffer.com/docs/regions
+  region: "gcp-us-central1",
 )
 
-response = turbopuffer.namespace("products").write(
-  distance_metric: "cosine_distance",
-  upsert_rows: [
-    {id: "2108ed60-6851-49a0-9016-8325434f3845", vector: [0.1, 0.2], attributes: {name: "Red boots", price: 34.99}}
-  ]
+ns = tpuf.namespace("example")
+
+# Query nearest neighbors with filter
+result = ns.query(
+  rank_by: ["vector", "ANN", openai_or_rand_vector("walrus narwhal")],
+  top_k: 10,
+  filters: ["And", [["name", "Eq", "foo"], ["public", "Eq", 1]]],
+  include_attributes: ["name"],
 )
+puts result.rows
+# {id: 1, "$dist": 0.0, name: "foo"}
+
+# Full-text search on an attribute
+# If you want to combine FTS and vector search, see https://turbopuffer.com/docs/hybrid-search
+result = ns.query(
+  top_k: 10,
+  filters: ["name", "Eq", "foo"],
+  rank_by: ["text", "BM25", "quick walrus"],
+)
+puts result.rows
+# {id: 1, "$dist": 0.19856808}
+# {id: 2, "$dist": 0.16853257}
 
-puts(response.rows_affected)
+# See https://turbopuffer.com/docs/quickstart for more.s
 ```
 
 ### Pagination
@@ -213,13 +233,7 @@ You can provide typesafe request parameters like so:
 ```ruby
 turbopuffer.namespace("products").write(
   distance_metric: "cosine_distance",
-  upsert_rows: [
-    Turbopuffer::Row.new(
-      id: "2108ed60-6851-49a0-9016-8325434f3845",
-      vector: [0.1, 0.2],
-      attributes: {name: "Red boots", price: 34.99}
-    )
-  ]
+  upsert_rows: [Turbopuffer::Row.new(id: "2108ed60-6851-49a0-9016-8325434f3845", vector: [0.1, 0.2])]
 )
 ```
 
@@ -237,13 +251,7 @@ turbopuffer.namespace("products").write(
 # You can also splat a full Params class:
 params = Turbopuffer::NamespaceWriteParams.new(
   distance_metric: "cosine_distance",
-  upsert_rows: [
-    Turbopuffer::Row.new(
-      id: "2108ed60-6851-49a0-9016-8325434f3845",
-      vector: [0.1, 0.2],
-      attributes: {name: "Red boots", price: 34.99}
-    )
-  ]
+  upsert_rows: [Turbopuffer::Row.new(id: "2108ed60-6851-49a0-9016-8325434f3845", vector: [0.1, 0.2])]
 )
 turbopuffer.namespace("products").write(**params)
 ```

data/lib/turbopuffer/models/row.rb

@@ -33,6 +33,14 @@ module Turbopuffer
       def respond_to_missing?(name, include_private = false)
         @data.key?(name) || super
       end
+
+      def []=(key, value)
+        unless key.instance_of?(Symbol)
+          raise ArgumentError.new("Expected symbol key for set, got #{key.inspect}")
+        end
+
+        @data[key] = value
+      end
     end
   end
 end

data/lib/turbopuffer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Turbopuffer
-  VERSION = "0.2.0.pre.alpha.2"
+  VERSION = "0.2.0.pre.alpha.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: turbopuffer-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre.alpha.2
+  version: 0.2.0.pre.alpha.3
 platform: ruby
 authors:
 - Turbopuffer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-21 00:00:00.000000000 Z
+date: 2025-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool