ruby-openai 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3d2b8f98be44b7f33fce40f271bccc3dc1c72237df7ad64baed43f4ea79fb51
-  data.tar.gz: f19cc5e7155b47e6f7ccb7c5642679e5d8f7a6600e6d4f9e592ebc16313b74f0
+  metadata.gz: dfe7d331fc5d5a16f74089b9395232cd1abf0d6b05bd78be4db91e1b65d71a4c
+  data.tar.gz: 610d363ebf1d6a53f015aeaf20cd551c1020731fd423ba4074ff3eb044239fa1
 SHA512:
-  metadata.gz: 8f2c05fae48718593ea7990c480f6108844a698a943c8db2e3e01f3e31e95ede1ca2a5bd0dec5364a9b1730698c3802e24eecec585d20e59b03e1a421c8a3c4e
-  data.tar.gz: 303d6df6cea50a4f9ac50f8cab7329e585e201aeb2532709b161b830896cc1e733e0c48dfa6ebff22d13d930c3a0ff76425b8e0294c7e175a1bc4e07b84710a2
+  metadata.gz: '08b25f159fc149ccd09034da891cf5e77c999964a6d06ea6d916c62ad3e4a9ba2b1aa73757b617c0152ca1760f386514da081e978a6ca9963706f3f385814b78'
+  data.tar.gz: 144bd11f3791fa818193eaab7d8eeb6b04c33f4b99342ca573acea76f0ffcef4604033daaea54b2ae43411abf84e572db97304f7195c08116a55fedd1524d2aa

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.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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-openai (3.4.0)
+    ruby-openai (3.5.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, 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
 
@@ -267,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

@@ -43,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.4.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.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Alex
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-01 00:00:00.000000000 Z
+date: 2023-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty