chroma-db 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c10027541e8648c0ba4e6ebe73fef4fdb75d55a1c04c0e59bcd681a1b2108598
-  data.tar.gz: fb5a8a590885bc26fcabfd379b6ee5aaada355f99e05ab50eca32280a80bccea
+  metadata.gz: 860772eeeda54b7057681aa0d82bf1d1737501c6d699645d74f0df907e2881d0
+  data.tar.gz: 66acb245e05333fdf2c2abae27823d8963f7c75c7186b0922ae83265cdb577ca
 SHA512:
-  metadata.gz: 3665995e6028599eae9daf8f546e2923075b441596b4f5854bfb33901405ea8c59c47d8ec237d1c079e8e9b68115181fb2cfb4db5fd794db1e2a5a8cd61bf755
-  data.tar.gz: 1f1a9534d6422b34b7d7f0a8a6cb1a4f331076e44dc030e46fcbf7af971b9181747b1fa38a616cf3c44636010a54ea0eaba357dd3f7878f94cf51c40d883d854
+  metadata.gz: '09c0a28cc809673c658558f95bb3fa85bc6e4845eb95b076105b4aa0e083693663e0fab386e534ae674848fc0007944b135e8a85d48a4bd616a5a105b7592b31'
+  data.tar.gz: b1037adef96c371cbc794580000e40ea1017085093889f248019095f80c82f18d74ca6a5394703f81f873d6366d9a99aebae56dbe6391c4e34274b56d794ccae

data/Gemfile.lock

@@ -1,91 +1,103 @@
 PATH
   remote: .
   specs:
-    chroma-db (0.6.0)
+    chroma-db (0.7.0)
       dry-monads (~> 1.6)
       ruby-next (>= 0.15.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.4)
+    abbrev (0.1.2)
+    addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
-    concurrent-ruby (1.2.2)
-    crack (0.4.5)
+    bigdecimal (3.1.7)
+    concurrent-ruby (1.2.3)
+    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.0)
+    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)
+    minitest (5.22.3)
+    paco (0.2.3)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
-    psych (5.1.0)
+      racc
+    psych (5.1.2)
       stringio
-    public_suffix (5.0.1)
+    public_suffix (5.0.5)
+    racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.0.6)
-    rbs (3.1.0)
-    rdoc (6.5.0)
+    rake (13.2.1)
+    rbs (3.4.4)
+      abbrev
+    rdoc (6.6.3.1)
       psych (>= 4.0.0)
-    regexp_parser (2.8.0)
-    rexml (3.2.5)
-    rubocop (1.50.2)
+    regexp_parser (2.9.0)
+    require-hooks (0.2.2)
+    rexml (3.2.6)
+    rubocop (1.62.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)
+      rubocop-ast (>= 1.31.1, < 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.31.2)
+      parser (>= 3.3.0.4)
+    rubocop-performance (1.20.2)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+    ruby-next (1.0.2)
+      paco (~> 0.2)
+      require-hooks (~> 0.2)
+      ruby-next-core (= 1.0.2)
+      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.2)
+    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.35.1)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.50.2)
+      rubocop (~> 1.62.0)
       standard-custom (~> 1.0.0)
-      standard-performance (~> 1.0.1)
-    standard-custom (1.0.0)
+      standard-performance (~> 1.3)
+    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.3.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.20.2)
+    stringio (3.1.0)
+    unicode-display_width (2.5.0)
+    unparser (0.6.13)
       diff-lcs (~> 1.3)
-      parser (>= 3.2.0)
-    webmock (3.18.1)
+      parser (>= 3.3.0)
+    webmock (3.23.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.6.8)
+    zeitwerk (2.6.13)
 
 PLATFORMS
   arm64-darwin-22

data/README.md

@@ -41,7 +41,7 @@ For a complete example, please refer to the Jupyter Noterbook [Chroma gem](https
 
 ## Requirements
 - Ruby 2.7.8 or newer
-- Chroma Database 0.3.25 or later running as a client/server model.
+- 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.
 
@@ -61,6 +61,7 @@ To use the Jupyter Noterbook [Chroma gem](https://github.com/mariochavez/chroma/
     $ 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. 
 
@@ -68,6 +69,8 @@ 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). 
 

data/lib/.rbnext/2.7/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: use_ssl) do |http|
             Chroma::Util.log_debug("Sending a request", {method: method, uri: uri, params: params})
             http.request(request)
@@ -125,6 +125,7 @@ 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
         end

data/lib/.rbnext/2.7/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/.rbnext/2.7/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/.rbnext/3.1/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: use_ssl) do |http|
             Chroma::Util.log_debug("Sending a request", {method: method, uri: uri, params: params})
             http.request(request)
@@ -117,6 +117,7 @@ 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
         end

data/lib/.rbnext/3.1/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/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,6 +117,7 @@ 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
         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.7.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.7.0
 platform: ruby
 authors:
 - Mario Alberto Chávez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-06 00:00:00.000000000 Z
+date: 2024-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Ruby client for Chroma DB.