omniai 1.8.1 → 1.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cca8dd5cc19989ca0a3fc89d1e8f2c5a56611378a202ea8da2fd49528454ea6c
-  data.tar.gz: ee0abcf49b13df01ed5b63ed557de44d42d640fb966bcfb5c7592e19aff06f93
+  metadata.gz: 3aa80243c35a4c2b3ed765f36cc901778618686adba661bb807cd7bd5f698c62
+  data.tar.gz: a5b7a73edda5894f1461f50f6543f124fe628c800772a5b28cb28ecbe7ac2367
 SHA512:
-  metadata.gz: eb48e8f76d7cd1836ad8dc0ceb577362a3f289026749e2cc49044e31d25758a625ff66fe8003be12dc09585d9ee571671dd4f6d0b8c355cc7962eb4c136ec9f0
-  data.tar.gz: 41cf6419a3cf3c1662e2f6c5925ae5a05e991f6f2e8f81bcf3d5dfb62ad029bf3d6c32565892ef81acc651a43533dc3a7e9efb2c75922bbdddf28bb29e18b3c2
+  metadata.gz: f85926e78211149bd4d822e4685d0fda12fca80c54953f7a3c8ca18c404a9b97a64900f24f63401d5c81620d4f5867404486d41fd7390d674679044190198209
+  data.tar.gz: 9f85af9d52bf2d989332be7f0d81b9ca0fc15420de6ddfc1158787e9e2cebdff5d5c084b5135019e3588175d7392e884e2c41a02688317c628ea73b94ea5cdce

data/README.md

@@ -2,14 +2,142 @@
 
 [![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 of many different AIs:
+OmniAI standardizes the APIs of various AI / LLM companies such as Anthropic, Google, Mistral and OpenAI for the generation of text, the conversion of text-to-speech, the conversion of speech-to-text, the generation of embeddings, and more. It offers a unified API regardless of the provider and task.
 
 - [OmniAI::Anthropic](https://github.com/ksylvest/omniai-anthropic)
 - [OmniAI::Google](https://github.com/ksylvest/omniai-google)
 - [OmniAI::Mistral](https://github.com/ksylvest/omniai-mistral)
 - [OmniAI::OpenAI](https://github.com/ksylvest/omniai-openai)
 
-All libraries are community maintained.
+## Examples
+
+### Example #1: [Chat](https://github.com/ksylvest/omniai/blob/main/examples/chat)
+
+```ruby
+require 'omniai/anthropic'
+
+CLIENT = OmniAI::Anthropic::Client.new
+
+CAT_URL = 'https://images.unsplash.com/photo-1472491235688-bdc81a63246e?q=80&w=1024&h=1024&fit=crop&fm=jpg'
+DOG_URL = 'https://images.unsplash.com/photo-1517849845537-4d257902454a?q=80&w=1024&h=1024&fit=crop&fm=jpg'
+
+CLIENT.chat(stream: $stdout) do |prompt|
+  prompt.system('You are a helpful biologist with an expertise in animals that responds with the latin names.')
+  prompt.user do |message|
+    message.text('What animals are in the attached photos?')
+    message.url(CAT_URL, 'image/jpeg')
+    message.url(DOG_URL, 'image/jpeg')
+  end
+end
+```
+
+```
+The animals in the photos are:
+
+1. A cat (*Felis catus*).
+2. A dog (*Canis familiaris*).
+```
+
+### Example #2: [Text-to-Speech](https://github.com/ksylvest/omniai/blob/main/examples/text_to_speech)
+
+```ruby
+require 'omniai/openai'
+
+CLIENT = OmniAI::OpenAI::Client.new
+
+File.open(File.join(__dir__, 'audio.wav'), 'wb') do |file|
+  CLIENT.speak('Sally sells seashells by the seashore.', format: OmniAI::Speak::Format::WAV) do |chunk|
+    file << chunk
+  end
+end
+```
+
+### Example #3: [Speech-to-Text](https://github.com/ksylvest/omniai/blob/main/examples/speech_to_text)
+
+```ruby
+require 'omniai/openai'
+
+CLIENT = OmniAI::OpenAI::Client.new
+
+File.open(File.join(__dir__, 'audio.wav'), 'rb') do |file|
+  transcription = CLIENT.transcribe(file)
+  puts(transcription.text)
+end
+```
+
+### Example #4: [Tools](https://github.com/ksylvest/omniai/blob/main/examples/tools)
+
+```ruby
+require 'omniai/google'
+
+CLIENT = OmniAI::Google::Client.new
+
+TOOL = OmniAI::Tool.new(
+  proc { |location:, unit: 'celsius'| "#{rand(20..50)}° #{unit} in #{location}" },
+  name: 'Weather',
+  description: 'Lookup the weather in a location',
+  parameters: OmniAI::Tool::Parameters.new(
+    properties: {
+      location: OmniAI::Tool::Property.string(description: 'e.g. Toronto'),
+      unit: OmniAI::Tool::Property.string(enum: %w[celcius fahrenheit]),
+    },
+    required: %i[location]
+  )
+)
+
+completion = CLIENT.chat(tools: [TOOL]) do |prompt|
+  prompt.user do |message|
+    message.text('What is the weather in "London" in celcius and "Seattle" in fahrenheit?')
+  end
+end
+
+puts(completion.text)
+```
+
+```
+The weather is 24° celcius in London and 42° fahrenheit in Seattle.
+```
+
+### Example #5: [Embeddings](https://github.com/ksylvest/omniai/blob/main/examples/embeddings)
+
+```ruby
+require 'omniai/mistral'
+
+CLIENT = OmniAI::Mistral::Client.new
+
+Entry = Data.define(:text, :embedding) do
+  def initialize(text:)
+    super(text:, embedding: CLIENT.embed(text).embedding)
+  end
+end
+
+ENTRIES = [
+  Entry.new(text: 'John is a musician.'),
+  Entry.new(text: 'Paul is a plumber.'),
+  Entry.new(text: 'George is a teacher.'),
+  Entry.new(text: 'Ringo is a doctor.'),
+].freeze
+
+def search(query)
+  embedding = CLIENT.embed(query).embedding
+
+  results = ENTRIES.sort_by do |data|
+    Math.sqrt(data.embedding.zip(embedding).map { |a, b| (a - b)**2 }.reduce(:+))
+  end
+
+  puts "'#{query}': '#{results.first.text}'"
+end
+
+search('What does George do?')
+search('Who is a doctor?')
+search('Who do you call to fix a toilet?')
+```
+
+```
+'What does George do?': 'George is a teacher.'
+'Who is a doctor?': 'Ringo is a doctor.'
+'Who do you call to fix a toilet?': 'Paul is a plumber.'
+```
 
 ## Installation
 
@@ -83,7 +211,7 @@ require 'omniai/openai'
 require 'logger'
 
 logger = Logger.new(STDOUT)
-client = OmniAI::Example::Client.new(logger:)
+client = OmniAI::OpenAI::Client.new(logger:)
 ```
 
 ```

data/lib/omniai/chat/choice.rb

@@ -2,7 +2,8 @@
 
 module OmniAI
   class Chat
-    # For for.
+    # A choice wraps a message and index returned by an LLM. The default is to generate a single choice. Some LLMs
+    # support generating multiple choices at once (e.g. giving you multiple options to choose from).
     class Choice
       # @return [Integer]
       attr_accessor :index
@@ -12,7 +13,6 @@ module OmniAI
 
       # @param message [Message]
       # @param index [Integer]
-      # @param tool_call_list [Array<ToolCall>]
       def initialize(message:, index: 0)
         @message = message
         @index = index
@@ -59,7 +59,7 @@ module OmniAI
         message.content
       end
 
-      # @return [Array<ToolCall, nil]
+      # @return [Array<ToolCall>, nil]
       def tool_call_list
         message.tool_call_list
       end

data/lib/omniai/chat/prompt.rb

@@ -144,6 +144,24 @@ module OmniAI
       def user(content = nil, &)
         message(content, role: Role::USER, &)
       end
+
+      # @example
+      #   prompt.agent('the capital of Canada is Ottawa.')
+      #
+      # @example
+      #   prompt.agent do |message|
+      #     message.text 'the capital of Canada is Ottawa.'
+      #   end
+      #
+      # @param content [String, nil]
+      #
+      # @yield [builder]
+      # @yieldparam builder [Message::Builder]
+      #
+      # @return [Message]
+      def agent(content = nil, &)
+        message(content, role: Role::AGENT, &)
+      end
     end
   end
 end

data/lib/omniai/chat/tool_call_result.rb

@@ -11,7 +11,7 @@ module OmniAI
       attr_accessor :tool_call_id
 
       # @param content [Object]
-      # @param tool_call [ToolCall]
+      # @param tool_call_id [String]
       def initialize(content:, tool_call_id:)
         @content = content
         @tool_call_id = tool_call_id

data/lib/omniai/client.rb

@@ -75,15 +75,15 @@ module OmniAI
     # Initialize a client by provider (e.g. 'openai'). This method attempts to require the provider.
     #
     # @raise [OmniAI::Error] if the provider is not defined and the gem is not installed
-    # @param provider [String] required (e.g. 'anthropic', 'google', 'mistral', 'openai', etc)
+    # @param provider [String, Symbol] required (e.g. 'anthropic', 'google', 'mistral', 'openai', etc)
     # @return [OmniAI::Client]
     def self.find(provider:, **)
       klass =
         case provider
-        when 'anthropic' then anthropic
-        when 'google' then google
-        when 'mistral' then mistral
-        when 'openai' then openai
+        when :anthropic, 'anthropic' then anthropic
+        when :google, 'google' then google
+        when :mistral, 'mistral' then mistral
+        when :openai, 'openai' then openai
         else raise Error, "unknown provider=#{provider.inspect}"
         end
 

data/lib/omniai/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniai
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.8.3
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-17 00:00:00.000000000 Z
+date: 2024-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
+rubygems_version: 3.5.18
 signing_key: 
 specification_version: 4
 summary: A generalized framework for interacting with many AI services