ruby-openai 3.3.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f31dd3158125262e5c187ee9503b21a9e9c0f423440c8da7a54e6abfaa932da3
-  data.tar.gz: 1c80b95c3d6587c3ddf95145f970690bf83572ef24902b455d126e2205f42c0d
+  metadata.gz: dfe7d331fc5d5a16f74089b9395232cd1abf0d6b05bd78be4db91e1b65d71a4c
+  data.tar.gz: 610d363ebf1d6a53f015aeaf20cd551c1020731fd423ba4074ff3eb044239fa1
 SHA512:
-  metadata.gz: 9c8e2185a4c2822a54aaeaaa6eca5034e01c2796010df65d4ac7688e70e19da7546e120a64eed8bd3bb30417be54492570a5713d2ba3b684778e508b053cc0d3
-  data.tar.gz: d0d9a8aade92949b509882fe699809b659bc82ddf79ba54485f7d6e304abcfecf50e20dae18fa3df4bda5b41d364a6519f24d27e7177a64d773f7e408b644d23
+  metadata.gz: '08b25f159fc149ccd09034da891cf5e77c999964a6d06ea6d916c62ad3e4a9ba2b1aa73757b617c0152ca1760f386514da081e978a6ca9963706f3f385814b78'
+  data.tar.gz: 144bd11f3791fa818193eaab7d8eeb6b04c33f4b99342ca573acea76f0ffcef4604033daaea54b2ae43411abf84e572db97304f7195c08116a55fedd1524d2aa

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.5.0] - 2023-03-02
+
+### Added
+
+- Add Client#transcribe and Client translate endpoints - Whisper over the wire! Thanks to [@Clemalfroy](https://github.com/Clemalfroy)
+
+## [3.4.0] - 2023-03-01
+
+### Added
+
+- Add Client#chat endpoint - ChatGPT over the wire!
+
 ## [3.3.0] - 2023-02-15
 
 ### Changed

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.3.0)
+    ruby-openai (3.5.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

@@ -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, transcribe or translate audio with Whisper, create images with DALL·E, or write code with Codex...
 
 ## Installation
 
@@ -89,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(
@@ -252,6 +267,38 @@ Pass a string to check if it violates OpenAI's Content Policy:
     => 5.505014632944949e-05
 ```
 
+### Whisper
+
+Whisper is a speech to text model that can be used to generate text based on an 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"
+```
+
+#### Transcribe
+
+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"
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/openai/client.rb

@@ -7,6 +7,10 @@ module OpenAI
       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: {})
       OpenAI::Client.json_post(path: "/completions", parameters: parameters)
     end
@@ -39,6 +43,14 @@ module OpenAI
       OpenAI::Client.json_post(path: "/moderations", parameters: parameters)
     end
 
+    def transcribe(parameters: {})
+      OpenAI::Client.multipart_post(path: "/audio/transcriptions", parameters: parameters)
+    end
+
+    def translate(parameters: {})
+      OpenAI::Client.multipart_post(path: "/audio/translations", parameters: parameters)
+    end
+
     def self.get(path:)
       HTTParty.get(
         uri(path: path),

data/lib/openai/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Alex
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-15 00:00:00.000000000 Z
+date: 2023-03-02 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.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: []