chroma-db 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9273343cf2f29991d61d8e5393dfd06541211c84e03769162fa984c9ca2c8620
-  data.tar.gz: 3dd3e94d5914e5776aef673f18b06bbb6f61254bbe4eb51ae25f8675f6c9c72b
+  metadata.gz: 81e14d1d408077096602201fb386612b9d511a0294726efcba2942491a164763
+  data.tar.gz: bc06c130d7ad215d5a2264527813e10900bda1b6d8975de8c59712a7cb438a99
 SHA512:
-  metadata.gz: 8c94d838879f22cae956b9a4b7e66f8b8a8d76792770dda6eb9a91b197aa0eb3b8408256653402feb750732f35fb221ae2ebedfe05ab49d89896b80579228ed0
-  data.tar.gz: f5ad7421b54da9909a3a1c76d36d07738ccd44aaa934a7e960e5b102608e24c61e36243b59c0d2ba469e01c34b2cc360e2a07a82516d1a4a2d73cfffa49334fa
+  metadata.gz: 109074182103666dca9fb201c0dc473220b0a5ee6849ff3022203a4debea1388347b98d74a0ce14d75361953a1c70b6c1a24ab62387c317e394712fe677e082a
+  data.tar.gz: f075cf97229240b6d38ff72946188ec436a0010b8f0925d1b30a63e6c2b3dc0b6bf8436a16d0c3abf5c89cabe64951b73bd10eb036b95a3ae9a40b8f2c778cdd

data/.rbnextrc

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

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
+## [0.4.0] 2023-05-23
+
+- This version implements Chroma's API change where Collection uses its collection id for many operations. Changes in the
+  gem are internals, public API remains the same. Just be aware you need Chroma 0.3.25 or better with this gem version.
+
+## [0.3.0] 2023-05-19
+
+- Uses Ruby Next to transpile newer Ruby to older Ruby versions in order to support Ruby 2.7, 3.0, and 3.1
+
+## [0.2.0] 2023-05-12
+
+- Complete API to communicate with Chroma database via its API interface
+
 ## [0.1.0] - 2023-05-04
 
 - Initial release

data/Gemfile

@@ -13,4 +13,6 @@ gem "standard", "~> 1.3"
 
 gem "rbs", "~> 3.1"
 
+gem "sdoc", "~> 2.6", ">= 2.6.1"
+
 gem "webmock", "~> 3.18", ">= 3.18.1"

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    chroma-db (0.2.0)
+    chroma-db (0.4.0)
       dry-monads (~> 1.6)
+      ruby-next (>= 0.15.0)
 
 GEM
   remote: https://rubygems.org/
@@ -13,6 +14,7 @@ GEM
     concurrent-ruby (1.2.2)
     crack (0.4.5)
       rexml
+    diff-lcs (1.5.0)
     dry-core (1.0.0)
       concurrent-ruby (~> 1.0)
       zeitwerk (~> 2.6)
@@ -28,10 +30,14 @@ GEM
     parallel (1.23.0)
     parser (3.2.2.1)
       ast (~> 2.4.1)
+    psych (5.1.0)
+      stringio
     public_suffix (5.0.1)
     rainbow (3.1.1)
     rake (13.0.6)
     rbs (3.1.0)
+    rdoc (6.5.0)
+      psych (>= 4.0.0)
     regexp_parser (2.8.0)
     rexml (3.2.5)
     rubocop (1.50.2)
@@ -49,7 +55,16 @@ GEM
     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)
+      unparser (~> 0.6.0)
+    ruby-next-core (0.15.3)
+    ruby-next-parser (3.1.1.3)
+      parser (>= 3.0.3.1)
     ruby-progressbar (1.13.0)
+    sdoc (2.6.1)
+      rdoc (>= 5.0)
     standard (1.28.2)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
@@ -61,7 +76,11 @@ GEM
     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)
+      diff-lcs (~> 1.3)
+      parser (>= 3.2.0)
     webmock (3.18.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
@@ -77,6 +96,8 @@ DEPENDENCIES
   minitest (~> 5.0)
   rake (~> 13.0)
   rbs (~> 3.1)
+  ruby-next (>= 0.15.0)
+  sdoc (~> 2.6, >= 2.6.1)
   standard (~> 1.3)
   webmock (~> 3.18, >= 3.18.1)
 

data/README.md

@@ -1,39 +1,78 @@
-# Chroma
+# Chroma's Ruby client
 
-TODO: Delete this and the text below, and describe your gem
+Chroma is the open-source embedding database. Chroma makes it easy to build LLM apps by making knowledge, facts, and skills pluggable for LLMs.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/chroma`. To experiment with that code, run `bin/console` for an interactive prompt.
+This Ruby gem is a client to connect to Chroma's database via its API.
 
-## Installation
+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
+
+```ruby
+require "logger"
+
+# Requiere Chroma Ruby client.
+require "chroma-db"
+
+# Configure Chroma's host. Here you can specify your own host.
+Chroma.connect_host = "http://localhost:8000"
+Chroma.logger = Logger.new($stdout)
+Chroma.log_level = Chroma::LEVEL_ERROR
+
+# Check current Chrome server version
+version = Chroma::Resources::Database.version
+puts version
+
+# Create a new collection
+collection = Chroma::Resources::Collection.create(collection_name, {lang: "ruby", gem: "chroma-db"})
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+# Add embeddings
+embeddings = [
+  Chroma::Resources::Embedding.new(id: "1", embedding: [1.3, 2.6, 3.1], metadata: {client: "chroma-rb"}, document: "ruby"),
+  Chroma::Resources::Embedding.new(id: "2", embedding: [3.7, 2.8, 0.9], metadata: {client: "chroma-rb"}, document: "rails")
+]
+collection.add(embeddings)
+```
 
-Install the gem and add to the application's Gemfile by executing:
+For a complete example, please refer to the Jupyter Noterbook [Chroma gem](https://github.com/mariochavez/chroma/blob/main/notebook/Chroma%20Gem.ipynb)
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+## Requirements
+- Ruby 2.7.8 or newer
+- Chroma Database 0.3.25 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
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install chroma-db
 
-## Usage
+## 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:
 
-TODO: Write usage instructions here
+    $ pip install jupyterlab notebook ipywidgets
+    $ gem install iruby
+    $ iruby register --force
 
-## Development
+## 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. 
 
-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 install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To generate Rdoc documentation for the gem, run `bundle exec rake rdoc`.
 
 ## 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://opensource.org/licenses/MIT).
+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/Rakefile

@@ -12,3 +12,17 @@ end
 require "standard/rake"
 
 task default: %i[test standard]
+
+require "sdoc" # and use your RDoc task the same way you used it before
+require "rdoc/task" # ensure this file is also required in order to use `RDoc::Task`
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = "doc/rdoc"      # name of output directory
+  rdoc.options << "--format=sdoc" # explictly set the sdoc generator
+  rdoc.template = "rails"         # template used on api.rubyonrails.org
+end
+
+desc "Run Ruby Next nextify"
+task :nextify do
+  sh "bundle exec ruby-next nextify -V"
+end

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

@@ -0,0 +1,138 @@
+# 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 = options.delete(:use_ssl) || false
+          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
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end