chroma-db 0.7.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 860772eeeda54b7057681aa0d82bf1d1737501c6d699645d74f0df907e2881d0
-  data.tar.gz: 66acb245e05333fdf2c2abae27823d8963f7c75c7186b0922ae83265cdb577ca
+  metadata.gz: 5a4fc64ab9c97c9630f0f438467d4a126c7665a33992ad0f357ca9ddfaab7eeb
+  data.tar.gz: d5b48661b75917eaf8923dd7d2125230f9701144d3cffb18a5addeb8e90419e6
 SHA512:
-  metadata.gz: '09c0a28cc809673c658558f95bb3fa85bc6e4845eb95b076105b4aa0e083693663e0fab386e534ae674848fc0007944b135e8a85d48a4bd616a5a105b7592b31'
-  data.tar.gz: b1037adef96c371cbc794580000e40ea1017085093889f248019095f80c82f18d74ca6a5394703f81f873d6366d9a99aebae56dbe6391c4e34274b56d794ccae
+  metadata.gz: 986a2f8366a22ebca4b8f7aa831aa4bd04ef373768f62d7811b7f0f45d45dcc58d6fbe2758dc1af85ea2a8111d3aeee8185930b4639af412fb912d8067f5c970
+  data.tar.gz: ddbf174e31dd7999a6dd0462f9fe03b3e0a439a71bb0cb7487d1d09f558ebd6a67aa6f543e28babd432d5f9fb24804c52ad322a8f53e5737a396ba9c09222274

data/.rbnextrc

@@ -1,5 +1,5 @@
 nextify: |
   ./lib
-  --min-version=2.6
+  --min-version=3.1.0
   --edge
   --proposed

data/.ruby-version

@@ -1 +1 @@
-3.2.2
+3.3.5

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## 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

@@ -5,14 +5,10 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in chroma-db.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-
-gem "minitest", "~> 5.0"
-
-gem "standard", "~> 1.3"
-
-gem "rbs", "~> 3.1"
+gem "rake", "~> 13.2", ">= 13.2.1"
 
+gem "minitest", "~> 5.25.0"
+gem "standard", "~> 1.41"
+gem "rbs", "~> 3.6.0"
 gem "sdoc", "~> 2.6", ">= 2.6.1"
-
-gem "webmock", "~> 3.18", ">= 3.18.1"
+gem "webmock", "~> 3.24"

data/Gemfile.lock

@@ -1,19 +1,19 @@
 PATH
   remote: .
   specs:
-    chroma-db (0.7.0)
+    chroma-db (0.8.1)
       dry-monads (~> 1.6)
-      ruby-next (>= 0.15.0)
+      ruby-next (~> 1.0, >= 1.0.3)
+      zeitwerk (~> 2.6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    abbrev (0.1.2)
-    addressable (2.8.6)
-      public_suffix (>= 2.0.2, < 6.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.2)
-    bigdecimal (3.1.7)
-    concurrent-ruby (1.2.3)
+    bigdecimal (3.1.8)
+    concurrent-ruby (1.3.4)
     crack (1.0.0)
       bigdecimal
       rexml
@@ -25,93 +25,95 @@ GEM
       concurrent-ruby (~> 1.0)
       dry-core (~> 1.0, < 2)
       zeitwerk (~> 2.6)
-    hashdiff (1.1.0)
+    hashdiff (1.1.1)
     json (2.7.2)
     language_server-protocol (3.17.0.3)
     lint_roller (1.1.0)
-    minitest (5.22.3)
+    logger (1.6.1)
+    minitest (5.25.1)
     paco (0.2.3)
-    parallel (1.24.0)
-    parser (3.3.0.5)
+    parallel (1.26.3)
+    parser (3.3.5.0)
       ast (~> 2.4.1)
       racc
     psych (5.1.2)
       stringio
-    public_suffix (5.0.5)
-    racc (1.7.3)
+    public_suffix (6.0.1)
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
-    rbs (3.4.4)
-      abbrev
-    rdoc (6.6.3.1)
+    rbs (3.6.1)
+      logger
+    rdoc (6.7.0)
       psych (>= 4.0.0)
-    regexp_parser (2.9.0)
+    regexp_parser (2.9.2)
     require-hooks (0.2.2)
-    rexml (3.2.6)
-    rubocop (1.62.1)
+    rexml (3.3.8)
+    rubocop (1.66.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.2)
-      parser (>= 3.3.0.4)
-    rubocop-performance (1.20.2)
+    rubocop-ast (1.32.3)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.22.1)
       rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
-    ruby-next (1.0.2)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-next (1.0.3)
       paco (~> 0.2)
       require-hooks (~> 0.2)
-      ruby-next-core (= 1.0.2)
+      ruby-next-core (= 1.0.3)
       ruby-next-parser (>= 3.2.2.0)
       unparser (~> 0.6.0)
-    ruby-next-core (1.0.2)
+    ruby-next-core (1.0.3)
     ruby-next-parser (3.2.2.0)
       parser (>= 3.0.3.1)
     ruby-progressbar (1.13.0)
     sdoc (2.6.1)
       rdoc (>= 5.0)
-    standard (1.35.1)
+    standard (1.41.0)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.62.0)
+      rubocop (~> 1.66.0)
       standard-custom (~> 1.0.0)
-      standard-performance (~> 1.3)
+      standard-performance (~> 1.5)
     standard-custom (1.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.50)
-    standard-performance (1.3.1)
+    standard-performance (1.5.0)
       lint_roller (~> 1.1)
-      rubocop-performance (~> 1.20.2)
-    stringio (3.1.0)
-    unicode-display_width (2.5.0)
-    unparser (0.6.13)
+      rubocop-performance (~> 1.22.0)
+    stringio (3.1.1)
+    unicode-display_width (2.6.0)
+    unparser (0.6.15)
       diff-lcs (~> 1.3)
       parser (>= 3.3.0)
-    webmock (3.23.0)
+    webmock (3.24.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.6.13)
+    zeitwerk (2.6.18)
 
 PLATFORMS
   arm64-darwin-22
+  arm64-darwin-24
+  x86_64-darwin-22
   x86_64-linux
 
 DEPENDENCIES
   chroma-db!
-  minitest (~> 5.0)
-  rake (~> 13.0)
-  rbs (~> 3.1)
-  ruby-next (>= 0.15.0)
+  minitest (~> 5.25.0)
+  rake (~> 13.2, >= 13.2.1)
+  rbs (~> 3.6.0)
+  ruby-next (~> 1.0, >= 1.0.3)
   sdoc (~> 2.6, >= 2.6.1)
-  standard (~> 1.3)
-  webmock (~> 3.18, >= 3.18.1)
+  standard (~> 1.41)
+  webmock (~> 3.24)
 
 BUNDLED WITH
-   2.4.12
+   2.4.19

data/README.md

@@ -7,6 +7,7 @@ This Ruby gem is a client to connect to Chroma's database via its API.
 Find more information about Chroma on how to install at their website. [https://www.trychroma.com/](https://www.trychroma.com/)
 
 ## Description
+
 Chroma-rb is a Ruby client for Chroma Database. It works with version 0.3.22 or better **(Please see requirements below)**.
 
 A small example usage
@@ -39,43 +40,65 @@ collection.add(embeddings)
 
 For a complete example, please refer to the Jupyter Noterbook [Chroma gem](https://github.com/mariochavez/chroma/blob/main/notebook/Chroma%20Gem.ipynb)
 
+### Hosted Chroma
+
+You can use this gem with Chroma hosted service at [https://trychroma.com](https://trychroma.com). In the configuration
+options, you can set the `api_key` to use the hosted service. Also, you can set the `tenant` and `database` to use
+the hosted service, by default they are set to `default_tenant` and `default_database`.
+
+```ruby
+Chroma.api_key = "cd75e50bf8213fb7ce57c05b"
+Chroma.tenant = "my_tenant"     # Optional
+Chroma.database = "my_database" # Optional
+```
+
 ## Requirements
-- Ruby 2.7.8 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.
 
 ## Installation
+
 To install the gem and add to the application's Gemfile, execute:
 
-    $ bundle add chroma-db
+    bundle add chroma-db
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install chroma-db
+    gem install chroma-db
 
 ## Use the Jupyter notebook
+
 To use the Jupyter Noterbook [Chroma gem](https://github.com/mariochavez/chroma/blob/main/notebook/Chroma%20Gem.ipynb) in this repository, please install python 3.9 or better, iruby and Jupyter notebook dependencies:
 
-    $ pip install jupyterlab notebook ipywidgets
-    $ gem install iruby
-    $ iruby register --force
+    pip install jupyterlab notebook ipywidgets
+    gem install iruby
+    iruby register --force
+
+**NOTE:** Notebook has an example on how to create embeddings using [Ollama](https://ollama.com) and [Nomic embed text](https://ollama.com/library/nomic-embed-text) with a simple Ruby HTTP client.
 
-**NOTE: ** Notebook has an example on how to create embeddings using [Ollama](https://ollama.com) and [Nomic embed text](https://ollama.com/library/nomic-embed-text) with a simple Ruby HTTP client.
-## Development 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. 
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 generate Rdoc documentation for the gem, run `bundle exec rake rdoc`.
 
 ## Rails integration
+
 If you are looking for a solution to embed your ActiveRecord models into ChromaDB, look at [Cromable gem](https://github.com/AliOsm/chromable)
+
 ## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/mariochavez/chroma. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/mariochavez/chroma/blob/main/CODE_OF_CONDUCT.md). 
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/mariochavez/chroma>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/mariochavez/chroma/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://github.com/mariochavez/chroma/blob/main/LICENSE.txt).
 
 ## Code of Conduct
+
 Everyone interacting in the Chroma project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mariochavez/chroma/blob/main/CODE_OF_CONDUCT.md).

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"] = api_key unless api_key.nil?
           request
         end
       end

data/lib/chroma/chroma.rb

@@ -19,6 +19,9 @@ module Chroma
     def_delegators :@config, :api_version, :api_version=
     def_delegators :@config, :log_level, :log_level=
     def_delegators :@config, :logger, :logger=
+    def_delegators :@config, :tenant, :tenant=
+    def_delegators :@config, :database, :database=
+    def_delegators :@config, :api_key, :api_key=
   end
 
   def self.api_url

data/lib/chroma/chroma_configuration.rb

@@ -26,6 +26,33 @@ module Chroma
     # Returns the String host name.
     attr_accessor :connect_host
 
+    # Sets the tenant for the Chroma service, Defaults to 'default_tenant'.
+    #
+    # Examples
+    #
+    #   config.tenant = "my_tenant"
+    #
+    # Returns the String tenant.
+    attr_accessor :tenant
+
+    # Sets the database for the Chroma service, Defaults to 'default_database'.
+    #
+    # Examples
+    #
+    #   config.database = "my_database"
+    #
+    # Returns the String database.
+    attr_accessor :database
+
+    # Sets the API Key for the Chroma service, for `x-chroma-token` header.
+    #
+    # Examples
+    #
+    #   config.api_key = "1234abcd"
+    #
+    # Returns the String database.
+    attr_accessor :api_key
+
     # Sets the base path for the Chroma API.
     #
     # Examples
@@ -70,6 +97,9 @@ module Chroma
       @api_version = "v1"
 
       @log_level = Chroma::LEVEL_INFO
+
+      @tenant ||= "default_tenant"
+      @database ||= "default_database"
     end
   end
 end

data/lib/chroma/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chroma-db
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Mario Alberto Chávez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-13 00:00:00.000000000 Z
+date: 2024-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads
@@ -24,34 +24,60 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: ruby-next
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 1.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: ruby-next
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 1.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 1.0.3
 description: Chroma is the open-source embedding database. Chroma makes it easy to
   build LLM apps by making knowledge, facts, and skills pluggable for LLMs.
 email:
@@ -69,11 +95,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/.rbnext/2.7/chroma/api_operations/request.rb
-- lib/.rbnext/2.7/chroma/resources/collection.rb
-- lib/.rbnext/2.7/chroma/resources/database.rb
-- lib/.rbnext/3.1/chroma/api_operations/request.rb
-- lib/.rbnext/3.1/chroma/resources/collection.rb
 - lib/chroma-db.rb
 - lib/chroma/api_operations/request.rb
 - lib/chroma/chroma.rb
@@ -100,14 +121,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.8
+      version: 3.1.4
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
 summary: Ruby client for Chroma DB.

data/lib/.rbnext/2.7/chroma/api_operations/request.rb

@@ -1,139 +0,0 @@
-# frozen_string_literal: true
-
-module Chroma
-  module APIOperations
-    using RubyNext
-
-    # Request's response Data object.
-    #
-    # status - HTTP status code. It is zero when a request fails due to network error.
-    # body - Parsed JSON object or response body.
-    # headers - HTTP response headers.
-    # error - Exception or Net::HTTPResponse object if the response is not Net::HTTPSuccess
-    #
-    # NOTE: Not supported yet by Ruby Next
-    # Response = Data.define(:status, :body, :headers, :error)
-    Response = Struct.new("Response", :status, :body, :headers, :error)
-
-    # Request module provides functionality to perform HTTP requests.
-    module Request
-      module ClassMethods
-        include Dry::Monads[:result]
-
-        # Execute an HTTP request and return a monad wrapping the response.
-        #
-        # method - The HTTP method to use (e.g. 'GET', 'POST'). Method must be a `Symbol`.
-        # url - The URL to send the request to.
-        # params - The query parameters or request body. Params needs to be in a form of a Hash.
-        # options - Additional options to pass to the request.
-        #
-        # A `Dry::Monads::Result` monad wrapping the response, either a success or failure.
-        # The response is a `Chroma::APIOperations::Response` Data object.
-        #
-        # Examples
-        #
-        #   result = execute_request(:get, "https://example.com", {name: "test request"})
-        #   if result.success?
-        #     puts "Response status: #{result.success.status}"
-        #     puts "Response body: #{result.success.body}"
-        #   else
-        #     puts "Request failed with error: #{result.failure.error}"
-        #   end
-        def execute_request(method, url, params = {}, options = {})
-          uri = URI.parse(url)
-
-          request = build_request(method, uri, params)
-
-          use_ssl = uri.scheme == "https"
-          response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: use_ssl) do |http|
-            Chroma::Util.log_debug("Sending a request", {method: method, uri: uri, params: params})
-            http.request(request)
-          end
-
-          build_response(response)
-        rescue => ex
-          build_response(ex)
-        end
-
-        private def build_response(response)
-          case; when ((__m__ = response)) && false 
-          when (((success_response,) = nil) || ((Net::HTTPSuccess === __m__) && ((success_response = __m__) || true)))
-
-
-            Chroma::Util.log_info("Successful response", code: success_response.code)
-
-            build_response_details(success_response)
-          when (((redirect_response,) = nil) || ((Net::HTTPRedirection === __m__) && ((redirect_response = __m__) || true)))
-
-
-            Chroma::Util.log_info("Server redirect response", code: redirect_response.code, location: redirect_response["location"])
-
-            build_response_details(redirect_response)
-          when (((client_error_response,) = nil) || ((Net::HTTPClientError === __m__) && ((client_error_response = __m__) || true)))
-
-
-            Chroma::Util.log_error("Client error response", code: client_error_response.code, body: client_error_response.body)
-
-            build_response_details(client_error_response)
-          when (((server_error_response,) = nil) || ((Net::HTTPServerError === __m__) && ((server_error_response = __m__) || true)))
-
-
-            Chroma::Util.log_error("Server error response", code: server_error_response.code)
-
-            build_response_details(server_error_response, parse_body: false)
-          else
-            Chroma::Util.log_error("An error happened", error: response.to_s)
-
-            build_response_details(response, exception: true, parse_body: false)
-          end
-        end
-
-        private def build_response_details(response, exception: false, parse_body: true)
-          response_data = Chroma::APIOperations::Response.new(
-            exception ? 0 : response.code.to_i,
-            if exception
-              exception.to_s
-            else
-              (parse_body ? body_to_json(response.body) : response.body)
-            end,
-            exception ? {} : response.each_header.to_h,
-            response.is_a?(Net::HTTPSuccess) ? nil : response
-          )
-
-          case; when ((__m__ = response)) && false 
-          when (Net::HTTPSuccess === __m__)
-            return Success(response_data)
-          else
-            return Failure(response_data)
-          end
-        end
-
-        private def body_to_json(content)
-          JSON.parse(content, symbolize_keys: true)
-        rescue JSON::ParserError, TypeError
-          content
-        end
-
-        private def build_request(method, uri, params)
-          request = case method
-          when :post then Net::HTTP::Post.new(uri)
-          when :put then Net::HTTP::Put.new(uri)
-          when :delete then Net::HTTP::Delete.new(uri)
-          else
-            Net::HTTP::Get.new(uri)
-          end
-
-          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
-        end
-      end
-
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-    end
-  end
-end