roseflow-openai 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 022b3ba6d3486eb3a7ed6abce48815272b2e4d5a52502dc814ebcc26c8c44712
-  data.tar.gz: eac633fb4aab864322916a3c5aa4e71cf15fe937d4c34aec84cbf8b444b44778
+  metadata.gz: 40a8de2181c6b43b561fe331f6ad6af571a0ade5554f2dc468be70aafcc94de5
+  data.tar.gz: 6689cb738ea1170dd30229cc80405879fb327b2d00fb4871205021852ddc5d8a
 SHA512:
-  metadata.gz: 4fb415158051794661293c7ec227c9384ac8edd3882e209a70cb559f95710d99248f01bba3c91633d6398594132cb1fcb9c5780477074a1aec1f86a95ba43555
-  data.tar.gz: c8d660546cbc37cb46e577f32e51ddfc71c5454f0dfc62fa8fbbbdfa90ba3ae0d40018fd71de856755dab4ed4350ddb30592d82185e0f29d6710b2105441f29d
+  metadata.gz: 65711accd9d75651f3d56cbae8b02275d41c8d1beca380f2747711148e60086c9163a57159d6358672afde2bc938c92c53138d7ea3d447556947dfb56ec44c9e
+  data.tar.gz: 8242cfca9ed092991e9eda08cf914195eba2609669219bd3b49d0b55c4ef12e27e1e4341b547ba0fcc062e825964e847438371b07a6be84b2c1614887ad9eaea

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.2.0] - 2023-07-24
+
+- Roseflow::OpenAI::Model now implements Roseflow::AI::Model API spec.
+- API operations are now composed and validated before calling the API.
+
 ## [0.1.0] - 2023-04-26
 
 - Initial release

data/Gemfile

@@ -8,3 +8,5 @@ gemspec
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.5"
 gem "standard", "~> 1.3"
+
+eval_gemfile "Gemfile.local" if File.exist?("Gemfile.local")

data/lib/roseflow/openai/chat_message.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "roseflow/chat/message"
+
+module Types
+  module OpenAI
+    FunctionCallObject = Types::Hash
+    StringOrObject = Types::String | FunctionCallObject
+    StringOrArray = Types::String | Types::Array
+  end
+end
+
+module Roseflow
+  module OpenAI
+    class ChatMessage < Roseflow::Chat::Message
+      attribute? :function_call, Types::OpenAI::FunctionCallObject
+    end
+  end
+end

data/lib/roseflow/openai/client.rb

@@ -2,6 +2,7 @@
 
 require "faraday"
 require "faraday/retry"
+require "roseflow/types"
 require "roseflow/openai/config"
 require "roseflow/openai/model"
 require "roseflow/openai/response"
@@ -32,6 +33,23 @@ module Roseflow
         end
       end
 
+      # Posts an operation to the API.
+      #
+      # @param operation [OpenAI::Operation] the operation to post
+      # @yield [String] the streamed API response
+      # @return [OpenAI::Response] the API response object if no block is given
+      def post(operation, &block)
+        response = connection.post(operation.path) do |request|
+          request.body = operation.body
+          if operation.stream
+            request.options.on_data = Proc.new do |chunk|
+              yield chunk if block_given?
+            end
+          end
+        end
+        response unless block_given?
+      end
+
       # Creates a chat completion.
       #
       # @param model [Roseflow::OpenAI::Model] the model to use
@@ -42,7 +60,7 @@ module Roseflow
         response = connection.post("/v1/chat/completions") do |request|
           request.body = options.merge({
             model: model.name,
-            messages: messages
+            messages: messages,
           })
         end
         ChatResponse.new(response)
@@ -58,10 +76,11 @@ module Roseflow
       def streaming_chat_completion(model:, messages:, **options, &block)
         streamed = []
         connection.post("/v1/chat/completions") do |request|
+          options.delete(:streaming)
           request.body = options.merge({
             model: model.name,
             messages: messages,
-            stream: true
+            stream: true,
           })
           request.options.on_data = Proc.new do |chunk|
             yield streaming_chunk(chunk) if block_given?
@@ -81,7 +100,7 @@ module Roseflow
         response = connection.post("/v1/completions") do |request|
           request.body = options.merge({
             model: model.name,
-            prompt: prompt
+            prompt: prompt,
           })
         end
         CompletionResponse.new(response)
@@ -100,7 +119,7 @@ module Roseflow
           request.body = options.merge({
             model: model.name,
             prompt: prompt,
-            stream: true
+            stream: true,
           })
           request.options.on_data = Proc.new do |chunk|
             yield streaming_chunk(chunk) if block_given?
@@ -120,7 +139,7 @@ module Roseflow
         response = connection.post("/v1/edits") do |request|
           request.body = options.merge({
             model: model.name,
-            instruction: instruction
+            instruction: instruction,
           })
         end
         EditResponse.new(response)
@@ -144,7 +163,7 @@ module Roseflow
           connection.post("/v1/embeddings") do |request|
             request.body = {
               model: model.name,
-              input: input
+              input: input,
             }
           end
         )
@@ -160,8 +179,8 @@ module Roseflow
           url: Config::OPENAI_API_URL,
           headers: {
             # "Content-Type" => "application/json",
-            "OpenAI-Organization" => config.organization_id
-          }
+            "OpenAI-Organization" => config.organization_id,
+          },
         ) do |faraday|
           faraday.request :authorization, "Bearer", -> { config.api_key }
           faraday.request :json
@@ -182,4 +201,4 @@ module Roseflow
       end
     end # Client
   end # OpenAI
-end # Roseflow
+end # Roseflow

data/lib/roseflow/openai/model.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "dry-struct"
-require "roseflow/tokenizer"
+require "roseflow/tiktoken/tokenizer"
 require "active_support/core_ext/module/delegation"
 
 module Types
@@ -25,32 +25,39 @@ module Roseflow
 
       # Tokenizer instance for the model.
       def tokenizer
-        @tokenizer_ ||= Tokenizer.new(model: name)
+        @tokenizer_ ||= Roseflow::Tiktoken::Tokenizer.new(model: name)
       end
 
-      # Handles the model call.
-      # FIXME: Operations should be rewritten to match the client API.
+      # Convenience method for chat completions.
+      #
+      # @param messages [Array<String>] Messages to use
+      # @param options [Hash] Options to use
+      # @yield [chunk] Chunk of data if stream is enabled
+      # @return [OpenAI::ChatResponse] the chat response object if no block is given
+      def chat(messages, options = {}, &block)
+        token_count = tokenizer.count_tokens(transform_chat_messages(options.fetch(:messages, [])))
+        raise TokenLimitExceededError, "Token limit for model #{name} exceeded: #{token_count} is more than #{max_tokens}" if token_count > max_tokens
+        response = call(:chat, options.merge({ messages: messages, model: name }), &block)
+        ChatResponse.new(response) unless block_given?
+      end
+
+      # Calls the model.
       #
       # @param operation [Symbol] Operation to perform
-      # @param input [String] Input to use
-      def call(operation, input, **options)
-        token_count = tokenizer.count_tokens(transform_chat_messages(input))
-        if token_count < max_tokens
-          case operation
-          when :chat
-            @provider_.create_chat_completion(model: name, messages: transform_chat_messages(input), **options)
-          when :completion
-            @provider_.create_completion(input)
-          when :image
-            @provider_.create_image_completion(input)
-          when :embed
-            @provider_.create_embedding(input)
-          else
-            raise ArgumentError, "Invalid operation: #{operation}"
-          end
-        else
-          raise TokenLimitExceededError, "Token limit for model #{name} exceeded: #{token_count} is more than #{max_tokens}"
-        end
+      # @param options [Hash] Options to use
+      # @yield [chunk] Chunk of data if stream is enabled
+      # @return [Faraday::Response] raw API response if no block is given
+      def call(operation, options, &block)
+        operation = OperationHandler.new(operation, options).call
+        client.post(operation, &block)
+      end
+
+      # Returns a list of operations for the model.
+      #
+      # TODO: OpenAI does not actually provide this information per model.
+      # Figure out a way to do this in a proper way if feasible.
+      def operations
+        OperationHandler::OPERATION_CLASSES.keys
       end
 
       # Indicates if the model is chattable.
@@ -99,6 +106,8 @@ module Roseflow
 
       private
 
+      attr_reader :provider_
+
       def assign_attributes
         @name = @model_.fetch("id")
         @created_at = Time.at(@model_.fetch("created"))
@@ -108,6 +117,10 @@ module Roseflow
       def transform_chat_messages(input)
         input.map(&:to_h)
       end
+
+      def client
+        provider_.client
+      end
     end # Model
 
     # Represents a model permission.

data/lib/roseflow/openai/operation_handler.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "operations/chat"
+require_relative "operations/completion"
+require_relative "operations/image"
+require_relative "operations/image_edit"
+require_relative "operations/image_variation"
+require_relative "operations/embedding"
+
+module Roseflow
+  module OpenAI
+    class OperationHandler
+      OPERATION_CLASSES = {
+        chat: Operations::Chat,
+        completion: Operations::Completion,
+        embedding: Operations::Embedding,
+        image: Operations::Image,
+        image_edit: Operations::ImageEdit,
+        image_variation: Operations::ImageVariation,
+      }
+
+      def initialize(operation, options = {})
+        @operation = operation
+        @options = options
+      end
+
+      def call
+        operation_class.new(@options)
+      end
+
+      private
+
+      def operation_class
+        OPERATION_CLASSES.fetch(@operation) do
+          raise ArgumentError, "Invalid operation: #{@operation}"
+        end
+      end
+    end
+  end
+end

data/lib/roseflow/openai/operations/base.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Roseflow
+  module OpenAI
+    module Operations
+      class Base < Dry::Struct
+        transform_keys(&:to_sym)
+
+        attribute :model, Types::String
+
+        def body
+          to_h.except(:path)
+        end
+      end
+    end
+  end
+end

data/lib/roseflow/openai/operations/chat.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+require "roseflow/openai/chat_message"
+
+module Roseflow
+  module OpenAI
+    module Operations
+      # Chat operation.
+      #
+      # Given a list of messages comprising a conversation, the model will
+      # return a response.
+      #
+      # See https://platform.openai.com/docs/api-reference/chat for more
+      # information.
+      #
+      # Many of the attributes are actually optional for the API, but we
+      # provide defaults to them. This may change in the future.
+      class Chat < Base
+        attribute :messages, Types::Array.of(ChatMessage)
+        attribute? :functions, Types::Array.of(Types::Hash)
+        attribute? :function_call, Types::OpenAI::StringOrObject
+        attribute :temperature, Types::Float.default(1.0)
+        attribute :top_p, Types::Float.default(1.0)
+        attribute :n, Types::Integer.default(1)
+        attribute :stream, Types::Bool.default(false)
+        attribute? :stop, Types::OpenAI::StringOrArray
+        attribute? :max_tokens, Types::Integer
+        attribute :presence_penalty, Types::Number.default(0)
+        attribute :frequency_penalty, Types::Number.default(0)
+        attribute? :user, Types::String
+
+        attribute :path, Types::String.default("/v1/chat/completions")
+      end
+    end
+  end
+end

data/lib/roseflow/openai/operations/completion.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Roseflow
+  module OpenAI
+    module Operations
+      # Completion operation.
+      #
+      # Given a prompt, the model will return one or more predicted
+      # completions, and can also return the probabilities of
+      # alternative tokens at each position.
+      #
+      # See https://platform.openai.com/docs/api-reference/completions
+      # for more information.
+      #
+      # Many of the attributes are actually optional for the API, but we
+      # provide defaults to them. This may change in the future.
+      class Completion < Base
+        attribute :prompt, Types::OpenAI::StringOrArray
+        attribute? :suffix, Types::String
+        attribute :max_tokens, Types::Integer.default(16)
+        attribute :temperature, Types::Float.default(1.0)
+        attribute :top_p, Types::Float.default(1.0)
+        attribute :n, Types::Integer.default(1)
+        attribute :stream, Types::Bool.default(false)
+        attribute? :logprobs, Types::Integer
+        attribute :echo, Types::Bool.default(false)
+        attribute? :stop, Types::OpenAI::StringOrArray
+        attribute :presence_penalty, Types::Number.default(0)
+        attribute :frequency_penalty, Types::Number.default(0)
+        attribute :best_of, Types::Integer.default(1)
+        attribute? :user, Types::String
+
+        attribute :path, Types::String.default("/v1/completions")
+      end
+    end
+  end
+end

data/lib/roseflow/openai/operations/embedding.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Roseflow
+  module OpenAI
+    module Operations
+      # Embedding operation.
+      #
+      # Get a vector representation of a given input that can be easily
+      # consumed by machine learning models and algorithms.
+      #
+      # See https://platform.openai.com/docs/api-reference/embeddings
+      # for more information.
+      #
+      # Many of the attributes are actually optional for the API, but we
+      # provide defaults to them. This may change in the future.
+      class Embedding < Base
+        attribute :input, Types::OpenAI::StringOrArray
+        attribute? :user, Types::String
+
+        attribute :path, Types::String.default("/v1/embeddings")
+      end
+    end
+  end
+end

data/lib/roseflow/openai/operations/image.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Roseflow
+  module OpenAI
+    module Operations
+      # Image operation.
+      #
+      # Given a prompt and/or an input image, the model will generate
+      # a new image. This operation creates an image given a prompt.
+      #
+      # See https://platform.openai.com/docs/api-reference/images for
+      # more information.
+      #
+      # Many of the attributes are actually optional for the API, but we
+      # provide defaults to them. This may change in the future.
+      class Image < Dry::Struct
+        transform_keys(&:to_sym)
+
+        attribute :prompt, Types::String
+        attribute :n, Types::Integer.default(1)
+        attribute :size, Types::String.default("1024x1024")
+        attribute :response_format, Types::String.default("url")
+        attribute? :user, Types::String
+
+        attribute :path, Types::String.default("/v1/images/generations")
+
+        def body
+          to_h.except(:path)
+        end
+      end
+    end
+  end
+end

data/lib/roseflow/openai/operations/image_edit.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Roseflow
+  module OpenAI
+    module Operations
+      # Image edit operation.
+      #
+      # Given a prompt and/or an input image, the model will generate
+      # a new image. This operation creates an edited or extended image
+      # given an original image and a prompt.
+      #
+      # See https://platform.openai.com/docs/api-reference/images for
+      # more information.
+      #
+      # Many of the attributes are actually optional for the API, but we
+      # provide defaults to them. This may change in the future.
+      class ImageEdit < Dry::Struct
+        transform_keys(&:to_sym)
+
+        attribute :image, Types::String
+        attribute? :mask, Types::String
+        attribute :prompt, Types::String
+        attribute :n, Types::Integer.default(1)
+        attribute :size, Types::String.default("1024x1024")
+        attribute :response_format, Types::String.default("url")
+        attribute? :user, Types::String
+
+        attribute :path, Types::String.default("/v1/images/edits")
+
+        def body
+          to_h.except(:path)
+        end
+      end
+    end
+  end
+end

data/lib/roseflow/openai/operations/image_variation.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Roseflow
+  module OpenAI
+    module Operations
+      # Image variation operation.
+      #
+      # Given a prompt and/or an input image, the model will generate
+      # a new image. This operation creates a variation of a given image.
+      #
+      # See https://platform.openai.com/docs/api-reference/images for
+      # more information.
+      #
+      # Many of the attributes are actually optional for the API, but we
+      # provide defaults to them. This may change in the future.
+      class ImageVariation < Dry::Struct
+        transform_keys(&:to_sym)
+
+        attribute :image, Types::String
+        attribute :n, Types::Integer.default(1)
+        attribute :size, Types::String.default("1024x1024")
+        attribute :response_format, Types::String.default("url")
+        attribute? :user, Types::String
+
+        attribute :path, Types::String.default("/v1/images/variations")
+
+        def body
+          to_h.except(:path)
+        end
+      end
+    end
+  end
+end

data/lib/roseflow/openai/provider.rb

@@ -38,11 +38,11 @@ module Roseflow
       # @option options [Integer] :streaming Whether to stream back partial progress
       # @option options [String] :user A unique identifier representing your end-user
       # @return [Roseflow::OpenAI::ChatResponse] The response object from the API.
-      def chat(model:, messages:, **options)
+      def chat(model:, messages:, **options, &block)
         streaming = options.fetch(:streaming, false)
 
         if streaming
-          client.streaming_chat_completion(model: model, messages: messages.map(&:to_h), **options)
+          client.streaming_chat_completion(model: model, messages: messages.map(&:to_h), **options, &block)
         else
           client.create_chat_completion(model: model, messages: messages.map(&:to_h), **options)
         end

data/lib/roseflow/openai/response.rb

@@ -4,11 +4,6 @@ require "dry-struct"
 require "roseflow/types"
 require "roseflow/openai/embedding"
 
-module Types
-  include Dry.Types()
-  Number = Types::Integer | Types::Float
-end
-
 module Roseflow
   module OpenAI
     FailedToCreateEmbeddingError = Class.new(StandardError)
@@ -142,7 +137,7 @@ module Roseflow
       transform_keys(&:to_sym)
 
       attribute :object, Types::String.default("embedding")
-      attribute :embedding, Types::Array(Types::Number)
+      attribute :embedding, Types::Array(::Types::Number)
       attribute :index, Types::Integer
     end # OpenAIEmbedding
 

data/lib/roseflow/openai/version.rb

@@ -8,9 +8,9 @@ module Roseflow
 
     module VERSION
       MAJOR = 0
-      MINOR = 1
+      MINOR = 2
       PATCH = 0
-      PRE   = nil
+      PRE = nil
 
       STRING = [MAJOR, MINOR, PATCH, PRE].compact.join(".")
     end

data/lib/roseflow/openai.rb

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 
+require "roseflow/types"
+
 require_relative "openai/version"
+require_relative "openai/client"
+require_relative "openai/config"
+require_relative "openai/operation_handler"
+require_relative "openai/provider"
 
 module Roseflow
   module OpenAI

data/roseflow-openai.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "dry-struct"
   spec.add_dependency "faraday"
   spec.add_dependency "faraday-retry"
+  spec.add_dependency "roseflow-tiktoken"
 
   spec.add_development_dependency "awesome_print"
   spec.add_development_dependency "pry"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roseflow-openai
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Lauri Jutila
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-10 00:00:00.000000000 Z
+date: 2023-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: roseflow-tiktoken
+  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'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -167,11 +181,20 @@ files:
 - Rakefile
 - config/openai.yml
 - lib/roseflow/openai.rb
+- lib/roseflow/openai/chat_message.rb
 - lib/roseflow/openai/client.rb
 - lib/roseflow/openai/config.rb
 - lib/roseflow/openai/embedding.rb
 - lib/roseflow/openai/model.rb
 - lib/roseflow/openai/model_repository.rb
+- lib/roseflow/openai/operation_handler.rb
+- lib/roseflow/openai/operations/base.rb
+- lib/roseflow/openai/operations/chat.rb
+- lib/roseflow/openai/operations/completion.rb
+- lib/roseflow/openai/operations/embedding.rb
+- lib/roseflow/openai/operations/image.rb
+- lib/roseflow/openai/operations/image_edit.rb
+- lib/roseflow/openai/operations/image_variation.rb
 - lib/roseflow/openai/provider.rb
 - lib/roseflow/openai/response.rb
 - lib/roseflow/openai/structs.rb