ruby-openai 3.5.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfe7d331fc5d5a16f74089b9395232cd1abf0d6b05bd78be4db91e1b65d71a4c
-  data.tar.gz: 610d363ebf1d6a53f015aeaf20cd551c1020731fd423ba4074ff3eb044239fa1
+  metadata.gz: 3a26687eb00056e37ab5f2eed5b7bf6e73b4a9479016a101a828ae014ed299aa
+  data.tar.gz: c729b1a8b2df16db50af716664108b1fb2418ef22f4159b7993148474cd93ad2
 SHA512:
-  metadata.gz: '08b25f159fc149ccd09034da891cf5e77c999964a6d06ea6d916c62ad3e4a9ba2b1aa73757b617c0152ca1760f386514da081e978a6ca9963706f3f385814b78'
-  data.tar.gz: 144bd11f3791fa818193eaab7d8eeb6b04c33f4b99342ca573acea76f0ffcef4604033daaea54b2ae43411abf84e572db97304f7195c08116a55fedd1524d2aa
+  metadata.gz: ddd2bf5992ade00580d0c2cd2b668e70eb999c39a487da4020e46ad8debe96a08b5e0e5560baa612b4e89d0f91765532394a1d69f3cd7214c6bb938edb10118f
+  data.tar.gz: aba44b222706820b3233fdcb623da8ba766c431485a723c870092c09608b4e1a7ab3466834d8683690b2873318bd807bcc3c57fe848831ed3c5fb8fc473d1a1a

data/CHANGELOG.md

@@ -5,6 +5,18 @@ 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
+
+- Add much-needed ability to increase HTTParty timeout, and set default to 120 seconds. Thanks to [@mbackermann](https://github.com/mbackermann) for the PR and to everyone who requested this!
+
 ## [3.5.0] - 2023-03-02
 
 ### 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.46.0"
+gem "rubocop", "~> 1.48.1"
 gem "vcr", "~> 6.1.0"
 gem "webmock", "~> 3.18.1"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-openai (3.5.0)
+    ruby-openai (3.7.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.1.0)
+    parser (3.2.1.1)
       ast (~> 2.4.1)
     public_suffix (5.0.1)
     rainbow (3.1.1)
@@ -43,7 +43,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.46.0)
+    rubocop (1.48.1)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
@@ -53,9 +53,9 @@ GEM
       rubocop-ast (>= 1.26.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.26.0)
+    rubocop-ast (1.27.0)
       parser (>= 3.2.1.0)
-    ruby-progressbar (1.11.0)
+    ruby-progressbar (1.13.0)
     unicode-display_width (2.4.2)
     vcr (6.1.0)
     webmock (3.18.1)
@@ -71,7 +71,7 @@ DEPENDENCIES
   dotenv (~> 2.8.1)
   rake (~> 13.0)
   rspec (~> 3.12)
-  rubocop (~> 1.46.0)
+  rubocop (~> 1.48.1)
   ruby-openai!
   vcr (~> 6.1.0)
   webmock (~> 3.18.1)

data/README.md

@@ -7,16 +7,16 @@
 
 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...
 
-## Installation
+Check out [Ruby AI Builders](https://discord.gg/k4Uc224xVD) on Discord!
 
 ### Bundler
 
 Add this line to your application's Gemfile:
 
 ```ruby
-    gem "ruby-openai"
+gem "ruby-openai"
 ```
 
 And then execute:
@@ -32,7 +32,7 @@ $ gem install ruby-openai
 and require with:
 
 ```ruby
-    require "openai"
+require "openai"
 ```
 
 ## Upgrading
@@ -49,7 +49,7 @@ The `::Ruby::OpenAI` module has been removed and all classes have been moved und
 For a quick test you can pass your token directly to a new client:
 
 ```ruby
-    client = OpenAI::Client.new(access_token: "access_token_goes_here")
+client = OpenAI::Client.new(access_token: "access_token_goes_here")
 ```
 
 ### With Config
@@ -57,16 +57,39 @@ 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
-    OpenAI.configure do |config|
-        config.access_token = ENV.fetch('OPENAI_ACCESS_TOKEN')
-        config.organization_id = ENV.fetch('OPENAI_ORGANIZATION_ID') # Optional.
-    end
+OpenAI.configure do |config|
+    config.access_token = ENV.fetch('OPENAI_ACCESS_TOKEN')
+    config.organization_id = ENV.fetch('OPENAI_ORGANIZATION_ID') # Optional.
+end
 ```
 
 Then you can create a client like this:
 
 ```ruby
-    client = OpenAI::Client.new
+client = OpenAI::Client.new
+```
+
+#### 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. 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",
+        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.uri_base = "https://oai.hconeai.com" # Optional
+        config.request_timeout = 240 # Optional
+    end
 ```
 
 ### Models
@@ -74,34 +97,38 @@ Then you can create a client like this:
 There are different models that can be used to generate text. For a full list and to retrieve information about a single models:
 
 ```ruby
-    client.models.list
-    client.models.retrieve(id: "text-ada-001")
+client.models.list
+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
 
-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):
+ChatGPT is a model that can be used to generate text in a conversational style. You can use it to [generate a response](https://platform.openai.com/docs/api-reference/chat/create) 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?"
-
+response = client.chat(
+    parameters: {
+        model: "gpt-3.5-turbo", # Required.
+        messages: [{ role: "user", content: "Hello!"}], # Required.
+        temperature: 0.7,
+    })
+puts response.dig("choices", 0, "message", "content")
+# => "Hello! How may I assist you today?"
 ```
 
 ### Completions
@@ -109,14 +136,14 @@ ChatGPT is a model that can be used to generate text in a conversational style.
 Hit the OpenAI API for a completion using other GPT-3 models:
 
 ```ruby
-    response = client.completions(
-        parameters: {
-            model: "text-davinci-001",
-            prompt: "Once upon a time",
-            max_tokens: 5
-        })
-    puts response["choices"].map { |c| c["text"] }
-    => [", there lived a great"]
+response = client.completions(
+    parameters: {
+        model: "text-davinci-001",
+        prompt: "Once upon a time",
+        max_tokens: 5
+    })
+puts response["choices"].map { |c| c["text"] }
+# => [", there lived a great"]
 ```
 
 ### Edits
@@ -124,15 +151,15 @@ Hit the OpenAI API for a completion using other GPT-3 models:
 Send a string and some instructions for what to do to the string:
 
 ```ruby
-    response = client.edits(
-        parameters: {
-            model: "text-davinci-edit-001",
-            input: "What day of the wek is it?",
-            instruction: "Fix the spelling mistakes"
-        }
-    )
-    puts response.dig("choices", 0, "text")
-    => What day of the week is it?
+response = client.edits(
+    parameters: {
+        model: "text-davinci-edit-001",
+        input: "What day of the wek is it?",
+        instruction: "Fix the spelling mistakes"
+    }
+)
+puts response.dig("choices", 0, "text")
+# => What day of the week is it?
 ```
 
 ### Embeddings
@@ -140,12 +167,12 @@ Send a string and some instructions for what to do to the string:
 You can use the embeddings endpoint to get a vector of numbers representing an input. You can then compare these vectors for different inputs to efficiently check how similar the inputs are.
 
 ```ruby
-    client.embeddings(
-        parameters: {
-            model: "babbage-similarity",
-            input: "The food was delicious and the waiter..."
-        }
-    )
+client.embeddings(
+    parameters: {
+        model: "babbage-similarity",
+        input: "The food was delicious and the waiter..."
+    }
+)
 ```
 
 ### Files
@@ -153,18 +180,18 @@ You can use the embeddings endpoint to get a vector of numbers representing an i
 Put your data in a `.jsonl` file like this:
 
 ```json
-    {"prompt":"Overjoyed with my new phone! ->", "completion":" positive"}
-    {"prompt":"@lakers disappoint for a third straight night ->", "completion":" negative"}
+{"prompt":"Overjoyed with my new phone! ->", "completion":" positive"}
+{"prompt":"@lakers disappoint for a third straight night ->", "completion":" negative"}
 ```
 
 and pass the path to `client.files.upload` to upload it to OpenAI, and then interact with it:
 
 ```ruby
-    client.files.upload(parameters: { file: "path/to/sentiment.jsonl", purpose: "fine-tune" })
-    client.files.list
-    client.files.retrieve(id: 123)
-    client.files.content(id: 123)
-    client.files.delete(id: 123)
+client.files.upload(parameters: { file: "path/to/sentiment.jsonl", purpose: "fine-tune" })
+client.files.list
+client.files.retrieve(id: 123)
+client.files.content(id: 123)
+client.files.delete(id: 123)
 ```
 
 ### Fine-tunes
@@ -172,51 +199,51 @@ and pass the path to `client.files.upload` to upload it to OpenAI, and then inte
 Upload your fine-tuning data in a `.jsonl` file as above and get its ID:
 
 ```ruby
-    response = client.files.upload(parameters: { file: "path/to/sentiment.jsonl", purpose: "fine-tune" })
-    file_id = JSON.parse(response.body)["id"]
+response = client.files.upload(parameters: { file: "path/to/sentiment.jsonl", purpose: "fine-tune" })
+file_id = JSON.parse(response.body)["id"]
 ```
 
 You can then use this file ID to create a fine-tune model:
 
 ```ruby
-    response = client.finetunes.create(
-        parameters: {
-        training_file: file_id,
-        model: "text-ada-001"
-    })
-    fine_tune_id = JSON.parse(response.body)["id"]
+response = client.finetunes.create(
+    parameters: {
+    training_file: file_id,
+    model: "text-ada-001"
+})
+fine_tune_id = JSON.parse(response.body)["id"]
 ```
 
 That will give you the fine-tune ID. If you made a mistake you can cancel the fine-tune model before it is processed:
 
 ```ruby
-    client.finetunes.cancel(id: fine_tune_id)
+client.finetunes.cancel(id: fine_tune_id)
 ```
 
 You may need to wait a short time for processing to complete. Once processed, you can use list or retrieve to get the name of the fine-tuned model:
 
 ```ruby
-    client.finetunes.list
-    response = client.finetunes.retrieve(id: fine_tune_id)
-    fine_tuned_model = JSON.parse(response.body)["fine_tuned_model"]
+client.finetunes.list
+response = client.finetunes.retrieve(id: fine_tune_id)
+fine_tuned_model = JSON.parse(response.body)["fine_tuned_model"]
 ```
 
 This fine-tuned model name can then be used in completions:
 
 ```ruby
-    response = client.completions(
-        parameters: {
-            model: fine_tuned_model,
-            prompt: "I love Mondays!"
-        }
-    )
-    JSON.parse(response.body)["choices"].map { |c| c["text"] }
+response = client.completions(
+    parameters: {
+        model: fine_tuned_model,
+        prompt: "I love Mondays!"
+    }
+)
+JSON.parse(response.body)["choices"].map { |c| c["text"] }
 ```
 
 You can delete the fine-tuned model when you are done with it:
 
 ```ruby
-    client.finetunes.delete(fine_tuned_model: fine_tuned_model)
+client.finetunes.delete(fine_tuned_model: fine_tuned_model)
 ```
 
 ### Image Generation
@@ -225,9 +252,9 @@ Generate an image using DALL·E! The size of any generated images must be one of
 if not specified the image will default to `1024x1024`.
 
 ```ruby
-    response = client.images.generate(parameters: { prompt: "A baby sea otter cooking pasta wearing a hat of some sort", size: "256x256" })
-    puts response.dig("data", 0, "url")
-    => "https://oaidalleapiprodscus.blob.core.windows.net/private/org-Rf437IxKhh..."
+response = client.images.generate(parameters: { prompt: "A baby sea otter cooking pasta wearing a hat of some sort", size: "256x256" })
+puts response.dig("data", 0, "url")
+# => "https://oaidalleapiprodscus.blob.core.windows.net/private/org-Rf437IxKhh..."
 ```
 
 ![Ruby](https://i.ibb.co/6y4HJFx/img-d-Tx-Rf-RHj-SO5-Gho-Cbd8o-LJvw3.png)
@@ -237,9 +264,9 @@ if not specified the image will default to `1024x1024`.
 Fill in the transparent part of an image, or upload a mask with transparent sections to indicate the parts of an image that can be changed according to your prompt...
 
 ```ruby
-    response = client.images.edit(parameters: { prompt: "A solid red Ruby on a blue background", image: "image.png", mask: "mask.png" })
-    puts response.dig("data", 0, "url")
-    => "https://oaidalleapiprodscus.blob.core.windows.net/private/org-Rf437IxKhh..."
+response = client.images.edit(parameters: { prompt: "A solid red Ruby on a blue background", image: "image.png", mask: "mask.png" })
+puts response.dig("data", 0, "url")
+# => "https://oaidalleapiprodscus.blob.core.windows.net/private/org-Rf437IxKhh..."
 ```
 
 ![Ruby](https://i.ibb.co/sWVh3BX/dalle-ruby.png)
@@ -249,9 +276,9 @@ Fill in the transparent part of an image, or upload a mask with transparent sect
 Create n variations of an image.
 
 ```ruby
-    response = client.images.variations(parameters: { image: "image.png", n: 2 })
-    puts response.dig("data", 0, "url")
-    => "https://oaidalleapiprodscus.blob.core.windows.net/private/org-Rf437IxKhh..."
+response = client.images.variations(parameters: { image: "image.png", n: 2 })
+puts response.dig("data", 0, "url")
+# => "https://oaidalleapiprodscus.blob.core.windows.net/private/org-Rf437IxKhh..."
 ```
 
 ![Ruby](https://i.ibb.co/TWJLP2y/img-miu-Wk-Nl0-QNy-Xtj-Lerc3c0l-NW.png)
@@ -262,27 +289,27 @@ Create n variations of an image.
 Pass a string to check if it violates OpenAI's Content Policy:
 
 ```ruby
-    response = client.moderations(parameters: { input: "I'm worried about that." })
-    puts response.dig("results", 0, "category_scores", "hate")
-    => 5.505014632944949e-05
+response = client.moderations(parameters: { input: "I'm worried about that." })
+puts response.dig("results", 0, "category_scores", "hate")
+# => 5.505014632944949e-05
 ```
 
 ### Whisper
 
-Whisper is a speech to text model that can be used to generate text based on an audio files:
+Whisper is a speech to text model that can be used to generate text based on audio files:
 
 #### Translate
 
 The translations API takes as input the audio file in any of the supported languages and transcribes the audio into English.
 
 ```ruby
-    response = client.translate(
-        parameters: {
-            model: "whisper-1",
-            file: File.open('path_to_file'),
-        })
-    puts response.parsed_body['text']
-    => "Translation of the text"
+response = client.translate(
+    parameters: {
+        model: "whisper-1",
+        file: File.open('path_to_file', 'rb'),
+    })
+puts response.parsed_response['text']
+# => "Translation of the text"
 ```
 
 #### Transcribe
@@ -290,13 +317,13 @@ The translations API takes as input the audio file in any of the supported langu
 The transcriptions API takes as input the audio file you want to transcribe and returns the text in the desired output file format.
 
 ```ruby
-    response = client.transcribe(
-        parameters: {
-            model: "whisper-1",
-            file: File.open('path_to_file'),
-        })
-    puts response.parsed_body['text']
-    => "Transcription of the text"
+response = client.transcribe(
+    parameters: {
+        model: "whisper-1",
+        file: File.open('path_to_file', 'rb'),
+    })
+puts response.parsed_response['text']
+# => "Transcription of the text"
 ```
 
 ## Development

data/lib/openai/client.rb

@@ -1,10 +1,10 @@
 module OpenAI
   class Client
-    URI_BASE = "https://api.openai.com/".freeze
-
-    def initialize(access_token: nil, organization_id: 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
 
     def chat(parameters: {})
@@ -54,7 +54,8 @@ module OpenAI
     def self.get(path:)
       HTTParty.get(
         uri(path: path),
-        headers: headers
+        headers: headers,
+        timeout: request_timeout
       )
     end
 
@@ -62,7 +63,8 @@ module OpenAI
       HTTParty.post(
         uri(path: path),
         headers: headers,
-        body: parameters&.to_json
+        body: parameters&.to_json,
+        timeout: request_timeout
       )
     end
 
@@ -70,19 +72,21 @@ module OpenAI
       HTTParty.post(
         uri(path: path),
         headers: headers.merge({ "Content-Type" => "multipart/form-data" }),
-        body: parameters
+        body: parameters,
+        timeout: request_timeout
       )
     end
 
     def self.delete(path:)
       HTTParty.delete(
         uri(path: path),
-        headers: headers
+        headers: headers,
+        timeout: request_timeout
       )
     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
@@ -92,5 +96,9 @@ module OpenAI
         "OpenAI-Organization" => OpenAI.configuration.organization_id
       }
     end
+
+    private_class_method def self.request_timeout
+      OpenAI.configuration.request_timeout
+    end
   end
 end

data/lib/openai/version.rb

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

data/lib/openai.rb

@@ -13,14 +13,18 @@ module OpenAI
 
   class Configuration
     attr_writer :access_token
-    attr_accessor :api_version, :organization_id
+    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
 
     def access_token

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.5.0
+  version: 3.7.0
 platform: ruby
 authors:
 - Alex
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-02 00:00:00.000000000 Z
+date: 2023-03-25 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: []
@@ -85,8 +85,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key:
+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: []