roseflow-openrouter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87a20a3c7e3eabe923827fb046a4d418901e2719d845244b3cd6488301044a89
-  data.tar.gz: b0b3cc0894bba52d00d95b75ec093a2c86cf1621d2bc9f7849de1a6c61b9b754
+  metadata.gz: ba6bf09e77bd3ffe1bfa32ba78f30a22bd8ee2d938da8c70f4a460440f0b636a
+  data.tar.gz: ec10261de4f4ca103b970a2c0b9852ca85902d473f4115feb825609a3ee521d1
 SHA512:
-  metadata.gz: e393acceab954ba51cec59a2dd518928c9e9e3fcca4ec2f77475e1c4dc9b9caab8cd318b23f7d9026fbe8343e8cdf104d5f9f5d80a78e9505fe686444b6f6604
-  data.tar.gz: d026c4386e835b3841e47e8c14ad913d25413bf82d3b1c6506c5c596017001936bc13926e44fa905cb0b36c476053f5ce6c5070d47ef7adf8009cc6ac305d78b
+  metadata.gz: b848cd7df7ba6ad3ca2db234ddbf189d3f9df181775156751dfe729e291df792d5d9330ad3a5ed02b9a51143764fdb082892ae503a15a3038c53bed07c24a530
+  data.tar.gz: 1009537eb7d61cfce5f9e3935fd018547f939be964ce7d57a6ee80ce0546fa223ec8edc566c73366620eee6b28437aca9afdda920d665e738b34ec16cc8e6bcd

data/CHANGELOG.md

@@ -1,4 +1,6 @@
-## [Unreleased]
+## [0.2.0] - 2023-07-24
+
+- Model API changes to match Roseflow::AI::Model API spec.
 
 ## [0.1.0] - 2023-07-18
 

data/Gemfile

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

data/lib/roseflow/open_router/chat_message.rb

@@ -0,0 +1,18 @@
+# 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 OpenRouter
+    class ChatMessage < Roseflow::Chat::Message
+    end
+  end
+end

data/lib/roseflow/open_router/client.rb

@@ -4,17 +4,18 @@ require "faraday"
 require "faraday/retry"
 require "roseflow/open_router/config"
 require "roseflow/open_router/model"
-
-FARADAY_RETRY_OPTIONS = {
-  max: 3,
-  interval: 0.05,
-  interval_randomness: 0.5,
-  backoff_factor: 2,
-}
+require "fast_jsonparser"
 
 module Roseflow
   module OpenRouter
     class Client
+      FARADAY_RETRY_OPTIONS = {
+        max: 3,
+        interval: 0.05,
+        interval_randomness: 0.5,
+        backoff_factor: 2,
+      }
+
       def initialize(config = Config.new, provider = nil)
         @config = config
         @provider = provider
@@ -22,12 +23,24 @@ module Roseflow
 
       def models
         response = connection.get("/api/v1/models")
-        body = JSON.parse(response.body)
+        body = FastJsonparser.parse(response.body)
         body.fetch("data", []).map do |model|
           OpenRouter::Model.new(model, self)
         end
       end
 
+      def post(operation, &block)
+        connection.post(operation.path) do |request|
+          request.body = operation.body
+
+          if operation.stream
+            request.options.on_data = Proc.new do |chunk|
+              yield chunk
+            end
+          end
+        end
+      end
+
       def completion(model:, prompt:, **options)
         connection.post("/api/v1/chat/completions") do |request|
           request.body = options.merge({
@@ -84,7 +97,7 @@ module Roseflow
         return chunk unless chunk.match(/{.*}/)
 
         chunk.scan(/{.*}/).map do |json|
-          JSON.parse(json).dig("choices", 0, "delta", "content")
+          FastJsonparser.parse(json).dig("choices", 0, "delta", "content")
         end.join("")
       end
     end

data/lib/roseflow/open_router/model.rb

@@ -3,6 +3,9 @@
 require "dry/struct"
 require "active_support/core_ext/module/delegation"
 
+require "roseflow/open_router/operation_handler"
+require "roseflow/open_router/response"
+
 module Types
   include Dry.Types()
 end
@@ -22,12 +25,40 @@ module Roseflow
         @context_length
       end
 
+      # 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)
+        response = call(:completion, options.merge({ messages: messages, model: name }), &block)
+        ChatResponse.new(response) unless block_given?
+      end
+
+      # Calls the model.
+      #
+      # @param operation [Symbol] Operation to perform
+      # @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.merge({ model: name })).call
+        client.post(operation, &block)
+      end
+
       private
 
+      attr_reader :provider_
+
       def assign_attributes
-        @name = @model_.fetch("id")
-        @id = @model_.fetch("id")
-        @context_length = @model_.fetch("context_length")
+        @name = @model_.fetch(:id)
+        @id = @model_.fetch(:id)
+        @context_length = @model_.fetch(:context_length)
+      end
+
+      def client
+        provider_.client
       end
     end
   end

data/lib/roseflow/open_router/operation_handler.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "operations/completion"
+
+module Roseflow
+  module OpenRouter
+    class OperationHandler
+      OPERATION_CLASSES = {
+        completion: Operations::Completion,
+      }
+
+      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/open_router/operations/base.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Roseflow
+  module OpenRouter
+    module Operations
+      class Base < Dry::Struct
+        transform_keys(&:to_sym)
+
+        def body
+          to_h.except(:path)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "base"
+require "roseflow/open_router/chat_message"
+
+module Roseflow
+  module OpenRouter
+    module Operations
+      # Chat operation.
+      #
+      # Given a list of messages comprising a conversation, the model will
+      # return a response.
+      #
+      # See https://openrouter.ai/docs for more information.
+      #
+      # The OpenRouter API is compatible with OpenAI Chat API. See
+      # https://platform.openai.com/docs/api-reference/chat/create for more.
+      class Completion < Base
+        attribute? :model, Types::String
+        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("/api/v1/chat/completions")
+      end
+    end
+  end
+end

data/lib/roseflow/open_router/provider.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+require "roseflow/open_router/client"
+require "roseflow/open_router/config"
+require "roseflow/open_router/model_repository"
+
 module Roseflow
   module OpenRouter
     class Provider
@@ -16,13 +20,7 @@ module Roseflow
       end
 
       def completion(model:, prompt:, **options)
-        streaming = options.fetch(:streaming, false)
-
-        if streaming
-          client.streaming_completion(model: model, prompt: prompt, **options)
-        else
-          client.completion(model: model, prompt: prompt, **options)
-        end
+        raise DeprecationError, "This method is deprecated. Please use Model operations instead."
       end
 
       private

data/lib/roseflow/open_router/response.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require "dry/struct"
+require "active_support/core_ext/module/delegation"
+
+require "roseflow/types"
+require "fast_jsonparser"
+
+module Roseflow
+  module OpenRouter
+    class ApiResponse
+      delegate :success?, :failure?, :body, to: :@response
+
+      def initialize(response)
+        @response = response
+      end
+    end
+
+    class TextApiResponse < ApiResponse
+      def body
+        @body ||= FastJsonparser.parse(@response.body)
+      end
+
+      def choices
+        body[:choices].map { |choice| Choice.new(choice) }
+      end
+    end
+
+    class ChatResponse < TextApiResponse
+      def response
+        choices.first
+      end
+
+      alias reply response
+    end
+
+    class Choice < Dry::Struct
+      transform_keys(&:to_sym)
+
+      attribute? :text, Types::String
+      attribute? :message do
+        attribute :role, Types::String
+        attribute :content, Types::String
+      end
+
+      attribute? :finish_reason, Types::String
+      attribute :index, Types::Integer
+
+      def to_s
+        return message.content if message
+        return text if text
+      end
+    end # Choice
+
+    class DataOnlyEvent < Dry::Struct
+      transform_keys(&:to_sym)
+    end
+
+    class Delta < Dry::Struct
+      transform_keys(&:to_sym)
+
+      attribute :content, Types::String
+    end
+
+    class StreamingChoice < Dry::Struct
+      transform_keys(&:to_sym)
+
+      attribute :index, Types::Integer
+      attribute :delta, Delta
+      attribute :finish_reason, Types::StringOrNil
+    end
+
+    class StreamingDone < Dry::Struct
+    end
+
+    class StreamingData < Dry::Struct
+      transform_keys(&:to_sym)
+
+      attribute :choices, Types::Array.of(StreamingChoice)
+      attribute :model, Types::String
+
+      def self.from_chunk(data)
+        return StreamingDone.new if data == "[DONE]"
+        new(FastJsonparser.parse(data.strip))
+      rescue StandardError => e
+        puts "FAILED: #{data}"
+        puts "EXCEPTION: #{e.message}"
+      end
+    end
+
+    class ApiUsage < Dry::Struct
+      transform_keys(&:to_sym)
+
+      attribute :prompt_tokens, Types::Integer
+      attribute? :completion_tokens, Types::Integer
+      attribute :total_tokens, Types::Integer
+    end # ApiUsage
+
+    class ApiResponseBody < Dry::Struct
+      transform_keys(&:to_sym)
+
+      attribute? :id, Types::String
+      attribute :object, Types::String
+      attribute :created, Types::Integer
+      attribute? :model, Types::String
+      attribute :usage, ApiUsage
+      attribute :choices, Types::Array
+
+      def success?
+        true
+      end
+    end # ApiResponseBody
+  end
+end

data/lib/roseflow/open_router/version.rb

@@ -8,7 +8,7 @@ module Roseflow
 
     module VERSION
       MAJOR = 0
-      MINOR = 1
+      MINOR = 2
       PATCH = 0
       PRE = nil
 

data/lib/roseflow/open_router.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "roseflow/types"
 require_relative "open_router/version"
 require_relative "open_router/client"
 require_relative "open_router/config"
@@ -10,5 +11,6 @@ require_relative "open_router/provider"
 module Roseflow
   module OpenRouter
     class Error < StandardError; end
+    class DeprecationError < StandardError; end
   end
 end

data/roseflow-openrouter.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 "fast_jsonparser", "~> 0.6.0"
 
   spec.add_development_dependency "awesome_print"
   spec.add_development_dependency "pry"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roseflow-openrouter
 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-07-19 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: fast_jsonparser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -167,11 +181,16 @@ files:
 - Rakefile
 - config/openrouter.yml
 - lib/roseflow/open_router.rb
+- lib/roseflow/open_router/chat_message.rb
 - lib/roseflow/open_router/client.rb
 - lib/roseflow/open_router/config.rb
 - lib/roseflow/open_router/model.rb
 - lib/roseflow/open_router/model_repository.rb
+- lib/roseflow/open_router/operation_handler.rb
+- lib/roseflow/open_router/operations/base.rb
+- lib/roseflow/open_router/operations/completion.rb
 - lib/roseflow/open_router/provider.rb
+- lib/roseflow/open_router/response.rb
 - lib/roseflow/open_router/version.rb
 - roseflow-openrouter.gemspec
 - sig/roseflow/openrouter.rbs