ruby-openai 3.6.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cee1b8ea9256b9e74487bd152c640acf176ee65f7860521b3ee9f0901dddb5f
-  data.tar.gz: 12bb3313fbcfd6d9098a13975b2ea9784126e603a321a63e4540891efbf720ab
+  metadata.gz: 3a26687eb00056e37ab5f2eed5b7bf6e73b4a9479016a101a828ae014ed299aa
+  data.tar.gz: c729b1a8b2df16db50af716664108b1fb2418ef22f4159b7993148474cd93ad2
 SHA512:
-  metadata.gz: c684505ae1469c9066c2b6731dc6e9ee32b4efed151a005bf83f6c070991d60d714122bb10dc7a6239dcbf99fbee9486397d22de0df74287754ac5088460732c
-  data.tar.gz: 70381208b506f04536ced0db66b1519e34d3dfc368796c9f17e7994fa8f95d46f902746f4513ae570a7e41d36d788a88c6ca69f6b999b88ad6be247f6547b913
+  metadata.gz: ddd2bf5992ade00580d0c2cd2b668e70eb999c39a487da4020e46ad8debe96a08b5e0e5560baa612b4e89d0f91765532394a1d69f3cd7214c6bb938edb10118f
+  data.tar.gz: aba44b222706820b3233fdcb623da8ba766c431485a723c870092c09608b4e1a7ab3466834d8683690b2873318bd807bcc3c57fe848831ed3c5fb8fc473d1a1a

data/CHANGELOG.md

@@ -5,6 +5,12 @@ 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.7.0] - 2023-03-25
+
+### Added
+
+- Allow the usage of proxy base URIs like https://www.helicone.ai/. Thanks to [@mmmaia](https://github.com/mmmaia) for the PR!
+
 ## [3.6.0] - 2023-03-22
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-openai (3.6.0)
+    ruby-openai (3.7.0)
       httparty (>= 0.18.1)
 
 GEM

data/README.md

@@ -7,7 +7,7 @@
 
 Use the [OpenAI API](https://openai.com/blog/openai-api/) with Ruby! 🤖❤️
 
-Generate text with ChatGPT, transcribe or translate audio with Whisper, create images with DALL·E, or write code with Codex...
+Generate text with ChatGPT, transcribe and translate audio with Whisper, or create images with DALL·E...
 
 Check out [Ruby AI Builders](https://discord.gg/k4Uc224xVD) on Discord!
 
@@ -69,21 +69,26 @@ Then you can create a client like this:
 client = OpenAI::Client.new
 ```
 
-#### Setting request timeout
+#### Custom timeout or base URI
 
-The default timeout for any OpenAI request is 120 seconds. You can change that passing the `request_timeout` when initializing the client:
+The default timeout for any OpenAI request is 120 seconds. You can change that passing the `request_timeout` when initializing the client. You can also change the base URI used for all requests, eg. to use observability tools like [Helicone](https://docs.helicone.ai/quickstart/integrate-in-one-line-of-code):
 
 ```ruby
-    client = OpenAI::Client.new(access_token: "access_token_goes_here", request_timeout: 25)
+    client = OpenAI::Client.new(
+        access_token: "access_token_goes_here",
+        uri_base: "https://oai.hconeai.com",
+        request_timeout: 240
+    )
 ```
 
 or when configuring the gem:
 
 ```ruby
     OpenAI.configure do |config|
-        config.access_token = ENV.fetch('OPENAI_ACCESS_TOKEN')
-        config.organization_id = ENV.fetch('OPENAI_ORGANIZATION_ID') # Optional.
-        config.request_timeout = 25 # Optional
+        config.access_token = ENV.fetch("OPENAI_ACCESS_TOKEN")
+        config.organization_id = ENV.fetch("OPENAI_ORGANIZATION_ID") # Optional
+        config.uri_base = "https://oai.hconeai.com" # Optional
+        config.request_timeout = 240 # Optional
     end
 ```
 
@@ -98,14 +103,18 @@ client.models.retrieve(id: "text-ada-001")
 
 #### Examples
 
-- [GPT-3](https://beta.openai.com/docs/models/gpt-3)
+- [GPT-4 (limited beta)](https://platform.openai.com/docs/models/gpt-4)
+  - gpt-4
+  - gpt-4-0314
+  - gpt-4-32k
+- [GPT-3.5](https://platform.openai.com/docs/models/gpt-3-5)
+  - gpt-3.5-turbo
+  - gpt-3.5-turbo-0301
+  - text-davinci-003
+- [GPT-3](https://platform.openai.com/docs/models/gpt-3)
   - text-ada-001
   - text-babbage-001
   - text-curie-001
-  - text-davinci-001
-- [Codex (private beta)](https://beta.openai.com/docs/models/codex-series-private-beta)
-  - code-davinci-002
-  - code-cushman-001
 
 ### ChatGPT
 
@@ -297,7 +306,7 @@ The translations API takes as input the audio file in any of the supported langu
 response = client.translate(
     parameters: {
         model: "whisper-1",
-        file: File.open('path_to_file'),
+        file: File.open('path_to_file', 'rb'),
     })
 puts response.parsed_response['text']
 # => "Translation of the text"
@@ -311,7 +320,7 @@ The transcriptions API takes as input the audio file you want to transcribe and
 response = client.transcribe(
     parameters: {
         model: "whisper-1",
-        file: File.open('path_to_file'),
+        file: File.open('path_to_file', 'rb'),
     })
 puts response.parsed_response['text']
 # => "Transcription of the text"

data/lib/openai/client.rb

@@ -1,10 +1,9 @@
 module OpenAI
   class Client
-    URI_BASE = "https://api.openai.com/".freeze
-
-    def initialize(access_token: nil, organization_id: nil, request_timeout: nil)
+    def initialize(access_token: nil, organization_id: nil, uri_base: nil, request_timeout: nil)
       OpenAI.configuration.access_token = access_token if access_token
       OpenAI.configuration.organization_id = organization_id if organization_id
+      OpenAI.configuration.uri_base = uri_base if uri_base
       OpenAI.configuration.request_timeout = request_timeout if request_timeout
     end
 
@@ -87,7 +86,7 @@ module OpenAI
     end
 
     private_class_method def self.uri(path:)
-      URI_BASE + OpenAI.configuration.api_version + path
+      OpenAI.configuration.uri_base + OpenAI.configuration.api_version + path
     end
 
     private_class_method def self.headers

data/lib/openai/version.rb

@@ -1,3 +1,3 @@
 module OpenAI
-  VERSION = "3.6.0".freeze
+  VERSION = "3.7.0".freeze
 end

data/lib/openai.rb

@@ -13,15 +13,17 @@ module OpenAI
 
   class Configuration
     attr_writer :access_token
-    attr_accessor :api_version, :organization_id, :request_timeout
+    attr_accessor :api_version, :organization_id, :uri_base, :request_timeout
 
     DEFAULT_API_VERSION = "v1".freeze
+    DEFAULT_URI_BASE = "https://api.openai.com/".freeze
     DEFAULT_REQUEST_TIMEOUT = 120
 
     def initialize
       @access_token = nil
       @api_version = DEFAULT_API_VERSION
       @organization_id = nil
+      @uri_base = DEFAULT_URI_BASE
       @request_timeout = DEFAULT_REQUEST_TIMEOUT
     end
 

data/ruby-openai.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Alex"]
   spec.email         = ["alexrudall@users.noreply.github.com"]
 
-  spec.summary       = "A Ruby gem for the OpenAI GPT-3 API"
+  spec.summary       = "OpenAI API + Ruby! 🤖❤️"
   spec.homepage      = "https://github.com/alexrudall/ruby-openai"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 3.7.0
 platform: ruby
 authors:
 - Alex
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-22 00:00:00.000000000 Z
+date: 2023-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -88,5 +88,5 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: A Ruby gem for the OpenAI GPT-3 API
+summary: "OpenAI API + Ruby! \U0001F916❤️"
 test_files: []