cloudflare-ai 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4a98e10b8688a9f4a0853534b104c9a05ceaa91e4405c71d4dde52fdd1953ce7
+  data.tar.gz: 5921d2c627b91dfcf58375b39e9d0781f839e880d8c996146d7002f9ba48f365
+SHA512:
+  metadata.gz: a2c1f4389bea67083ef6e19e12620b29850bdf818e4bbce1e3dcd4e5916175fabf69f04fe33b36ae539ec43f622aeb3456f3fff34ec9f236e745fe7f853cdbdc
+  data.tar.gz: c3e48f425b89449cae0bcbc480ee23c94d6494972f950070f3bb18e013711da95b45d7b6e3b2c2e7c9069ef458cc384ddf76ef3ea3a55cc61e46453bd190e189

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## [Unreleased]
+
+## [0.1.1] - 2024-01-21
+- Support for server-side streaming responses
+
+## [0.1.0] - 2024-01-20
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Ajay Krishnan
+
+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,127 @@
+cloudflare-ai:  a Cloudflare Workers AI client for ruby developers
+---
+Cloudflare is testing its [Workers AI](https://blog.cloudflare.com/workers-ai) API. 
+Hopefully this project makes it easier for ruby-first developers to consume 
+Cloudflare's latest and greatest. 
+
+I'm a lawyer who codes, and I'm really interested in applying retrieval-augmented
+generation to make legal services more accessible. [Email me](mailto:cloudflare-ai@krishnan.ca).
+
+If you're looking for legal help, it's best to book a slot via https://www.krishnan.ca.
+
+## Todo
+It's still early days, and here are my immediate priorities:
+* [ ] Support for streamed responses
+* [ ] CI pipeline and guidance for contributors
+* [ ] Support for more AI model categories
+  * [x] [Text Generation](https://developers.cloudflare.com/workers-ai/models/text-generation/)
+  * [ ] [Text Embeddings](https://developers.cloudflare.com/workers-ai/models/text-embeddings/)
+  * [ ] [Text Classification](https://developers.cloudflare.com/workers-ai/models/text-classification/)
+  * [ ] [Image Classification](https://developers.cloudflare.com/workers-ai/models/image-classification/)
+  * [ ] [Translation](https://developers.cloudflare.com/workers-ai/models/translation/)
+  * [ ] [Text-to-Image](https://developers.cloudflare.com/workers-ai/models/text-to-image/)
+  * [ ] [Automatic Speech Recognition](https://developers.cloudflare.com/workers-ai/models/speech-recognition/)
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Logging](#logging)
+- [Development](#development)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    bundle add cloudflare-ai
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    gem install cloudflare-ai
+
+## Usage
+
+```ruby
+require "cloudflare/ai"
+```
+
+### Cloudflare Workers AI
+Please visit the [Cloudflare Workers AI website](https://developers.cloudflare.com/workers-ai/) for more details.
+Thiis gem provides a client that wraps around [Cloudflare's REST API](https://developers.cloudflare.com/workers-ai/get-started/rest-api/).
+
+
+### Client
+
+```ruby
+client = Cloudflare::AI::Client.new(account_id: ENV["CLOUDFLARE_ACCOUNT_ID"], api_token: ENV["CLOUDFLARE_API_TOKEN"])
+```
+
+#### Result object
+All invocations of the client return a `Cloudflare::AI::Result` object. This object's serializable JSON output is 
+based on the raw response from the Cloudflare API. 
+
+```ruby
+result = client.complete(prompt: "What is your name?")
+
+# Successful
+puts result.response # => "My name is John."
+puts result.success? # => true
+puts result.failure? # => false
+puts result.to_json # => {"result":{"response":"My name is John"},"success":true,"errors":[],"messages":[]}
+
+# Unsuccessful
+puts result.response # => nil
+puts result.success? # => false
+puts result.failure? # => true
+puts result.to_json # => {"result":null,"success":false,"errors":[{"code":7009,"message":"Upstream service unavailable"}],"messages":[]}
+```
+
+
+#### Text generation (chat / scoped prompt)
+```ruby
+messages = [
+  Cloudflare::AI::Message.new(role: "system", content: "You are a big fan of Cloudflare and Ruby."),
+  Cloudflare::AI::Message.new(role: "user", content: "What is your favourite tech stack?"),
+  Cloudflare::AI::Message.new(role: "assistant", content: "I love building with Ruby on Rails and Cloudflare!"),
+  Cloudflare::AI::Message.new(role: "user", content: "Really? You like Cloudflare even though there isn't great support for Ruby?"),
+]
+result = client.chat(messages: messages)
+puts result.response # => "Yes, I love Cloudflare!"
+```
+
+##### Streaming responses
+Responses will be streamed back to the client using Server Side Events (SSE) if a block is passed to the `chat` or `complete` method.
+```ruby
+result = client.complete(prompt: "Hi!") { |data| puts data}
+# {"response":" "}
+# {"response":" Hello"}
+# {"response":" there"}
+# {"response":"!"}
+# {"response":""}
+# [DONE]
+```
+## Logging
+
+This gem uses standard logging mechanisms and defaults to `:warn` level. Most messages are at info level, but we will add debug or warn statements as needed.
+To show all log messages:
+
+```ruby
+Cloudflare::AI.logger.level = :debug
+```
+
+You can use this logger as you would the default ruby logger. For example:
+```ruby
+Cloudflare::AI.logger = Logger.new($stdout)
+```
+## Development
+
+1. `git clone https://github.com/ajaynomics/cloudflare-ai.git`
+2. `bundle exec rake` to ensure that the tests pass and to run standardrb
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ajaynomics/cloudflare-ai.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). A special thanks to the team at [langchainrb](https://github.com/andreibondarev/langchainrb) – I learnt a lot reading your codebase as I muddled my way through the initial effort.

data/lib/cloudflare/ai/client.rb

@@ -0,0 +1,64 @@
+require "event_stream_parser"
+require "faraday"
+
+class Cloudflare::AI::Client
+  attr_reader :url, :account_id, :api_token
+
+  def initialize(account_id:, api_token:)
+    @account_id = account_id
+    @api_token = api_token
+  end
+
+  def complete(prompt:, model_name: models[:text_generation].first, &block)
+    url = service_url_for(account_id: account_id, model_name: model_name)
+    stream = block ? true : false
+    payload = create_payload({prompt: prompt}, stream: stream)
+    post_request(url, payload, &block)
+  end
+
+  def chat(messages:, model_name: models[:text_generation].first, &block)
+    url = service_url_for(account_id: account_id, model_name: model_name)
+    stream = block ? true : false
+    payload = create_payload({messages: messages.map(&:serializable_hash)}, stream: stream)
+    post_request(url, payload, &block)
+  end
+
+  def models
+    {
+      text_generation: %w[@cf/meta/llama-2-7b-chat-fp16 @cf/meta/llama-2-7b-chat-int8 @cf/mistral/mistral-7b-instruct-v0.1 @hf/thebloke/codellama-7b-instruct-awq],
+      speech_recognition: %w[@cf/openai/whisper],
+      translation: %w[@cf/meta/m2m100-1.2b],
+      text_classification: %w[@cf/huggingface/distilbert-sst-2-int8],
+      image_classification: %w[@cf/huggingface/distilbert-sst-2-int8],
+      text_to_image: %w[@cf/stabilityai/stable-diffusion-xl-base-1.0],
+      text_embeddings: %w[@cf/baai/bge-base-en-v1.5 @cf/baai/bge-large-en-v1.5 @cf/baai/bge-small-en-v1.5]
+    }.freeze
+  end
+
+  private
+
+  def create_payload(data, stream: false)
+    data.merge({stream: stream}).to_json
+  end
+
+  def post_request(url, payload, &block)
+    if block
+      parser = EventStreamParser::Parser.new
+      connection.post(url, payload) do |response|
+        response.options.on_data = parser.stream do |_type, data, _id, _reconnection_time, _size|
+          yield data
+        end
+      end
+    else
+      Cloudflare::AI::Result.new(connection.post(url, payload).body)
+    end
+  end
+
+  def connection
+    @connection ||= ::Faraday.new(headers: {Authorization: "Bearer #{api_token}"})
+  end
+
+  def service_url_for(account_id:, model_name:)
+    "https://api.cloudflare.com/client/v4/accounts/#{account_id}/ai/run/#{model_name}"
+  end
+end

data/lib/cloudflare/ai/contextual_logger.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Cloudflare
+  module AI
+    class ContextualLogger
+      MESSAGE_COLOR_OPTIONS = {
+        debug: {
+          color: :white
+        },
+        error: {
+          color: :red
+        },
+        fatal: {
+          color: :red,
+          background: :white,
+          mode: :bold
+        },
+        unknown: {
+          color: :white
+        },
+        info: {
+          color: :white
+        },
+        warn: {
+          color: :yellow,
+          mode: :bold
+        }
+      }
+
+      def initialize(logger)
+        @logger = logger
+        @levels = Logger::Severity.constants.map(&:downcase)
+      end
+
+      def respond_to_missing?(method, include_private = false)
+        @logger.respond_to?(method, include_private)
+      end
+
+      def method_missing(method, *args, **kwargs, &block)
+        return @logger.send(method, *args, **kwargs, &block) unless @levels.include?(method)
+
+        for_class = kwargs.delete(:for)
+        for_class_name = for_class&.name
+
+        log_line_parts = []
+        log_line_parts << "[cloudflare-ai]".colorize(color: :yellow)
+        log_line_parts << if for_class.respond_to?(:logger_options)
+          "[#{for_class_name}]".colorize(for_class.logger_options) + ":"
+        elsif for_class_name
+          "[#{for_class_name}]:"
+        end
+        log_line_parts << args.first.colorize(MESSAGE_COLOR_OPTIONS[method])
+        log_line = log_line_parts.compact.join(" ")
+
+        @logger.send(
+          method,
+          log_line
+        )
+      end
+    end
+  end
+end

data/lib/cloudflare/ai/message.rb

@@ -0,0 +1,20 @@
+require "active_model"
+
+class Cloudflare::AI::Message
+  include ActiveModel::Validations
+  include ActiveModel::Serializers::JSON
+
+  attr_accessor :role, :content
+
+  validates_inclusion_of :role, in: %w[system user assistant]
+  validates_presence_of :content
+
+  def initialize(role:, content:)
+    @role = role
+    @content = content
+  end
+
+  def attributes
+    {role: role, content: content}
+  end
+end

data/lib/cloudflare/ai/result.rb

@@ -0,0 +1,32 @@
+require "active_support/core_ext/hash/indifferent_access"
+
+class Cloudflare::AI::Result
+  attr_reader :result, :success, :errors, :messages
+
+  def initialize(json)
+    @json = json
+    @json = JSON.parse(@json) unless @json.is_a?(Hash)
+    @json = @json.with_indifferent_access
+
+    @result = @json["result"]
+    @success = @json["success"]
+    @errors = @json["errors"]
+    @messages = @json["messages"]
+  end
+
+  def to_json
+    @json.to_json
+  end
+
+  def failure?
+    !success?
+  end
+
+  def success?
+    success
+  end
+
+  def response
+    result.with_indifferent_access["response"]
+  end
+end

data/lib/cloudflare/ai/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Cloudflare
+  module AI
+    VERSION = "0.2.0"
+  end
+end

data/lib/cloudflare/ai.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "ai/version"
+require "logger"
+require "pathname"
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect(
+  "ai" => "AI"
+)
+loader.push_dir("#{__dir__}/", namespace: Cloudflare)
+loader.setup
+
+module Cloudflare
+  module AI
+    class << self
+      attr_reader :logger, :root
+
+      def logger=(logger)
+        @logger = ContextualLogger.new(logger)
+      end
+    end
+
+    self.logger ||= ::Logger.new($stdout, level: :debug)
+
+    @root = Pathname.new(__dir__)
+
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: cloudflare-ai
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Ajay Krishnan
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: event_stream_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+description: This opinionated ruby client is intended to make it uncomfortably easy
+  to use Cloudflare's models.
+email:
+- rubygems@krishnan.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/cloudflare/ai.rb
+- lib/cloudflare/ai/client.rb
+- lib/cloudflare/ai/contextual_logger.rb
+- lib/cloudflare/ai/message.rb
+- lib/cloudflare/ai/result.rb
+- lib/cloudflare/ai/version.rb
+homepage: https://rubygems.org/gems/cloudflare-ai
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/cloudflare-ai
+  source_code_uri: https://github.com/ajaynomics/cloudflare-ai
+  changelog_uri: https://github.com/ajaynomics/cloudflare-ai/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: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.5
+signing_key:
+specification_version: 4
+summary: A client for the Cloudflare Workers AI API.
+test_files: []