raif 1.0.0 → 1.2.0

data/config/locales/admin.en.yml

@@ -8,19 +8,23 @@ en:
           title: 'Agent #%{id}'
       common:
         agents: Agents
+        all: All
         arguments: Arguments
         at: at
+        citations: Citations
         completed: Completed
         completed_at: Completed At
         completion_tokens: Completion Tokens
         conversation_entries: Conversation Entries
         conversation_history: Conversation History
         conversations: Conversations
+        count: Count
         created_at: Created At
         creator: Creator
         details: Details
         entries_count: Entries Count
         entry: Entry
+        est_cost: est. cost
         failed: Failed
         failed_at: Failed At
         filter: Filter
@@ -38,12 +42,17 @@ en:
         model_response: Model Response
         model_tool_invocations: Model Tool Invocations
         no_agents: No agents found.
+        no_citations: No citations found in this response.
         no_conversations: No conversations found.
         no_model_completions: No model completions found.
         no_model_tool_invocations: No model tool invocations found.
         no_tasks: No tasks found.
         no_tool_calls: No tool calls
         pending: Pending
+        period_all: All time
+        period_day: Past 24 hours
+        period_month: Past month
+        period_week: Past week
         prettified: Prettified
         prompt: Prompt
         prompt_tokens: Prompt Tokens
@@ -58,6 +67,7 @@ en:
         since: Since
         source: Source
         started_at: Started At
+        stats: Stats
         status: Status
         system_prompt: System Prompt
         task: Task
@@ -67,8 +77,10 @@ en:
         tool_invocations: Tool Invocations
         tool_name: Tool Name
         tool_type: Tool Type
+        total_cost: Total Cost
         total_tokens: Total Tokens
         type: Type
+        update: Update
         user_message: User Message
       conversations:
         show:
@@ -85,6 +97,10 @@ en:
         show:
           back_to_model_tool_invocations: Back to Model Tool Invocations
           title: 'Model Tool Invocation #%{id}'
+      stats:
+        tasks:
+          back_to_stats: Back to Stats
+          title: Task Stats
       tasks:
         show:
           back_to_tasks: Back to Tasks

data/config/locales/en.yml

@@ -2,16 +2,27 @@
 en:
   raif:
     agents:
-      errors:
-        available_model_tools:
-          too_short: must have at least 1 tool
+      native_tool_calling_agent:
+        errors:
+          available_model_tools:
+            too_short: must have at least 1 tool in addition to the agent_final_answer tool
+      re_act_agent:
+        errors:
+          available_model_tools:
+            too_short: must have at least 1 tool
     common:
       send: Send
+      sources: Sources
       there_was_an_error_generating_this_response: There was an error generating this response
       tools: Tools
       type_your_message: Type your message...
     conversation:
       initial_chat_message: Hello, how can I help you today?
+    embedding_model_names:
+      bedrock_titan_embed_text_v2: AWS Bedrock Titan Text Embeddings v2
+      open_ai_text_embedding_3_large: OpenAI Text Embedding 3 Large
+      open_ai_text_embedding_3_small: OpenAI Text Embedding 3 Small
+      open_ai_text_embedding_ada_002: OpenAI Text Embedding Ada 002
     languages:
       ar: Arabic
       da: Danish
@@ -40,11 +51,44 @@ en:
       anthropic_claude_3_5_sonnet: Anthropic Claude 3.5 Sonnet
       anthropic_claude_3_7_sonnet: Anthropic Claude 3.7 Sonnet
       anthropic_claude_3_opus: Anthropic Claude 3 Opus
+      anthropic_claude_4_opus: Anthropic Claude 4 Opus
+      anthropic_claude_4_sonnet: Anthropic Claude 4 Sonnet
+      bedrock_amazon_nova_lite: Amazon Nova Lite (via AWS Bedrock)
+      bedrock_amazon_nova_micro: Amazon Nova Micro (via AWS Bedrock)
+      bedrock_amazon_nova_pro: Amazon Nova Pro (via AWS Bedrock)
       bedrock_claude_3_5_haiku: Anthropic Claude 3.5 Haiku (via AWS Bedrock)
       bedrock_claude_3_5_sonnet: Anthropic Claude 3.5 Sonnet (via AWS Bedrock)
       bedrock_claude_3_7_sonnet: Anthropic Claude 3.7 Sonnet (via AWS Bedrock)
       bedrock_claude_3_opus: Anthropic Claude 3 Opus (via AWS Bedrock)
+      bedrock_claude_4_opus: Anthropic Claude 4 Opus (via AWS Bedrock)
+      bedrock_claude_4_sonnet: Anthropic Claude 4 Sonnet (via AWS Bedrock)
       open_ai_gpt_3_5_turbo: OpenAI GPT-3.5 Turbo
+      open_ai_gpt_4_1: OpenAI GPT-4.1
+      open_ai_gpt_4_1_mini: OpenAI GPT-4.1 Mini
+      open_ai_gpt_4_1_nano: OpenAI GPT-4.1 Nano
       open_ai_gpt_4o: OpenAI GPT-4o
       open_ai_gpt_4o_mini: OpenAI GPT-4o Mini
+      open_ai_o1: OpenAI o1
+      open_ai_o1_mini: OpenAI o1 Mini
+      open_ai_o3: OpenAI o3
+      open_ai_o3_mini: OpenAI o3 Mini
+      open_ai_o4_mini: OpenAI o4 Mini
+      open_ai_responses_gpt_3_5_turbo: OpenAI GPT-3.5 Turbo (Responses API)
+      open_ai_responses_gpt_4_1: OpenAI GPT-4.1 (Responses API)
+      open_ai_responses_gpt_4_1_mini: OpenAI GPT-4.1 Mini (Responses API)
+      open_ai_responses_gpt_4_1_nano: OpenAI GPT-4.1 Nano (Responses API)
+      open_ai_responses_gpt_4o: OpenAI GPT-4o (Responses API)
+      open_ai_responses_gpt_4o_mini: OpenAI GPT-4o Mini (Responses API)
+      open_ai_responses_o1: OpenAI o1 (Responses API)
+      open_ai_responses_o1_mini: OpenAI o1 Mini (Responses API)
+      open_ai_responses_o1_pro: OpenAI o1 Pro (Responses API)
+      open_ai_responses_o3: OpenAI o3 (Responses API)
+      open_ai_responses_o3_mini: OpenAI o3 Mini (Responses API)
+      open_ai_responses_o3_pro: OpenAI o3 Pro (Responses API)
+      open_ai_responses_o4_mini: OpenAI o4 Mini (Responses API)
+      open_router_claude_3_7_sonnet: Anthropic Claude 3.7 Sonnet (via OpenRouter)
+      open_router_deepseek_chat_v3: DeepSeek Chat v3 (via OpenRouter)
+      open_router_gemini_2_0_flash: Google Gemini 2.0 Flash (via OpenRouter)
+      open_router_llama_3_1_8b_instruct: Meta Llama 3.1 8B Instruct (via OpenRouter)
+      open_router_llama_3_3_70b_instruct: Meta Llama 3.3 70B Instruct (via OpenRouter)
       raif_test_llm: Raif Test LLM

data/config/routes.rb

@@ -13,6 +13,12 @@ Raif::Engine.routes.draw do
 
   namespace :admin do
     root to: redirect("admin/model_completions")
+    resources :stats, only: [:index]
+
+    namespace :stats do
+      resources :tasks, only: [:index]
+    end
+
     resources :tasks, only: [:index, :show]
     resources :conversations, only: [:index, :show]
     resources :model_completions, only: [:index, :show]

data/db/migrate/20250224234252_create_raif_tables.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class CreateRaifTables < ActiveRecord::Migration[8.0]
+class CreateRaifTables < ActiveRecord::Migration[7.1]
   def change
     json_column_type = if connection.adapter_name.downcase.include?("postgresql")
       :jsonb

data/db/migrate/20250421202149_add_response_format_to_raif_conversations.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddResponseFormatToRaifConversations < ActiveRecord::Migration[7.1]
+  def change
+    add_column :raif_conversations, :response_format, :integer, default: 0, null: false
+  end
+end

data/db/migrate/20250424200755_add_cost_columns_to_raif_model_completions.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class AddCostColumnsToRaifModelCompletions < ActiveRecord::Migration[7.1]
+  # If you need to backfill cost columns for existing records:
+  # Raif::ModelCompletion.find_each do |model_completion|
+  #   model_completion.calculate_costs
+  #   model_completion.save(validate: false)
+  # end
+  def change
+    add_column :raif_model_completions, :prompt_token_cost, :decimal, precision: 10, scale: 6
+    add_column :raif_model_completions, :output_token_cost, :decimal, precision: 10, scale: 6
+    add_column :raif_model_completions, :total_cost, :decimal, precision: 10, scale: 6
+  end
+end

data/db/migrate/20250424232946_add_created_at_indexes.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class AddCreatedAtIndexes < ActiveRecord::Migration[7.1]
+  def change
+    add_index :raif_model_completions, :created_at
+    add_index :raif_tasks, :created_at
+    add_index :raif_conversations, :created_at
+    add_index :raif_conversation_entries, :created_at
+    add_index :raif_agents, :created_at
+  end
+end

data/db/migrate/20250502155330_add_status_indexes_to_raif_tasks.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class AddStatusIndexesToRaifTasks < ActiveRecord::Migration[7.1]
+  def change
+    add_index :raif_tasks, :completed_at
+    add_index :raif_tasks, :failed_at
+    add_index :raif_tasks, :started_at
+
+    # Index for type + status combinations which will be common in the admin interface
+    add_index :raif_tasks, [:type, :completed_at]
+    add_index :raif_tasks, [:type, :failed_at]
+    add_index :raif_tasks, [:type, :started_at]
+  end
+end

data/db/migrate/20250507155314_add_retry_count_to_raif_model_completions.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddRetryCountToRaifModelCompletions < ActiveRecord::Migration[7.1]
+  def change
+    add_column :raif_model_completions, :retry_count, :integer, default: 0, null: false
+  end
+end

data/db/migrate/20250527213016_add_response_id_and_response_array_to_model_completions.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class AddResponseIdAndResponseArrayToModelCompletions < ActiveRecord::Migration[7.1]
+  def change
+    json_column_type = if connection.adapter_name.downcase.include?("postgresql")
+      :jsonb
+    else
+      :json
+    end
+
+    add_column :raif_model_completions, :response_id, :string
+    add_column :raif_model_completions, :response_array, json_column_type
+  end
+end

data/db/migrate/20250603140622_add_citations_to_raif_model_completions.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class AddCitationsToRaifModelCompletions < ActiveRecord::Migration[7.1]
+  def change
+    json_column_type = if connection.adapter_name.downcase.include?("postgresql")
+      :jsonb
+    else
+      :json
+    end
+
+    add_column :raif_model_completions, :citations, json_column_type
+  end
+end

data/db/migrate/20250603202013_add_stream_response_to_raif_model_completions.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddStreamResponseToRaifModelCompletions < ActiveRecord::Migration[7.1]
+  def change
+    add_column :raif_model_completions, :stream_response, :boolean, default: false, null: false
+  end
+end

data/lib/generators/raif/agent/agent_generator.rb

@@ -1,22 +1,32 @@
 # frozen_string_literal: true
 
 module Raif
-  class AgentGenerator < Rails::Generators::NamedBase
-    source_root File.expand_path("templates", __dir__)
-    desc "Creates a new Raif::Agent subclass in app/models/raif/agents"
+  module Generators
+    class AgentGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+      desc "Creates a new Raif::Agent subclass in app/models/raif/agents"
 
-    def create_agent
-      template "agent.rb.tt", "app/models/raif/agents/#{file_name}.rb"
-    end
+      def create_application_agent
+        template "application_agent.rb.tt", "app/models/raif/application_agent.rb" unless File.exist?("app/models/raif/application_agent.rb")
+      end
 
-  private
+      def create_agent
+        template "agent.rb.tt", "app/models/raif/agents/#{file_name}.rb"
+      end
 
-    def class_name
-      name.classify
-    end
+      def create_directory
+        empty_directory "app/models/raif/agents" unless File.directory?("app/models/raif/agents")
+      end
+
+    private
+
+      def class_name
+        name.classify
+      end
 
-    def file_name
-      name.underscore
+      def file_name
+        name.underscore
+      end
     end
   end
 end

data/lib/generators/raif/agent/templates/agent.rb.tt

@@ -2,15 +2,15 @@
 
 module Raif
   module Agents
-    class <%= class_name %> < Raif::Agent
+    class <%= class_name %> < Raif::ApplicationAgent
       # If you want to always include a certain set of model tools with this agent type,
       # uncomment this callback to populate the available_model_tools attribute with your desired model tools.
-      # before_create -> {
+      # def populate_default_model_tools
       #   self.available_model_tools ||= [
       #     Raif::ModelTools::WikipediaSearchTool,
       #     Raif::ModelTools::FetchUrlTool
       #   ]
-      # }
+      # end
 
       # Enter your agent's system prompt here. Alternatively, you can change your agent's superclass
       # to an existing agent types (like Raif::Agents::ReActAgent) to utilize an existing system prompt.

data/lib/generators/raif/agent/templates/application_agent.rb.tt

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Raif
+  class ApplicationAgent < Raif::Agent
+    # Add any shared agent behavior here
+  end
+end

data/lib/generators/raif/conversation/conversation_generator.rb

@@ -7,6 +7,16 @@ module Raif
 
       desc "Creates a new conversation type in the app/models/raif/conversations directory"
 
+      class_option :response_format,
+        type: :string,
+        default: "text",
+        desc: "Response format for the task (text, html, or json)"
+
+      def create_application_conversation
+        template "application_conversation.rb.tt",
+          "app/models/raif/application_conversation.rb" unless File.exist?("app/models/raif/application_conversation.rb")
+      end
+
       def create_conversation_file
         template "conversation.rb.tt", File.join("app/models/raif/conversations", "#{file_name}.rb")
       end

data/lib/generators/raif/conversation/templates/application_conversation.rb.tt

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Raif
+  class ApplicationConversation < Raif::Conversation
+    # Add any shared conversation behavior here
+  end
+end

data/lib/generators/raif/conversation/templates/conversation.rb.tt

@@ -2,28 +2,23 @@
 
 module Raif
   module Conversations
-    class <%= class_name %> < Raif::Conversation
-      # If you want to always include a certain set of model tools with this conversation type, 
+    class <%= class_name %> < Raif::ApplicationConversation
+      # Set the response format for the task. Options are :html, :text, or :json.
+      # If you set this to something other than :text, make sure to include instructions to the model in your system prompt
+      llm_response_format :<%= options[:response_format] %>
+
+      # If you want to always include a certain set of model tools with this conversation type,
       # uncomment this callback to populate the available_model_tools attribute with your desired model tools.
       # before_create -> { self.available_model_tools = ["Raif::ModelTools::Example"] }
 
-      # Override the methods below to customize the system prompt for this conversation type. 
-      # Raif::Conversation expects a JSON response with a message key from the model, so make sure your system prompt instructs the model to respond accordingly.
+      # Override the methods below to customize the system prompt for this conversation type.
       # def system_prompt_intro
       #   Raif.config.conversation_system_prompt_intro
       # end
-      
+
       # def build_system_prompt
       #   <<~PROMPT
       #     #{system_prompt_intro}
-      #
-      #     # Your Responses
-      #     Your responses should always be in JSON format with a "message" field containing your response to your collaborator. For example:
-      #     {
-      #       "message": "Your response message"
-      #     }
-      #     #{tool_usage_system_prompt}
-      #     #{system_prompt_reminders}
       #     #{system_prompt_language_preference}
       #   PROMPT
       # end
@@ -32,6 +27,13 @@ module Raif
       # def initial_chat_message
       #   I18n.t("#{self.class.name.underscore.gsub("/", ".")}.initial_chat_message")
       # end
+
+      # This method will be called when receing a model response to a Raif::ConversationEntry
+      # By default, it just passes the model response message through, but you can override
+      # for custom response message processing
+      # def process_model_response_message(message:, entry:)
+      #   message
+      # end
     end
   end
-end 
+end

data/lib/generators/raif/install/templates/initializer.rb

@@ -4,26 +4,56 @@ Raif.configure do |config|
   # Your OpenAI API key. Defaults to ENV["OPENAI_API_KEY"]
   # config.open_ai_api_key = ENV["OPENAI_API_KEY"]
 
-  # Whether OpenAI models are enabled. Defaults to true
-  # config.open_ai_models_enabled = true
+  # Whether OpenAI models are enabled.
+  # config.open_ai_models_enabled = ENV["OPENAI_API_KEY"].present?
+
+  # Whether OpenAI embedding models are enabled.
+  # config.open_ai_embedding_models_enabled = ENV["OPENAI_API_KEY"].present?
 
   # Your Anthropic API key. Defaults to ENV["ANTHROPIC_API_KEY"]
   # config.anthropic_api_key = ENV["ANTHROPIC_API_KEY"]
 
-  # Whether Anthropic models are enabled. Defaults to true
-  # config.anthropic_models_enabled = true
+  # Whether Anthropic models are enabled.
+  # config.anthropic_models_enabled = ENV["ANTHROPIC_API_KEY"].present?
 
-  # Whether Anthropic models via AWS Bedrock are enabled. Defaults to true
-  # config.anthropic_bedrock_models_enabled = true
+  # Whether Anthropic models via AWS Bedrock are enabled. Defaults to false
+  # config.bedrock_models_enabled = false
 
   # The AWS Bedrock region to use. Defaults to "us-east-1"
   # config.aws_bedrock_region = "us-east-1"
 
+  # Prefix to apply to the model name in AWS Bedrock API calls (e.g. us.anthropic.claude-3-5-haiku-20241022-v1:0)
+  # config.aws_bedrock_model_name_prefix = "us"
+
+  # Whether Titan embedding models are enabled. Defaults to false
+  # config.bedrock_embedding_models_enabled = false
+
+  # Your OpenRouter API key. Defaults to ENV["OPENROUTER_API_KEY"]
+  # config.open_router_api_key = ENV["OPENROUTER_API_KEY"]
+
+  # Whether OpenRouter models are enabled.
+  # config.open_router_models_enabled = ENV["OPENROUTER_API_KEY"].present?
+
+  # The app name to include in OpenRouter API requests headers. Optional.
+  # config.open_router_app_name = "My App"
+
+  # The site URL to include in OpenRouter API requests headers. Optional.
+  # config.open_router_site_url = "https://myapp.com"
+
   # The default LLM model to use. Defaults to "open_ai_gpt_4o"
   # Available keys:
+  #   open_ai_gpt_4_1
+  #   open_ai_gpt_4_1_mini
+  #   open_ai_gpt_4_1_nano
   #   open_ai_gpt_4o_mini
   #   open_ai_gpt_4o
   #   open_ai_gpt_3_5_turbo
+  #   open_ai_responses_gpt_4_1
+  #   open_ai_responses_gpt_4_1_mini
+  #   open_ai_responses_gpt_4_1_nano
+  #   open_ai_responses_gpt_4o_mini
+  #   open_ai_responses_gpt_4o
+  #   open_ai_gpt_3_5_turbo
   #   anthropic_claude_3_7_sonnet
   #   anthropic_claude_3_5_sonnet
   #   anthropic_claude_3_5_haiku
@@ -32,8 +62,27 @@ Raif.configure do |config|
   #   bedrock_claude_3_7_sonnet
   #   bedrock_claude_3_5_haiku
   #   bedrock_claude_3_opus
+  #   bedrock_amazon_nova_micro
+  #   bedrock_amazon_nova_lite
+  #   bedrock_amazon_nova_pro
+  #   open_router_claude_3_7_sonnet
+  #   open_router_llama_3_3_70b_instruct
+  #   open_router_llama_3_1_8b_instruct
+  #   open_router_gemini_2_0_flash
+  #   open_router_deepseek_chat_v3
+  #
   # config.default_llm_model_key = "open_ai_gpt_4o"
 
+  # The default embedding model to use when calling Raif.generate_embedding!
+  # Defaults to "open_ai_text_embedding_3_small"
+  # Available keys:
+  #   open_ai_text_embedding_3_small
+  #   open_ai_text_embedding_3_large
+  #   open_ai_text_embedding_ada_002
+  #   bedrock_titan_embed_text_v2
+  #
+  # config.default_embedding_model_key = "open_ai_text_embedding_3_small"
+
   # A lambda that returns true if the current user is authorized to access admin controllers.
   # By default it returns false, so you must implement this in your application to use the admin controllers.
   # If your application's user model has an admin? method, you could use something like this:
@@ -46,9 +95,13 @@ Raif.configure do |config|
 
   # The system prompt intro for Raif::Task instances. Defaults to "You are a helpful assistant."
   # config.task_system_prompt_intro = "You are a helpful assistant."
+  # Or you can use a lambda to return a dynamic system prompt intro:
+  # config.task_system_prompt_intro = ->(task){ "You are a helpful assistant. Today's date is #{Date.today.strftime('%B %d, %Y')}." }
 
   # The system prompt intro for Raif::Conversation instances. Defaults to "You are a helpful assistant who is collaborating with a teammate."
   # config.conversation_system_prompt_intro = "You are a helpful assistant who is collaborating with a teammate."
+  # Or you can use a lambda to return a dynamic system prompt intro:
+  # config.conversation_system_prompt_intro = ->(conversation){ "You are a helpful assistant talking to #{conversation.creator.email}. Today's date is #{Date.today.strftime('%B %d, %Y')}." }
 
   # The conversation types that are available. Defaults to ["Raif::Conversation"]
   # If you want to use custom conversation types that inherits from Raif::Conversation, you can add them here.
@@ -75,6 +128,9 @@ Raif.configure do |config|
   # The user tool types that are available. Defaults to []
   # config.user_tool_types = []
 
+  # The chunk size threshold for streaming updates. Defaults to 25.
+  # config.streaming_update_chunk_size_threshold = 25
+
   # Whether LLM API requests are enabled. Defaults to true.
   # Use this to globally disable requests to LLM APIs.
   # config.llm_api_requests_enabled = true

data/lib/generators/raif/model_tool/model_tool_generator.rb

@@ -15,11 +15,6 @@ module Raif
         say_status :success, "Model tool created successfully", :green
         say "\nYou can now implement your model tool in:"
         say "  app/models/raif/model_tools/#{file_name}.rb"
-        say "\nImportant methods to implement:"
-        say "  - example_model_invocation: An example of how to invoke the tool, to be provided to the LLM"
-        say "  - tool_arguments_schema: JSON schema for validating arguments when the tool is invoked"
-        say "  - tool_description: A brief description of what the tool does, to be provided to the LLM"
-        say "  - process_invocation: The main method that executes the tool's functionality"
       end
 
     end