huginn_ollama_agent 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e3fa742e907e01a2d71241761e082ab51bc8488192278df8693523927eef9a7e
+  data.tar.gz: 618ef39a32e3ccc4ca3da53cc2d8f1876cc3706ad53d2cb66e1e928a19f3bc9f
+SHA512:
+  metadata.gz: 5398a357bdd6c5a22ef0ce4778f3d77a1f4bed97a50de6d4da54cd86e1a4093d1df3dd141b4656b57887d44c97bd45d51056aa665d805c8a84c0de8b6b4b71f4
+  data.tar.gz: aa2abc6c4a51a51d2274507159bb1c75dd9d37a1ca88946ef1a142234b769b17806853146b97cf09de2c9fc59292db91e2d0ab323a88d5c7cc8a90597ed4f924

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2024 Nicolas Germain
+
+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/lib/huginn_ollama_agent/ollama_agent.rb

@@ -0,0 +1,299 @@
+module Agents
+  class OllamaAgent < Agent
+    include FormConfigurable
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule 'every_1h'
+
+    description do
+      <<-MD
+      The Ollama Agent interacts with Ollama's api.
+
+      The `type` can be like generate.
+
+      `debug` is used for verbose mode.
+
+      `model` (required) the model name.
+
+      `prompt` the prompt to generate a response.
+
+      `context` the context parameter returned from a previous request to /generate, this can be used to keep a short conversational memory.
+
+      `stream` if false the response will be returned as a single response object, rather than a stream of objects.
+
+      `raw` if true no formatting will be applied to the prompt. You may choose to use the raw parameter if you are specifying a full templated prompt in your request to the API.
+
+      `expected_receive_period_in_days` is used to determine if the Agent is working. Set it to the maximum number of days
+      that you anticipate passing without this Agent receiving an incoming Event.
+      MD
+    end
+
+    event_description <<-MD
+      Events look like this:
+
+         {
+            "model": "mistral",
+            "created_at": "2024-03-25T20:54:25.920292408Z",
+            "response": " I'm assuming you're asking if the question or instruction provided in the prompt is clear and effective. To answer that, I would need to see the specific prompt you have in mind. If you could please share it with me, I'd be happy to help evaluate its clarity and effectiveness.",
+            "done": true,
+            "context": [
+              733,
+              16289,
+              28793,
+              28705,
+              1235,
+              272,
+              11510,
+              771,
+              1550,
+              733,
+              28748,
+              16289,
+              28793,
+              315,
+              28742,
+              28719,
+              16347,
+              368,
+              28742,
+              267,
+              7201,
+              513,
+              272,
+              2996,
+              442,
+              13126,
+              3857,
+              297,
+              272,
+              11510,
+              349,
+              3081,
+              304,
+              5645,
+              28723,
+              1791,
+              4372,
+              369,
+              28725,
+              315,
+              682,
+              927,
+              298,
+              1032,
+              272,
+              2948,
+              11510,
+              368,
+              506,
+              297,
+              2273,
+              28723,
+              1047,
+              368,
+              829,
+              4665,
+              4098,
+              378,
+              395,
+              528,
+              28725,
+              315,
+              28742,
+              28715,
+              347,
+              4610,
+              298,
+              1316,
+              15627,
+              871,
+              25312,
+              304,
+              23798,
+              28723
+            ],
+            "total_duration": 12033891123,
+            "load_duration": 921427821,
+            "prompt_eval_count": 14,
+            "prompt_eval_duration": 1246297000,
+            "eval_count": 62,
+            "eval_duration": 9865732000
+          }
+
+    MD
+
+    def default_options
+      {
+        'type' => 'generate',
+        'model' => 'mistral',
+        'url' => '',
+        'prompt' => '',
+        'context' => '',
+        'stream' => 'false',
+        'raw' => 'false',
+        'debug' => 'false',
+        'expected_receive_period_in_days' => '2',
+      }
+    end
+
+    form_configurable :type, type: :array, values: ['generate']
+    form_configurable :model, type: :string
+    form_configurable :url, type: :string
+    form_configurable :prompt, type: :string
+    form_configurable :context, type: :string
+    form_configurable :stream, type: :boolean
+    form_configurable :raw, type: :boolean
+    form_configurable :debug, type: :boolean
+    form_configurable :expected_receive_period_in_days, type: :string
+    def validate_options
+      errors.add(:base, "type has invalid value: should be 'generate'") if interpolated['type'].present? && !%w(generate).include?(interpolated['type'])
+
+      unless options['model'].present?
+        errors.add(:base, "model is a required field")
+      end
+
+      unless options['url'].present?
+        errors.add(:base, "url is a required field")
+      end
+
+      unless options['prompt'].present?
+        errors.add(:base, "prompt is a required field")
+      end
+
+      if options.has_key?('stream') && boolify(options['stream']).nil?
+        errors.add(:base, "if provided, stream must be true or false")
+      end
+
+      if options.has_key?('raw') && boolify(options['raw']).nil?
+        errors.add(:base, "if provided, raw must be true or false")
+      end
+
+      if options.has_key?('debug') && boolify(options['debug']).nil?
+        errors.add(:base, "if provided, debug must be true or false")
+      end
+
+      unless options['expected_receive_period_in_days'].present? && options['expected_receive_period_in_days'].to_i > 0
+        errors.add(:base, "Please provide 'expected_receive_period_in_days' to indicate how many days can pass before this Agent is considered to be not working")
+      end
+    end
+
+    def working?
+      event_created_within?(options['expected_receive_period_in_days']) && !recent_error_logs?
+    end
+
+    def receive(incoming_events)
+      incoming_events.each do |event|
+        interpolate_with(event) do
+          log event
+          trigger_action
+        end
+      end
+    end
+
+    def check
+      trigger_action
+    end
+
+    private
+
+
+    def log_curl_output(code,body)
+
+      log "request status : #{code}"
+
+      if interpolated['debug'] == 'true'
+        log "request status : #{code}"
+        log "body"
+        log body
+      end
+
+    end
+
+    def push_model(model)
+
+      uri = URI.parse(interpolated['url'] + '/api/pull')
+      request = Net::HTTP::Post.new(uri)
+      request.body = JSON.dump({
+        "name" => interpolated['model']
+      })
+
+      req_options = {
+        use_ssl: uri.scheme == "https",
+      }
+
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+
+      log_curl_output(response.code,response.body)
+
+    end
+
+    def check_remote_model()
+      url = URI(interpolated['url'] + '/api/tags')
+      https = Net::HTTP.new(url.host, url.port)
+
+      request = Net::HTTP::Get.new(url)
+      response = https.request(request)
+
+      log_curl_output(response.code,response.body)
+
+      payload = JSON.parse(response.body)
+      payload['models'].each do |modele|
+        return true if modele['name'] == interpolated['model'] + ':latest'
+      end
+
+      false
+    end
+
+    def generate_completion()
+
+      request_payload = {}
+      request_payload['model'] = interpolated['model']
+      request_payload['prompt'] = interpolated['prompt']
+      request_payload['stream'] = boolify(interpolated['stream'])
+      request_payload['raw'] = boolify(interpolated['raw'])
+      request_payload['context'] = context if !interpolated['context'].empty?
+
+      if check_remote_model()
+        if interpolated['debug'] == 'true'
+          log "#{interpolated['model']} found"
+        end
+      else
+        if interpolated['debug'] == 'true'
+          log "#{interpolated['model']} not found"
+        end
+        push_model(interpolated['model'])
+      end
+
+      uri = URI.parse(interpolated['url'] + '/api/generate')
+      request = Net::HTTP::Post.new(uri)
+      request.body = JSON.dump(request_payload)
+
+      req_options = {
+        use_ssl: uri.scheme == "https",
+      }
+
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+
+      log_curl_output(response.code,response.body)
+
+      payload = JSON.parse(response.body)
+      create_event payload: payload
+
+    end
+    
+
+    def trigger_action
+
+      case interpolated['type']
+      when "generate"
+        generate_completion()
+      else
+        log "Error: type has an invalid value (#{type})"
+      end
+    end
+  end
+end

data/lib/huginn_ollama_agent.rb

@@ -0,0 +1,4 @@
+require 'huginn_agent'
+
+#HuginnAgent.load 'huginn_ollama_agent/concerns/my_agent_concern'
+HuginnAgent.register 'huginn_ollama_agent/ollama_agent'

data/spec/ollama_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::OllamaAgent do
+  before(:each) do
+    @valid_options = Agents::OllamaAgent.new.default_options
+    @checker = Agents::OllamaAgent.new(:name => "OllamaAgent", :options => @valid_options)
+    @checker.user = users(:bob)
+    @checker.save!
+  end
+
+  pending "add specs here"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: huginn_ollama_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicolas Germain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: huginn_agent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Write a longer description or delete this line.
+email:
+- ngermain@hihouhou.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/huginn_ollama_agent.rb
+- lib/huginn_ollama_agent/ollama_agent.rb
+- spec/ollama_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_ollama_agent
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key: 
+specification_version: 4
+summary: Write a short summary, because Rubygems requires one.
+test_files:
+- spec/ollama_agent_spec.rb