omniai-openai 0.1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dad3f2ba5038bc2fda1952c3cd44c39cbd1c63c9e88c17ac1865512bcddc99b1
-  data.tar.gz: 4365c7981ded1983ac9e726767840450ac02504796da1e73e746df74592fd5f6
+  metadata.gz: 17b76524bf985fda37fec8e7cea18aece3380a1831be7de6abe2652767aafc92
+  data.tar.gz: e32a791f07f2697f56f2dfa15f11e8b05abf4416610925880d12cc7b5d0dda90
 SHA512:
-  metadata.gz: 31f56e1a8edb727ef8de2bf859389417623079f8aef008bc71aa9fe114b266c1f09b2c92af3cfe0783d1a45c04d3fd97fd9b40cce4d9afe8db0edd0658087768
-  data.tar.gz: c0b9877e41f3ddb539612a46f2267074ae7ca94b52b6ced1411b0c18beb80cc3533c69e0efe6a3cc8959442f6d0c12050e9f47a2d015281cf89a88572384484a
+  metadata.gz: 9aa657f83ece505e056597a36c73a77f24abc45af4094c5e982b949bc9631ba6a401ff410220855c43073232578bda7fe37ed7003e006259caaf8d1333825dab
+  data.tar.gz: a96fe7cb53c737220b21c43013af12fab828476336827c446bfb12e64b02340ef55cac0a762facd0d5103db8afad078bf72b94fe760bbda2d36437eeee68468b

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+
+gem 'rspec'
+gem 'rspec_junit_formatter'
+gem 'rubocop'
+gem 'rubocop-rake'
+gem 'rubocop-rspec'
+gem 'webmock'

data/README.md

@@ -1,31 +1,118 @@
-# Omniai::Openai
+# OmniAI::OpenAI
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/omniai/openai`. To experiment with that code, run `bin/console` for an interactive prompt.
+An OpenAI implementation of the [OmniAI](https://github.com/ksylvest/omniai) APIs.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+```sh
+gem install omniai-openai
+```
 
-Install the gem and add to the application's Gemfile by executing:
+## Usage
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+### Client
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+A client is setup as follows if `ENV['OPENAI_API_KEY']` exists:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+client = OmniAI::OpenAI::Client.new
+```
 
-## Usage
+A client may also be passed the following options:
+
+- `api_key` (required - default is `ENV['OPENAI_API_KEY']`)
+- `organization` (optional)
+- `project` (optional)
+- `host` (optional)
+
+### Configuration
+
+Global configuration is supported for the following options:
+
+```ruby
+OmniAI::OpenAI.configure do |config|
+  config.api_key = 'sk-...' # default: ENV['OPENAI_API_KEY']
+  config.organization = '...' # default: ENV['OPENAI_ORGANIZATION']
+  config.project = '...' # default: ENV['OPENAI_PROJECT']
+  config.host = '...' # default: 'https://api.openai.com'
+end
+```
+
+### Chat
+
+A chat completion is generated by passing in prompts using any a variety of formats:
+
+```ruby
+completion = client.chat.completion('Tell me a joke!')
+completion.choice.message.content # 'Why did the chicken cross the road? To get to the other side.'
+```
+
+```ruby
+completion = client.chat.completion({
+  role: OmniAI::OpenAI::Chat::Role::USER,
+  content: 'Is it wise to jump off a bridge?'
+})
+completion.choice.message.content # 'No.'
+```
+
+```ruby
+completion = client.chat.completion([
+  {
+    role: OmniAI::OpenAI::Chat::Role::SYSTEM,
+    content: 'You are a helpful assistant.'
+  },
+  'What is the capital of Canada?',
+])
+completion.choice.message.content # 'The capital of Canada is Ottawa.'
+```
+
+#### Model
+
+`model` takes an optional string (default is `gtp-4o`):
+
+```ruby
+completion = client.chat.completion('How fast is a cheetah?', model: OmniAI::OpenAI::Chat::Model::GPT_3_5_TURBO)
+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`):
+
+```ruby
+completion = client.chat.completion('Pick a number between 1 and 5', temperature: 2.0)
+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:
+
+```ruby
+stream = proc do |chunk|
+  print(chunk.choice.delta.content) # 'Better', 'three', 'hours', ...
+end
+client.chat.completion('Be poetic.', stream:)
+```
 
-TODO: Write usage instructions here
+[OpenAI API Reference `stream`](https://platform.openai.com/docs/api-reference/chat/create#chat-create-stream)
 
-## Development
+#### Format
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+`format` takes an optional symbol (`:json`) and that setes the `response_format` to `json_object`:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+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" }
+```
 
-## Contributing
+[OpenAI API Reference `response_format`](https://platform.openai.com/docs/api-reference/chat/create#chat-create-stream)
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/omniai-openai.
+> 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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module OpenAI
+    # An OpenAI chat implementation.
+    class Chat < OmniAI::Chat
+      JSON_RESPONSE_FORMAT = { type: 'json_object' }.freeze
+
+      module Model
+        GPT_4O = 'gpt-4o'
+        GPT_4 = 'gpt-4'
+        GPT_4_TURBO = 'gpt-4-turbo'
+        GPT_3_5_TURBO = 'gpt-3.5-turbo'
+      end
+
+      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
+
+      # @return [String]
+      def path
+        "/#{OmniAI::OpenAI::Client::VERSION}/chat/completions"
+      end
+    end
+  end
+end

data/lib/omniai/openai/client.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module OpenAI
+    # An OpenAI client implementation. Usage:
+    #
+    # w/ `api_key``:
+    #   client = OmniAI::OpenAI::Client.new(api_key: '...')
+    #
+    # w/ ENV['OPENAI_API_KEY']:
+    #
+    #   ENV['OPENAI_API_KEY'] = '...'
+    #   client = OmniAI::OpenAI::Client.new
+    #
+    # w/ config:
+    #
+    #   OmniAI::OpenAI.configure do |config|
+    #     config.api_key = '...'
+    #   end
+    #
+    #   client = OmniAI::OpenAI::Client.new
+    class Client < OmniAI::Client
+      VERSION = 'v1'
+
+      # @param api_key [String] optional - defaults to `OmniAI::OpenAI.config.api_key`
+      # @param project_id [String] optional - defaults to `OmniAI::OpenAI.config.project`
+      # @param organization_id [String] optional - defaults to `OmniAI::OpenAI.config.organization`
+      # @param logger [Logger] optional - defaults to `OmniAI::OpenAI.config.logger`
+      def initialize(
+        api_key: OmniAI::OpenAI.config.api_key,
+        organization: OmniAI::OpenAI.config.organization,
+        project: OmniAI::OpenAI.config.project,
+        logger: OmniAI::OpenAI.config.logger,
+        host: OmniAI::OpenAI.config.host
+      )
+        raise(ArgumentError, %(ENV['OPENAI_API_KEY'] must be defined or `api_key` must be passed)) if api_key.nil?
+
+        super(api_key:, logger:)
+
+        @organization = organization
+        @project = project
+        @host = host
+      end
+
+      # @return [HTTP::Client]
+      def connection
+        @connection ||= begin
+          http = HTTP.auth("Bearer #{api_key}").persistent(@host)
+          http = http.headers('OpenAI-Organization': @organization) if @organization
+          http = http.headers('OpenAI-Project': @project) if @project
+          http
+        end
+      end
+
+      # @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
+end

data/lib/omniai/openai/config.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module OpenAI
+    # Configuration for managing the OpenAI `api_key` / `organization` / `project` / `logger`.
+    class Config < OmniAI::Config
+      attr_accessor :organization, :project, :chat_options
+
+      def initialize
+        super
+        @api_key = ENV.fetch('OPENAI_API_KEY', nil)
+        @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
+end

data/lib/omniai/openai/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAI
   module OpenAI
-    VERSION = "0.1.0"
+    VERSION = '1.0.1'
   end
 end

data/lib/omniai/openai.rb

@@ -1,9 +1,25 @@
 # frozen_string_literal: true
 
-require_relative "openai/version"
+require 'event_stream_parser'
+require 'omniai'
+require 'zeitwerk'
+
+loader = Zeitwerk::Loader.for_gem
+loader.push_dir(__dir__, namespace: OmniAI)
+loader.inflector.inflect 'openai' => 'OpenAI'
+loader.setup
 
 module OmniAI
+  # A namespace for everything OpenAI.
   module OpenAI
-    class Error < StandardError; end
+    # @return [OmniAI::OpenAI::Config]
+    def self.config
+      @config ||= Config.new
+    end
+
+    # @yield [OmniAI::OpenAI::Config]
+    def self.configure
+      yield config
+    end
   end
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: omniai-openai
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-10 00:00:00.000000000 Z
+date: 2024-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: omniai
+  name: event_stream_parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,13 +25,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: omniai
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -39,13 +39,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -59,16 +59,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".rubocop.yml"
+- Gemfile
 - README.md
-- Rakefile
 - lib/omniai/openai.rb
+- lib/omniai/openai/chat.rb
+- lib/omniai/openai/client.rb
+- lib/omniai/openai/config.rb
 - lib/omniai/openai/version.rb
-- sig/omniai/openai.rbs
 homepage: https://github.com/ksylvest/omniai-openai
 licenses: []
-metadata: {}
+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:
 rdoc_options: []
 require_paths:
@@ -77,7 +80,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,8 +0,0 @@
-AllCops:
-  TargetRubyVersion: 3.0
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes

data/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]

data/sig/omniai/openai.rbs

@@ -1,6 +0,0 @@
-module Omniai
-  module Openai
-    VERSION: String
-    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-  end
-end