aoororachain 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 284ff16b017b5f61a4308863affa07001b954330ecba1dafd50b1712d1b37d0f
+  data.tar.gz: f9ab6347628e62ed16ea0c5083eb58d5f0ee731a76446b16991e253302532ba6
+SHA512:
+  metadata.gz: 789f73b9acb88506caf3744d0c2c769c4cd2838bbfdd42f29cf11b9c0b7df7e8b248cc4283e54fb795a195270c274a1a6ef3efd354c1c80e3947f53e3dbc33a7
+  data.tar.gz: 3c99aa8e13512d8aaef08fafa2804e104769d0b02d78afed69c80b6824a210e19295ac079998bdf139a9c0c754ac9bf125e6678d597c524b2a6207ae7016e841

data/.rubocop.yml

@@ -0,0 +1 @@
+/Users/mariochavez/Development/neovim-files/.rubocop.yml

data/.solargraph.yml

@@ -0,0 +1 @@
+/Users/mariochavez/Development/neovim-files/.solargraph.yml

data/.standard.yml

@@ -0,0 +1,8 @@
+fix: true               # default: false
+parallel: true          # default: false
+format: progress        # default: Standard::Formatter
+ruby_version: 3.2.2     # default: RUBY_VERSION
+default_ignores: false  # default: true
+
+ignore:                 # default: []
+  - 'tmp/**/*'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-05-24
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at mario.chavez@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in aoororachain.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "standard", "~> 1.3"

data/Gemfile.lock

@@ -0,0 +1,124 @@
+PATH
+  remote: .
+  specs:
+    aoororachain (0.1.0)
+      chroma-db (~> 0.5.0)
+      llm_client (~> 0.1.2)
+      pdf-reader (~> 2.11)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    Ascii85 (1.1.0)
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
+    afm (0.2.2)
+    ast (2.4.2)
+    chroma-db (0.5.0)
+      dry-monads (~> 1.6)
+      ruby-next (>= 0.15.0)
+    concurrent-ruby (1.2.2)
+    diff-lcs (1.5.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    dry-core (1.0.0)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
+    dry-monads (1.6.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    ffi (1.15.5)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    hashery (2.1.2)
+    http (5.1.1)
+      addressable (~> 2.8)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      llhttp-ffi (~> 0.4.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.0.0)
+    llhttp-ffi (0.4.0)
+      ffi-compiler (~> 1.0)
+      rake (~> 13.0)
+    llm_client (0.1.2)
+      dry-monads (~> 1.6)
+      http (~> 5.1, >= 5.1.1)
+      ruby-next (>= 0.15.0)
+    minitest (5.18.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    pdf-reader (2.11.0)
+      Ascii85 (~> 1.0)
+      afm (~> 0.2.1)
+      hashery (~> 2.0)
+      ruby-rc4
+      ttfunk
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      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)
+      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)
+      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)
+    ruby-rc4 (0.1.5)
+    standard (1.28.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50.2)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.0.1)
+    standard-custom (1.0.0)
+      lint_roller (~> 1.0)
+    standard-performance (1.0.1)
+      lint_roller (~> 1.0)
+      rubocop-performance (~> 1.16.0)
+    ttfunk (1.7.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+    unicode-display_width (2.4.2)
+    unparser (0.6.7)
+      diff-lcs (~> 1.3)
+      parser (>= 3.2.0)
+    zeitwerk (2.6.8)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  aoororachain!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.4.12

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Mario Alberto Chávez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# Aoororachain
+
+
+Aoororachain is Ruby chain tool to work with LLMs
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add aoororachain
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install aoororachain
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/aoororachain. 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/[USERNAME]/aoororachain/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).
+
+## Code of Conduct
+
+Everyone interacting in the Aoororachain project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/aoororachain/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/aoororachain/chains/retrieval_qa.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Aoororachain
+  module Chains
+    class RetrievalQA
+      def initialize(llm, retriever, type: :stuff)
+        @llm = llm
+        @retriever = retriever
+        @type = type
+      end
+
+      def complete(prompt:)
+        context = @retriever.search(prompt)
+
+        system_prompt = "Una conversación entre un humano y un asistente de inteligencia artificial. El asistente response usando el contexto la pregunta. Si no sabes la respuesta, simplemente di que no sabes, no trates de inventar una."
+        context_prompt = "Contexto: #{context.map(&:document).join(" ").tr("\n", " ")}"
+        question_prompt = "Pregunta: #{prompt}"
+
+        stuff_prompt = [system_prompt, context_prompt, question_prompt]
+        success, response = @llm.complete(prompt: stuff_prompt.join(". "))
+
+        if success
+          completion = {
+            response:,
+            sources: context.map(&:metadata)
+          }
+        else
+          completion = {
+            response: "Sorry we had a problem with the LLM",
+            sources: []
+          }
+          Aoororachain::Util.log_error("Failed to complete", message: response)
+        end
+
+        completion
+      end
+    end
+  end
+end

data/lib/aoororachain/configuration.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Aoororachain
+  # The Configuration class allows you to configure Aoororachain
+  # It can be initialized directly calling #new method.
+  #
+  # Examples
+  #
+  #   configuration = Aoororachain::Configuration.new
+  #   configurarion.logger = Logger.new($stdout)
+  #
+  # Or via a setup block.
+  #
+  # Examples
+  #
+  #   Aoororachain::Configuration.setup do |config|
+  #     config.logger = Logger.new($stdout)
+  #   end
+  class Configuration
+    # Sets the logger for the Aoororachain service client.
+    #
+    # Examples
+    #
+    #   config.logger = Logger.new(STDOUT)
+    #
+    # Returns the Logger instance.
+    attr_accessor :logger
+    # Sets the logger's log level for the Aoororachain service client.
+    #
+    # Examples
+    #
+    #   config.log_level = Aoororachain::LEVEL_INFO
+    #
+    # Returns the log level constant
+    attr_accessor :log_level
+
+    def self.setup
+      new.tap do |instance|
+        yield(instance) if block_given?
+      end
+    end
+
+    def initialize
+      @log_level = Aoororachain::LEVEL_INFO
+    end
+  end
+end

data/lib/aoororachain/document.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Aoororachain
+  class Document
+    attr_reader :content, :metadata
+
+    def initialize(content, metadata = {})
+      @content = content
+      @metadata = metadata
+    end
+  end
+end

data/lib/aoororachain/embeddings/local_python_embedding.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+module Aoororachain
+  module Embeddings
+    class LocalPythonEmbedding
+      MODEL_INSTRUCTOR_L = "hkunlp/instructor-large"
+      MODEL_INSTRUCTOR_XL = "hkunlp/instructor-xl"
+      MODEL_ALL_MPNET = "sentence-transformers/all-mpnet-base-v2"
+
+      def initialize(options = {})
+        @model = options.delete(:model) || MODEL_ALL_MPNET
+        @device = options.delete(:device) || "cpu"
+
+        Aoororachain::Util.log_info("Using", data: {model: @model, device: @device})
+        Aoororachain::Util.log_info("This embedding calls Python code using system call. First time initialization might take long due to Python dependencies installation.")
+
+        install_python_dependencies
+      end
+
+      def embed_documents(documents, include_metadata: false)
+        texts = documents.map { |document| "#{document.content} #{include_metadata ? document.metadata.to_json : ""}.strip" }
+
+        embeddings = embed_texts(texts)
+        embeddings || []
+      end
+
+      def embed_texts(texts)
+        return if texts.empty?
+
+        Aoororachain::Util.log_info("First time usage might take long time due to models download.")
+        texts_file_path = save_texts_to_file(texts)
+
+        embeddings_file_path = embed_texts_python(texts_file_path)
+
+        embeddings = load_embeddings(embeddings_file_path) if !embeddings_file_path.nil?
+        embeddings || []
+      end
+
+      def embed_query(text)
+        return [] if text.nil? || text.strip == ""
+
+        Aoororachain::Util.log_info("First time usage might take long time due to models download.")
+        [embed_text_python(text)]
+      end
+
+      def to_s
+        "#{self.class} : #{@model} : #{@device}"
+      end
+
+      private
+
+      def run_system(command)
+        _, stdout, stderr, wait_thr = Open3.popen3(command)
+        stdout_data = stdout.gets(nil)
+        stdout.close
+        stderr_data = stderr.gets(nil)
+        stderr.close
+        exit_code = wait_thr.value
+
+        [stdout_data, stderr_data, exit_code]
+      end
+
+      def load_embeddings(file_path)
+        embeddings = JSON.parse(File.read(file_path))
+        delete_file(file_path)
+
+        embeddings
+      end
+
+      def parse_output(data)
+        delimiter = "========"
+        parsed_text = data.split(delimiter).last.strip
+
+        return nil if parsed_text.nil?
+        JSON.parse(parsed_text)
+      end
+
+      def embed_text_python(text)
+        command = <<~PYTHON
+          python - << EOF
+          from InstructorEmbedding import INSTRUCTOR
+          from langchain.embeddings import HuggingFaceInstructEmbeddings
+
+          instructor_embeddings = HuggingFaceInstructEmbeddings(model_name="#{@model}",
+                                                                model_kwargs={"device": "#{@device}"})
+
+          embeddings = instructor_embeddings.embed_query("#{text}")
+          print("========")
+          print(embeddings)
+        PYTHON
+
+        stdout_data, stderr_data, exit_code = run_system(command)
+
+        if exit_code != 0
+          Aoororachain::Util.log_error("Failed to embed documents: #{stderr_data}")
+          return nil
+        end
+
+        Aoororachain::Util.log_debug("Text embedded")
+        parse_output(stdout_data)
+      end
+
+      def embed_texts_python(texts_file_path)
+        embeddings_file_path = "#{texts_file_path}.emb"
+
+        command = <<~PYTHON
+          python - << EOF
+          import json
+          from InstructorEmbedding import INSTRUCTOR
+          from langchain.embeddings import HuggingFaceInstructEmbeddings
+
+          instructor_embeddings = HuggingFaceInstructEmbeddings(model_name="#{@model}",
+                                                                model_kwargs={"device": "#{@device}"})
+
+          with open("#{texts_file_path}") as f:
+              file_content = f.read()
+
+          documents = json.loads(file_content)
+
+          embeddings = instructor_embeddings.embed_documents(list(documents))
+
+          with open("#{embeddings_file_path}", "w", encoding="utf-8") as file:
+              json.dump(embeddings, file, ensure_ascii=False, indent=4)
+          EOF
+        PYTHON
+
+        _, stderr_data, exit_code = run_system(command)
+
+        if exit_code != 0
+          Aoororachain::Util.log_error("Failed to embed documents: #{stderr_data}")
+          return nil
+        end
+
+        Aoororachain::Util.log_debug("Documents embedded")
+        embeddings_file_path
+      end
+
+      def delete_file(file_path)
+        File.delete(file_path)
+      rescue => ex
+        Aoororachain::Util.log_error("Failed delete file #{file_path}", data: {exception: ex.to_s})
+      end
+
+      def save_texts_to_file(texts)
+        temp_file = Tempfile.new("Aoororachain.embeddings")
+        temp_file.write(texts.to_json)
+        temp_file.close
+
+        file_path = temp_file.path
+        Aoororachain::Util.log_debug("Texts saved to #{file_path}.")
+
+        file_path
+      end
+
+      def install_python_dependencies
+        stdout_data, stderr_data, exit_code = run_system("pip -q install langchain sentence_transformers InstructorEmbedding")
+
+        if exit_code != 0
+          Aoororachain.log_error("Failed to install Python dependencies: #{stderr_data}")
+          return false
+        end
+
+        Aoororachain::Util.log_debug("Python installed dependencies: #{stdout_data}")
+        true
+      end
+    end
+  end
+end

data/lib/aoororachain/llms/llama_server.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "llm_client"
+
+module Aoororachain
+  module Llms
+    class LlamaServer
+      def initialize(host)
+        LlmClient.host = host
+        LlmClient.logger = Aoororachain.logger
+        LlmClient.log_level = Aoororachain.log_level
+      end
+
+      def complete(prompt:)
+        result = LlmClient.completion(prompt)
+
+        [result.success?, result.success? ? result.success.body["response"].gsub(/Usuario:.*Asistente:/, "") : result.failure.message]
+      end
+    end
+  end
+end

data/lib/aoororachain/loaders/directory_loader.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Aoororachain
+  module Loaders
+    class DirectoryLoader
+      def initialize(path:, glob:, loader:, parser: nil)
+        @path = path
+        @glob = glob
+        @loader = loader
+        @parser = parser
+      end
+
+      def load
+        Dir.glob("#{@path}/#{@glob}").map { |file| @loader.load(file, parser: @parser) }
+      end
+    end
+  end
+end

data/lib/aoororachain/loaders/file_loader.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Aoororachain
+  module Loaders
+    class FileLoader
+      def self.load(file, parser: nil)
+        text = File.read(file)
+        metadata = {source: file}
+
+        if !parser.nil?
+          text, additional_metadata = parser.parse(text)
+          Aoororachain::Util.log_debug("Extracted metadata using parser #{parser.class}", {additional_metadata:})
+          metadata.merge!(additional_metadata)
+        end
+
+        Aoororachain::Util.log_debug("File loaded", {file:})
+        [Document.new(text, metadata)]
+      end
+    end
+  end
+end

data/lib/aoororachain/loaders/pdf_loader.rb

@@ -0,0 +1,33 @@
+## frozen_string_literal: true
+
+require "pdf/reader"
+
+module Aoororachain
+  module Loaders
+    class PDFLoader
+      def self.load(file, parser: nil)
+        reader = PDF::Reader.new(file)
+        documents = []
+
+        base_metadata = {source: file, pages: reader.page_count}
+
+        reader.pages.each do |page|
+          metadata = base_metadata.dup
+          metadata[:page] = page.number
+          text = page.text
+
+          if !parser.nil?
+            text, additional_metadata = parser.parse(text)
+            Aoororachain::Util.log_debug("Extracted metadata using parser #{parser.class}", {additional_metadata:})
+            metadata.merge!(additional_metadata)
+          end
+
+          documents << Document.new(text, metadata)
+        end
+
+        Aoororachain::Util.log_debug("File loaded", {file:})
+        documents
+      end
+    end
+  end
+end

data/lib/aoororachain/recursive_text_splitter.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Aoororachain
+  class RecursiveTextSplitter
+    def initialize(size: 1024, overlap: 200)
+      @size = size
+      @overlap = overlap
+    end
+
+    def split_documents(documents)
+      original_documents = Array(documents)
+
+      new_documents = []
+      original_documents.each do |document|
+        texts = split_text(document.content)
+        texts.each do |text|
+          new_documents << Document.new(text, document.metadata)
+        end
+      end
+
+      new_documents
+    end
+
+    def split_text(text)
+      split_recursive(text, 0, [])
+    end
+
+    private
+
+    def split_recursive(text, start_index, chunks)
+      # Base case: If the remaining word count is less than the chunk size, return the chunks
+      if start_index + @size > text.length
+        chunks << text[start_index..]
+        return chunks
+      end
+
+      # Calculate the end index of the current chunk
+      end_index = start_index + @size
+      end_index += @overlap if start_index != 0
+
+      # Add the current chunk to the array
+      chunk = text[start_index...end_index]
+
+      # Correct start and end indexes
+      start_index_corrected = (start_index == 0) ? start_index : detect_first_whitespace_or_line_return_position(chunk)
+      end_index_corrected = detect_last_whitespace_or_line_return_position(chunk)
+
+      if start_index_corrected == end_index_corrected
+        end_index_corrected = end_index
+        chunks << chunk
+      else
+        chunks << chunk[start_index_corrected..end_index_corrected]&.strip
+      end
+
+      # Calculate the next start index with overlap
+      next_start_index = end_index - @overlap - (@size - end_index_corrected)
+
+      # Recursively split the remaining words
+      split_recursive(text, next_start_index, chunks)
+    end
+
+    def detect_first_whitespace_or_line_return_position(string)
+      position = string.index(/\s|\n/)
+      position.nil? ? 0 : position
+    end
+
+    def detect_last_whitespace_or_line_return_position(string)
+      position = string.rindex(/\s|\n/)
+      position.nil? ? -1 : position
+    end
+  end
+end

data/lib/aoororachain/util.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Aoororachain
+  module Util
+    # Logs an error message with the given data using the provided Logger instance.
+    #
+    # message - A String message to be logged.
+    # data - A Hash of additional data to be included in the log entry.
+    #
+    # Examples
+    #
+    #   Util.log_error("An error occurred", { user_id: 123, error_code: "404" })
+    #
+    # Returns nothing.
+    def self.log_error(message, data = {})
+      config = data.delete(:config) || Aoororachain.config
+      logger = config.logger || Aoororachain.logger
+
+      if (!logger.nil? || !config.log_level.nil?) && config.log_level <= Aoororachain::LEVEL_ERROR
+        log_internal(message, data, level: Aoororachain::LEVEL_ERROR, logger: Aoororachain.logger)
+      end
+    end
+
+    # Logs a debug message with the given data using the provided Logger instance.
+    #
+    # message - A String message to be logged.
+    # data - A Hash of additional data to be included in the log entry.
+    #
+    # Examples
+    #
+    #   Util.log_debug("Debugging information", { user_id: 123, action: "update" })
+    #
+    # Returns nothing.
+    def self.log_debug(message, data = {})
+      config = data.delete(:config) || Aoororachain.config
+      logger = config.logger || Aoororachain.logger
+
+      if (!logger.nil? || !config.log_level.nil?) && config.log_level <= Aoororachain::LEVEL_DEBUG
+        log_internal(message, data, level: Aoororachain::LEVEL_DEBUG, logger: Aoororachain.logger)
+      end
+    end
+
+    # Logs an informational message with the given data using the provided Logger instance.
+    #
+    # message - A String message to be logged.
+    # data - A Hash of additional data to be included in the log entry.
+    #
+    # Examples
+    #
+    #   Util.log_info("Processing request", { request_id: "abc123", route: "/users" })
+    #
+    # Returns nothing.
+    def self.log_info(message, data = {})
+      config = data.delete(:config) || Aoororachain.config
+      logger = config.logger || Aoororachain.logger
+
+      if (!logger.nil? || !config.log_level.nil?) && config.log_level <= Aoororachain::LEVEL_INFO
+        log_internal(message, data, level: Aoororachain::LEVEL_INFO, logger: Aoororachain.logger)
+      end
+    end
+
+    def self.log_internal(message, data = {}, level:, logger:)
+      data_str = data.reject { |_k, v| v.nil? }.map { |(k, v)| "#{k}=#{v}" }.join(" ")
+
+      logger&.log(level, "message=#{message} #{data_str}".strip)
+    end
+    private_class_method :log_internal
+  end
+end

data/lib/aoororachain/vector_stores/chroma.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "chroma-db"
+
+module Aoororachain
+  module VectorStores
+    class Chroma
+      DEFAULT_RESULTS = 3
+
+      def initialize(embedder:, options: {})
+        ::Chroma.connect_host = options.delete(:host)
+        ::Chroma.logger = options.delete(:logger) || Aoororachain.logger
+        ::Chroma.log_level = options.delete(:log_level) || Aoororachain.log_level
+
+        @embedder = embedder
+      end
+
+      def from_documents(documents, index:, include_metadata: false)
+        @store = ::Chroma::Resources::Collection.get_or_create(index, {embedder: @embedder.to_s})
+
+        documents_embeddings = embed_documents(documents, include_metadata:)
+
+        documents_embeddings.each do |batch|
+          Aoororachain::Util.log_debug("Storing embeddings")
+          @store.add(batch)
+        end
+
+        true
+      end
+
+      def from_index(index)
+        @store = ::Chroma::Resources::Collection.get_or_create(index, {embedder: @embedder.to_s})
+
+        true
+      end
+
+      def add(documents, include_metadata: false)
+        documents_embeddings = embed_documents(documents, include_metadata:)
+
+        documents_embeddings.each do |batch|
+          Aoororachain::Util.log_debug("Storing embeddings")
+          @store.add(batch)
+        end
+
+        true
+      end
+
+      def as_retriever(search_type: :similarity, results: DEFAULT_RESULTS)
+        Aoororachain::VectorStores::Retriever.new(self, search_type:, similarity:, results:)
+      end
+
+      def similarity_search_by_vector(query, results: DEFAULT_RESULTS, filter: {})
+        query(query_texts: query, results:, where: filter, include: %w[metadatas documents])
+      end
+
+      def similarity_search_with_score(query, results: DEFAULT_RESULTS, filter: {})
+        query(query_texts: query, results:, where: filter)
+      end
+      alias_method :similarity_search, :similarity_search_with_score
+
+      private
+
+      def query(query_texts: "", results: DEFAULT_RESULTS, where: {}, include: %w[metadatas documents distances])
+        embeddings = @embedder.embed_query(query_texts)
+        Aoororachain::Util.log_debug("Query embeddings #{query_texts}", data: {embeddings:, results:, where:, include:})
+
+        @store.query(query_embeddings: embeddings, results:, where:, include:)
+      end
+
+      def embed_documents(documents, include_metadata: false)
+        documents_embeddings = @embedder.embed_documents(documents, include_metadata:)
+
+        batch_size = 3_000
+        index = 0
+
+        documents.each_slice(batch_size).map do |batch|
+          batch.map do |document|
+            element = ::Chroma::Resources::Embedding.new(id: SecureRandom.uuid, embedding: documents_embeddings[index], metadata: document.metadata, document: document.content)
+            index += 1
+            element
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aoororachain/vector_stores/retriever.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Aoororachain
+  module VectorStores
+    class Retriever
+      attr_accessor :search_type, :results
+
+      def initialize(vector_store, search_type: :similarity, results: 3)
+        @vector_store = vector_store
+        @search_type = search_type
+        @results = results
+      end
+
+      def search(query, **options)
+        results = options.delete(:results) || @results
+        filter = options.delete(:filter) || {}
+
+        if @search_type == :similarity
+          @vector_store.similarity_search(query, results:, filter:)
+        end
+      end
+    end
+  end
+end

data/lib/aoororachain/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Aoororachain
+  VERSION = "0.1.0"
+end

data/lib/aoororachain.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "uri"
+require "json"
+require "logger"
+require "forwardable"
+require "tempfile"
+
+require_relative "aoororachain/version"
+require_relative "aoororachain/util"
+require_relative "aoororachain/configuration"
+require_relative "aoororachain/document"
+require_relative "aoororachain/loaders/directory_loader"
+require_relative "aoororachain/loaders/file_loader"
+require_relative "aoororachain/loaders/pdf_loader"
+require_relative "aoororachain/recursive_text_splitter"
+require_relative "aoororachain/embeddings/local_python_embedding"
+require_relative "aoororachain/vector_stores/chroma"
+require_relative "aoororachain/vector_stores/retriever"
+require_relative "aoororachain/llms/llama_server"
+require_relative "aoororachain/chains/retrieval_qa"
+
+module Aoororachain
+  # map to the same values as the standard library's logger
+  LEVEL_DEBUG = Logger::DEBUG
+  LEVEL_ERROR = Logger::ERROR
+  LEVEL_INFO = Logger::INFO
+
+  @config = Aoororachain::Configuration.setup
+
+  class << self
+    extend Forwardable
+
+    attr_reader :config
+
+    # User configuration options
+    def_delegators :@config, :log_level, :log_level=
+    def_delegators :@config, :logger, :logger=
+  end
+
+  Aoororachain.log_level = ENV["AOORORACHAIN_LOG"].to_i unless ENV["AOORORACHAIN_LOG"].nil?
+end

data/sig/aoororachain.rbs

@@ -0,0 +1,4 @@
+module Aoororachain
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: aoororachain
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mario Alberto Chávez
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chroma-db
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: pdf-reader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: llm_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+description: Ruby chain tools to work with LLMs
+email:
+- mario.chavez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".solargraph.yml"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/aoororachain.rb
+- lib/aoororachain/chains/retrieval_qa.rb
+- lib/aoororachain/configuration.rb
+- lib/aoororachain/document.rb
+- lib/aoororachain/embeddings/local_python_embedding.rb
+- lib/aoororachain/llms/llama_server.rb
+- lib/aoororachain/loaders/directory_loader.rb
+- lib/aoororachain/loaders/file_loader.rb
+- lib/aoororachain/loaders/pdf_loader.rb
+- lib/aoororachain/recursive_text_splitter.rb
+- lib/aoororachain/util.rb
+- lib/aoororachain/vector_stores/chroma.rb
+- lib/aoororachain/vector_stores/retriever.rb
+- lib/aoororachain/version.rb
+- sig/aoororachain.rbs
+homepage: https://mariochavez.io
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://mariochavez.io
+  source_code_uri: https://mariochavez.io
+  changelog_uri: https://mariochavez.io
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.14
+signing_key:
+specification_version: 4
+summary: Aoororachain for working with LLMs
+test_files: []