omniai-openai 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17b76524bf985fda37fec8e7cea18aece3380a1831be7de6abe2652767aafc92
-  data.tar.gz: e32a791f07f2697f56f2dfa15f11e8b05abf4416610925880d12cc7b5d0dda90
+  metadata.gz: f35b8f18f1fed4fc62a4d69d1ec9d94b7b93dfe6d7110e9f64369625cafd8702
+  data.tar.gz: 746528fa3065f9f843bafb9b82946dda6d57bb121b81bbf6a8f4c43e72e1888e
 SHA512:
-  metadata.gz: 9aa657f83ece505e056597a36c73a77f24abc45af4094c5e982b949bc9631ba6a401ff410220855c43073232578bda7fe37ed7003e006259caaf8d1333825dab
-  data.tar.gz: a96fe7cb53c737220b21c43013af12fab828476336827c446bfb12e64b02340ef55cac0a762facd0d5103db8afad078bf72b94fe760bbda2d36437eeee68468b
+  metadata.gz: 4a11987f0c6dceeed121166820240c9c878ddc7f88b7c2cf2598c5f14ed5cdc1d6730d3463396f4c56b38f37d7ac4d983b7af461afd00c58db613a58b887d075
+  data.tar.gz: 129bd67690492743d3945fc15da22d5b9f4ec1bc384c56d8dcd2d60d1fd0419f802c6b804cbf154efdd4828d5e42220a30f890d58c08f9aaa634c1c8ba8bfa20

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

@@ -49,7 +49,7 @@ completion.choice.message.content # 'Why did the chicken cross the road? To get
 
 ```ruby
 completion = client.chat.completion({
-  role: OmniAI::OpenAI::Chat::Role::USER,
+  role: OmniAI::Chat::Role::USER,
   content: 'Is it wise to jump off a bridge?'
 })
 completion.choice.message.content # 'No.'
@@ -58,7 +58,7 @@ completion.choice.message.content # 'No.'
 ```ruby
 completion = client.chat.completion([
   {
-    role: OmniAI::OpenAI::Chat::Role::SYSTEM,
+    role: OmniAI::Chat::Role::SYSTEM,
     content: 'You are a helpful assistant.'
   },
   'What is the capital of Canada?',
@@ -116,3 +116,56 @@ 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)

data/lib/omniai/openai/client.rb

@@ -64,6 +64,20 @@ 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
     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
 
       def initialize
         super
@@ -13,6 +13,7 @@ module OmniAI
         @project = ENV.fetch('OPENAI_PROJECT', nil)
         @host = ENV.fetch('OPENAI_HOST', 'https://api.openai.com')
         @chat_options = {}
+        @transcribe_options = {}
       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.1'
+    VERSION = '1.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniai-openai
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Kevin Sylvestre
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-14 00:00:00.000000000 Z
+date: 2024-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -65,6 +65,7 @@ files:
 - lib/omniai/openai/chat.rb
 - lib/omniai/openai/client.rb
 - lib/omniai/openai/config.rb
+- lib/omniai/openai/transcribe.rb
 - lib/omniai/openai/version.rb
 homepage: https://github.com/ksylvest/omniai-openai
 licenses: []
@@ -72,7 +73,7 @@ metadata:
   homepage_uri: https://github.com/ksylvest/omniai-openai
   changelog_uri: https://github.com/ksylvest/omniai-openai/releases
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -87,8 +88,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.5.3
+signing_key: 
 specification_version: 4
 summary: A generalized framework for interacting with OpenAI
 test_files: []