scout-ai 0.2.0 → 1.0.0

data/scout-ai.gemspec

@@ -0,0 +1,130 @@
+# Generated by juwelier
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: scout-ai 1.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "scout-ai".freeze
+  s.version = "1.0.0".freeze
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Miguel Vazquez".freeze]
+  s.date = "2025-06-05"
+  s.description = "assorted functionalities to help scouts use AI".freeze
+  s.email = "mikisvaz@gmail.com".freeze
+  s.executables = ["scout-ai".freeze]
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".vimproject",
+    "LICENSE",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bin/scout-ai",
+    "lib/scout-ai.rb",
+    "lib/scout/llm/agent.rb",
+    "lib/scout/llm/agent/chat.rb",
+    "lib/scout/llm/ask.rb",
+    "lib/scout/llm/backends/bedrock.rb",
+    "lib/scout/llm/backends/huggingface.rb",
+    "lib/scout/llm/backends/ollama.rb",
+    "lib/scout/llm/backends/openai.rb",
+    "lib/scout/llm/backends/openwebui.rb",
+    "lib/scout/llm/backends/relay.rb",
+    "lib/scout/llm/backends/responses.rb",
+    "lib/scout/llm/chat.rb",
+    "lib/scout/llm/embed.rb",
+    "lib/scout/llm/parse.rb",
+    "lib/scout/llm/rag.rb",
+    "lib/scout/llm/tools.rb",
+    "lib/scout/llm/utils.rb",
+    "lib/scout/model/base.rb",
+    "lib/scout/model/python/base.rb",
+    "lib/scout/model/python/huggingface.rb",
+    "lib/scout/model/python/huggingface/causal.rb",
+    "lib/scout/model/python/huggingface/causal/next_token.rb",
+    "lib/scout/model/python/huggingface/classification",
+    "lib/scout/model/python/huggingface/classification.rb",
+    "lib/scout/model/python/torch.rb",
+    "lib/scout/model/python/torch/dataloader.rb",
+    "lib/scout/model/python/torch/helpers.rb",
+    "lib/scout/model/python/torch/introspection.rb",
+    "lib/scout/model/python/torch/load_and_save.rb",
+    "lib/scout/model/util/run.rb",
+    "lib/scout/model/util/save.rb",
+    "python/scout_ai/__init__.py",
+    "python/scout_ai/__pycache__/__init__.cpython-310.pyc",
+    "python/scout_ai/__pycache__/__init__.cpython-311.pyc",
+    "python/scout_ai/__pycache__/huggingface.cpython-310.pyc",
+    "python/scout_ai/__pycache__/huggingface.cpython-311.pyc",
+    "python/scout_ai/__pycache__/util.cpython-310.pyc",
+    "python/scout_ai/__pycache__/util.cpython-311.pyc",
+    "python/scout_ai/atcold/__init__.py",
+    "python/scout_ai/atcold/plot_lib.py",
+    "python/scout_ai/atcold/spiral.py",
+    "python/scout_ai/huggingface/data.py",
+    "python/scout_ai/huggingface/eval.py",
+    "python/scout_ai/huggingface/model.py",
+    "python/scout_ai/huggingface/rlhf.py",
+    "python/scout_ai/huggingface/train/__init__.py",
+    "python/scout_ai/huggingface/train/__pycache__/__init__.cpython-310.pyc",
+    "python/scout_ai/huggingface/train/__pycache__/next_token.cpython-310.pyc",
+    "python/scout_ai/huggingface/train/next_token.py",
+    "python/scout_ai/language_model.py",
+    "python/scout_ai/util.py",
+    "scout-ai.gemspec",
+    "scout_commands/agent/ask",
+    "scout_commands/agent/kb",
+    "scout_commands/llm/ask",
+    "scout_commands/llm/process",
+    "scout_commands/llm/template",
+    "test/data/cat.jpg",
+    "test/data/person/brothers",
+    "test/data/person/identifiers",
+    "test/data/person/marriages",
+    "test/data/person/parents",
+    "test/scout/llm/agent/test_chat.rb",
+    "test/scout/llm/backends/test_bedrock.rb",
+    "test/scout/llm/backends/test_huggingface.rb",
+    "test/scout/llm/backends/test_ollama.rb",
+    "test/scout/llm/backends/test_openai.rb",
+    "test/scout/llm/backends/test_openwebui.rb",
+    "test/scout/llm/backends/test_relay.rb",
+    "test/scout/llm/backends/test_responses.rb",
+    "test/scout/llm/test_agent.rb",
+    "test/scout/llm/test_ask.rb",
+    "test/scout/llm/test_chat.rb",
+    "test/scout/llm/test_embed.rb",
+    "test/scout/llm/test_parse.rb",
+    "test/scout/llm/test_rag.rb",
+    "test/scout/llm/test_tools.rb",
+    "test/scout/llm/test_utils.rb",
+    "test/scout/model/python/huggingface/causal/test_next_token.rb",
+    "test/scout/model/python/huggingface/test_causal.rb",
+    "test/scout/model/python/huggingface/test_classification.rb",
+    "test/scout/model/python/test_base.rb",
+    "test/scout/model/python/test_huggingface.rb",
+    "test/scout/model/python/test_torch.rb",
+    "test/scout/model/python/torch/test_helpers.rb",
+    "test/scout/model/test_base.rb",
+    "test/scout/model/util/test_save.rb",
+    "test/test_helper.rb"
+  ]
+  s.homepage = "http://github.com/mikisvaz/scout-ai".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "3.6.6".freeze
+  s.summary = "AI gear for scouts".freeze
+
+  s.specification_version = 4
+
+  s.add_runtime_dependency(%q<scout-rig>.freeze, [">= 0".freeze])
+end
+

data/scout_commands/agent/ask

@@ -19,8 +19,11 @@ Use STDIN to add context to the question
 -h--help Print this help
 -l--log* Log level
 -t--template* Use a template
+-c--chat* Follow a conversation
 -m--model* Model to use
+-e--endpoint* Endpoint to use
 -f--file* Incorporate file at the start
+-wt--workflow_tasks* Export these tasks to the agent
 EOF
 if options[:help]
   if defined? scout_usage
@@ -37,34 +40,149 @@ file = options.delete(:file)
 
 agent, *question_parts = ARGV
 
+agent_path = Scout.var.Agent[agent].find_with_extension(:rb)
+
+agent = LLM::Agent.load agent_path
+
+#workflow_tasks = options.delete(:workflow_tasks)
+#
+#workflow = begin
+#             if agent_dir.workflow.set_extension('rb').exists?
+#               Workflow.require_workflow agent_dir.workflow.set_extension('rb').find
+#             else
+#               Misc.with_env "SCOUT_WORKFLOW_AUTOINSTALL", false do
+#                 Workflow.require_workflow agent
+#               end
+#             end
+#           rescue
+#           end
+#
+#if workflow_tasks and workflow
+#  workflow.clear_exports
+#  workflow.export_asynchronous *workflow_tasks.split(',')
+#end
+#
+#knowledge_base = KnowledgeBase.load(agent_dir.knowledge_base) if agent_dir.knowledge_base.exists?
+#knowledge_base ||= begin workflow.knowledge_base rescue nil end || KnowledgeBase.new(agent_dir.knowledge_base)
+#
+#agent = LLM::Agent.new **options.merge(workflow: workflow, knowledge_base: knowledge_base)
+
+#question = question_parts * " " 
+#
+#if template = options.delete(:template)
+#  if Open.exists?(template)
+#    template_question = Open.read(template)
+#  else
+#    template_question = Scout.questions[template].read
+#  end
+#  if template_question.include?('???')
+#    question = template_question.sub('???', question)
+#  else
+#    question = template_question
+#  end
+#end
+#
+#if question.include?('...')
+#  context = file ? Open.read(file) : STDIN.read 
+#  question = question.sub('...', context)
+#end
+#
+#if chat
+#  conversation = Open.exist?(chat)? Open.read(chat) : "" 
+#  question = question.empty? ? conversation : conversation + "\nuser:\n" +  question
+#  new = agent.ask(question, options)
+#  conversation = question + "\nassistant:\n" + new
+#  Open.write(chat, conversation)
+#else
+#  puts agent.ask(question, options)
+#end
+
+file, chat, inline, template, dry_run = IndiferentHash.process_options options, :file, :chat, :inline, :template, :dry_run
+
+agent, question = ARGV * " "
+
+agent_name ||= 'default'
+agent_file = Scout.chats[agent_name]
+
+agent_file = agent_file.find_with_extension('rb')
+
+if agent_file.exists?
+  if agent_file.directory?
+    agent = load agent_file.agent.find_with_extension('rb')
+  else
+    agent = load agent_file
+  end
+else
+  raise ParameterException agent_file
+end
 
-workflow = begin
-             Workflow.require_workflow agent
-           rescue
-           end
-
-knowledge_base = begin workflow.knowledge_base rescue nil end || KnowledgeBase.new(Scout.var.Agent[agent])
-
-agent = LLM::Agent.new workflow: workflow, knowledge_base: knowledge_base
-
-question = question_parts * " " 
-
-if template = options.delete(:template)
+if template
   if Open.exists?(template)
     template_question = Open.read(template)
-  else
+  elsif Scout.questions[template].exists?
     template_question = Scout.questions[template].read
+  elsif Scout.chats.system[template].exists?
+    template_question = Scout.chats.system[template].read
+  elsif Scout.chats[template].exists?
+    template_question = Scout.chats[template].read
   end
   if template_question.include?('???')
     question = template_question.sub('???', question)
+  elsif not question.empty?
+    question = template_question + "\nuser: #{question}"
   else
     question = template_question
   end
 end
 
 if question.include?('...')
-  context = file ? Open.read(file) : STDIN.read 
+  context = file ? Open.read(file) : STDIN.read
   question = question.sub('...', context)
+elsif file
+  question = "<file basename=#{File.basename file}>[[[\n" + Open.read(file) + "\n]]]</file>"
 end
 
-puts LLM.ask(question, options)
+if chat
+  conversation = Open.exist?(chat)? LLM.chat(chat) : [] 
+  convo_options = LLM.options conversation
+  conversation = question.empty? ? conversation : conversation +  LLM.chat(question)
+
+  if dry_run
+    ppp LLM.print conversation
+    exit 0
+  end
+  new = agent.ask(conversation, convo_options.merge(options.merge(return_messages: true)))
+  conversation = Open.read(chat) + LLM.print(new)
+  Open.write(chat, conversation)
+elsif inline
+
+  file = Open.read inline
+
+  new_file = ""
+  while true
+    pre, question, post = 
+      file.partition(/^\s*#\s*ask:(?:.*?)(?=^\s*[^\s#])/smu)
+
+      break if post.empty?
+
+    new_file << pre
+    new_file << question
+    clean_question = question.gsub('#', '').gsub(/\s+/,' ').sub(/.*ask:\s*/,'').strip
+    chat = [
+      {role: :system, content: "Write a succint reply with no commentary and no formatting."}, 
+      {role: :user, content: "Find the following question as a comment in the file give a response to be placed inline: #{question}"},
+      LLM.tag('file', file, inline)
+    ]
+    response = LLM.ask(LLM.chat(chat))
+    new_file << <<-EOF
+# Response start
+#{response}
+# Response end
+    EOF
+    file = post
+  end
+  new_file << file
+  Open.write(inline, new_file)
+else
+  puts agent.ask(question, options)
+end

data/scout_commands/agent/kb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+agent = ARGV.shift
+
+agent_dir = Scout.var.Agent[agent]
+
+if ARGV.any?
+  ARGV.push "--knowledge_base"
+  ARGV.push agent_dir.knowledge_base
+  ARGV.push "--log"
+  ARGV.push Log.severity.to_s
+end
+ARGV.unshift 'kb'
+
+load Scout.bin.scout.find

data/scout_commands/llm/ask

@@ -3,22 +3,30 @@
 require 'scout'
 require 'scout-ai'
 
-$0 = "scout #{$previous_commands.any? ? $previous_commands*" " + " " : "" }#{ File.basename(__FILE__) }" if $previous_commands
+$0 = "scout-ai #{$previous_commands.any? ? $previous_commands*" " + " " : "" }#{ File.basename(__FILE__) }" if $previous_commands
 
 options = SOPT.setup <<EOF
+Ask an LLM model
 
-Ask GPT
+$ #{$0} [<options>] [<question>]
 
-$ #{$0} [<options>] [question]
-
-Use STDIN to add context to the question
+Use STDIN to add context to the question. The context can be referenced using
+three dots '...'. The model will be prompted with the question, unless the
+inline option is used. If the chat option is used, the response will be added
+to the end of the file. If the file option is used the file contents will be
+prepended before the question.  With the template option, the file will be read
+as if it were the question, and the actual question will be placed under the
+characters '???', if they are present.
 
 -h--help Print this help
--l--log* Log level
 -t--template* Use a template
+-c--chat* Follow a conversation
+-i--inline* Ask inline questions about a file
+-f--file* Incorporate file at the start
 -m--model* Model to use
 -e--endpoint* Endpoint to use
--f--file* Incorporate file at the start
+-b--backend* Backend to use
+-d--dry_run Dry run, don't ask
 EOF
 if options[:help]
   if defined? scout_usage
@@ -31,26 +39,77 @@ end
 
 Log.severity = options.delete(:log).to_i if options.include? :log
 
-file = options.delete(:file)
+file, chat, inline, template, dry_run = IndiferentHash.process_options options, :file, :chat, :inline, :template, :dry_run
 
 question = ARGV * " "
 
-if template = options.delete(:template)
+if template
   if Open.exists?(template)
     template_question = Open.read(template)
-  else
+  elsif Scout.questions[template].exists?
     template_question = Scout.questions[template].read
+  elsif Scout.chats.system[template].exists?
+    template_question = Scout.chats.system[template].read
+  elsif Scout.chats[template].exists?
+    template_question = Scout.chats[template].read
   end
   if template_question.include?('???')
     question = template_question.sub('???', question)
+  elsif not question.empty?
+    question = template_question + "\nuser: #{question}"
   else
     question = template_question
   end
 end
 
 if question.include?('...')
-  context = file ? Open.read(file) : STDIN.read 
+  context = file ? Open.read(file) : STDIN.read
   question = question.sub('...', context)
+elsif file
+  question = "<file basename=#{File.basename file}>[[[\n" + Open.read(file) + "\n]]]</file>"
 end
 
-puts LLM.ask(question, options)
+if chat
+  conversation = Open.exist?(chat)? LLM.chat(chat) : [] 
+  convo_options = LLM.options conversation
+  conversation = question.empty? ? conversation : conversation +  LLM.chat(question)
+
+  if dry_run
+    ppp LLM.print conversation
+    exit 0
+  end
+  new = LLM.ask(conversation, convo_options.merge(options.merge(return_messages: true)))
+  conversation = Open.read(chat) + LLM.print(new)
+  Open.write(chat, conversation)
+elsif inline
+
+  file = Open.read inline
+
+  new_file = ""
+  while true
+    pre, question, post = 
+      file.partition(/^\s*#\s*ask:(?:.*?)(?=^\s*[^\s#])/smu)
+
+      break if post.empty?
+
+    new_file << pre
+    new_file << question
+    clean_question = question.gsub('#', '').gsub(/\s+/,' ').sub(/.*ask:\s*/,'').strip
+    chat = [
+      {role: :system, content: "Write a succint reply with no commentary and no formatting."}, 
+      {role: :user, content: "Find the following question as a comment in the file give a response to be placed inline: #{question}"},
+      LLM.tag('file', file, inline)
+    ]
+    response = LLM.ask(LLM.chat(chat))
+    new_file << <<-EOF
+# Response start
+#{response}
+# Response end
+    EOF
+    file = post
+  end
+  new_file << file
+  Open.write(inline, new_file)
+else
+  puts LLM.ask(question, options)
+end

data/scout_commands/llm/process

@@ -32,7 +32,9 @@ directory = ARGV.first || Scout.var.ask.find
 directory = Path.setup directory
 
 while true
-  directory.glob('*.json').each do |file|
+  files = directory.glob('*.json')
+
+  files.each do |file|
     target = directory.reply[id + '.json']
 
     if ! File.exist?(target)
@@ -46,5 +48,5 @@ while true
     Open.rm(file)
   end
 
-  sleep 1
+  sleep 1 if files.empty?
 end

data/test/scout/llm/agent/test_chat.rb

@@ -0,0 +1,14 @@
+require File.expand_path(__FILE__).sub(%r(/test/.*), '/test/test_helper.rb')
+require 'scout/llm/agent'
+require File.expand_path(__FILE__).sub(%r(.*/test/), '').sub(/test_(.*)\.rb/,'\1')
+
+require 'scout/llm/agent'
+class TestAgent < Test::Unit::TestCase
+  def test_true
+    a = LLM::Agent.new
+    a.start_chat.system 'you are a robot'
+    a.user "hi"
+    ppp a.print
+  end
+end
+

data/test/scout/llm/backends/test_bedrock.rb

@@ -0,0 +1,60 @@
+require File.expand_path(__FILE__).sub(%r(/test/.*), '/test/test_helper.rb')
+require File.expand_path(__FILE__).sub(%r(.*/test/), '').sub(/test_(.*)\.rb/,'\1')
+
+class TestLLMBedrock < Test::Unit::TestCase
+  def _test_ask
+    prompt =<<-EOF
+say hi
+    EOF
+    ppp LLM::Bedrock.ask prompt, model: "anthropic.claude-3-sonnet-20240229-v1:0", model_max_tokens: 100, model_anthropic_version: 'bedrock-2023-05-31'
+  end
+
+
+  def _test_embeddings
+    Log.severity = 0
+    text =<<-EOF
+Some text
+    EOF
+    emb = LLM::Bedrock.embed text, log_errors: true
+    assert(Float === emb.first)
+  end
+
+  def test_tool
+    prompt =<<-EOF
+What is the weather in London. Should I take my umbrella? Use the provided tool
+    EOF
+
+    tools = [
+      {
+        "type": "function",
+        "function": {
+          "name": "get_weather",
+          "description": "Get the current temperature and raining conditions for a specific location",
+          "parameters": {
+            "type": "object",
+            "properties": {
+              "location": {
+                "type": "string",
+                "description": "The city and state, e.g., San Francisco, CA"
+              },
+              "unit": {
+                "type": "string",
+                "enum": ["Celsius", "Fahrenheit"],
+                "description": "The temperature unit to use. Infer this from the user's location."
+              }
+            },
+            "required": ["location", "unit"]
+          }
+        }
+      },
+    ]
+
+    sss 0
+    response = LLM::Bedrock.ask prompt, tool_choice: 'required', tools: tools, model: "anthropic.claude-3-sonnet-20240229-v1:0", model_max_tokens: 100, model_anthropic_version: 'bedrock-2023-05-31' do |name,arguments|
+      "It's 15 degrees and raining."
+    end
+
+    ppp response
+  end
+end
+

data/test/scout/llm/backends/test_huggingface.rb

@@ -13,7 +13,7 @@ user: write a script that sorts files in a directory
     ppp LLM::Huggingface.ask prompt, model: 'HuggingFaceTB/SmolLM2-135M-Instruct'
   end
 
-  def test_embeddings
+  def _test_embeddings
     Log.severity = 0
     text =<<-EOF
 Some text
@@ -22,7 +22,7 @@ Some text
     assert(Float === emb.first)
   end
 
-  def test_embedding_array
+  def _test_embedding_array
     Log.severity = 0
     text =<<-EOF
 Some text
@@ -31,7 +31,7 @@ Some text
     assert(Float === emb.first.first)
   end
 
-  def test_tool
+  def _test_tool
     prompt =<<-EOF
 What is the weather in London. Should I take an umbrella?
     EOF

data/test/scout/llm/backends/test_ollama.rb

@@ -13,22 +13,42 @@ user: write a script that sorts files in a directory
     ppp LLM::OLlama.ask prompt, model: 'mistral', mode: 'chat'
   end
 
-  def test_embeddings
+  def test_tool_call_output
     Log.severity = 0
-    text =<<-EOF
-Some text
+    prompt =<<-EOF
+function_call:
+
+{"type":"function","function":{"name":"Baking-bake_muffin_tray","arguments":{}},"id":"Baking_bake_muffin_tray_Default"}
+
+function_call_output:
+
+{"id":"Baking_bake_muffin_tray_Default","content":"Baking batter (Mixing base (Whisking eggs from share/pantry/eggs) with mixer (share/pantry/flour))"}
+
+user:
+
+How do you bake muffins, according to the tool I provided you. Don't
+tell me the recipe you already know, use the tool call output. Let me
+know if you didn't get it.
     EOF
-    emb = LLM::OLlama.embed text, model: 'mistral'
-    assert(Float === emb.first)
+    ppp LLM::OLlama.ask prompt, model: 'mistral', mode: 'chat'
   end
 
-  def test_embedding_array
+  def test_tool_call_output_weather
     Log.severity = 0
-    text =<<-EOF
-Some text
+    prompt =<<-EOF
+function_call:
+
+{"name":"get_current_temperature", "arguments":{"location":"London","unit":"Celsius"},"id":"tNTnsQq2s6jGh0npOh43AwDD"}
+
+function_call_output:
+
+{"id":"tNTnsQq2s6jGh0npOh43AwDD", "content":"It's 15 degrees and raining."}
+
+user:
+
+should i take an umbrella?
     EOF
-    emb = LLM::OLlama.embed [text], model: 'mistral'
-    assert(Float === emb.first.first)
+    ppp LLM::OLlama.ask prompt, model: 'mistral'
   end
 
   def test_tool
@@ -68,5 +88,23 @@ What is the weather in London. Should I take an umbrella?
 
     ppp respose
   end
+
+  def test_embeddings
+    Log.severity = 0
+    text =<<-EOF
+Some text
+    EOF
+    emb = LLM::OLlama.embed text, model: 'mistral'
+    assert(Float === emb.first)
+  end
+
+  def test_embedding_array
+    Log.severity = 0
+    text =<<-EOF
+Some text
+    EOF
+    emb = LLM::OLlama.embed [text], model: 'mistral'
+    assert(Float === emb.first.first)
+  end
 end