omniai-openai 1.3.3 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5f48cc11134ffb023a4d1797a637ee1a0a6ae0365da799df07c484f177a58cb
-  data.tar.gz: 971a2c0524376bd64cf4c1e04b82ab0373b20314d11a06eb0ebc7113f6b9515f
+  metadata.gz: ccfa9de2275327a63e5e187d40050fe86c5c22098a1caf03418fd34e3bd87462
+  data.tar.gz: 163cbd9b4dab840e0d16dbb7677c4caab56552717a6dbba27afb3326832b70c6
 SHA512:
-  metadata.gz: c3765f6900534a23d7dc6033f0dc73dc31845494b938e33d345374e4e76ba16e300083cf1c2bedfc82ccc727a29636327092ea86b05f265eae40881de43fe0e8
-  data.tar.gz: b37e93448e1b3314724af029fcdca1f472b6a4e55b027a864079881d5139211b4f8001c0b805479af24ff6f69e586fd919d78bf10843d7de046ca525805e75e3
+  metadata.gz: 7ce15471f2609194788cfef73679e8c95bae0d9b011aecdc1087fe3f546239be4ca9053de3e4100808b403a34bb8d997a76a67d66b299afae426a812bd35f430
+  data.tar.gz: d0d1e276d090972077b51de2fab52f710fff7f2cd78b22a95cb3b7dbea23eac64d3d3f48d5f584abf3b108a24b8566946e23f81ccb78d92752b04fcd6067dd1e

data/Gemfile

@@ -5,7 +5,6 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake'
-
 gem 'rspec'
 gem 'rspec_junit_formatter'
 gem 'rubocop'
@@ -13,3 +12,4 @@ gem 'rubocop-rake'
 gem 'rubocop-rspec'
 gem 'simplecov'
 gem 'webmock'
+gem 'yard'

data/README.md

@@ -70,21 +70,10 @@ completion.choice.message.content # 'Why did the chicken cross the road? To get
 ```
 
 ```ruby
-completion = client.chat({
-  role: OmniAI::Chat::Role::USER,
-  content: 'Is it wise to jump off a bridge?'
-})
-completion.choice.message.content # 'No.'
-```
-
-```ruby
-completion = client.chat([
-  {
-    role: OmniAI::Chat::Role::SYSTEM,
-    content: 'You are a helpful assistant.'
-  },
-  'What is the capital of Canada?',
-])
+completion = client.chat do |prompt|
+  prompt.system('Your are an expert in geography.')
+  prompt.user('What is the capital of Canada?')
+end
 completion.choice.message.content # 'The capital of Canada is Ottawa.'
 ```
 
@@ -128,10 +117,10 @@ client.chat('Be poetic.', stream:)
 `format` takes an optional symbol (`:json`) and that setes the `response_format` to `json_object`:
 
 ```ruby
-completion = client.chat([
-  { role: OmniAI::Chat::Role::SYSTEM, content: OmniAI::Chat::JSON_PROMPT },
-  { role: OmniAI::Chat::Role::USER, content: 'What is the name of the drummer for the Beatles?' }
-], format: :json)
+completion = client.chat(format: :json) do |prompt|
+  prompt.system(OmniAI::Chat::JSON_PROMPT)
+  prompt.user('What is the name of the drummer for the Beatles?')
+end
 JSON.parse(completion.choice.message.content) # { "name": "Ringo" }
 ```
 

data/lib/omniai/openai/chat.rb

@@ -3,6 +3,14 @@
 module OmniAI
   module OpenAI
     # An OpenAI chat implementation.
+    #
+    # Usage:
+    #
+    #   completion = OmniAI::OpenAI::Chat.process!(client: client) do |prompt|
+    #     prompt.system('You are an expert in the field of AI.')
+    #     prompt.user('What are the biggest risks of AI?')
+    #   end
+    #   completion.choice.message.content # '...'
     class Chat < OmniAI::Chat
       JSON_RESPONSE_FORMAT = { type: 'json_object' }.freeze
 
@@ -20,11 +28,12 @@ module OmniAI
       # @return [Hash]
       def payload
         OmniAI::OpenAI.config.chat_options.merge({
-          messages:,
+          messages: @prompt.serialize,
           model: @model,
           stream: @stream.nil? ? nil : !@stream.nil?,
           temperature: @temperature,
           response_format: (JSON_RESPONSE_FORMAT if @format.eql?(:json)),
+          tools: @tools&.map(&:prepare),
         }).compact
       end
 

data/lib/omniai/openai/client.rb

@@ -67,10 +67,11 @@ module OmniAI
       # @param format [Symbol] optional :text or :json
       # @param temperature [Float, nil] optional
       # @param stream [Proc, nil] optional
+      # @param tools [Array<OmniAI::Tool>, nil] optional
       #
       # @return [OmniAI::Chat::Completion]
-      def chat(messages, model: Chat::DEFAULT_MODEL, temperature: nil, format: nil, stream: nil)
-        Chat.process!(messages, model:, temperature:, format:, stream:, client: self)
+      def chat(messages, model: Chat::DEFAULT_MODEL, temperature: nil, format: nil, stream: nil, tools: nil)
+        Chat.process!(messages, model:, temperature:, format:, stream:, tools:, client: self)
       end
 
       # @raise [OmniAI::Error]
@@ -82,7 +83,7 @@ module OmniAI
       # @param temperature [Float, nil] optional
       # @param format [Symbol] :text, :srt, :vtt, or :json (default)
       #
-      # @return text [OmniAI::Transcribe::Transcription]
+      # @return [OmniAI::Transcribe]
       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

data/lib/omniai/openai/thread/messages.rb

@@ -34,7 +34,6 @@ module OmniAI
         # @param content [String, Array, nil] optional
         # @param attachments [Array, nil] optional
         # @param metadata [Hash, nil] optional
-        # @param client [OmniAI::OpenAI::Client] optional
         # @return [OmniAI::OpenAI::Thread::Message]
         def build(role: nil, content: nil, attachments: [], metadata: {})
           Message.new(role:, content:, attachments:, metadata:, thread_id: @thread.id, client: @client)

data/lib/omniai/openai/thread/run.rb

@@ -183,7 +183,7 @@ module OmniAI
           self
         end
 
-        # @param interval [Integer, Float, nil] optional (seconds)
+        # @param delay [Numeric, nil] optional (seconds)
         #
         # @return [OmniAI::OpenAI::Thread::Run]
         def poll!(delay: 2)

data/lib/omniai/openai/thread/runs.rb

@@ -31,12 +31,11 @@ module OmniAI
         end
 
         # @param assistant_id [String] required
-        # @param model [String] optional
-        # @param temperature [Float] optional
-        # @param instructions [String] optional
+        # @param model [String, nil] optional
+        # @param temperature [Float, nil] optional
+        # @param instructions [String, nil] optional
         # @param tools [Array<Hash>, nil] optional
         # @param metadata [Hash, nil] optional
-        # @param client [OmniAI::OpenAI::Client] optional
         # @return [OmniAI::OpenAI::Thread::Message]
         def build(assistant_id:, model: nil, temperature: nil, instructions: nil, tools: nil, metadata: {})
           Run.new(

data/lib/omniai/openai/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAI
   module OpenAI
-    VERSION = '1.3.3'
+    VERSION = '1.6.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniai-openai
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.6.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-25 00:00:00.000000000 Z
+date: 2024-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -105,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.14
 signing_key: 
 specification_version: 4
 summary: A generalized framework for interacting with OpenAI