intelligence 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 694776aeafc7552879d8b9d5358907e62c90a6fc5a1219081ee1d1a4cb5ddeef
-  data.tar.gz: 380f5cd13200750f65938fd4e92c21218af8c2b57af0614bfe16f714ba296e68
+  metadata.gz: 754f9f4fd414c8bee3fd90ea14aeae011e21f3312e483096f5a50b41698dfef5
+  data.tar.gz: 7ba7e4cb7cd172e152f8ab6c886255a13d0bbf26b6c6e0f674b71765ed03cf67
 SHA512:
-  metadata.gz: f2ca65b2a4e3a202bc1b331f7965da9e76a8ccd2ec83f7c5c273c94137fb1e0131226ecf3bf2aed6d50e262933d26c0024b3a5052edda28c39768c766b508e29
-  data.tar.gz: c6694ffa62ddd9eb766f42fb9cc073195a01e11e0d34cd346588b3923266c14f794d1711e1766888369874e27ce4ac696de0513055af8e27149a778611ce0cb2
+  metadata.gz: db69984a0028e297a30346406f351388caca294094fabe00d30c8598f038db8731acfbf1ded26c6fa8f653bf388826ec6fa07327c5868bec40ba6686a7f38182
+  data.tar.gz: f1a21376458d278c46828c564951a945bc7c896951946911e06fe73c04204dad2147ce91ba83434161d55e0c0c1a7132d1d9f7006ea9f2ef3fbe59bcf24bc87d

data/intelligence.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do | spec |
   spec.require_paths = [ "lib" ]
 
   spec.add_runtime_dependency 'faraday', '~> 2.7'
-  spec.add_runtime_dependency 'adaptiveconfiguration', '~> 1.0.0.beta01'
+  spec.add_runtime_dependency 'adaptiveconfiguration', '~> 1.0.0.beta08'
   spec.add_runtime_dependency 'mime-types', '~> 3.6'
 
   spec.add_development_dependency 'rspec', '~> 3.4'

data/lib/intelligence/adapter/base.rb

@@ -1,7 +1,20 @@
+require_relative 'class_methods/construction'
+
 module Intelligence
   module Adapter
     class Base
       extend AdaptiveConfiguration::Configurable
-    end 
+      extend ClassMethods::Construction
+
+      def initialize( options = nil, configuration: nil )
+        @options = options ? self.class.configure( options ) : {}
+        @options = configuration.merge( @options ) if configuration
+      end
+
+    protected 
+      attr_reader :options
+
+    end
   end
-end
+end
+

data/lib/intelligence/adapter/class_methods/construction.rb

@@ -0,0 +1,17 @@
+module Intelligence
+  module Adapter
+    module ClassMethods
+      module Construction
+
+        def build( options = nil, &block )
+          self.new( configuration: self.configure( options, &block ) )
+        end
+
+        def build!( options = nil, &block )
+          self.new( configuration: self.configure!( options, &block ) ) 
+        end
+
+      end
+    end
+  end
+end

data/lib/intelligence/adapter/module_methods/construction.rb

@@ -0,0 +1,43 @@
+module Intelligence
+  module Adapter
+    module ModuleMethods
+      module Construction
+
+        def []( adapter_type )
+
+          raise ArgumentError.new( "An adapter type is required but nil was given." ) \
+            if adapter_type.nil?
+
+          class_name = adapter_type.to_s.split( '_' ).map( &:capitalize ).join
+          class_name += "::Adapter"
+
+          adapter_class = Intelligence.const_get( class_name ) rescue nil
+          if adapter_class.nil?
+            adapter_file = File.expand_path( "../../../adapters/#{adapter_type}", __FILE__ )
+            unless require adapter_file
+              raise ArgumentError.new( 
+                "The Intelligence adapter file #{adapter_file} is missing or does not define #{class_name}." 
+              )
+            end
+            adapter_class = Intelligence.const_get( class_name ) rescue nil
+          end
+
+          raise ArgumentError.new( "An unknown Intelligence adapter #{adapter_type} was requested." ) \
+            if adapter_class.nil? 
+
+          adapter_class
+
+        end
+
+        def build( adapter_type, attributes = nil, &block )
+          self.[]( adapter_type ).build( attributes, &block )
+        end
+
+        def build!( adapter_type, attributes = nil, &block )
+          self.[]( adapter_type ).build!( attributes, &block )
+        end
+
+      end
+    end
+  end
+end  

data/lib/intelligence/adapter.rb

@@ -1,8 +1,8 @@
-require_relative 'adapter/construction_methods'
+require_relative 'adapter/module_methods/construction'
 require_relative 'adapter/base'
 
 module Intelligence
   module Adapter
-    extend ConstructionMethods
+    extend ModuleMethods::Construction
   end
 end

data/lib/intelligence/adapters/anthropic/adapter.rb

@@ -7,16 +7,16 @@ module Intelligence
       configuration do 
 
         # normalized properties for all endpoints
-        parameter :key, required: true 
+        parameter :key 
 
         # anthropic specific properties for all endpoints
-        parameter :version, String, required: true, default: '2023-06-01'
+        parameter :version, String, default: '2023-06-01'
  
         group :chat_options do 
   
           # normalized properties for anthropic generative text endpoint
-          parameter :model, String, required: true
-          parameter :max_tokens, Integer, required: true
+          parameter :model, String
+          parameter :max_tokens, Integer
           parameter :temperature, Float
           parameter :top_k, Integer
           parameter :top_p, Float
@@ -40,17 +40,6 @@ module Intelligence
         
       end
 
-      attr_reader :key
-      attr_reader :version
-      attr_reader :chat_options
-
-      def initialize( attributes = nil, &block )
-        configuration = self.class.configure( attributes, &block ) 
-        @key = configuration[ :key ]
-        @version = configuration[ :version ]
-        @chat_options = configuration[ :chat_options ] || {}
-      end
-
       include ChatMethods
 
     end 

data/lib/intelligence/adapters/anthropic/chat_methods.rb

@@ -1,5 +1,3 @@
-require 'base64'
-
 module Intelligence
   module Anthropic
     module ChatMethods
@@ -10,11 +8,13 @@ module Intelligence
         CHAT_REQUEST_URI
       end
 
-      def chat_request_headers( options = {} )
+      def chat_request_headers( options = nil )
+        options = options ? self.class.configure( options ) : {}
+        options = @options.merge( options )
         result = {}
 
-        key = options[ :key ] || self.key
-        version = options[ :version ] || self.version || "2023-06-01" 
+        key = options[ :key ] 
+        version = options[ :version ] || "2023-06-01" 
 
         raise ArgumentError.new( 
           "An Anthropic key is required to build an Anthropic chat request." 
@@ -27,9 +27,10 @@ module Intelligence
         result 
       end
 
-      def chat_request_body( conversation, options = {} )
-        options = self.class.configure( options ) unless options.empty?
-        result = self.chat_options.merge( options ).compact
+      def chat_request_body( conversation, options = nil )
+        options = options ? self.class.configure( options ) : {}
+        options = @options.merge( options )
+        result = options[ :chat_options ]&.compact || {}
 
         system_message = translate_system_message( conversation[ :system_message ] )
         result[ :system ] = system_message unless system_message.nil?

data/lib/intelligence/adapters/cerebras.rb

@@ -8,10 +8,10 @@ module Intelligence
       chat_request_uri "https://api.cerebras.ai/v1/chat/completions"
       
       configuration do 
-        parameter :key, required: true 
+        parameter :key 
         group :chat_options do 
-          parameter :model, String, required: true
-          parameter :max_tokens, Integer, required: true
+          parameter :model, String
+          parameter :max_tokens, Integer
           parameter :response_format do 
             parameter :type, String, default: 'json_schema'
             parameter :json_schema

data/lib/intelligence/adapters/generic/adapter.rb

@@ -4,18 +4,7 @@ require_relative 'chat_methods'
 module Intelligence
   module Generic
     class Adapter < Adapter::Base
-
-      attr_reader :key
-      attr_reader :chat_options
-
-      def initialize( attributes = nil, &block )
-        configuration = self.class.configure( attributes, &block ) 
-        @key = configuration[ :key ]
-        @chat_options = configuration[ :chat_options ] || {}
-      end
-
       include ChatMethods
-    
     end 
   end
-end
+end

data/lib/intelligence/adapters/generic/chat_methods.rb

@@ -20,10 +20,12 @@ module Intelligence
         self.class.chat_request_uri
       end
 
-      def chat_request_headers( options = {} )
+      def chat_request_headers( options = nil )
+        options = options ? self.class.configure( options ) : {}
+        options = @options.merge( options )
         result = {}
 
-        key = options[ :key ] || self.key
+        key = options[ :key ]
 
         raise ArgumentError.new( "An API key is required to build a chat request." ) \
           if key.nil?
@@ -34,8 +36,11 @@ module Intelligence
         result 
       end
 
-      def chat_request_body( conversation, options = {} )
-        result = self.chat_options.merge( options ).compact
+      def chat_request_body( conversation, options = nil )
+        options = options ? self.class.configure( options ) : {}
+        options = @options.merge( options )
+        
+        result = options[ :chat_options ]
         result[ :messages ] = []
 
         system_message = system_message_to_s( conversation[ :system_message ] )
@@ -79,6 +84,28 @@ module Intelligence
                 'requires binary content to include content type and ( packed ) bytes'  
               )
             end
+          when :file 
+            content_type = content[ :content_type ]
+            uri = content[ :uri ]
+            if content_type && uri
+              mime_type = MIME::Types[ content_type ].first
+              if mime_type&.media_type == 'image'
+                result_message_content << {
+                  type: 'image_url',
+                  image_url: { url: uri }
+                }
+              else
+                raise UnsupportedContentError.new( 
+                  :generic, 
+                  'only support content of type image/*' 
+                ) 
+              end
+            else 
+              raise UnsupportedContentError.new(
+                :generic, 
+                'requires binary content to include content type and ( packed ) bytes'  
+              )
+            end
           end
         end
         result_message[ :content ] = result_message_content
@@ -124,7 +151,7 @@ module Intelligence
       end
 
       def chat_result_error_attributes( response )
-
+        
         error_type, error_description = translate_error_response_status( response.status )
         result = {
           error_type: error_type.to_s,
@@ -178,7 +205,6 @@ module Intelligence
 
           next if line.end_with?( '[DONE]' )
           data = JSON.parse( line )
-
           if data.is_a?( Hash )
             
             data[ 'choices' ]&.each do | data_choice |
@@ -196,10 +222,8 @@ module Intelligence
                 data_choice_content = data_choice_delta[ 'content' ] || ''
                 if last_content.nil? || last_content[ :type ] == :tool_call
                   contents.push( { type: :text, text: data_choice_content } )
-                elsif last_content[ :type ].nil?
+                elsif last_content[ :type ] == :text || last_content[ :type ].nil?
                   last_content[ :type ] = :text 
-                  last_content[ :text ] = data_choice_content
-                elsif last_content[ :type ] == :text 
                   last_content[ :text ] = ( last_content[ :text ] || '' ) + data_choice_content
                 end
               elsif data_choice_delta.include?( 'function_call' )
@@ -223,7 +247,7 @@ module Intelligence
                 end
               end
               choices[ data_choice_index ][ :message ][ :contents ] = contents
-              choices[ data_choice_index ][ :end_reason ] = 
+              choices[ data_choice_index ][ :end_reason ] ||= 
                 translate_end_result( data_choice_finish_reason )
             end
   

data/lib/intelligence/adapters/google/adapter.rb

@@ -7,12 +7,12 @@ module Intelligence
       configuration do 
 
         # normalized properties for all endpoints
-        parameter :key, String, required: true  
+        parameter :key, String  
 
         group :chat_options, as: :generationConfig do
 
           # normalized properties for google generative text endpoint
-          parameter :model, String, required: true
+          parameter :model, String
           parameter :max_tokens, Integer, as: :maxOutputTokens
           parameter :n, Integer, as: :candidateCount
           parameter :temperature, Float
@@ -38,19 +38,6 @@ module Intelligence
 
       end
 
-      attr_reader :key
-      attr_reader :model
-      attr_reader :stream
-      attr_reader :chat_options
-
-      def initialize( attributes = nil, &block )
-        configuration = self.class.configure( attributes, &block ).to_h 
-        @key = configuration.delete( :key )
-        @model = configuration[ :generationConfig ]&.delete( :model )
-        @stream = configuration[ :generationConfig ]&.delete( :stream ) || false
-        @chat_options = configuration[ :generationConfig ] || {}
-      end
-
       include ChatMethods
 
     end 

data/lib/intelligence/adapters/google/chat_methods.rb

@@ -6,18 +6,37 @@ module Intelligence
 
       GENERATIVE_LANGUAGE_URI = "https://generativelanguage.googleapis.com/v1beta/models/"
 
-      def chat_request_uri( options )
+      SUPPORTED_BINARY_MEDIA_TYPES = %w[ text ]
+
+      SUPPORTED_BINARY_CONTENT_TYPES = %w[
+        image/png image/jpeg image/webp image/heic image/heif 
+        audio/aac audio/flac audio/mp3 audio/m4a audio/mpeg audio/mpga audio/mp4 audio/opus 
+        audio/pcm audio/wav audio/webm
+        application/pdf 
+      ]
+
+      SUPPORTED_FILE_MEDIA_TYPES = %w[ text ]
+
+      SUPPORTED_CONTENT_TYPES = %w[
+        image/png image/jpeg image/webp image/heic image/heif 
+        video/x-flv video/quicktime video/mpeg video/mpegps video/mpg video/mp4 video/webm 
+        video/wmv video/3gpp
+        audio/aac audio/flac audio/mp3 audio/m4a audio/mpeg audio/mpga audio/mp4 audio/opus 
+        audio/pcm audio/wav audio/webm
+        application/pdf 
+      ]
 
-        options = options.nil? || options.empty? ? {} : self.class.configure( options )
+      def chat_request_uri( options )
+        options = options ? self.class.configure( options ) : {}
+        options = @options.merge( options )
 
-        key = options[ :key ] || self.key
-        
+        key = options[ :key ] 
         gc = options[ :generationConfig ] || {}
-        model = gc[ :model ] || self.model
-        stream = gc.key?( :stream ) ? gc[ :stream ] : self.stream
+        model = gc[ :model ]
+        stream = gc.key?( :stream ) ? gc[ :stream ] : false 
       
         raise ArgumentError.new( "A Google API key is required to build a Google chat request." ) \
-          if self.key.nil?
+          if key.nil?
         raise ArgumentError.new( "A Google model is required to build a Google chat request." ) \
           if model.nil?
         
@@ -25,12 +44,11 @@ module Intelligence
         path = File.join( uri.path, model )
         path += stream ? ':streamGenerateContent' : ':generateContent'
         uri.path = path
-        query = { key: self.key }
+        query = { key: key }
         query[ :alt ] = 'sse' if stream
         uri.query = URI.encode_www_form( query )
 
         uri.to_s
-      
       end
 
       def chat_request_headers( options = {} )
@@ -38,16 +56,16 @@ module Intelligence
       end
 
       def chat_request_body( conversation, options = {} )
+        options = options ? self.class.configure( options ) : {}
+        options = @options.merge( options )
 
-        result = {}
-        result[ :generationConfig ] = self.chat_options
-
-        options = options.nil? || options.empty? ? {} : self.class.configure( options )
-        result = result.merge( options )
+        gc = options[ :generationConfig ]
+        # discard properties not part of the google generationConfig schema
+        gc.delete( :model )
+        gc.delete( :stream )
 
-        # discard properties not part of the google endpoint schema
-        result[ :generationConfig ].delete( :model )
-        result[ :generationConfig ].delete( :stream )
+        result = {}
+        result[ :generationConfig ] = gc
 
         # construct the system prompt in the form of the google schema
         system_instructions = translate_system_message( conversation[ :system_message ] )
@@ -67,8 +85,9 @@ module Intelligence
               content_type = content[ :content_type ]
               bytes = content[ :bytes ]
               if content_type && bytes
-                unless MIME::Types[ content_type ].empty?
-                  # TODO: verify the specific google supported MIME types
+                mime_type = MIME::Types[ content_type ].first
+                if SUPPORTED_BINARY_MEDIA_TYPES.include?( mime_type&.media_type ) || 
+                   SUPPORTED_BINARY_CONTENT_TYPES.include?( content_type )
                   result_message_parts << {
                     inline_data: {
                       mime_type: content_type,
@@ -78,7 +97,7 @@ module Intelligence
                 else
                   raise UnsupportedContentError.new( 
                     :google, 
-                    'only support recognized mime types' 
+                    "does not support #{content_type} content type"
                   ) 
                 end
               else 
@@ -86,7 +105,35 @@ module Intelligence
                   :google, 
                   'requires binary content to include content type and ( packed ) bytes'  
                 )
-              end
+              end 
+            when :file
+              content_type = content[ :content_type ]
+              uri = content[ :uri ]
+              if content_type && uri
+                mime_type = MIME::Types[ content_type ].first
+                if SUPPORTED_FILE_MEDIA_TYPES.include?( mime_type&.media_type ) || 
+                   SUPPORTED_FILE_CONTENT_TYPES.include?( content_type )
+                  result_message_parts << {
+                    file_data: {
+                      mime_type: content_type,
+                      file_uri: uri
+                    }
+                  }
+                else
+                  raise UnsupportedContentError.new( 
+                    :google, 
+                    "does not support #{content_type} content type"
+                  ) 
+                end
+              else 
+                raise UnsupportedContentError.new(
+                  :google, 
+                  'requires file content to include content type and uri'  
+                )
+              end 
+ 
+            else 
+              raise InvalidContentError.new( :google ) 
             end 
           end
 

data/lib/intelligence/adapters/groq.rb

@@ -8,7 +8,7 @@ module Intelligence
       chat_request_uri 'https://api.groq.com/openai/v1/chat/completions'
 
       configuration do 
-        parameter :key, String, required: true
+        parameter :key, String
         group :chat_options do 
           parameter :frequency_penalty, Float
           parameter :logit_bias
@@ -45,6 +45,25 @@ module Intelligence
         end
       end
 
+      alias chat_request_generic_message_attributes chat_request_message_attributes 
+      
+      # groq models only support the legacy Open AI message schema for the assistant 
+      # messages while supporting the modern message schema for user messages 
+      def chat_request_message_attributes( message )
+        role = message[ :role ]&.to_sym 
+        case role 
+        when :user 
+          chat_request_generic_message_attributes( message )
+        when :assistant 
+          chat_request_legacy_message_attributes( message )
+        else 
+          raise UnsupportedContentError.new(
+            :mistral, 
+            'only supports user and assistant message roles'  
+          )
+        end
+      end
+
     end
 
   end

data/lib/intelligence/adapters/hyperbolic.rb

@@ -8,7 +8,7 @@ module Intelligence
       chat_request_uri "https://api.hyperbolic.xyz/v1/chat/completions"
       
       configuration do 
-        parameter :key, String, required: true 
+        parameter :key, String 
         group :chat_options do 
           parameter :model, String
           parameter :temperature, Float

data/lib/intelligence/adapters/legacy/adapter.rb

@@ -3,11 +3,9 @@ require_relative 'chat_methods'
 
 module Intelligence
   module Legacy 
-
     class Adapter < Generic::Adapter
       include ChatMethods
     end
-
   end
 end
 

data/lib/intelligence/adapters/legacy/chat_methods.rb

@@ -3,20 +3,37 @@ module Intelligence
     module ChatMethods
 
       def chat_request_body( conversation, options = {} )
-        result = self.chat_options.merge( options ).compact
+        options = options ? self.class.configure( options ) : {}
+        options = @options.merge( options )
+
+        result = options[ :chat_options ]&.compact || {}
         result[ :messages ] = []
 
         system_message = system_message_to_s( conversation[ :system_message ] )
         result[ :messages ] << { role: 'system', content: system_message } if system_message
-
-        conversation[ :messages ]&.each do | message |
-          result[ :messages ] << chat_request_message_attributes( message )
+        
+        # detect if the conversation has any non-text content; this handles the sittuation 
+        # where non-vision models only support the legacy message schema while the vision 
+        # models only support the modern message schema 
+        has_non_text_content = conversation[ :messages ]&.find do | message |
+          message[ :contents ]&.find do | content |
+            content[ :type ] != nil && content[ :type ] != :text 
+          end
+        end
+        
+        if has_non_text_content
+          conversation[ :messages ]&.each do | message |
+            result[ :messages ] << chat_request_message_attributes( message )
+          end
+        else 
+          conversation[ :messages ]&.each do | message |
+            result[ :messages ] << chat_request_legacy_message_attributes( message )
+          end
         end
-
         JSON.generate( result )
       end 
 
-      def chat_request_message_attributes( message )
+      def chat_request_legacy_message_attributes( message )
         result_message = { role: message[ :role ] }
         result_message_content = ""
         

data/lib/intelligence/adapters/mistral.rb

@@ -0,0 +1,57 @@
+require_relative 'legacy/adapter'
+
+module Intelligence
+  module Mistral
+
+    class Adapter < Legacy::Adapter
+
+      chat_request_uri "https://api.mistral.ai/v1/chat/completions"
+      
+      configuration do 
+        parameter :key, String 
+        group :chat_options do 
+          parameter :model, String
+          parameter :temperature, Float
+          parameter :top_p, Float
+          parameter :max_tokens, Integer
+          parameter :min_tokens, Integer
+          parameter :seed, Integer, as: :random_seed 
+          parameter :stop, String, array: true
+          parameter :stream, [ TrueClass, FalseClass ]
+
+          parameter :random_seed, Integer
+          group :response_format do 
+            parameter :type, String 
+          end
+          group :tool_choice do 
+            parameter :type, String 
+            group :function do 
+              parameter :name, String 
+            end
+          end
+        end
+      end
+
+      alias chat_request_generic_message_attributes chat_request_message_attributes 
+      
+      # mistral vision models only support the legacy Open AI message schema for the assistant 
+      # messages while supporting the modern message schema for user messages :facepalm:
+      def chat_request_message_attributes( message )
+        role = message[ :role ]&.to_sym 
+        case role 
+        when :user 
+          chat_request_generic_message_attributes( message )
+        when :assistant 
+          chat_request_legacy_message_attributes( message )
+        else 
+          raise UnsupportedContentError.new(
+            :mistral, 
+            'only supports user and assistant message roles'  
+          )
+        end
+      end
+
+    end
+
+  end
+end