omniai-openai 1.0.2 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 667d8318e96d3e6611a3ca20ced5dcefefc0896a4c84c48427ce441756cb9e60
-  data.tar.gz: 13161c5726cc33fcc7934a4164f751244b3c577fb52a1cdf30301dc10f733c84
+  metadata.gz: 8fa0f1acc820456282d48d42e9bc1154f8aa9b83fe9fa86817e1d3446a8cd31d
+  data.tar.gz: cd4c84c579985a17c96edadcb91324b545035bf170fb20c3172855e13e83586c
 SHA512:
-  metadata.gz: d44485bdcebe5ee67a846c4517ea62fdb4fd98dfbab464f64fd10316561a396369ce5579367c8f073d79edfee0a790baa46c2fc31dfd2a4522221f0d16679a23
-  data.tar.gz: 2f1054f58e35f37012bc6b95f7605b0eeee01010718c2446a14b623b37cde0028d08ed56330d10bf1145fe5dfa69c3c138f54f5ec7d2bf65e55eb4727a21c664
+  metadata.gz: c4583c5da031c749e56b6ec2bbcf59daaebe8f873c5fe9a9cbdfdfb67acf8d8eabc798a754fe5e2784fd73495bb91181deb3e323d00e0e84d962ff86624192a5
+  data.tar.gz: fcf7612d1f7361697820a3e14cf5558fe83fb096b1154a5c3a67c3c6c64823d230e1c1d029252ee91fa0e9cd26bbba398fc18612189171db891d47a830536266

data/Gemfile

@@ -11,4 +11,5 @@ gem 'rspec_junit_formatter'
 gem 'rubocop'
 gem 'rubocop-rake'
 gem 'rubocop-rspec'
+gem 'simplecov'
 gem 'webmock'

data/README.md

@@ -1,5 +1,7 @@
 # OmniAI::OpenAI
 
+[![CircleCI](https://circleci.com/gh/ksylvest/omniai-openai.svg?style=svg)](https://circleci.com/gh/ksylvest/omniai-openai)
+
 An OpenAI implementation of the [OmniAI](https://github.com/ksylvest/omniai) APIs.
 
 ## Installation
@@ -116,3 +118,116 @@ JSON.parse(completion.choice.message.content) # { "name": "Ringo" }
 [OpenAI API Reference `response_format`](https://platform.openai.com/docs/api-reference/chat/create#chat-create-stream)
 
 > When using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message.
+
+### Transcribe
+
+A transcription is generated by passing in a path to a file:
+
+```ruby
+transcription = client.transcribe(file.path)
+transcription.text # '...'
+```
+
+#### Prompt
+
+`prompt` is optional and can provide additional context for transcribing:
+
+```ruby
+transcription = client.transcribe(file.path, prompt: '')
+transcription.text # '...'
+```
+
+[OpenAI API Reference `prompt`](https://platform.openai.com/docs/api-reference/audio/createTranscription#audio-createtranscription-prompt)
+
+#### Format
+
+`format` is optional and supports `json`, `text`, `srt` or `vtt`:
+
+```ruby
+transcription = client.transcribe(file.path, format: OmniAI::Transcribe::Format::TEXT)
+transcription.text # '...'
+```
+
+[OpenAI API Reference `response_format`](https://platform.openai.com/docs/api-reference/audio/createTranscription#audio-createtranscription-response_format)
+
+#### Language
+
+`language` is optional and may improve accuracy and latency:
+
+```ruby
+transcription = client.transcribe(file.path, language: OmniAI::Transcribe::Language::SPANISH)
+transcription.text
+```
+
+[OpenAI API Reference `language`](https://platform.openai.com/docs/api-reference/audio/createTranscription#audio-createtranscription-language)
+
+#### Temperature
+
+`temperature` is optional and must be between 0.0 (more deterministic) and 1.0 (less deterministic):
+
+```ruby
+transcription = client.transcribe(file.path, temperature: 0.2)
+transcription.text
+```
+
+[OpenAI API Reference `temperature`](https://platform.openai.com/docs/api-reference/audio/createTranscription#audio-createtranscription-temperature)
+
+### Speak
+
+Speech can be generated by passing text with a block:
+
+```ruby
+File.open('example.ogg', 'wb') do |file|
+  client.speak('How can a clam cram in a clean cream can?') do |chunk|
+    file << chunk
+  end
+end
+```
+
+If a block is not provided then a tempfile is returned:
+
+```ruby
+tempfile = client.speak('Can you can a can as a canner can can a can?')
+tempfile.close
+tempfile.unlink
+```
+
+#### Voice
+
+`voice` is optional and must be one of the supported voices:
+
+```ruby
+client.speak('She sells seashells by the seashore.', voice: OmniAI::OpenAI::Speak::Voice::SHIMMER)
+```
+
+[OpenAI API Reference `voice`](https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-voice)
+
+#### Model
+
+`model` is optional and must be either `tts-1` or `tts-1-hd` (default):
+
+```ruby
+client.speak('I saw a kitten eating chicken in the kitchen.', format: OmniAI::OpenAI::Speak::Model::TTS_1)
+```
+
+[OpenAI API Refernce `model`](https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-model)
+
+#### Speed
+
+`speed` is optional and must be between 0.25 and 0.40:
+
+```ruby
+client.speak('How much wood would a woodchuck chuck if a woodchuck could chuck wood?', speed: 4.0)
+```
+
+[OmniAI API Reference `speed`](https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-speed)
+
+#### Format
+
+`format` is optional and supports `MP3` (default), `OPUS`, `AAC`, `FLAC`, `WAV` or `PCM`:
+
+```ruby
+client.speak('A pessemistic pest exists amidst us.', format: OmniAI::OpenAI::Speak::Format::FLAC)
+```
+
+[OpenAI API Reference `format`](https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-response_format)

data/lib/omniai/openai/client.rb

@@ -64,6 +64,41 @@ module OmniAI
       def chat(messages, model: Chat::Model::GPT_4O, temperature: nil, format: nil, stream: nil)
         Chat.process!(messages, model:, temperature:, format:, stream:, client: self)
       end
+
+      # @raise [OmniAI::Error]
+      #
+      # @param path [String]
+      # @param model [String]
+      # @param language [String, nil] optional
+      # @param prompt [String, nil] optional
+      # @param temperature [Float, nil] optional
+      # @param format [Symbol] :text, :srt, :vtt, or :json (default)
+      #
+      # @return text [OmniAI::Transcribe::Transcription]
+      def transcribe(path, model: Transcribe::Model::WHISPER, language: nil, prompt: nil, temperature: nil, format: nil)
+        Transcribe.process!(path, model:, language:, prompt:, temperature:, format:, client: self)
+      end
+
+      # @raise [OmniAI::Error]
+      #
+      # @param input [String] required
+      # @param model [String] optional
+      # @param voice [String] optional
+      # @param speed [Float] optional
+      # @param format [String] optional (default "aac"):
+      #   - "aac"
+      #   - "mp3"
+      #   - "flac"
+      #   - "opus"
+      #   - "pcm"
+      #   - "wav"
+      #
+      # @yield [output] optional
+      #
+      # @return [Tempfile``]
+      def speak(input, model: Speak::Model::TTS_1_HD, voice: Speak::Voice::ALLOY, speed: nil, format: nil, &)
+        Speak.process!(input, model:, voice:, speed:, format:, client: self, &)
+      end
     end
   end
 end

data/lib/omniai/openai/config.rb

@@ -4,7 +4,7 @@ module OmniAI
   module OpenAI
     # Configuration for managing the OpenAI `api_key` / `organization` / `project` / `logger`.
     class Config < OmniAI::Config
-      attr_accessor :organization, :project, :chat_options
+      attr_accessor :organization, :project, :chat_options, :transcribe_options, :speak_options
 
       def initialize
         super
@@ -13,6 +13,8 @@ module OmniAI
         @project = ENV.fetch('OPENAI_PROJECT', nil)
         @host = ENV.fetch('OPENAI_HOST', 'https://api.openai.com')
         @chat_options = {}
+        @transcribe_options = {}
+        @speak_options = {}
       end
     end
   end

data/lib/omniai/openai/speak.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module OpenAI
+    # An OpenAI transcribe implementation.
+    class Speak < OmniAI::Speak
+      module Model
+        TTS_1 = 'tts-1'
+        TTS_1_HD = 'tts-1-hd'
+      end
+
+      module Voice
+        ALLOY = 'alloy' # https://platform.openai.com/docs/guides/text-to-speech/alloy
+        ECHO = 'echo' # https://platform.openai.com/docs/guides/text-to-speech/echo
+        FABLE = 'fable' # https://platform.openai.com/docs/guides/text-to-speech/fable
+        NOVA = 'nova' # https://platform.openai.com/docs/guides/text-to-speech/nova
+        ONYX = 'onyx' # https://platform.openai.com/docs/guides/text-to-speech/onyx
+        SHIMMER = 'shimmer' # https://platform.openai.com/docs/guides/text-to-speech/shimmer
+      end
+
+      protected
+
+      # @return [Hash]
+      def payload
+        OmniAI::OpenAI
+          .config.speak_options
+          .merge(super)
+          .merge({ response_format: @format }.compact)
+      end
+
+      # @return [String]
+      def path
+        "/#{OmniAI::OpenAI::Client::VERSION}/audio/speech"
+      end
+    end
+  end
+end

data/lib/omniai/openai/transcribe.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module OpenAI
+    # An OpenAI transcribe implementation.
+    class Transcribe < OmniAI::Transcribe
+      module Model
+        WHISPER_1 = 'whisper-1'
+        WHISPER = WHISPER_1
+      end
+
+      protected
+
+      # @return [Hash]
+      def payload
+        OmniAI::OpenAI
+          .config.transcribe_options
+          .merge(super)
+          .merge({ response_format: @format || Format::JSON })
+      end
+
+      # @return [String]
+      def path
+        "/#{OmniAI::OpenAI::Client::VERSION}/audio/transcriptions"
+      end
+    end
+  end
+end

data/lib/omniai/openai/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAI
   module OpenAI
-    VERSION = '1.0.2'
+    VERSION = '1.1.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniai-openai
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.1
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-15 00:00:00.000000000 Z
+date: 2024-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -65,6 +65,8 @@ files:
 - lib/omniai/openai/chat.rb
 - lib/omniai/openai/client.rb
 - lib/omniai/openai/config.rb
+- lib/omniai/openai/speak.rb
+- lib/omniai/openai/transcribe.rb
 - lib/omniai/openai/version.rb
 homepage: https://github.com/ksylvest/omniai-openai
 licenses: []