chroma-db 0.8.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31c131ea9ab54905d2665520303a6fa9790e960cd70db7b8cfda1aac3ee09231
-  data.tar.gz: d21d2e933fee0ad66f37f053982e3601db7b3bce1702ce6ecb8cd6e0f70d8018
+  metadata.gz: 8f7a0ef254b27e7e3d06c9720893c4b416f971948aeda404da63d18325309c6f
+  data.tar.gz: 356777eec892cd99f11635cadcd4e510e5041cc40b8b04c2a8e4ecaa1179da65
 SHA512:
-  metadata.gz: cc54636facaf17ca619aebc999c9712f8babb112c53dca3935e3027bdb7d37e1412554fbef93357459e8da505c4f1030fbba7480474882667481c8fdb962fbc2
-  data.tar.gz: 12b613729e1f6981f56c7d4c91324ab417a2e6a05e299bd11eeb15388f49c8f5b45ec6e5b6287522789be2ae65b9387e9357ba14bebe31ec26838d0b784f4917
+  metadata.gz: cbb667f3547c3a08f0a3859d3dc3fe4802bbbca46722af363cfcfad556c163c83e3606b48254fd43c8b1186ace9c63e764e32568e7e7eef4987b8e89632847f0
+  data.tar.gz: 1822f4ff02a4dafffbb32078ed186da5d9ccb0228725bb8fbf5b61f8d1f89fd78c0297605e49a9e050e2086ce81ac67771b0a273db25ed59970b5930729a2baa

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## 0.8.2 2024-10-16
+
+- Fixes API change in Collection#query method. Parameters `where` and `where_document` are now optional.
+
+## 0.8.1 2024-10-16
+
+- Adds support for Chroma hosted service. See README for more details how to set your `api_key`, `tenant`, and `database`.
+
 ## [0.6.0] 2023-06-05
 
 - Fix failure to rescue from API call exceptions.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chroma-db (0.8.0)
+    chroma-db (0.8.2)
       dry-monads (~> 1.6)
       ruby-next (~> 1.0, >= 1.0.3)
       zeitwerk (~> 2.6.0)

data/README.md

@@ -54,7 +54,7 @@ Chroma.database = "my_database" # Optional
 
 ## Requirements
 
-- Ruby 3.0.6 or newer
+- Ruby 3.1.4 or newer
 - Chroma Database 0.4.24 or later running as a client/server model.
 
 For Chroma database 0.3.22 or older, please use version 0.3.0 of this gem.

data/lib/chroma/api_operations/request.rb

@@ -94,9 +94,9 @@ module Chroma
 
           case response
           in Net::HTTPSuccess
-            return Success(response_data)
+            Success(response_data)
           else
-            return Failure(response_data)
+            Failure(response_data)
           end
         end
 
@@ -107,6 +107,8 @@ module Chroma
         end
 
         private def build_request(method, uri, params)
+          uri.query = URI.encode_www_form(tenant: Chroma.tenant, database: Chroma.database) unless Chroma.api_key.nil?
+
           request = case method
           when :post then Net::HTTP::Post.new(uri)
           when :put then Net::HTTP::Put.new(uri)
@@ -115,10 +117,11 @@ module Chroma
             Net::HTTP::Get.new(uri)
           end
 
+          api_key = ENV.fetch("CHROMA_SERVER_AUTHN_CREDENTIALS", Chroma.api_key)
           request.content_type = "application/json"
           request.body = params.to_json if params.size > 0
           request.basic_auth(uri.user, uri.password) if !uri.user.nil?
-          request['X-Chroma-Token'] = ENV.fetch('CHROMA_SERVER_AUTHN_CREDENTIALS', nil) if ENV.fetch('CHROMA_SERVER_AUTHN_CREDENTIALS', nil)
+          request["X-Chroma-Token"] = api_key unless api_key.nil?
           request
         end
       end

data/lib/chroma/chroma.rb

@@ -25,18 +25,7 @@ module Chroma
   end
 
   def self.api_url
-    base_url = "#{connect_host}/#{api_base}/#{api_version}"
-    uri = URI(base_url)
-
-    unless api_key.nil?
-      query_params = {
-        tenant: tenant,
-        database: database
-      }
-      query_params["x-chroma-token"] = api_key
-      uri.query = URI.encode_www_form(query_params)
-    end
-    uri.to_s
+    "#{connect_host}/#{api_base}/#{api_version}"
   end
 
   Chroma.log_level = ENV["CHROMA_LOG"].to_i unless ENV["CHROMA_LOG"].nil?

data/lib/chroma/resources/collection.rb

@@ -34,7 +34,7 @@ module Chroma
       #   embeddings = collection.query(query_embeddings: [[1.5, 2.9, 3.3]], results: 5)
       #
       # Return an Array of Embedding with query results.
-      def query(query_embeddings:, results: 10, where: {}, where_document: {}, include: %w[metadatas documents distances])
+      def query(query_embeddings:, results: 10, where: nil, where_document: nil, include: %w[metadatas documents distances])
         payload = {
           query_embeddings:,
           n_results: results,
@@ -43,6 +43,8 @@ module Chroma
           include:
         }
 
+        payload.delete_if { |_key, value| value.nil? }
+
         result = self.class.execute_request(:post, "#{Chroma.api_url}/collections/#{id}/query", payload)
 
         if result.success?

data/lib/chroma/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Chroma
-  VERSION = "0.8.0"
+  VERSION = "0.8.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chroma-db
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.2
 platform: ruby
 authors:
 - Mario Alberto Chávez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-14 00:00:00.000000000 Z
+date: 2024-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads
@@ -128,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.21
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: Ruby client for Chroma DB.