llm_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 777149fdf2ef683ec6195bde6e601df1f7cb5c63636118549e20e7d523b622ed
+  data.tar.gz: 69fb1cf7477115727676d83cb1ff6e4ea17728a1cfb349a42c5e2deddf8b8d3b
+SHA512:
+  metadata.gz: c15ac237dec34b0848f3d6024709d3eb1125e406ad3012fbf3d1ea772d623872dbc57de5cd2c3c63fbf40665c05e7d795c25dbb35c7c346454ea4063e56503aa
+  data.tar.gz: d6698e4feb0dfbaf72bfd644186a5a7a90b4e8ac94fdd087392647f54d9997ceb15b25efba178f7b2a6fefa85c6fb4a62af8dfb8e1b9b16daabdd9d42fdfad70

data/.rbnextrc

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

data/.rubocop.yml

@@ -0,0 +1,7 @@
+require: standard
+
+inherit_gem:
+  standard: config/base.yml
+
+AllCops:
+  TargetRubyVersion: 3.2

data/.solargraph.yml

@@ -0,0 +1,20 @@
+include:
+  - "**/*.rb"
+exclude:
+  - spec/**/*
+  - test/**/*
+  - vendor/**/*
+  - ".bundle/**/*"
+require:
+- actioncable
+- actionmailer
+- actionpack
+- actionview
+- activejob
+- activemodel
+- activerecord
+- activestorage
+- activesupport
+plugins:
+  - solargraph-rails
+max_files: 5000

data/.standard.yml

@@ -0,0 +1,7 @@
+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: []

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-06-19
+
+- 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 llm_client.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "standard", "~> 1.3"

data/Gemfile.lock

@@ -0,0 +1,110 @@
+PATH
+  remote: .
+  specs:
+    llm_client (0.1.0)
+      dry-monads (~> 1.6)
+      http (~> 5.1, >= 5.1.1)
+      ruby-next (>= 0.15.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    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
+    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)
+    minitest (5.18.1)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    public_suffix (5.0.1)
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.5)
+    rubocop (1.52.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      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.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.18.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)
+    standard (1.29.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.52.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.1.0)
+    standard-custom (1.0.1)
+      lint_roller (~> 1.0)
+    standard-performance (1.1.0)
+      lint_roller (~> 1.0)
+      rubocop-performance (~> 1.18.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+    unicode-display_width (2.4.2)
+    unparser (0.6.8)
+      diff-lcs (~> 1.3)
+      parser (>= 3.2.0)
+    zeitwerk (2.6.8)
+
+PLATFORMS
+  arm64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  llm_client!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  ruby-next (>= 0.15.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,90 @@
+# Llm Client
+
+Ruby client to connect to [LLM Server](https://github.com/mariochavez/llm_server).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add llm_client
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install llm_client
+
+## Usage
+
+To start using the gem host configuration is need it. The host value is the URL where the LLM Server is running.
+
+```ruby
+LlmClient.host = "http://localhost:9292"
+```
+
+Optionally you can configure a Ruby Logger and log level.
+
+```ruby
+LlmClient.logger = Logger.new(STDOUT)
+LlmClient.log_level = LlmClient::LEVEL_DEBUG
+```
+
+Valid log levels are:
+- `LlmClient::LEVEL_DEBUG`
+- `LlmClient::LEVEL_ERROR`
+- `LlmClient::LEVEL_INFO`
+
+With configuration ready, you can start by checking that the LLM Server is up and running.
+
+```ruby
+result = LlmClient.heartbeat
+
+if result.success?
+  puts "Server is running"
+  response = result.success
+  puts "Status: #{response.status}"
+  puts "Body: #{response.body}"
+  puts "Headers: #{response.headers}"
+else
+  puts "Server is not responding"
+  error = result.failure
+  puts "Error: #{error}"
+end
+```
+
+Next, you can send a prompt to be completed by the LLM Server.
+
+```ruby
+response = LlmClient.completion("Who is the creator of Ruby language?")
+if result.success?
+  puts "Completions generated successfully"
+  response = result.success
+  puts "Status: #{response.status}"
+  puts "Body: #{response.body}"
+  puts "Headers: #{response.headers}"
+  calculated_response = response.body[:response]
+  puts "Calculated Response: #{calculated_response}"
+else
+  puts "Failed to generate completions"
+  error = result.failure
+  puts "Error: #{error}"
+end
+```
+
+The response in both cases is a `Result` monad that wraps a `Response` struct.
+
+## 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/mariochavez/llm_client. 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/llm_client/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/llm_client/blob/main/LICENSE.txt).
+
+## Code of Conduct
+
+Everyone interacting in the LlmClient project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mariochavez/llm_client/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,19 @@
+# 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]
+
+desc "Run Ruby Next nextify"
+task :nextify do
+  sh "bundle exec ruby-next nextify -V"
+end

data/lib/llm_client/configuration.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module LlmClient
+  # The Configuration class allows you to configure the connection settings for the LlmClient.
+  # It can be initialized directly calling #new method.
+  #
+  # Examples
+  #
+  #   configuration = LlmClient::Configuration.new
+  #   configurarion.host = "http://localhost:9292"
+  #
+  # Or via a setup block.
+  #
+  # Examples
+  #
+  #   LlmClient::Configuration.setup do |config|
+  #     config.host = "https://localhost:9292"
+  #   end
+  class Configuration
+    # Sets the host name for the Llm.
+    #
+    # Examples
+    #
+    #   config.host = "chroma.example.com"
+    #
+    # Returns the String host name.
+    attr_accessor :host
+
+    # Sets the logger for the LlmClient.
+    #
+    # Examples
+    #
+    #   config.logger = Logger.new(STDOUT)
+    #
+    # Returns the Logger instance.
+    attr_accessor :logger
+
+    # Sets the logger's log level for the LlmClient.
+    #
+    # Examples
+    #
+    #   config.log_level = LlmClient::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 = LlmClient::LEVEL_INFO
+    end
+  end
+end

data/lib/llm_client/errors.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module LlmClient
+  # Custom error class for connection-related errors in LLM client.
+  #
+  # This class inherits from the StandardError class and can be raised when there is an error in the connection to the LLM server.
+  #
+  class ConnectionError < StandardError
+    attr_reader :original_error
+
+    # Initialize a new ConnectionError object with an error message and the original error.
+    #
+    # Parameters:
+    #   message - A String representing the error message.
+    #   original_error - The original error object that caused the connection error.
+    #
+    # Returns a new ConnectionError object.
+    #
+    def initialize(message, original_error)
+      super(message)
+      @original_error = original_error
+    end
+  end
+end

data/lib/llm_client/http_client.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module LlmClient
+  # 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 if the response is not success
+  Response = Struct.new("Response", :status, :body, :headers, :error)
+
+  # Request class to perform HTTP requests.
+  class HttpClient
+    using RubyNext
+    include Dry::Monads[:result]
+
+    # Sends a heartbeat request to the LLM Server.
+    #
+    # This method is used to check the status of the LLM Server.
+    #
+    # Returns a dry-monad Result object, which can be a Success or Failure.
+    # If the server is running and responds successfully, a Success Result is returned.
+    # If there's an error or the server is not responding, a Failure Result is returned.
+    #
+    # Examples
+    #
+    #   result = heartbeat
+    #   if result.success?
+    #     puts "Server is running"
+    #     response = result.success
+    #     puts "Status: #{response.status}"
+    #     puts "Body: #{response.body}"
+    #     puts "Headers: #{response.headers}"
+    #   else
+    #     puts "Server is not responding"
+    #     error = result.failure
+    #     puts "Error: #{error}"
+    #   end
+    #
+    # Notes
+    #
+    #   - Make sure the LLM Server is running before calling this method.
+    #
+    def heartbeat
+      url = "#{LlmClient.host}/heartbeat"
+      Util.log_debug("Sending a request", method: :GET, url:)
+
+      response = HTTP.get(url)
+
+      if response.status.success?
+        Util.log_info("Successful response", status: response.status)
+        Success(build_response(response))
+      else
+        Util.log_info("Unsuccessful response", status: response.status)
+        Failure(build_response(response))
+      end
+    rescue => exception
+      Util.log_info("heartbeat error", error: exception.message)
+
+      error = LlmClient::ConnectionError.new("heartbeat error", exception)
+      Failure(Response.new(status: 0, body: error.message, headers: {}, error:))
+    end
+
+    # Public: Sends a completion request to the LLM Server.
+    #
+    # This method is used to generate completions based on a given prompt using the LLM Server.
+    #
+    # Parameters:
+    #   prompt - A String representing the prompt for which completions should be generated.
+    #
+    # Returns a dry-monad Result object, which can be a Success or Failure.
+    # If the completion request is successful, a Success Result is returned.
+    # If there's an error or the server fails to generate completions, a Failure Result is returned.
+    #
+    # Examples
+    #
+    #   result = completion("Hello, world!")
+    #   if result.success?
+    #     puts "Completions generated successfully"
+    #     response = result.success
+    #     puts "Status: #{response.status}"
+    #     puts "Body: #{response.body}"
+    #     puts "Headers: #{response.headers}"
+    #     calculated_response = response.body[:response]
+    #     puts "Calculated Response: #{calculated_response}"
+    #   else
+    #     puts "Failed to generate completions"
+    #     error = result.failure
+    #     puts "Error: #{error}"
+    #   end
+    #
+    # Notes
+    #
+    #   - Make sure the LLM Server is running before calling this method.
+    #
+    def completion(prompt)
+      url = "#{LlmClient.host}/completion"
+      Util.log_debug("Sending a request", method: :POST, url:)
+
+      response = HTTP.headers(
+        "Content-Type" => "application/json",
+        "Accept" => "application/json"
+      ).post(url, json: {prompt:})
+
+      if response.status.success?
+        Util.log_info("Successful response", status: response.status)
+        Success(build_response(response, parse: true))
+      else
+        Util.log_info("Unsuccessful response", status: response.status)
+        Failure(build_response(response))
+      end
+    rescue => exception
+      Util.log_info("prompt error", error: exception.message)
+
+      error = LlmClient::ConnectionError.new("prompt error", exception)
+      Failure(Response.new(status: 0, body: error.message, headers: {}, error:))
+    end
+
+    private
+
+    def build_response(response, parse: false)
+      Response.new(
+        status: response.status,
+        body: parse ? parse_json(response.body.to_s) : response.body.to_s,
+        headers: response.headers.to_h,
+        error: nil
+      )
+    end
+
+    def parse_json(content)
+      JSON.parse(content, symbolize_keys: true)
+    rescue JSON::ParserError, TypeError
+      content
+    end
+  end
+end

data/lib/llm_client/util.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module LlmClient
+  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) || LlmClient.config
+      logger = config.logger || LlmClient.logger
+
+      if (!logger.nil? || !config.log_level.nil?) && config.log_level <= LlmClient::LEVEL_ERROR
+        log_internal(message, data, level: LlmClient::LEVEL_ERROR, logger: LlmClient.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) || LlmClient.config
+      logger = config.logger || LlmClient.logger
+
+      if (!logger.nil? || !config.log_level.nil?) && config.log_level <= LlmClient::LEVEL_DEBUG
+        log_internal(message, data, level: LlmClient::LEVEL_DEBUG, logger: LlmClient.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) || LlmClient.config
+      logger = config.logger || LlmClient.logger
+
+      if (!logger.nil? || !config.log_level.nil?) && config.log_level <= LlmClient::LEVEL_INFO
+        log_internal(message, data, level: LlmClient::LEVEL_INFO, logger: LlmClient.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&.add(level, "message=#{message} #{data_str}".strip)
+    end
+    private_class_method :log_internal
+  end
+end

data/lib/llm_client/version.rb

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

data/lib/llm_client.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "http"
+require "dry-monads"
+require "json"
+require "logger"
+
+require "ruby-next"
+require "ruby-next/language/setup"
+
+RubyNext::Language.setup_gem_load_path(transpile: true)
+
+require_relative "llm_client/util"
+require_relative "llm_client/configuration"
+require_relative "llm_client/errors"
+require_relative "llm_client/http_client"
+require_relative "llm_client/version"
+
+# A module representing an LLM client.
+#
+# This module provides methods to interact with the LLM Server using an HTTP client.
+# It can be configured with a host, a Ruby logger, a log level, and provides methods to forward heartbeat and completion requests to the HTTP client.
+#
+# Examples
+#
+#   LlmClient.host = "http://localhost:9292"
+#   LlmClient.logger = Logger.new(STDOUT)
+#   LlmClient.log_level = LlmClient::LEVEL_DEBUG
+#
+# If logger is present and log level not set, it is LlmClientL::LEVEL_INFO by default.
+#
+# After LlmClient module configuration you can interact wiht the LLM Server.
+#
+# Examples
+#
+#   result = LlmClient.heartbeat
+#   if result.success?
+#     puts "Server is running"
+#     response = result.success
+#     puts "Status: #{response.status}"
+#     puts "Body: #{response.body}"
+#     puts "Headers: #{response.headers}"
+#   else
+#     puts "Server is not responding"
+#     error = result.failure
+#     puts "Error: #{error}"
+#   end
+#
+#   response = LlmClient.completion("Who is the creator of Ruby language?")
+#   if result.success?
+#     puts "Completions generated successfully"
+#     response = result.success
+#     puts "Status: #{response.status}"
+#     puts "Body: #{response.body}"
+#     puts "Headers: #{response.headers}"
+#     calculated_response = response.body[:response]
+#     puts "Calculated Response: #{calculated_response}"
+#   else
+#     puts "Failed to generate completions"
+#     error = result.failure
+#     puts "Error: #{error}"
+#   end
+#
+module LlmClient
+  # map to the same values as the standard library's logger
+  LEVEL_DEBUG = Logger::DEBUG
+  LEVEL_ERROR = Logger::ERROR
+  LEVEL_INFO = Logger::INFO
+
+  @config = LlmClient::Configuration.setup
+  @http_client = LlmClient::HttpClient.new
+
+  class << self
+    extend Forwardable
+
+    attr_reader :config, :http_client
+
+    # User configuration options
+    def_delegators :@config, :host, :host=
+    def_delegators :@config, :logger, :logger=
+    def_delegators :@config, :log_level, :log_level=
+
+    # Http client
+    def_delegators :@http_client, :heartbeat, :completion
+  end
+
+  LlmClient.log_level = ENV["LLM_CLIENT_LOG"].to_i unless ENV["LLM_CLIENT_LOG"].nil?
+end

data/sig/llm_client.rbs

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

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: llm_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mario Alberto Chávez
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: ruby-next-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+- !ruby/object:Gem::Dependency
+  name: ruby-next
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+description: Ruby client to connect to LLM Server.
+email:
+- mario.chavez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rbnextrc"
+- ".rubocop.yml"
+- ".solargraph.yml"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/llm_client.rb
+- lib/llm_client/configuration.rb
+- lib/llm_client/errors.rb
+- lib/llm_client/http_client.rb
+- lib/llm_client/util.rb
+- lib/llm_client/version.rb
+- sig/llm_client.rbs
+homepage: https://mariochavez.io
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://mariochavez.io
+  source_code_uri: https://github.com/mariochavez/llm_client
+  changelog_uri: https://github.com/mariochavez/llm_client/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.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: Ruby client for LLM Server.
+test_files: []