foobara-open-ai-api 0.0.6 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76be1cb3c24b8c905e2cc04313eef59367c09851ad6607fdff0005236ca4e285
-  data.tar.gz: ec7b733d9046a178066070d8ad1095211184c511ec0e05a614f699082ad2396f
+  metadata.gz: b1134ded66f3c63f8f0def005ed37383f5c69522899e51fe3316dce02c1210f8
+  data.tar.gz: 0170e54de38d1b4ac99b8d7c110d67ce67dbb2da53bebca8fdf94dda7c0f0027
 SHA512:
-  metadata.gz: 15b45c0ae249d87eeda1563f7ff525f366a266d55a6e5a4ae96e9e3ed3ab6d6974244880c90106842b7985eea1f79417c65513cd32f0cad27c564f990d1e3ae1
-  data.tar.gz: 26734ceffbd9b5f6923e7339754461ce4cd679a9756d9f5fa331aa12cffb2f297f4b50b2987fb9b7e9bc96ad15461de8b9cfd181b36f2f6843dec896d2dee93f
+  metadata.gz: be8f41c655f0a08a2c3b44a2c13ad9f5bf2f39fb055b2119b537a3459e344fb476bb672087e2887ae5e3d779bca81b93b0f9a2c0771a56f98b24a72fe26c8f9f
+  data.tar.gz: 2f091240994a101906585d51cd6915d0153dd7d2eb1f011f63d6cfa8f7e8593144be01ce1877ca47e8096870eef4b91cfa31a8966d617a8d24fce695d0675b39

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [0.0.7] - 2025-02-17
+
+- Add support for some newly added fields
+- Make sure our models don't break when OpenAI adds new attributes to their responses
+  before we have a chance to update them
+- Implement ListModels
+
 ## [0.0.6] - 2025-02-16
 
 - Rename Completion to ChatCompletion

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

@@ -0,0 +1,27 @@
+require "foobara/http_api_command"
+
+module Foobara
+  module Ai
+    module OpenAiApi
+      class BaseCommand < Foobara::Command
+        include HttpApiCommand
+
+        base_url "https://api.openai.com/v1"
+
+        inputs do
+          # TODO: come up with some kind of execution context object to wrap all of these calls upon which
+          # data wrapping a "request" can live instead of being passed around?
+          api_token :string
+        end
+
+        def api_token
+          inputs[:api_token] || ENV.fetch("OPENAI_API_KEY", nil)
+        end
+
+        def build_request_headers
+          self.request_headers = { "Content-Type" => "application/json", "Authorization" => "Bearer #{api_token}" }
+        end
+      end
+    end
+  end
+end

data/src/foobara/ai/open_ai_api/create_chat_completion.rb

@@ -1,13 +1,13 @@
+require_relative "base_command"
+
 module Foobara
   module Ai
     module OpenAiApi
-      class CreateChatCompletion < Foobara::Command
-        URL = "https://api.openai.com/v1/chat/completions".freeze
+      class CreateChatCompletion < BaseCommand
+        path "/chat/completions"
+        http_method :post
 
-        inputs do
-          # TODO: come up with some kind of execution context object to wrap all of these calls upon which
-          # data wrapping a "request" can live instead of being passed around?
-          api_token :string
+        add_inputs do
           model :string, default: "gpt-3.5-turbo", one_of: %w[gpt-3.5-turbo gpt-4]
           messages :array do
             role :string, one_of: %w[system user assistant]
@@ -17,50 +17,12 @@ module Foobara
 
         result Types::ChatCompletion
 
-        def execute
-          build_request_body
-          build_request_headers
-          issue_http_request
-          parse_response
-          build_completion
-
-          completion
-        end
-
-        attr_accessor :request_body, :request_headers, :response, :response_body, :completion
-
         def build_request_body
           self.request_body = { model:, messages: }
         end
 
-        def build_request_headers
-          self.request_headers = { "Content-Type" => "application/json", "Authorization" => "Bearer #{api_token}" }
-        end
-
-        def api_token
-          inputs[:api_token] || ENV.fetch("OPENAI_API_KEY", nil)
-        end
-
-        def issue_http_request
-          url = URI.parse(URL)
-          self.response = Net::HTTP.post(url, JSON.generate(request_body), request_headers)
-        end
-
-        def parse_response
-          completion_json = if response.is_a?(Net::HTTPSuccess)
-                              response.body
-                            else
-                              # :nocov:
-                              raise "Could not get completion from #{URL}: " \
-                                    "#{response.code} #{response.message}"
-                              # :nocov:
-                            end
-
-          self.response_body = JSON.parse(completion_json)
-        end
-
-        def build_completion
-          self.completion = Types::ChatCompletion.new(response_body)
+        def build_result
+          Types::ChatCompletion.new(response_body, ignore_unexpected_attributes: true)
         end
       end
     end

data/src/foobara/ai/open_ai_api/list_models.rb

@@ -0,0 +1,19 @@
+module Foobara
+  module Ai
+    module OpenAiApi
+      class ListModels < BaseCommand
+        path "/models"
+
+        inputs do
+          api_token :string
+        end
+
+        result [Types::Model]
+
+        def build_result
+          response_body["data"]
+        end
+      end
+    end
+  end
+end

data/src/foobara/ai/open_ai_api/types/chat_completion/message.rb

@@ -7,6 +7,7 @@ module Foobara
             attributes do
               role :string, one_of: %w[assistant user system]
               content :string
+              refusal :string, :allow_nil
             end
           end
         end

data/src/foobara/ai/open_ai_api/types/chat_completion/usage.rb

@@ -8,6 +8,16 @@ module Foobara
               prompt_tokens :integer
               completion_tokens :integer
               total_tokens :integer
+              prompt_tokens_details do
+                audio_tokens :integer
+                cached_tokens :integer
+              end
+              completion_tokens_details do
+                accepted_prediction_tokens :integer
+                audio_tokens :integer
+                reasoning_tokens :integer
+                rejected_prediction_tokens :integer
+              end
             end
           end
         end

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

@@ -12,6 +12,7 @@ module Foobara
             system_fingerprint :string, :allow_nil
             choices [Choice]
             usage Usage
+            service_tier :string, :allow_nil, one_of: %w[auto default]
           end
         end
       end

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

@@ -0,0 +1,16 @@
+module Foobara
+  module Ai
+    module OpenAiApi
+      module Types
+        class Model < Foobara::Model
+          attributes do
+            id :string
+            created :datetime
+            object :string
+            owned_by :string
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: foobara-open-ai-api
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.8
 platform: ruby
 authors:
 - Miles Georgi
 bindir: bin
 cert_chain: []
-date: 2025-02-16 00:00:00.000000000 Z
+date: 2025-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: foobara
+  name: foobara-http-api-command
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -36,11 +36,14 @@ files:
 - README.md
 - lib/foobara/open_ai_api.rb
 - src/foobara/ai/open_ai_api.rb
+- src/foobara/ai/open_ai_api/base_command.rb
 - src/foobara/ai/open_ai_api/create_chat_completion.rb
+- src/foobara/ai/open_ai_api/list_models.rb
 - src/foobara/ai/open_ai_api/types/chat_completion.rb
 - src/foobara/ai/open_ai_api/types/chat_completion/choice.rb
 - src/foobara/ai/open_ai_api/types/chat_completion/message.rb
 - src/foobara/ai/open_ai_api/types/chat_completion/usage.rb
+- src/foobara/ai/open_ai_api/types/model.rb
 homepage: https://github.com/foobara/open-ai-api
 licenses:
 - Apache-2.0