chromable 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6d73bbad7320d850d166f26242c6dda3e66d953c8fce98ff6f7ccc442ba79be
-  data.tar.gz: 8d5c5bf8082c3736715f11c79d68d95781917e86c511e09a148293758d4bba4d
+  metadata.gz: 5b0b02fff83da824d9195113352c1d68dfaaa06bde568eba6448fb4cb79e0919
+  data.tar.gz: 879ac8e61ba6be8a9490174f13517c509409c0d271fd93e9fd06d6a22cf3f1fe
 SHA512:
-  metadata.gz: c023701e1f6cf205af6d5fe8dfbf44f84904896c1cf8bb1937060d98f1f218c668524f02a75f60384ce109a26eb3c0a4a7394ab37c2a56c938dac33387572874
-  data.tar.gz: 5d75a9dc95ddefd0698d3544d9281a361ec16d89d49de3b93742f10f3a2798ac700da1c609a78bc2d6af31817ee798ffff8bfb28aa6d18b1793c871e07a84ef9
+  metadata.gz: a5a97a3c29f46ee311eafa1d2ea9d51d032568a2bafa64877d22590403152b623318a93d650328af3db1db005e5315b4a90002185a9bfa0c328fcb81dd374276
+  data.tar.gz: cc14d192452c5e4f72ee090f5423c7b78afe1449e1cd1b25009fcb7d4db29394fe50a2093e107c438f9d4b0d60a46ff8f3230f4a6fd9a1aab5f5b33cdc99798e

data/README.md

@@ -4,19 +4,11 @@ Ruby on Rails integration for ChromaDB based on `chroma-db` gem.
 
 ## Installation
 
-Since `chromable` is depending on `chroma-db` gem, you will need to install it using:
-
-    $ bundle add chroma-db
-
-Or, if you are not using bundler, install it by executing:
-
-    $ gem install chroma-db
-
-Then, install `chromable` and add to the application's Gemfile by executing:
+Install `chromable` and add it to the application's Gemfile by executing:
 
     $ bundle add chromable
 
-Or, if you are not using bundler, install it by executing:
+Or, if bundler is not being used to manage dependencies, install `chromable` by executing:
 
     $ gem install chromable
 
@@ -39,6 +31,10 @@ class Post < ApplicationRecord
   include Chromable
 
   chromable document: :content, metadata: %i[author category], embedder: :embed
+
+  def embed
+    # Call OpenAI now please :)
+  end
 end
 ```
 
@@ -51,6 +47,8 @@ Optionaly you can pass `collection_name:`. If not passed, the plural form of the
 
 All `chromable` method arguments are optional.
 
+At this point, `chromable` will create, update, and destroy the ChromaDB embeddings for your objects based on Rails callbacks.
+
 To interact with the ChromaDB collection, `chromable` provides `Model.collection` method to retrieve the collection instance.
 Also, `chromable` provides the following methods for each model instance:
 

data/lib/chromable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Chromable
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

data/lib/chromable.rb

@@ -53,6 +53,6 @@ module Chromable
   end
 
   alias embedding chroma_embedding unless method_defined? :embedding
-  alias upsert_embedding chroma_embedding unless method_defined? :upsert_embedding
-  alias destroy_embedding chroma_embedding unless method_defined? :destroy_embedding
+  alias upsert_embedding chroma_upsert_embedding unless method_defined? :upsert_embedding
+  alias destroy_embedding chroma_destroy_embedding unless method_defined? :destroy_embedding
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chromable
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Ali Hamdi Ali Fadel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-07 00:00:00.000000000 Z
+date: 2023-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport