omniai 1.1.2 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: facf65abfc03bc2fedc0572bbdebe5baca776da08b3eba9f4bde4b082bf037a7
-  data.tar.gz: 265613b4ab126f34d68d079241d8f4d2eae96c3e5c4f083aa9ff2761003a5678
+  metadata.gz: 62558072fec9583fe2df59e34498e31b449fc551a7d262a21ad45c1aa8bef721
+  data.tar.gz: 2b410f4fdccea4fdae2d839c60f703cbf311c3ad9b43f4f87b862f719c5e2ca8
 SHA512:
-  metadata.gz: a689d6591eabb97d47fea58a73c2b7fcc133c62aea51180bffe846976086b3819099708757cae85e20c5db3e38964b9dc7c0dc1cbc9fa8b076bc322a56dec4cb
-  data.tar.gz: bc80184100a4ca2888fb8a0ee3b93ac8d9d301e875e541e692b9a08564eb85fa59d58fcd88e35c4d72142624621ef73174b276c8da95ae53bfcabd1fc1ae776d
+  metadata.gz: 5d975d4d7767392a20cab800bbcc17c988ae18adf0d6c31c816e99ab6b33cbeb9fac319d6e15bdbd425da3e00d2843c28004223f24c3471c1e2c60c55428fba4
+  data.tar.gz: e9967f2302492db51c6af31c101a908bf19392d5eefe87829a2d146431ea6d17b6d3516493a92beeae780b75cfb0e61a7214ddfd52817df5199f6d1e9b36642e

data/README.md

@@ -1,6 +1,8 @@
 # OmniAI
 
-OmniAI is a flexible AI library that standardizes the APIs for multipe AI providers:
+[![CircleCI](https://circleci.com/gh/ksylvest/omniai.svg?style=svg)](https://circleci.com/gh/ksylvest/omniai)
+
+OmniAI is a flexible AI library that standardizes the APIs for multiple AI providers:
 
 - [OmniAI::Anthropic](https://github.com/ksylvest/omniai-anthropic)
 - [OmniAI::Google](https://github.com/ksylvest/omniai-google)
@@ -29,7 +31,7 @@ OmniAI implements APIs for a number of popular clients by default. A client can
 #### [OmniAI::Anthropic](https://github.com/ksylvest/omniai-anthropic)
 
 ```ruby
-require 'omniai-anthropic'
+require 'omniai/anthropic'
 
 client = OmniAI::Anthropic::Client.new
 ```
@@ -37,7 +39,7 @@ client = OmniAI::Anthropic::Client.new
 #### [OmniAI::Google](https://github.com/ksylvest/omniai-google)
 
 ```ruby
-require 'omniai-google'
+require 'omniai/google'
 
 client = OmniAI::Google::Client.new
 ```
@@ -45,7 +47,7 @@ client = OmniAI::Google::Client.new
 #### [OmniAI::Mistral](https://github.com/ksylvest/omniai-mistral)
 
 ```ruby
-require 'omniai-mistral'
+require 'omniai/mistral'
 
 client = OmniAI::Mistral::Client.new
 ```
@@ -53,7 +55,7 @@ client = OmniAI::Mistral::Client.new
 #### [OmniAI::OpenAI](https://github.com/ksylvest/omniai-openai)
 
 ```ruby
-require 'omniai-openai'
+require 'omniai/openai'
 
 client = OmniAI::OpenAI::Client.new
 ```
@@ -62,19 +64,19 @@ client = OmniAI::OpenAI::Client.new
 
 Clients that support chat (e.g. Anthropic w/ "Claude", Google w/ "Gemini", Mistral w/ "LeChat", OpenAI w/ "ChatGPT", etc) generate completions using the following calls:
 
-#### w/ a Simple Prompt
+#### Completions using Single Message
 
 ```ruby
 completion = client.chat('Tell me a joke.')
 completion.choice.message.content # '...'
 ```
 
-#### w/ a Collection of Messages
+#### Completions using Multiple Messages
 
 ```ruby
 messages = [
   {
-    role: 'system',
+    role: OmniAI::Chat::Role::SYSTEM,
     content: 'You are a helpful assistant with an expertise in geography.',
   },
   'What is the capital of Canada?'
@@ -83,27 +85,7 @@ completion = client.chat(messages, model: '...', temperature: 0.7, format: :json
 completion.choice.message.content  # '...'
 ```
 
-#### w/ a Collection of Files
-
-```ruby
-
-image_a_url = "https://images.unsplash.com/photo-1517849845537-4d257902454a?w=800&h=800&format=jpeg&fit=crop"
-image_b_url = "https://images.unsplash.com/photo-1537151625747-768eb6cf92b2?q=80&w=1024&h=1024&format=jpeg"
-
-message = {
-  role: 'user',
-  content: [
-    OmniAI::Chat::Content.new('What are in these images and are they different?'),
-    OmniAI::Chat::Content.new(image_a_url, type: :image),
-    OmniAI::Chat::Content.new(image_b_url, type: :image),
-  ]
-}
-
-completion = client.chat(message)
-completion.choice.message.content  # '...'
-```
-
-#### Streaming
+#### Completions using Real-Time Streaming
 
 ```ruby
 stream = proc do |chunk|
@@ -116,7 +98,17 @@ client.chat('Tell me a joke.', stream:)
 
 Clients that support chat (e.g. OpenAI w/ "Whisper", etc) convert recordings to text via the following calls:
 
+#### Transcriptions with Path
+
+```ruby
+transcription = client.transcribe("example.ogg")
+transcription.text # '...'
+```
+
+#### Transcriptions with Files
+
 ```ruby
-transcription = client.transcribe(file.path)
+file = File.open("example.ogg", "rb")
+transcription = client.transcribe(file)
 transcription.text # '...'
 ```

data/lib/omniai/chat/choice.rb

@@ -16,7 +16,9 @@ module OmniAI
         new(index:, delta:, message:)
       end
 
-      # @param data [Hash]
+      # @param index [Integer]
+      # @param delta [OmniAI::Chat::Delta] optional
+      # @param message [OmniAI::Chat::Message] optional
       def initialize(index:, delta:, message:)
         @index = index
         @delta = delta

data/lib/omniai/chat/chunk.rb

@@ -36,7 +36,7 @@ module OmniAI
         @choices ||= @data['choices'].map { |data| Choice.for(data:) }
       end
 
-      # @param [index] [Integer]
+      # @param index [Integer]
       # @return [OmniAI::Chat::Delta]
       def choice(index: 0)
         choices[index]

data/lib/omniai/chat/completion.rb

@@ -43,7 +43,7 @@ module OmniAI
         @choices ||= @data['choices'].map { |data| Choice.for(data:) }
       end
 
-      # @param [index] [Integer] optional - default is 0
+      # @param index [Integer] optional - default is 0
       # @return [OmniAI::Chat::Choice]
       def choice(index: 0)
         choices[index]

data/lib/omniai/chat/content.rb

@@ -6,8 +6,7 @@ module OmniAI
     class Content
       attr_accessor :type, :value
 
-      # @param url [String]
-      # @param text [String]
+      # @param value [String]
       # @param type [Symbol] :image / :video / :audio / :text
       def initialize(value, type: :text)
         @value = value

data/lib/omniai/chat/stream.rb

@@ -5,7 +5,6 @@ module OmniAI
     # A stream given when streaming.
     class Stream
       # @param response [HTTP::Response]
-      # @param block [Proc]
       def initialize(response:)
         @response = response
         @parser = EventStreamParser::Parser.new

data/lib/omniai/client.rb

@@ -48,7 +48,7 @@ module OmniAI
 
     # @raise [OmniAI::Error]
     #
-    # @param file [IO]
+    # @param io [String, Pathname, IO] required
     # @param model [String]
     # @param language [String, nil] optional
     # @param prompt [String, nil] optional
@@ -56,7 +56,7 @@ module OmniAI
     # @param format [Symbol] :text, :srt, :vtt, or :json (default)
     #
     # @return text [OmniAI::Transcribe::Transcription]
-    def transcribe(file, model:, language: nil, prompt: nil, temperature: nil, format: nil)
+    def transcribe(io, model:, language: nil, prompt: nil, temperature: nil, format: nil)
       raise NotImplementedError, "#{self.class.name}#speak undefined"
     end
   end

data/lib/omniai/transcribe.rb

@@ -96,15 +96,15 @@ module OmniAI
       new(...).process!
     end
 
-    # @param path [String] required
+    # @param io [String, Pathname, IO] required
     # @param client [OmniAI::Client] the client
     # @param model [String] required
     # @param language [String, nil] optional
     # @param prompt [String, nil] optional
     # @param temperature [Float, nil] optional
     # @param format [String, nil] optional
-    def initialize(path, client:, model:, language: nil, prompt: nil, temperature: nil, format: Format::JSON)
-      @path = path
+    def initialize(io, client:, model:, language: nil, prompt: nil, temperature: nil, format: Format::JSON)
+      @io = io
       @model = model
       @language = language
       @prompt = prompt
@@ -128,7 +128,7 @@ module OmniAI
     # @return [Hash]
     def payload
       {
-        file: HTTP::FormData::File.new(@path),
+        file: HTTP::FormData::File.new(@io),
         model: @model,
         language: @language,
         prompt: @prompt,

data/lib/omniai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OmniAI
-  VERSION = '1.1.2'
+  VERSION = '1.1.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniai
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.4
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-17 00:00:00.000000000 Z
+date: 2024-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -80,7 +80,8 @@ files:
 - lib/omniai/transcribe/transcription.rb
 - lib/omniai/version.rb
 homepage: https://github.com/ksylvest/omniai
-licenses: []
+licenses:
+- MIT
 metadata:
   homepage_uri: https://github.com/ksylvest/omniai
   changelog_uri: https://github.com/ksylvest/omniai/releases