scout-ai 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 36833eaae86ac11476b39ac0f188cfa2106a9cad810fcdd53de37a9b356e15e0
+  data.tar.gz: 014a3927cb41bd99b28b866c442bacca65c21a27b79491e3bd790c1051115f4b
+SHA512:
+  metadata.gz: 0d4ebfecd2e6ed94901b955536d6c6a36817ac7aa1eaafcfd657c563185b69c5eb03293aef2446a0444842c1d263dc79a951342e57fd3704f96b931ef02cb027
+  data.tar.gz: 45ed2228cca6bfeea3d0161ff766b1abfb2137def68eb1c3c142ee9b32a234a9b95223612026b3683d0f72aba308853e1bd9d92ca4e5cdbfdb9500555810a4fa

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.vimproject

@@ -0,0 +1,61 @@
+scout-ai=/$PWD filter="*.rb *.rake Rakefile *.rdoc *.R *.sh *.js *.haml *.sass *.txt *.conf" {
+ Rakefile
+ bin=bin filter="*"{
+  scout-ai
+ }
+ etc=etc filter="*"{
+  config
+ }
+ lib=lib {
+  scout-ai.rb
+  scout=scout{
+   llm=llm{
+    utils.rb
+    parse.rb
+    backends=backends{
+     ollama.rb
+     openai.rb
+     openwebui.rb
+     huggingface.rb
+     relay.rb
+    }
+    ask.rb
+
+    embed.rb
+
+    rag.rb
+
+    tools.rb
+    agent.rb
+   }
+  }
+ }
+ test=test {
+  data=data filter="*"{
+   person=person{
+    identifiers
+    brothers
+    marriages
+    parents
+   }
+  }
+  test_helper.rb
+ }
+ data=data filter="*"{
+ }
+ scout_commands=scout_commands filter="*"{
+  llm=llm{
+   ask
+   template
+   process
+  }
+  agent=agent{
+   ask
+  }
+ }
+ questions=questions filter="*"{
+  coach
+  evaluator
+  templater
+ }
+}

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016-2017 Miguel Vázquez García
+
+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/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2025 Miguel Vazquez
+
+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.rdoc

@@ -0,0 +1,18 @@
+= scout-ai
+
+Description goes here.
+
+== Contributing to scout-ai
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2025 Miguel Vazquez. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+ENV["BRANCH"] = 'main'
+
+require 'rubygems'
+require 'rake'
+require 'juwelier'
+Juwelier::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "scout-ai"
+  gem.homepage = "http://github.com/mikisvaz/scout-ai"
+  gem.license = "MIT"
+  gem.summary = %Q{AI gear for scouts}
+  gem.description = %Q{assorted functionalities to help scouts use AI}
+  gem.email = "mikisvaz@gmail.com"
+  gem.authors = ["Miguel Vazquez"]
+
+  # dependencies defined in Gemfile
+end
+Juwelier::RubygemsDotOrgTasks.new
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "scout-ai #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/bin/scout-ai

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'scout-ai'
+
+load Scout.bin.scout.find

data/lib/scout/llm/agent.rb

@@ -0,0 +1,78 @@
+require_relative 'ask'
+
+module LLM
+  class Agent
+    attr_accessor :system, :workflow, :knowledge_base
+    def initialize(system = nil, workflow: nil, knowledge_base: nil, model: nil, **kwargs)
+      @system = system
+      @workflow = workflow
+      @knowledge_base = knowledge_base
+      @model = model
+      @other_options = kwargs
+    end
+
+    def format_message(message, prefix = "user")
+      message.split(/\n\n+/).reject{|line| line.empty? }.collect do |line|
+        prefix + "\t" + line.gsub("\n", ' ')
+      end * "\n"
+    end
+
+    def system_prompt
+      system = @system
+      system = [system] unless system.nil? || system.is_a?(Array)
+
+      if @knowledge_base
+        system << <<-EOF
+You have access to the following databases associating entities:
+        EOF
+
+        knowledge_base.all_databases.each do |database|
+          system << <<-EOF.strip + (knowledge_base.undirected(database) ? ". Undirected" : "")
+* #{database}: #{knowledge_base.source(database)} => #{knowledge_base.target(database)}
+          EOF
+        end
+      end
+
+      system * "\n"
+    end
+
+    def prompt(messages)
+      if system_prompt
+        [format_message(system_prompt, "system"), messages.collect{|m| format_message(m)}.flatten] * "\n"
+      else
+        messages.collect{|m| format_message(m)}.flatten
+      end
+    end
+
+    # function: takes an array of messages and calls LLM.ask with them
+    def ask(messages, model = nil)
+      messages = [messages] unless messages.is_a? Array
+      model ||= @model
+
+      tools = []
+      tools += LLM.workflow_tools(workflow) if workflow
+      tools += LLM.knowledge_base_tool_definition(knowledge_base) if knowledge_base
+
+      LLM.ask prompt(messages), @other_options.merge(model: model, log_errors: true, tools: tools) do |name,parameters|
+        case name
+        when 'children'
+          parameters = IndiferentHash.setup(parameters)
+          database, entities = parameters.values_at "database", "entities"
+          Log.high "Finding #{entities} children in #{database}"
+          knowledge_base.children(database, entities).target
+        else
+          if workflow
+            begin
+              Log.high "Calling #{workflow}##{name} with #{Log.fingerprint parameters}"
+              workflow.job(name, parameters).run
+            rescue
+              $!.message
+            end
+          else
+            raise "What?"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/scout/llm/ask.rb

@@ -0,0 +1,50 @@
+require 'scout'
+require_relative 'backends/openai'
+require_relative 'backends/ollama'
+require_relative 'backends/openwebui'
+require_relative 'backends/relay'
+
+module LLM
+  def self.ask(question, options = {}, &block)
+    endpoint = IndiferentHash.process_options options, :endpoint
+
+    endpoint ||= Scout::Config.get :endpoint, :ask, :llm, env: 'ASK_ENDPOINT,LLM_ENDPOINT', default: :openai
+    if endpoint && Scout.etc.AI[endpoint].exists?
+      options = IndiferentHash.add_defaults options, Scout.etc.AI[endpoint].yaml
+    end
+
+    backend = IndiferentHash.process_options options, :backend
+    backend ||= Scout::Config.get :backend, :ask, :llm, env: 'ASK_BACKEND,LLM_BACKEND', default: :openai
+
+
+    case backend
+    when :openai, "openai"
+      LLM::OpenAI.ask(question, options, &block)
+    when :ollama, "ollama"
+      LLM::OLlama.ask(question, options, &block)
+    when :openwebui, "openwebui"
+      LLM::OpenWebUI.ask(question, options, &block)
+    when :relay, "relay"
+      LLM::Relay.ask(question, options, &block)
+    else
+      raise "Unknown backend: #{backend}"
+    end
+  end
+
+  def self.workflow_ask(workflow, question, options = {})
+    workflow_tools = LLM.workflow_tools(workflow)
+    self.ask(question, options.merge(tools: workflow_tools)) do |task_name,parameters|
+      workflow.job(task_name, parameters).run
+    end
+  end
+
+  def self.knowledge_base_ask(knowledge_base, question, options = {})
+    knowledge_base_tools = LLM.knowledge_base_tool_definition(knowledge_base)
+    self.ask(question, options.merge(tools: knowledge_base_tools)) do |task_name,parameters|
+      parameters = IndiferentHash.setup(parameters)
+      database, entities = parameters.values_at "database", "entities"
+      Log.info "Finding #{entities} children in #{database}"
+      knowledge_base.children(database, entities).collect{|e| e.sub('~', '=>')}
+    end
+  end
+end

data/lib/scout/llm/backends/huggingface.rb

@@ -0,0 +1,67 @@
+require_relative '../parse'
+require_relative '../tools'
+
+module LLM
+  module Huggingface
+
+    def self.model(model_options)
+      require 'rbbt-util'
+      require 'rbbt/vector/model/huggingface'
+
+      model, task, checkpoint, dir = IndiferentHash.process_options model_options, :model, :task, :checkpoint, :dir
+      model ||= Scout::Config.get(:model, :huggingface, env: 'HUGGINGFACE_MODEL,HF_MODEL')
+
+      HuggingfaceModel.new task, model, dir, model_options
+    end
+
+    def self.ask(question, options = {}, &block)
+      model_options = IndiferentHash.pull_keys options, :model
+      model_options = IndiferentHash.add_defaults model_options, :task => "CausalLM"
+
+      model = self.model model_options
+
+      messages = LLM.parse(question)
+
+      system = []
+      prompt = []
+      messages.each do |message|
+        role, content = message.values_at :role, :content
+        if role == 'system'
+          system << content
+        else
+          prompt << content
+        end
+      end
+
+      parameters = options.merge(messages: messages)
+      Log.debug "Calling client with parameters: #{Log.fingerprint parameters}"
+
+      response = model.eval(messages)
+      message = response[-1]
+      while message["role"] == "assistant" && message["tool_calls"]
+        messages << message
+
+        message["tool_calls"].each do |tool_call|
+          response_message = LLM.tool_response(tool_call, &block)
+          messages << response_message
+        end
+
+        parameters[:messages] = messages
+        Log.debug "Calling client with parameters: #{Log.fingerprint parameters}"
+        response = model.eval(parameters)
+        message = response[-1]
+      end
+
+      message["content"]
+    end
+
+    def self.embed(text, options = {})
+      model_options = IndiferentHash.pull_keys options, :model
+      model_options = IndiferentHash.add_defaults model_options, :task => "Embedding"
+
+      model = self.model model_options
+
+      (Array === text) ? model.eval_list(text) : model.eval(text)
+    end
+  end
+end

data/lib/scout/llm/backends/ollama.rb

@@ -0,0 +1,103 @@
+require 'ollama-ai'
+require_relative '../parse'
+require_relative '../tools'
+require_relative '../utils'
+
+module LLM
+  module OLlama
+    def self.client(url, key = nil)
+      Ollama.new(
+        credentials: {
+          address: url,
+          bearer_token: key
+        },
+        options: { stream: false, debug: true }
+      )
+    end
+
+    def self.ask(question, options = {}, &block)
+
+      client, url, key, model = IndiferentHash.process_options options, :client, :url, :key, :model
+
+      if client.nil?
+        url ||= Scout::Config.get(:url, :ollama_ask, :ask, :ollama, env: 'OLLAMA_URL', default: "http://localhost:11434")
+        key ||= LLM.get_url_config(:key, url, :ollama_ask, :ask, :ollama, env: 'OLLAMA_KEY')
+        client = self.client url, key
+      end
+
+      if model.nil?
+        url ||= Scout::Config.get(:url, :ollama_ask, :ask, :ollama, env: 'OLLAMA_URL', default: "http://localhost:11434")
+        model ||= LLM.get_url_config(:model, url, :ollama_ask, :ask, :ollama, env: 'OLLAMA_MODEL', default: "mistral")
+      end
+
+      mode  = IndiferentHash.process_options options, :mode
+
+      messages = LLM.parse(question)
+
+      system = []
+      prompt = []
+      messages.each do |message|
+        role, content = message.values_at :role, :content
+        if role == 'system'
+          system << content
+        else
+          prompt << content
+        end
+      end
+
+      case mode
+      when :chat, 'chat'
+        parameters = options.merge(model: model, messages: messages)
+        Log.debug "Calling client with parameters: #{Log.fingerprint parameters}"
+
+        response = client.chat(parameters)
+        response.collect do |choice|
+          message=choice['message']
+          while message["role"] == "assistant" && message["tool_calls"]
+            messages << message
+
+            message["tool_calls"].each do |tool_call|
+              response_message = LLM.tool_response(tool_call, &block)
+              messages << response_message
+            end
+
+            parameters[:messages] = messages
+            Log.debug "Calling client with parameters: #{Log.fingerprint parameters}"
+            response = client.chat(parameters)
+
+            message = response[0]['message']
+          end
+
+          message["content"]
+        end * ""
+      else
+        parameters = options.merge(model: model, prompt: prompt * "\n", system: system*"\n")
+        Log.debug "Calling client with parameters: #{Log.fingerprint parameters}"
+        response = client.generate(parameters)
+        response.collect{|e| e['response']} * ""
+      end
+    end
+
+    def self.embed(text, options = {})
+
+      client, url, key, model = IndiferentHash.process_options options, :client, :url, :key, :model
+
+      if client.nil?
+        url ||= Scout::Config.get(:url, :ollama_embed, :embed, :ollama, env: 'OLLAMA_URL', default: "http://localhost:11434")
+        key ||= LLM.get_url_config(:key, url, :ollama_embed, :embed, :ollama, env: 'OLLAMA_KEY')
+        client = self.client url, key
+      end
+
+      if model.nil?
+        url ||= Scout::Config.get(:url, :ollama_embed, :embed, :ollama, env: 'OLLAMA_URL', default: "http://localhost:11434")
+        model ||= LLM.get_url_config(:model, url, :ollama_embed, :embed, :ollama, env: 'OLLAMA_MODEL', default: "mistral")
+      end
+
+      parameters = { input: text, model: model }
+      Log.debug "Calling client with parameters: #{Log.fingerprint parameters}"
+      embeddings = client.request('api/embed', parameters)
+
+      Array === text ? embeddings.first['embeddings'] : embeddings.first['embeddings'].first
+    end
+  end
+end

data/lib/scout/llm/backends/openai.rb

@@ -0,0 +1,86 @@
+require 'scout'
+require 'openai'
+require_relative '../parse'
+require_relative '../tools'
+require_relative '../utils'
+
+module LLM
+  module OpenAI
+
+    def self.client(url, key, log_errors = false)
+      Object::OpenAI::Client.new(access_token:key, log_errors: log_errors, uri_base: url)
+    end
+
+    def self.ask(question, options = {}, &block)
+
+      client, url, key, model, log_errors = IndiferentHash.process_options options, :client, :url, :key, :model, :log_errors
+
+      if client.nil?
+        url ||= Scout::Config.get(:url, :openai_ask, :ask, :openai, env: 'OPENAI_URL')
+        key ||= LLM.get_url_config(:key, url, :openai_ask, :ask, :openai, env: 'OPENAI_KEY')
+        client = self.client url, key, log_errors
+      end
+
+      if model.nil?
+        url ||= Scout::Config.get(:url, :openai_ask, :ask, :openai, env: 'OPENAI_URL')
+        model ||= LLM.get_url_config(:model, url, :openai_ask, :ask, :openai, env: 'OPENAI_MODEL', default: "gpt-3.5-turbo")
+      end
+
+      role = IndiferentHash.process_options options, :role
+
+      messages = LLM.parse(question, role)
+
+      parameters = options.merge(model: model, messages: messages)
+
+      Log.debug "Calling client with parameters: #{Log.fingerprint parameters}"
+
+      response = client.chat(parameters: parameters)
+      Log.debug "Respose: #{Log.fingerprint response}"
+      message = response.dig("choices", 0, "message")
+      tool_calls = response.dig("choices", 0, "tool_calls") ||
+        response.dig("choices", 0, "message", "tool_calls")
+
+      parameters.delete :tool_choice
+
+      while tool_calls && tool_calls.any?
+        messages << message
+
+        cpus = Scout::Config.get :cpus, :tool_calling, default: 3
+        tool_calls.each do |tool_call|
+          response_message = LLM.tool_response(tool_call, &block)
+          messages << response_message
+        end
+
+        parameters[:messages] = messages.compact
+        Log.debug "Calling client with parameters: #{Log.fingerprint parameters}"
+        response = client.chat( parameters: parameters)
+        Log.debug "Respose: #{Log.fingerprint response}"
+
+        message = response.dig("choices", 0, "message")
+        tool_calls = response.dig("choices", 0, "tool_calls") ||
+          response.dig("choices", 0, "message", "tool_calls")
+      end
+
+      message.dig("content")
+    end
+
+    def self.embed(text, options = {})
+
+      client, url, key, model, log_errors = IndiferentHash.process_options options, :client, :url, :key, :model, :log_errors
+
+      if client.nil?
+        url ||= Scout::Config.get(:url, :openai_embed, :embed, :openai, env: 'OPENAI_URL')
+        key ||= LLM.get_url_config(:key, url, :openai_embed, :embed, :openai, env: 'OPENAI_KEY')
+        client = self.client url, key, log_errors
+      end
+
+      if model.nil?
+        url ||= Scout::Config.get(:url, :openai_embed, :embed, :openai, env: 'OPENAI_URL')
+        model ||= LLM.get_url_config(:model, url, :openai_embed, :embed, :openai, env: 'OPENAI_MODEL', default: "gpt-3.5-turbo")
+      end
+
+      response = client.embeddings(parameters: {input: text, model: model})
+      response.dig('data', 0, 'embedding')
+    end
+  end
+end

data/lib/scout/llm/backends/openwebui.rb

@@ -0,0 +1,63 @@
+require 'scout'
+require 'openai'
+require 'rest-client'
+require_relative '../parse'
+require_relative '../tools'
+require_relative '../utils'
+
+module LLM
+  module OpenWebUI
+
+    def self.rest(method, base_url, key, action, options = {})
+      url = File.join(base_url, action.to_s)
+      headers = {"Authorization" => "Bearer #{key}", "Content-Type" => "application/json"}
+      response = case method.to_sym
+                 when :post
+                   #RestClient.send(method, url, options, {content_type: "application/json", accept: "application/json", Authorization: "Bearer #{key}"})
+                   iii [url, options, headers]
+                   RestClient.post(url, options.to_json, headers)
+                 else
+                   RestClient.send(method, url, {content_type: "application/json", accept: "application/json", "Authorization" => "Bearer #{key}"})
+                 end
+      JSON.parse(response.body)
+    end
+
+    def self.ask(question, options = {}, &block)
+
+      url, key, model, log_errors = IndiferentHash.process_options options, :url, :key, :model, :log_errors
+
+      url ||= Scout::Config.get(:url, :openai_ask, :ask, :openai, env: 'OPENWEBUI_URL', default: "http://localhost:3000/api")
+      key ||= LLM.get_url_config(:key, url, :openai_ask, :ask, :openai, env: 'OPENWEBUI_KEY')
+      model ||= LLM.get_url_config(:model, url, :openai_ask, :ask, :openai, env: 'OPENWEBUI_MODEL')
+
+      role = IndiferentHash.process_options options, :role
+      messages = LLM.parse(question, role)
+
+      parameters = options.merge(model: model, messages: messages)
+
+      Log.debug "Calling client with parameters: #{Log.fingerprint parameters}"
+
+      response = self.rest(:post, url, key, "chat/completions" , parameters)
+
+      message = response.dig("choices", 0, "message")
+
+      parameters.delete :tool_choice
+
+      while message["role"] == "assistant" && message["tool_calls"]
+        messages << message
+        message["tool_calls"].each do |tool_call|
+          response_message = LLM.tool_response(tool_call, &block)
+          messages << response_message
+        end
+
+        parameters[:messages] = messages
+        Log.debug "Calling client with parameters: #{Log.fingerprint parameters}"
+        response = client.chat( parameters: parameters)
+
+        message = response.dig("choices", 0, "message")
+      end
+
+      message.dig("content")
+    end
+  end
+end

data/lib/scout/llm/backends/relay.rb

@@ -0,0 +1,36 @@
+require 'scout'
+require 'openai'
+require_relative '../parse'
+require_relative '../tools'
+
+module LLM
+	module Relay
+    def self.upload(server, file)
+      id = Misc.digest(Open.read(file))
+      CMD.cmd("scp #{file} #{server}:.scout/var/ask/#{ id }.json")
+      id
+    end
+
+    def self.gather(server, id)
+      TmpFile.with_file do |file|
+        begin
+          CMD.cmd("scp #{server}:.scout/var/ask/reply/#{ id }.json #{ file }")
+          JSON.parse(Open.read(file))
+        rescue
+          sleep 1
+          retry
+        end
+      end
+    end
+
+    def self.ask(question, options = {}, &block)
+      options[:question] = question
+
+      server = Scout::Config.get(:server, :relay, default: "localhost")
+      TmpFile.with_file(options.to_json) do |file|
+        id = upload(server, file)
+        gather(server, id)
+      end
+    end
+  end
+end