ruby-openai 3.2.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e8ff1d30efd244fc448e8f473834796b8b02b627a5a4fc4edfdb79062119cfd
-  data.tar.gz: dfd511d71c4a8d351e298cb6759bc876467840c70d073b0835259d18a4e4aa6e
+  metadata.gz: f3d2b8f98be44b7f33fce40f271bccc3dc1c72237df7ad64baed43f4ea79fb51
+  data.tar.gz: f19cc5e7155b47e6f7ccb7c5642679e5d8f7a6600e6d4f9e592ebc16313b74f0
 SHA512:
-  metadata.gz: 6df6919af3e66c044d7309f6f7272078a12a2532702ced4175365b9ca618b7f6cac88e8aa7d84ed9884fea053d032505b9b1a3be8f7a39cb47c056e2e7a87849
-  data.tar.gz: 529f048e9a35a7169f688cc49bb78a68b5787919c716dcb8c4017357db3124ed637314c931578b05aeedc76c72045c8f3144682c32f2a3879188270cbe7eae8d
+  metadata.gz: 8f2c05fae48718593ea7990c480f6108844a698a943c8db2e3e01f3e31e95ede1ca2a5bd0dec5364a9b1730698c3802e24eecec585d20e59b03e1a421c8a3c4e
+  data.tar.gz: 303d6df6cea50a4f9ac50f8cab7329e585e201aeb2532709b161b830896cc1e733e0c48dfa6ebff22d13d930c3a0ff76425b8e0294c7e175a1bc4e07b84710a2

data/.rubocop.yml

@@ -9,6 +9,8 @@ Style/Documentation:
 
 Layout/LineLength:
   Max: 100
+  Exclude:
+    - "**/*.gemspec"
 
 Metrics/BlockLength:
   Exclude:

data/CHANGELOG.md

@@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.4.0] - 2023-03-01
+
+### Added
+
+- Add Client#chat endpoint - ChatGPT over the wire!
+
+## [3.3.0] - 2023-02-15
+
+### Changed
+
+- Replace ::Ruby::OpenAI namespace with ::OpenAI - thanks [@kmcphillips](https://github.com/kmcphillips) for this work!
+- To upgrade, change `require 'ruby/openai'` to `require 'openai'` and change all references to `Ruby::OpenAI` to `OpenAI`.
+
 ## [3.2.0] - 2023-02-13
 
 ### Added

data/Gemfile

@@ -7,6 +7,6 @@ gem "byebug", "~> 11.1.3"
 gem "dotenv", "~> 2.8.1"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.12"
-gem "rubocop", "~> 1.45.1"
+gem "rubocop", "~> 1.46.0"
 gem "vcr", "~> 6.1.0"
 gem "webmock", "~> 3.18.1"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-openai (3.2.0)
+    ruby-openai (3.4.0)
       httparty (>= 0.18.1)
 
 GEM
@@ -23,7 +23,7 @@ GEM
     mini_mime (1.1.2)
     multi_xml (0.6.0)
     parallel (1.22.1)
-    parser (3.2.0.0)
+    parser (3.2.1.0)
       ast (~> 2.4.1)
     public_suffix (5.0.1)
     rainbow (3.1.1)
@@ -43,18 +43,18 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.45.1)
+    rubocop (1.46.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.24.1, < 2.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.24.1)
-      parser (>= 3.1.1.0)
+    rubocop-ast (1.26.0)
+      parser (>= 3.2.1.0)
     ruby-progressbar (1.11.0)
     unicode-display_width (2.4.2)
     vcr (6.1.0)
@@ -71,7 +71,7 @@ DEPENDENCIES
   dotenv (~> 2.8.1)
   rake (~> 13.0)
   rspec (~> 3.12)
-  rubocop (~> 1.45.1)
+  rubocop (~> 1.46.0)
   ruby-openai!
   vcr (~> 6.1.0)
   webmock (~> 3.18.1)

data/README.md

@@ -1,4 +1,4 @@
-# Ruby::OpenAI
+# Ruby OpenAI
 
 [![Gem Version](https://badge.fury.io/rb/ruby-openai.svg)](https://badge.fury.io/rb/ruby-openai)
 [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/alexrudall/ruby-openai/blob/main/LICENSE.txt)
@@ -7,7 +7,7 @@
 
 Use the [OpenAI API](https://openai.com/blog/openai-api/) with Ruby! 🤖❤️
 
-Generate text with GPT-3, create images with DALL·E, or write code with Codex...
+Generate text with ChatGPT, create images with DALL·E, or write code with Codex...
 
 ## Installation
 
@@ -32,9 +32,13 @@ $ gem install ruby-openai
 and require with:
 
 ```ruby
-    require "ruby/openai"
+    require "openai"
 ```
 
+## Upgrading
+
+The `::Ruby::OpenAI` module has been removed and all classes have been moved under the top level `::OpenAI` module. To upgrade, change `require 'ruby/openai'` to `require 'openai'` and change all references to `Ruby::OpenAI` to `OpenAI`.
+
 ## Usage
 
 - Get your API key from [https://beta.openai.com/account/api-keys](https://beta.openai.com/account/api-keys)
@@ -53,7 +57,7 @@ For a quick test you can pass your token directly to a new client:
 For a more robust setup, you can configure the gem with your API keys, for example in an `openai.rb` initializer file. Never hardcode secrets into your codebase - instead use something like [dotenv](https://github.com/motdotla/dotenv) to pass the keys safely into your environments.
 
 ```ruby
-    Ruby::OpenAI.configure do |config|
+    OpenAI.configure do |config|
         config.access_token = ENV.fetch('OPENAI_ACCESS_TOKEN')
         config.organization_id = ENV.fetch('OPENAI_ORGANIZATION_ID') # Optional.
     end
@@ -85,9 +89,24 @@ There are different models that can be used to generate text. For a full list an
   - code-davinci-002
   - code-cushman-001
 
+### ChatGPT
+
+ChatGPT is a model that can be used to generate text in a conversational style. You can use it to generate a response to a sequence of [messages](https://platform.openai.com/docs/guides/chat/introduction):
+
+```ruby
+    response = client.chat(
+        parameters: {
+            model: "gpt-3.5-turbo",
+            messages: [{ role: "user", content: "Hello!"}],
+        })
+    puts response.dig("choices", 0, "message", "content")
+    => "Hello! How may I assist you today?"
+
+```
+
 ### Completions
 
-Hit the OpenAI API for a completion:
+Hit the OpenAI API for a completion using other GPT-3 models:
 
 ```ruby
     response = client.completions(
@@ -274,4 +293,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Ruby::OpenAI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/alexrudall/ruby-openai/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Ruby OpenAI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/alexrudall/ruby-openai/blob/main/CODE_OF_CONDUCT.md).

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "ruby/openai"
+require "openai"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/{ruby/openai → openai}/client.rb

@@ -3,8 +3,12 @@ module OpenAI
     URI_BASE = "https://api.openai.com/".freeze
 
     def initialize(access_token: nil, organization_id: nil)
-      Ruby::OpenAI.configuration.access_token = access_token if access_token
-      Ruby::OpenAI.configuration.organization_id = organization_id if organization_id
+      OpenAI.configuration.access_token = access_token if access_token
+      OpenAI.configuration.organization_id = organization_id if organization_id
+    end
+
+    def chat(parameters: {})
+      OpenAI::Client.json_post(path: "/chat/completions", parameters: parameters)
     end
 
     def completions(parameters: {})
@@ -70,14 +74,14 @@ module OpenAI
     end
 
     private_class_method def self.uri(path:)
-      URI_BASE + Ruby::OpenAI.configuration.api_version + path
+      URI_BASE + OpenAI.configuration.api_version + path
     end
 
     private_class_method def self.headers
       {
         "Content-Type" => "application/json",
-        "Authorization" => "Bearer #{Ruby::OpenAI.configuration.access_token}",
-        "OpenAI-Organization" => Ruby::OpenAI.configuration.organization_id
+        "Authorization" => "Bearer #{OpenAI.configuration.access_token}",
+        "OpenAI-Organization" => OpenAI.configuration.organization_id
       }
     end
   end

data/lib/openai/compatibility.rb

@@ -0,0 +1,9 @@
+module Ruby
+  module OpenAI
+    VERSION = ::OpenAI::VERSION
+
+    Error = ::OpenAI::Error
+    ConfigurationError = ::OpenAI::ConfigurationError
+    Configuration = ::OpenAI::Configuration
+  end
+end

data/lib/{ruby/openai → openai}/files.rb

@@ -1,8 +1,8 @@
 module OpenAI
   class Files
     def initialize(access_token: nil, organization_id: nil)
-      Ruby::OpenAI.configuration.access_token = access_token if access_token
-      Ruby::OpenAI.configuration.organization_id = organization_id if organization_id
+      OpenAI.configuration.access_token = access_token if access_token
+      OpenAI.configuration.organization_id = organization_id if organization_id
     end
 
     def list

data/lib/{ruby/openai → openai}/finetunes.rb

@@ -1,8 +1,8 @@
 module OpenAI
   class Finetunes
     def initialize(access_token: nil, organization_id: nil)
-      Ruby::OpenAI.configuration.access_token = access_token if access_token
-      Ruby::OpenAI.configuration.organization_id = organization_id if organization_id
+      OpenAI.configuration.access_token = access_token if access_token
+      OpenAI.configuration.organization_id = organization_id if organization_id
     end
 
     def list

data/lib/{ruby/openai → openai}/images.rb

@@ -1,8 +1,8 @@
 module OpenAI
   class Images
     def initialize(access_token: nil, organization_id: nil)
-      Ruby::OpenAI.configuration.access_token = access_token if access_token
-      Ruby::OpenAI.configuration.organization_id = organization_id if organization_id
+      OpenAI.configuration.access_token = access_token if access_token
+      OpenAI.configuration.organization_id = organization_id if organization_id
     end
 
     def generate(parameters: {})

data/lib/{ruby/openai → openai}/models.rb

@@ -1,8 +1,8 @@
 module OpenAI
   class Models
     def initialize(access_token: nil, organization_id: nil)
-      Ruby::OpenAI.configuration.access_token = access_token if access_token
-      Ruby::OpenAI.configuration.organization_id = organization_id if organization_id
+      OpenAI.configuration.access_token = access_token if access_token
+      OpenAI.configuration.organization_id = organization_id if organization_id
     end
 
     def list

data/lib/openai/version.rb

@@ -0,0 +1,3 @@
+module OpenAI
+  VERSION = "3.4.0".freeze
+end

data/lib/openai.rb

@@ -0,0 +1,45 @@
+require "httparty"
+
+require_relative "openai/client"
+require_relative "openai/files"
+require_relative "openai/finetunes"
+require_relative "openai/images"
+require_relative "openai/models"
+require_relative "openai/version"
+
+module OpenAI
+  class Error < StandardError; end
+  class ConfigurationError < Error; end
+
+  class Configuration
+    attr_writer :access_token
+    attr_accessor :api_version, :organization_id
+
+    DEFAULT_API_VERSION = "v1".freeze
+
+    def initialize
+      @access_token = nil
+      @api_version = DEFAULT_API_VERSION
+      @organization_id = nil
+    end
+
+    def access_token
+      return @access_token if @access_token
+
+      error_text = "OpenAI access token missing! See https://github.com/alexrudall/ruby-openai#usage"
+      raise ConfigurationError, error_text
+    end
+  end
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= OpenAI::Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/ruby/openai.rb

@@ -1,46 +1,2 @@
-require "httparty"
-require "ruby/openai/client"
-require "ruby/openai/files"
-require "ruby/openai/finetunes"
-require "ruby/openai/images"
-require "ruby/openai/models"
-require "ruby/openai/version"
-
-module Ruby
-  module OpenAI
-    class Error < StandardError; end
-    class ConfigurationError < Error; end
-
-    class Configuration
-      attr_writer :access_token
-      attr_accessor :api_version, :organization_id
-
-      DEFAULT_API_VERSION = "v1".freeze
-
-      def initialize
-        @access_token = nil
-        @api_version = DEFAULT_API_VERSION
-        @organization_id = nil
-      end
-
-      def access_token
-        return @access_token if @access_token
-
-        error_text = "OpenAI access token missing! See https://github.com/alexrudall/ruby-openai#usage"
-        raise ConfigurationError, error_text
-      end
-    end
-
-    class << self
-      attr_writer :configuration
-    end
-
-    def self.configuration
-      @configuration ||= OpenAI::Configuration.new
-    end
-
-    def self.configure
-      yield(configuration)
-    end
-  end
-end
+require_relative "../openai"
+require_relative "../openai/compatibility"

data/ruby-openai.gemspec

@@ -1,8 +1,8 @@
-require_relative "lib/ruby/openai/version"
+require_relative "lib/openai/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "ruby-openai"
-  spec.version       = Ruby::OpenAI::VERSION
+  spec.version       = OpenAI::VERSION
   spec.authors       = ["Alex"]
   spec.email         = ["alexrudall@users.noreply.github.com"]
 
@@ -26,4 +26,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "httparty", ">= 0.18.1"
+
+  spec.post_install_message = "Note if upgrading: The `::Ruby::OpenAI` module has been removed and all classes have been moved under the top level `::OpenAI` module. To upgrade, change `require 'ruby/openai'` to `require 'openai'` and change all references to `Ruby::OpenAI` to `OpenAI`."
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Alex
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-13 00:00:00.000000000 Z
+date: 2023-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.18.1
-description: 
+description:
 email:
 - alexrudall@users.noreply.github.com
 executables: []
@@ -48,13 +48,15 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/openai.rb
+- lib/openai/client.rb
+- lib/openai/compatibility.rb
+- lib/openai/files.rb
+- lib/openai/finetunes.rb
+- lib/openai/images.rb
+- lib/openai/models.rb
+- lib/openai/version.rb
 - lib/ruby/openai.rb
-- lib/ruby/openai/client.rb
-- lib/ruby/openai/files.rb
-- lib/ruby/openai/finetunes.rb
-- lib/ruby/openai/images.rb
-- lib/ruby/openai/models.rb
-- lib/ruby/openai/version.rb
 - pull_request_template.md
 - ruby-openai.gemspec
 homepage: https://github.com/alexrudall/ruby-openai
@@ -65,7 +67,10 @@ metadata:
   source_code_uri: https://github.com/alexrudall/ruby-openai
   changelog_uri: https://github.com/alexrudall/ruby-openai/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message: 'Note if upgrading: The `::Ruby::OpenAI` module has been removed
+  and all classes have been moved under the top level `::OpenAI` module. To upgrade,
+  change `require ''ruby/openai''` to `require ''openai''` and change all references
+  to `Ruby::OpenAI` to `OpenAI`.'
 rdoc_options: []
 require_paths:
 - lib
@@ -80,8 +85,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.5
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: A Ruby gem for the OpenAI GPT-3 API
 test_files: []

data/lib/ruby/openai/version.rb

@@ -1,5 +0,0 @@
-module Ruby
-  module OpenAI
-    VERSION = "3.2.0".freeze
-  end
-end