omniai-openai 0.2.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 046a2d4be43b4a9537a18b90fc69a9a7bfb191d76471d5a9374cc731c5e8b8a3
-  data.tar.gz: e1f2914a05ae5a527c09126d015df285e6efaa86d37fca2ac16ec694799f186f
+  metadata.gz: 667d8318e96d3e6611a3ca20ced5dcefefc0896a4c84c48427ce441756cb9e60
+  data.tar.gz: 13161c5726cc33fcc7934a4164f751244b3c577fb52a1cdf30301dc10f733c84
 SHA512:
-  metadata.gz: cace4852fc0a5ce7b59cb0a74728324396384a3c7793611bc48c61081bb910ec2cfc3dd09e0b3d4bb14fe16767913663cc2621b964ac0e87f93dcb1fab10873c
-  data.tar.gz: 16fbad4c8b63260e069f07314811ad8cbbbb4bdbbcd2b412b63902372abf7271d9ccc87bbdc06cf529530f633408d80ab3d9f05d0032d1fc7a85d82ecd7f8d2c
+  metadata.gz: d44485bdcebe5ee67a846c4517ea62fdb4fd98dfbab464f64fd10316561a396369ce5579367c8f073d79edfee0a790baa46c2fc31dfd2a4522221f0d16679a23
+  data.tar.gz: 2f1054f58e35f37012bc6b95f7605b0eeee01010718c2446a14b623b37cde0028d08ed56330d10bf1145fe5dfa69c3c138f54f5ec7d2bf65e55eb4727a21c664

data/Gemfile

@@ -11,5 +11,4 @@ gem 'rspec_junit_formatter'
 gem 'rubocop'
 gem 'rubocop-rake'
 gem 'rubocop-rspec'
-gem 'vcr'
 gem 'webmock'

data/README.md

@@ -49,7 +49,7 @@ completion.choice.message.content # 'Why did the chicken cross the road? To get
 
 ```ruby
 completion = client.chat.completion({
-  role: OmniAI::OpenAI::Chat::Role::USER,
+  role: OmniAI::Chat::Role::USER,
   content: 'Is it wise to jump off a bridge?'
 })
 completion.choice.message.content # 'No.'
@@ -58,7 +58,7 @@ completion.choice.message.content # 'No.'
 ```ruby
 completion = client.chat.completion([
   {
-    role: OmniAI::OpenAI::Chat::Role::SYSTEM,
+    role: OmniAI::Chat::Role::SYSTEM,
     content: 'You are a helpful assistant.'
   },
   'What is the capital of Canada?',
@@ -75,6 +75,8 @@ completion = client.chat.completion('How fast is a cheetah?', model: OmniAI::Ope
 completion.choice.message.content # 'A cheetah can reach speeds over 100 km/h.'
 ```
 
+[OpenAI API Reference `model`](https://platform.openai.com/docs/api-reference/chat/create#chat-create-model)
+
 #### Temperature
 
 `temperature` takes an optional float between `0.0` and `2.0` (defaults is `0.7`):
@@ -84,6 +86,8 @@ completion = client.chat.completion('Pick a number between 1 and 5', temperature
 completion.choice.message.content # '3'
 ```
 
+[OpenAI API Reference `temperature`](https://platform.openai.com/docs/api-reference/chat/create#chat-create-temperature)
+
 #### Stream
 
 `stream` takes an optional a proc to stream responses in real-time chunks instead of waiting for a complete response:
@@ -95,11 +99,20 @@ end
 client.chat.completion('Be poetic.', stream:)
 ```
 
+[OpenAI API Reference `stream`](https://platform.openai.com/docs/api-reference/chat/create#chat-create-stream)
+
 #### Format
 
-`format` takes an optional symbol (i.e. `:json`) and switches the client to parsing message content as `json`:
+`format` takes an optional symbol (`:json`) and that setes the `response_format` to `json_object`:
 
 ```ruby
-completion = client.chat.completion('Please provide a color name / hex / hsl as JSON.', format: :json)
-completion.choice.message.content # { "name": "Black", "hex": "#000", "hsl": { "h": 0, "s": 0, "l": 0 } }
+completion = client.chat.completion([
+  { role: OmniAI::Chat::Role::SYSTEM, content: OmniAI::Chat::JSON_PROMPT },
+  { role: OmniAI::Chat::Role::USER, content: 'What is the name of the drummer for the Beatles?' }
+], format: :json)
+JSON.parse(completion.choice.message.content) # { "name": "Ringo" }
 ```
+
+[OpenAI API Reference `response_format`](https://platform.openai.com/docs/api-reference/chat/create#chat-create-stream)
+
+> When using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message.

data/lib/omniai/openai/chat.rb

@@ -3,15 +3,9 @@
 module OmniAI
   module OpenAI
     # An OpenAI chat implementation.
-    #
-    # Usage:
-    #
-    #   chat = OmniAI::OpenAI::Chat.new(client: client)
-    #   chat.completion('Tell me a joke.')
-    #   chat.completion(['Tell me a joke.'])
-    #   chat.completion({ role: 'user', content: 'Tell me a joke.' })
-    #   chat.completion([{ role: 'system', content: 'Tell me a joke.' }])
     class Chat < OmniAI::Chat
+      JSON_RESPONSE_FORMAT = { type: 'json_object' }.freeze
+
       module Model
         GPT_4O = 'gpt-4o'
         GPT_4 = 'gpt-4'
@@ -19,24 +13,22 @@ module OmniAI
         GPT_3_5_TURBO = 'gpt-3.5-turbo'
       end
 
-      module Role
-        ASSISTANT = 'assistant'
-        USER = 'user'
-        SYSTEM = 'system'
+      protected
+
+      # @return [Hash]
+      def payload
+        OmniAI::OpenAI.config.chat_options.merge({
+          messages:,
+          model: @model,
+          stream: @stream.nil? ? nil : !@stream.nil?,
+          temperature: @temperature,
+          response_format: (JSON_RESPONSE_FORMAT if @format.eql?(:json)),
+        }).compact
       end
 
-      # @raise [OmniAI::Error]
-      #
-      # @param prompt [String]
-      # @param model [String] optional
-      # @param format [Symbol] optional :text or :json
-      # @param temperature [Float, nil] optional
-      # @param stream [Proc, nil] optional
-      #
-      # @return [OmniAI::OpenAi::Chat::Response]
-      def completion(messages, model: Model::GPT_4O, temperature: nil, format: nil, stream: nil)
-        request = Request.new(client: @client, messages:, model:, temperature:, format:, stream:)
-        request.process!
+      # @return [String]
+      def path
+        "/#{OmniAI::OpenAI::Client::VERSION}/chat/completions"
       end
     end
   end

data/lib/omniai/openai/client.rb

@@ -52,9 +52,17 @@ module OmniAI
         end
       end
 
-      # @return [OmniAI::OpenAI::Chat]
-      def chat
-        Chat.new(client: self)
+      # @raise [OmniAI::Error]
+      #
+      # @param messages [String, Array, Hash]
+      # @param model [String] optional
+      # @param format [Symbol] optional :text or :json
+      # @param temperature [Float, nil] optional
+      # @param stream [Proc, nil] optional
+      #
+      # @return [OmniAI::Chat::Completion]
+      def chat(messages, model: Chat::Model::GPT_4O, temperature: nil, format: nil, stream: nil)
+        Chat.process!(messages, model:, temperature:, format:, stream:, client: self)
       end
     end
   end

data/lib/omniai/openai/config.rb

@@ -4,7 +4,7 @@ module OmniAI
   module OpenAI
     # Configuration for managing the OpenAI `api_key` / `organization` / `project` / `logger`.
     class Config < OmniAI::Config
-      attr_accessor :organization, :project
+      attr_accessor :organization, :project, :chat_options
 
       def initialize
         super
@@ -12,6 +12,7 @@ module OmniAI
         @organization = ENV.fetch('OPENAI_ORGANIZATION', nil)
         @project = ENV.fetch('OPENAI_PROJECT', nil)
         @host = ENV.fetch('OPENAI_HOST', 'https://api.openai.com')
+        @chat_options = {}
       end
     end
   end

data/lib/omniai/openai/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAI
   module OpenAI
-    VERSION = '0.2.0'
+    VERSION = '1.0.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniai-openai
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Kevin Sylvestre
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-14 00:00:00.000000000 Z
+date: 2024-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -63,7 +63,6 @@ files:
 - README.md
 - lib/omniai/openai.rb
 - lib/omniai/openai/chat.rb
-- lib/omniai/openai/chat/request.rb
 - lib/omniai/openai/client.rb
 - lib/omniai/openai/config.rb
 - lib/omniai/openai/version.rb
@@ -73,7 +72,7 @@ metadata:
   homepage_uri: https://github.com/ksylvest/omniai-openai
   changelog_uri: https://github.com/ksylvest/omniai-openai/releases
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -88,8 +87,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.5.3
+signing_key: 
 specification_version: 4
 summary: A generalized framework for interacting with OpenAI
 test_files: []

data/lib/omniai/openai/chat/request.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module OmniAI
-  module OpenAI
-    class Chat
-      # An implementation of OmniAI::Chat::Request for OpenAI.
-      class Request < OmniAI::Chat::Request
-        protected
-
-        # @return [Hash]
-        def payload
-          { messages: }.tap do |payload|
-            payload[:model] = @model
-            payload[:stream] = !@stream.nil? unless @stream.nil?
-            payload[:temperature] = @temperature if @temperature
-            payload[:response_format] = { type: 'json_object' } if @format.eql?(:json)
-          end
-        end
-
-        # @return [Array<Hash>]
-        def messages
-          arrayify(@messages).map do |content|
-            case content
-            when String then { role: OmniAI::OpenAI::Chat::Role::USER, content: }
-            when Hash then content
-            else raise Error, "Unsupported content=#{content.inspect}"
-            end
-          end
-        end
-
-        # @return [String]
-        def path
-          "/#{OmniAI::OpenAI::Client::VERSION}/chat/completions"
-        end
-
-        private
-
-        # @param value [Object, Array<Object>]
-        # @return [Array<Object>]
-        def arrayify(value)
-          value.is_a?(Array) ? value : [value]
-        end
-      end
-    end
-  end
-end