raif 1.0.0

data/lib/raif/configuration.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Raif
+  class Configuration
+    attr_accessor :agent_types,
+      :anthropic_api_key,
+      :anthropic_bedrock_models_enabled,
+      :anthropic_models_enabled,
+      :authorize_admin_controller_action,
+      :authorize_controller_action,
+      :aws_bedrock_model_name_prefix,
+      :aws_bedrock_region,
+      :conversation_entries_controller,
+      :conversation_system_prompt_intro,
+      :conversation_types,
+      :conversations_controller,
+      :current_user_method,
+      :default_llm_model_key,
+      :llm_api_requests_enabled,
+      :model_superclass,
+      :open_ai_api_key,
+      :open_ai_models_enabled,
+      :task_system_prompt_intro,
+      :user_tool_types
+
+    def initialize
+      # Set default config
+      @agent_types = Set.new(["Raif::Agents::ReActAgent", "Raif::Agents::NativeToolCallingAgent"])
+      @anthropic_api_key = ENV["ANTHROPIC_API_KEY"]
+      @anthropic_bedrock_models_enabled = true
+      @anthropic_models_enabled = true
+      @authorize_admin_controller_action = ->{ false }
+      @authorize_controller_action = ->{ false }
+      @aws_bedrock_region = "us-east-1"
+      @aws_bedrock_model_name_prefix = "us"
+      @task_system_prompt_intro = "You are a helpful assistant."
+      @conversation_entries_controller = "Raif::ConversationEntriesController"
+      @conversation_system_prompt_intro = "You are a helpful assistant who is collaborating with a teammate."
+      @conversation_types = Set.new(["Raif::Conversation"])
+      @conversations_controller = "Raif::ConversationsController"
+      @current_user_method = :current_user
+      @default_llm_model_key = "open_ai_gpt_4o"
+      @llm_api_requests_enabled = true
+      @model_superclass = "ApplicationRecord"
+      @open_ai_api_key = ENV["OPENAI_API_KEY"]
+      @open_ai_models_enabled = true
+      @user_tool_types = []
+    end
+
+    def validate!
+      unless Raif.available_llm_keys.include?(default_llm_model_key.to_sym)
+        raise Raif::Errors::InvalidConfigError,
+          "Raif.config.default_llm_model_key was set to #{default_llm_model_key}, but must be one of: #{Raif.available_llm_keys.join(", ")}"
+      end
+
+      if authorize_controller_action.respond_to?(:call)
+        authorize_controller_action.freeze
+      else
+        raise Raif::Errors::InvalidConfigError,
+          "Raif.config.authorize_controller_action must respond to :call and return a boolean"
+      end
+
+      if authorize_admin_controller_action.respond_to?(:call)
+        authorize_admin_controller_action.freeze
+      else
+        raise Raif::Errors::InvalidConfigError,
+          "Raif.config.authorize_admin_controller_action must respond to :call and return a boolean"
+      end
+
+      if open_ai_models_enabled && open_ai_api_key.blank?
+        raise Raif::Errors::InvalidConfigError,
+          "Raif.config.open_ai_api_key is required when Raif.config.open_ai_models_enabled is true. Set it via Raif.config.open_ai_api_key or ENV[\"OPENAI_API_KEY\"]" # rubocop:disable Layout/LineLength
+      end
+
+      if anthropic_models_enabled && anthropic_api_key.blank?
+        raise Raif::Errors::InvalidConfigError,
+          "Raif.config.anthropic_api_key is required when Raif.config.anthropic_models_enabled is true. Set it via Raif.config.anthropic_api_key or ENV['ANTHROPIC_API_KEY']" # rubocop:disable Layout/LineLength
+      end
+    end
+
+  end
+end

data/lib/raif/default_llms.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Raif
+  def self.default_llms
+    {
+      Raif::Llms::OpenAi => [
+        {
+          key: :open_ai_gpt_4o_mini,
+          api_name: "gpt-4o-mini",
+          model_provider_settings: { supports_structured_outputs: true }
+        },
+        {
+          key: :open_ai_gpt_4o,
+          api_name: "gpt-4o",
+          model_provider_settings: { supports_structured_outputs: true }
+        },
+        {
+          key: :open_ai_gpt_3_5_turbo,
+          api_name: "gpt-3.5-turbo",
+          model_provider_settings: { supports_structured_outputs: false }
+        },
+      ],
+      Raif::Llms::Anthropic => [
+        { key: :anthropic_claude_3_7_sonnet, api_name: "claude-3-7-sonnet-latest", max_completion_tokens: 8192 },
+        { key: :anthropic_claude_3_5_sonnet, api_name: "claude-3-5-sonnet-latest", max_completion_tokens: 8192 },
+        { key: :anthropic_claude_3_5_haiku, api_name: "claude-3-5-haiku-latest", max_completion_tokens: 8192 },
+        { key: :anthropic_claude_3_opus, api_name: "claude-3-opus-latest", max_completion_tokens: 4096 },
+      ],
+      Raif::Llms::BedrockClaude => [
+        { key: :bedrock_claude_3_5_sonnet, api_name: "anthropic.claude-3-5-sonnet-20241022-v2:0", max_completion_tokens: 8192 },
+        { key: :bedrock_claude_3_7_sonnet, api_name: "anthropic.claude-3-7-sonnet-20250219-v1:0", max_completion_tokens: 8192 },
+        { key: :bedrock_claude_3_5_haiku, api_name: "anthropic.claude-3-5-haiku-20241022-v1:0", max_completion_tokens: 8192 },
+        { key: :bedrock_claude_3_opus, api_name: "anthropic.claude-3-opus-20240229-v1:0", max_completion_tokens: 4096 },
+      ]
+    }
+  end
+end

data/lib/raif/engine.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+begin
+  require "factory_bot_rails"
+rescue LoadError # rubocop:disable Lint/SuppressedException
+end
+
+module Raif
+  class Engine < ::Rails::Engine
+    isolate_namespace Raif
+
+    # If the host app is using FactoryBot, add the factories to the host app so they can be used in host apptests
+    if defined?(FactoryBotRails)
+      config.factory_bot.definition_file_paths += [File.expand_path("../../../spec/factories/shared", __FILE__)]
+    end
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_bot
+      g.factory_bot dir: "spec/factories"
+    end
+
+    config.after_initialize do
+      ActiveSupport.on_load(:action_view) do
+        include Raif::Shared::ConversationsHelper
+      end
+    end
+
+    config.after_initialize do
+      next unless Raif.config.open_ai_models_enabled
+
+      Raif.default_llms[Raif::Llms::OpenAi].each do |llm_config|
+        Raif.register_llm(Raif::Llms::OpenAi, **llm_config)
+      end
+    end
+
+    config.after_initialize do
+      next unless Raif.config.anthropic_models_enabled
+
+      Raif.default_llms[Raif::Llms::Anthropic].each do |llm_config|
+        Raif.register_llm(Raif::Llms::Anthropic, **llm_config)
+      end
+    end
+
+    config.after_initialize do
+      next unless Raif.config.anthropic_bedrock_models_enabled
+
+      require "aws-sdk-bedrock"
+      require "aws-sdk-bedrockruntime"
+
+      Raif.default_llms[Raif::Llms::BedrockClaude].each do |llm_config|
+        Raif.register_llm(Raif::Llms::BedrockClaude, **llm_config)
+      end
+    end
+
+    config.after_initialize do
+      next unless Rails.env.test?
+
+      Raif.config.conversation_types += ["Raif::TestConversation"]
+
+      require "#{Raif::Engine.root}/spec/support/test_llm"
+      Raif.register_llm(Raif::Llms::Test, key: :raif_test_llm, api_name: "raif-test-llm")
+    end
+
+    config.after_initialize do
+      Raif.config.validate!
+    end
+
+    initializer "raif.assets" do
+      if Rails.application.config.respond_to?(:assets)
+        Rails.application.config.assets.precompile += [
+          "raif.js",
+          "raif.css",
+          "raif_admin.css"
+        ]
+      end
+    end
+
+    initializer "raif.importmap", before: "importmap" do |app|
+      if Rails.application.respond_to?(:importmap)
+        app.config.importmap.paths << Raif::Engine.root.join("config/importmap.rb")
+      end
+    end
+
+  end
+end

data/lib/raif/errors/action_not_authorized_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Raif
+  module Errors
+    class ActionNotAuthorizedError < StandardError
+    end
+  end
+end

data/lib/raif/errors/anthropic/api_error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Raif
+  module Errors
+    module Anthropic
+      class ApiError < StandardError
+      end
+    end
+  end
+end

data/lib/raif/errors/invalid_config_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Raif
+  module Errors
+    class InvalidConfigError < StandardError
+    end
+  end
+end

data/lib/raif/errors/invalid_conversation_type_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Raif
+  module Errors
+    class InvalidConversationTypeError < StandardError
+    end
+  end
+end

data/lib/raif/errors/invalid_user_tool_type_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Raif
+  module Errors
+    class InvalidUserToolTypeError < StandardError
+    end
+  end
+end

data/lib/raif/errors/open_ai/api_error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Raif
+  module Errors
+    module OpenAi
+      class ApiError < StandardError
+      end
+    end
+  end
+end

data/lib/raif/errors/open_ai/json_schema_error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Raif
+  module Errors
+    module OpenAi
+      class JsonSchemaError < StandardError
+      end
+    end
+  end
+end

data/lib/raif/errors.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "raif/errors/invalid_config_error"
+require "raif/errors/action_not_authorized_error"
+require "raif/errors/invalid_user_tool_type_error"
+require "raif/errors/invalid_conversation_type_error"
+require "raif/errors/open_ai/json_schema_error"
+require "raif/errors/open_ai/api_error"
+require "raif/errors/anthropic/api_error"

data/lib/raif/languages.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Raif
+  SUPPORTED_LANGUAGES = [
+    "ar",
+    "da",
+    "de",
+    "en",
+    "es",
+    "fi",
+    "fr",
+    "he",
+    "hi",
+    "it",
+    "ja",
+    "ko",
+    "nl",
+    "no",
+    "pl",
+    "pt",
+    "ru",
+    "sv",
+    "th",
+    "tr",
+    "uk",
+    "vi",
+    "zh",
+  ].freeze
+
+  def self.supported_languages
+    SUPPORTED_LANGUAGES
+  end
+end

data/lib/raif/rspec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "../../spec/support/rspec_helpers"
+require_relative "../../spec/support/test_model_tool"
+require_relative "../../spec/support/test_conversation"
+require_relative "../../spec/support/test_task"
+require_relative "../../spec/support/test_llm"

data/lib/raif/utils/html_to_markdown_converter.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Raif::Utils::HtmlToMarkdownConverter
+  def self.convert(html)
+    ReverseMarkdown.convert(html, unknown_tags: :bypass)
+  end
+end

data/lib/raif/utils/readable_content_extractor.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+class Raif::Utils::ReadableContentExtractor
+  attr_reader :raw_html
+
+  def initialize(raw_html)
+    @raw_html = raw_html
+  end
+
+  TAG_REMOVE_LIST = [
+    "a",
+    "button",
+    "form",
+    "iframe",
+    "img",
+    "input",
+    "label",
+    "nav",
+    "noscript",
+    "script",
+    "style",
+    "svg",
+    "footer"
+  ]
+
+  # This will first remove all tags in TAG_REMOVE_LIST and their children.
+  # Things in TAG_REMOVE_LIST are things that we do not consider likely to contain readable content.
+  # We also call scrub!(:strip) to remove anything unsafe, but leave the text content.
+  def extract_readable_content
+    body_content = Loofah.html5_document(raw_html).at("body")
+    return raw_html unless body_content
+
+    scrubbed_html = body_content
+      .scrub!(readable_content_scrubber)
+      .scrub!(empty_node_scrubber)
+      .scrub!(:strip)
+
+    scrubbed_html.inner_html
+  end
+
+  def readable_content_scrubber
+    @readable_content_scrubber ||= Loofah::Scrubber.new do |node|
+      # if the node is something we don't consider readable content, remove it entirely
+      node.remove if TAG_REMOVE_LIST.include?(node.name)
+
+      # strip all attributes from the tags
+      node.attributes.each { |attr| node.remove_attribute(attr.first) }
+
+      # remove html comments
+      node.remove if node.comment?
+    end
+  end
+
+  def empty_node_scrubber
+    # remove empty nodes from the bottom up so any parents that have only empty children also get removed
+    @empty_node_scrubber ||= Loofah::Scrubber.new(direction: :bottom_up) do |node|
+      node.remove if node.children.empty? && node.text.strip.empty?
+    end
+  end
+
+end

data/lib/raif/utils.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Raif::Utils
+  require "raif/utils/readable_content_extractor"
+  require "raif/utils/html_to_markdown_converter"
+end

data/lib/raif/version.rb

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

data/lib/raif.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "raif/version"
+require "raif/languages"
+require "raif/engine"
+require "raif/configuration"
+require "raif/errors"
+require "raif/utils"
+require "raif/default_llms"
+require "faraday"
+require "loofah"
+require "pagy"
+require "reverse_markdown"
+require "turbo-rails"
+
+module Raif
+  class << self
+    attr_accessor :configuration
+    attr_accessor :llm_registry
+
+    attr_writer :logger
+  end
+
+  def self.config
+    @configuration ||= Raif::Configuration.new
+  end
+
+  def self.configure
+    yield(config)
+  end
+
+  def self.logger
+    @logger ||= Rails.logger
+  end
+
+  def self.register_llm(llm_class, llm_config)
+    llm = llm_class.new(**llm_config)
+
+    unless llm.valid?
+      raise ArgumentError, "The LLM you tried to register is invalid: #{llm.errors.full_messages.join(", ")}"
+    end
+
+    @llm_registry ||= {}
+    @llm_registry[llm.key] = llm_config.merge(llm_class: llm_class)
+  end
+
+  def self.llm(model_key)
+    llm_config = llm_registry[model_key]
+
+    if llm_config.nil?
+      raise ArgumentError, "No LLM found for model key: #{model_key}. Available models: #{available_llm_keys.join(", ")}"
+    end
+
+    llm_class = llm_config[:llm_class]
+    llm_class.new(**llm_config.except(:llm_class))
+  end
+
+  def self.available_llms
+    llm_registry.values
+  end
+
+  def self.available_llm_keys
+    llm_registry.keys
+  end
+end

data/lib/tasks/raif_tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# desc "Explaining what the task does"
+# task :raif do
+#   # Task goes here
+# end