foobara-ollama-api 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7432f72bdbe66ce8ed9adb5d22a69a74e47346c10bf0a2cb56de459d547ae19
-  data.tar.gz: 3d632f7b7360eaf2ffe25f5dd1089ac82964cccc28c1afbc95ee7c89f3b71b7a
+  metadata.gz: 45199e4e73bda800594bae3a39b3f7bc81b06d86cc90ddc40e39981533900ced
+  data.tar.gz: 33d0789f0dc41abf5de8ed0e686a4be772bd003077432c66a35a0c219e2ae86d
 SHA512:
-  metadata.gz: 76838ec17ebc03802784e983a817be7dcdf891b6187ac467891a274da15a131a73f516faf385f5f7a2db66acbdc03d37cf875b4e163bd666d4daa3995cc0219f
-  data.tar.gz: eb422d4336d8b89fdc4fde88ef29c25329fa3f8bb072869ca855d95db625cd56411fc1aa133d33020c378758d7dd2a09c027eb86fde104e8791f2a8c57f0a5f2
+  metadata.gz: d174d2f705b82c05332eba7f4288ffeb8fa8117eeb03193b262b7382f60d41f7059eaa40d7c7f6c6cf18b77efe98be68fcf7eb9fb26a9d1db42574ee007e45df
+  data.tar.gz: 6d464afc7ae0587a0fc51f20a7673136fcbaeabb1166acdd37098328d6e0f01ba94bcefd55ea495a20778affd11e471d32629d636e6a11e7336ba2a83c10c138

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.0.3] - 2025-02-27
+
+- Increase timeout to 10 minutes
+
+## [0.0.2] - 2025-02-25
+
+- Add a ModelEnum as :model
+
 ## [0.0.1] - 2025-02-08
 
 - Initial release

data/README.md

@@ -11,15 +11,32 @@ your .gemspec file. Or even just `gem install foobara-ollama-api` if just playin
 
 An example usage:
 
-```ruby
+```irb
 irb(main):001> require "foobara/ollama_api"
 => true
-irb(main):002> chat_completion = Foobara::OllamaApi::GenerateChatCompletion.run!(
-  model: "llama3:8b",
-  messages: [{ role: "user", content: "What is the PH of honey?" }]
-)
-irb(main):003> puts chat_completion.message.content
-=> The pH of honey is 3.2 to 4.5 (slightly acidic.)
+irb(main):002* chat_completion = Foobara::Ai::OllamaApi::GenerateChatCompletion.run!(
+irb(main):003*   model: "llama3:8b",
+irb(main):004*   messages: [{ role: "user", content: "What is the PH of honey?" }]
+irb(main):005> )
+=> #<Foobara::Ai::OllamaApi::ChatCompletion:0x00007fae1e61a868...
+irb(main):006> puts chat_completion.message.content
+A sweet question!
+
+The pH of honey can vary depending on several factors, such as the type of flowers that the bees collect nectar from, the region where the honey is produced, and the processing methods used.
+
+  Generally, the pH of honey ranges from slightly acidic to neutral. Here are some approximate pH values for different types of honey:
+
+* Clover honey: pH 3.2-4.5
+* Orange blossom honey: pH 3.5-4.8
+* Tupelo honey: pH 4.0-5.0
+* Manuka honey: pH 4.5-5.5
+* Wildflower honey: pH 3.5-5.0
+
+On average, the pH of honey is around 4.2 to 4.5, which is slightly acidic to neutral. This is because honey contains small amounts of acids, such as gluconic acid and lactic acid, which are produced during fermentation by the bees.
+
+  It's worth noting that some types of honey, like Manuka honey, have a higher pH due to the presence of methylglyoxal (MGO), a compound that contributes to their unique properties.
+=> nil
+irb(main):007>
 ```
 
 ## Contributing

data/lib/foobara/ollama_api.rb

@@ -4,4 +4,6 @@ require "uri"
 require "foobara/all"
 require "foobara/http_api_command"
 
+require_relative "../../src/foobara/ai/ollama_api"
+
 Foobara::Util.require_directory "#{__dir__}/../../src"

data/src/foobara/ai/ollama_api/base_command.rb

@@ -2,7 +2,9 @@ module Foobara
   module Ai
     module OllamaApi
       class BaseCommand < Foobara::Command
-        include Concerns::Url
+        include HttpApiCommand
+
+        base_url { "#{ENV["OLLAMA_API_URL"] || "http://localhost:11434"}/api" }
       end
     end
   end

data/src/foobara/ai/ollama_api/generate_chat_completion.rb

@@ -1,17 +1,19 @@
-require_relative "base_post_command"
+require_relative "base_command"
 
 module Foobara
   module Ai
     module OllamaApi
-      class GenerateChatCompletion < BasePostCommand
+      class GenerateChatCompletion < BaseCommand
         inputs do
-          model :string, :required # TODO: make a model type
-          messages [Message], :required
+          model :model, :required
+          messages [Types::Message], :required
         end
 
-        result ChatCompletion
+        result Types::ChatCompletion
 
-        path "chat"
+        path "/chat"
+        http_method :post
+        http_timeout 600
 
         def build_request_body
           self.request_body = inputs.merge(stream: false)

data/src/foobara/ai/ollama_api/list_local_models.rb

@@ -3,10 +3,10 @@ require_relative "base_command"
 module Foobara
   module Ai
     module OllamaApi
-      class ListLocalModels < BaseGetCommand
-        result [LocalModel]
+      class ListLocalModels < BaseCommand
+        result [Types::LocalModel]
 
-        path "tags"
+        path "/tags"
 
         def build_result
           response_body["models"]

data/src/foobara/ai/ollama_api/list_running_models.rb

@@ -1,12 +1,12 @@
-require_relative "base_get_command"
+require_relative "base_command"
 
 module Foobara
   module Ai
     module OllamaApi
-      class ListRunningModels < BaseGetCommand
-        result [RunningModel]
+      class ListRunningModels < BaseCommand
+        result [Types::RunningModel]
 
-        path "ps"
+        path "/ps"
 
         def build_result
           response_body["models"]

data/src/foobara/ai/ollama_api/types/chat_completion.rb

@@ -3,20 +3,22 @@ require_relative "message"
 module Foobara
   module Ai
     module OllamaApi
-      class ChatCompletion < Foobara::Model
-        attributes do
-          model :string, :required # TODO: Make a model type
-          created_at :datetime, :required
-          message Message, :required
-          done :boolean, :required
-          total_duration :integer, :required # TODO: should we have a timespan type?
-          load_duration :integer, :required
-          prompt_eval_count :integer, :required
-          prompt_eval_duration :integer, :required
-          eval_count :integer, :required
-          eval_duration :integer, :required
-          # TODO: this one isn't documented for some reason
-          done_reason :string # TODO: create an enum type for this
+      module Types
+        class ChatCompletion < Foobara::Model
+          attributes do
+            model :string, :required # TODO: Make a model type
+            created_at :datetime, :required
+            message Message, :required
+            done :boolean, :required
+            total_duration :integer, :required # TODO: should we have a timespan type?
+            load_duration :integer, :required
+            prompt_eval_count :integer, :required
+            prompt_eval_duration :integer, :required
+            eval_count :integer, :required
+            eval_duration :integer, :required
+            # TODO: this one isn't documented for some reason
+            done_reason :string # TODO: create an enum type for this
+          end
         end
       end
     end

data/src/foobara/ai/ollama_api/types/local_model.rb

@@ -1,9 +1,13 @@
+require_relative "model"
+
 module Foobara
   module Ai
     module OllamaApi
-      class LocalModel < OllamaApi::Model
-        attributes do
-          modified_at :datetime, :required
+      module Types
+        class LocalModel < Model
+          attributes do
+            modified_at :datetime, :required
+          end
         end
       end
     end

data/src/foobara/ai/ollama_api/types/message.rb

@@ -1,12 +1,14 @@
 module Foobara
   module Ai
     module OllamaApi
-      class Message < Foobara::Model
-        attributes do
-          content :string, :required
-          role :string, :required # TODO: make a role type
-          images [:string] # TODO: make a base 64 image type
-          tool_calls :duck # TODO: make a tool calls type
+      module Types
+        class Message < Foobara::Model
+          attributes do
+            content :string, :required
+            role :string, :required # TODO: make a role type
+            images [:string] # TODO: make a base 64 image type
+            tool_calls :duck # TODO: make a tool calls type
+          end
         end
       end
     end

data/src/foobara/ai/ollama_api/types/model/details.rb

@@ -1,15 +1,17 @@
 module Foobara
   module Ai
     module OllamaApi
-      class Model < Foobara::Model
-        class Details < Foobara::Model
-          attributes do
-            parent_model :string, :required # TODO: should this be real model names?
-            format :string, :required # TODO: what are the valid values for this?
-            family :string, :required # TODO: what are the valid values for this?
-            families [:string], :required # TODO: what are the valid values for this?
-            parameter_size :string, :required # TODO: should we have a type to encapsulate 7.2B? Can just be a decimal?
-            quantization_level :string, :required # TODO: what are the valid values for this?
+      module Types
+        class Model < Foobara::Model
+          class Details < Foobara::Model
+            attributes do
+              parent_model :string, :required # TODO: should this be real model names?
+              format :string, :required # TODO: what are the valid values for this?
+              family :string, :required # TODO: what are the valid values for this?
+              families [:string], :required # TODO: what are the valid values for this?
+              parameter_size :string, :required # TODO: should we have a type to encapsulate 7.2B? Can be a decimal?
+              quantization_level :string, :required # TODO: what are the valid values for this?
+            end
           end
         end
       end

data/src/foobara/ai/ollama_api/types/model.rb

@@ -3,13 +3,15 @@ require_relative "model/details"
 module Foobara
   module Ai
     module OllamaApi
-      class Model < Foobara::Model
-        attributes do
-          name :string, :required # TODO: what are the valid values for this?
-          model :string, :required # TODO: what are the valid values for this?
-          size :integer, :required
-          digest :string, :required # TODO: create a type for this type of hash?
-          details Details, :required
+      module Types
+        class Model < Foobara::Model
+          attributes do
+            name :string, :required # TODO: what are the valid values for this?
+            model :string, :required # TODO: what are the valid values for this?
+            size :integer, :required
+            digest :string, :required # TODO: create a type for this type of hash?
+            details Details, :required
+          end
         end
       end
     end

data/src/foobara/ai/ollama_api/types/model_enum.rb

@@ -0,0 +1,14 @@
+require_relative "../list_local_models"
+
+module Foobara
+  module Ai
+    module OllamaApi
+      module Types
+        model_list = ListLocalModels.run!.map(&:model).sort
+        ModelEnum = Foobara::Enumerated.make_module(model_list)
+      end
+
+      foobara_register_type(:model, :string, one_of: Types::ModelEnum)
+    end
+  end
+end

data/src/foobara/ai/ollama_api/types/running_model.rb

@@ -3,10 +3,12 @@ require_relative "model"
 module Foobara
   module Ai
     module OllamaApi
-      class RunningModel < OllamaApi::Model
-        attributes do
-          expires_at :datetime, :required
-          size_vram :integer, :required
+      module Types
+        class RunningModel < Model
+          attributes do
+            expires_at :datetime, :required
+            size_vram :integer, :required
+          end
         end
       end
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: foobara-ollama-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Miles Georgi
 bindir: bin
 cert_chain: []
-date: 2025-02-08 00:00:00.000000000 Z
+date: 2025-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foobara-http-api-command
@@ -36,9 +36,6 @@ files:
 - lib/foobara/ollama_api.rb
 - src/foobara/ai/ollama_api.rb
 - src/foobara/ai/ollama_api/base_command.rb
-- src/foobara/ai/ollama_api/base_get_command.rb
-- src/foobara/ai/ollama_api/base_post_command.rb
-- src/foobara/ai/ollama_api/concerns/url.rb
 - src/foobara/ai/ollama_api/generate_chat_completion.rb
 - src/foobara/ai/ollama_api/list_local_models.rb
 - src/foobara/ai/ollama_api/list_running_models.rb
@@ -47,6 +44,7 @@ files:
 - src/foobara/ai/ollama_api/types/message.rb
 - src/foobara/ai/ollama_api/types/model.rb
 - src/foobara/ai/ollama_api/types/model/details.rb
+- src/foobara/ai/ollama_api/types/model_enum.rb
 - src/foobara/ai/ollama_api/types/running_model.rb
 homepage: https://github.com/foobara/ollama-api
 licenses:
@@ -63,7 +61,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.4.1
+      version: 3.4.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/src/foobara/ai/ollama_api/base_get_command.rb

@@ -1,11 +0,0 @@
-require_relative "base_command"
-
-module Foobara
-  module Ai
-    module OllamaApi
-      class BaseGetCommand < BaseCommand
-        include HttpApiGetCommand
-      end
-    end
-  end
-end

data/src/foobara/ai/ollama_api/base_post_command.rb

@@ -1,11 +0,0 @@
-require_relative "base_command"
-
-module Foobara
-  module Ai
-    module OllamaApi
-      class BasePostCommand < BaseCommand
-        include HttpApiPostCommand
-      end
-    end
-  end
-end

data/src/foobara/ai/ollama_api/concerns/url.rb

@@ -1,17 +0,0 @@
-module Foobara
-  module Ai
-    module OllamaApi
-      module Concerns
-        module Url
-          include Concern
-
-          module ClassMethods
-            def path(path)
-              url { "#{ENV["OLLAMA_API_URL"] || "http://localhost:11434"}/api/#{path}" }
-            end
-          end
-        end
-      end
-    end
-  end
-end