chroma-db 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c10027541e8648c0ba4e6ebe73fef4fdb75d55a1c04c0e59bcd681a1b2108598
-  data.tar.gz: fb5a8a590885bc26fcabfd379b6ee5aaada355f99e05ab50eca32280a80bccea
+  metadata.gz: 31c131ea9ab54905d2665520303a6fa9790e960cd70db7b8cfda1aac3ee09231
+  data.tar.gz: d21d2e933fee0ad66f37f053982e3601db7b3bce1702ce6ecb8cd6e0f70d8018
 SHA512:
-  metadata.gz: 3665995e6028599eae9daf8f546e2923075b441596b4f5854bfb33901405ea8c59c47d8ec237d1c079e8e9b68115181fb2cfb4db5fd794db1e2a5a8cd61bf755
-  data.tar.gz: 1f1a9534d6422b34b7d7f0a8a6cb1a4f331076e44dc030e46fcbf7af971b9181747b1fa38a616cf3c44636010a54ea0eaba357dd3f7878f94cf51c40d883d854
+  metadata.gz: cc54636facaf17ca619aebc999c9712f8babb112c53dca3935e3027bdb7d37e1412554fbef93357459e8da505c4f1030fbba7480474882667481c8fdb962fbc2
+  data.tar.gz: 12b613729e1f6981f56c7d4c91324ab417a2e6a05e299bd11eeb15388f49c8f5b45ec6e5b6287522789be2ae65b9387e9357ba14bebe31ec26838d0b784f4917

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/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,105 +1,119 @@
 PATH
   remote: .
   specs:
-    chroma-db (0.6.0)
+    chroma-db (0.8.0)
       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:
-    addressable (2.8.4)
-      public_suffix (>= 2.0.2, < 6.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.2)
-    concurrent-ruby (1.2.2)
-    crack (0.4.5)
+    bigdecimal (3.1.8)
+    concurrent-ruby (1.3.4)
+    crack (1.0.0)
+      bigdecimal
       rexml
-    diff-lcs (1.5.0)
-    dry-core (1.0.0)
+    diff-lcs (1.5.1)
+    dry-core (1.0.1)
       concurrent-ruby (~> 1.0)
       zeitwerk (~> 2.6)
     dry-monads (1.6.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 1.0, < 2)
       zeitwerk (~> 2.6)
-    hashdiff (1.0.1)
-    json (2.6.3)
+    hashdiff (1.1.1)
+    json (2.7.2)
     language_server-protocol (3.17.0.3)
-    lint_roller (1.0.0)
-    minitest (5.18.0)
-    parallel (1.23.0)
-    parser (3.2.2.1)
+    lint_roller (1.1.0)
+    logger (1.6.1)
+    minitest (5.25.1)
+    paco (0.2.3)
+    parallel (1.26.3)
+    parser (3.3.5.0)
       ast (~> 2.4.1)
-    psych (5.1.0)
+      racc
+    psych (5.1.2)
       stringio
-    public_suffix (5.0.1)
+    public_suffix (6.0.1)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.0.6)
-    rbs (3.1.0)
-    rdoc (6.5.0)
+    rake (13.2.1)
+    rbs (3.6.1)
+      logger
+    rdoc (6.7.0)
       psych (>= 4.0.0)
-    regexp_parser (2.8.0)
-    rexml (3.2.5)
-    rubocop (1.50.2)
+    regexp_parser (2.9.2)
+    require-hooks (0.2.2)
+    rexml (3.3.8)
+    rubocop (1.66.1)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      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.28.0, < 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.28.1)
-      parser (>= 3.2.1.0)
-    rubocop-performance (1.16.0)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    ruby-next (0.15.3)
-      ruby-next-core (= 0.15.3)
-      ruby-next-parser (>= 3.1.1.0)
+    rubocop-ast (1.32.3)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.22.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-next (1.0.3)
+      paco (~> 0.2)
+      require-hooks (~> 0.2)
+      ruby-next-core (= 1.0.3)
+      ruby-next-parser (>= 3.2.2.0)
       unparser (~> 0.6.0)
-    ruby-next-core (0.15.3)
-    ruby-next-parser (3.1.1.3)
+    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.28.2)
+    standard (1.41.0)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.50.2)
+      rubocop (~> 1.66.0)
       standard-custom (~> 1.0.0)
-      standard-performance (~> 1.0.1)
-    standard-custom (1.0.0)
+      standard-performance (~> 1.5)
+    standard-custom (1.0.2)
       lint_roller (~> 1.0)
-    standard-performance (1.0.1)
-      lint_roller (~> 1.0)
-      rubocop-performance (~> 1.16.0)
-    stringio (3.0.6)
-    unicode-display_width (2.4.2)
-    unparser (0.6.7)
+      rubocop (~> 1.50)
+    standard-performance (1.5.0)
+      lint_roller (~> 1.1)
+      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.2.0)
-    webmock (3.18.1)
+      parser (>= 3.3.0)
+    webmock (3.24.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.6.8)
+    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,40 +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
-- Chroma Database 0.3.25 or later running as a client/server model.
+
+- Ruby 3.0.6 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.
 
-## 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

@@ -44,7 +44,7 @@ module Chroma
 
           request = build_request(method, uri, params)
 
-          use_ssl = options.delete(:use_ssl) || false
+          use_ssl = uri.scheme == "https"
           response = Net::HTTP.start(uri.hostname, uri.port, use_ssl:) do |http|
             Chroma::Util.log_debug("Sending a request", {method:, uri:, params:})
             http.request(request)
@@ -117,7 +117,8 @@ module Chroma
 
           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
         end
       end

data/lib/chroma/chroma.rb

@@ -19,10 +19,24 @@ 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
-    "#{connect_host}/#{api_base}/#{api_version}"
+    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
   end
 
   Chroma.log_level = ENV["CHROMA_LOG"].to_i unless ENV["CHROMA_LOG"].nil?

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/resources/collection.rb

@@ -180,7 +180,7 @@ module Chroma
       #     Embedding.new(id: "Array#fetch", embeddings: [9.8, 2.3, 2.9], metadata: {url: "https://..."}),
       #     Embedding.new(id: "Array#select", embeddings: [5.6, 3.1, 4.7], metadata: {url: "https://..."})
       #   ]
-      #   collection.upsert()
+      #   collection.upsert(embeddings)
       #
       # Returns true with success or raises a Chroma::Error on failure.
       def upsert(embeddings = [])
@@ -237,22 +237,6 @@ module Chroma
         end
       end
 
-      # Creates an index for the collection.
-      #
-      # Examples:
-      #
-      #   collection = Chroma::Resource::Collection.get("ruby-documentation")
-      #   collection.create_index
-      #
-      # Returns true on success or raise a Chroma::Error on failure.
-      def create_index
-        result = self.class.execute_request(:post, "#{Chroma.api_url}/collections/#{id}/create_index")
-
-        return true if result.success?
-
-        self.class.raise_failure_error(result)
-      end
-
       # Create a new collection on the database.
       #
       # name - The name of the collection. Name needs to be between 3-63 characters, starts and ends

data/lib/chroma/resources/database.rb

@@ -29,17 +29,6 @@ module Chroma
         raise_failure_error(result)
       end
 
-      # Persist Chroma database data.
-      #
-      # Resturn true on success or raise a Chroma::Error on failure.
-      def self.persist
-        result = execute_request(:post, "#{Chroma.api_url}/persist")
-
-        return result.success.body if result.success?
-
-        raise_failure_error(result)
-      end
-
       # Check the heartbeat of the Chroma database server.
       #
       # Return a Hash with a timestamp.

data/lib/chroma/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chroma-db
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Mario Alberto Chávez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-06 00:00:00.000000000 Z
+date: 2024-10-14 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.4.12
+rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
 summary: Ruby client for Chroma DB.