omniai-openai 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32b555cd7f80abb2cc11a12986a0a8df15e5c1d9b6d31113f5e00b47174f4ec6
-  data.tar.gz: 81046a31442f6f2b1a1eb5d37723deefbb82cf7c145907ae0bb72db738e09080
+  metadata.gz: 7cb12222b6c13b368f2f25d55c66ff57e98114830a32bdd54ee82947aaf38674
+  data.tar.gz: 7600584957b977be573321a25a995f720fde9e9112fdd3e1b8676ce3d75461e0
 SHA512:
-  metadata.gz: '0939f67a3bc54221fc1141b00ab8eb1c38323178da2c3c78057cd25a288df776397eb204c18f5425005a92f05556a67b28b902b6520716c359b7901a70d7e183'
-  data.tar.gz: 7611023c850321bec21b71dfb626b5c308905e55a1485d5c965d1e31f2e9ced8fa09929ada98eff681a933499e5735b88243c404cf7452c2fbf0aab3fd515606
+  metadata.gz: 75f8bdbfff09e789058e15bf962efcbbe0146b3e522e5efc701ca1303ef734b68f6d19094502c2e8fd89f5db213687b6c5001967e3dfd1b46eaab060b4c4e4c0
+  data.tar.gz: 5b206397432e32277bda4767bad41707699607cf93e9a396570cbe78ab668f42b5c34c75f99d26d93cccd042b9c08359a899a4f375fabae7fc6c55a587515550

data/README.md

@@ -268,8 +268,17 @@ client.files.all
 
 ### Uploading a File
 
+#### Using a File
+
+```ruby
+file = client.files.build(io: File.open('demo.pdf', 'wb'))
+file.save!
+```
+
+#### Using a Path
+
 ```ruby
-file = client.files.build(io: File.open('...', 'wb'))
+file = client.files.build(io: 'demo.pdf'))
 file.save!
 ```
 
@@ -428,6 +437,15 @@ run.metadata = { user: 'Ringo' }
 run.save!
 ```
 
+#### Polling a Run
+
+```ruby
+run.terminated? # false
+run.poll!
+run.terminated? # true
+run.status # 'cancelled' / 'failed' / 'completed' / 'expired'
+```
+
 #### Cancelling a Run
 
 ```ruby

data/lib/omniai/openai/assistant.rb

@@ -49,7 +49,7 @@ module OmniAI
         client: Client.new,
         id: nil,
         name: nil,
-        model: nil,
+        model: OmniAI::Chat::DEFAULT_MODEL,
         description: nil,
         instructions: nil,
         metadata: {},

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

@@ -14,7 +14,7 @@ module OmniAI
 
         # @param limit [Integer] optional
         # @return [Array<OmniAI::Thread::Message>]
-        def all(limit:)
+        def all(limit: nil)
           Message.all(thread_id: @thread.id, limit:, client: @client)
         end
 

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

@@ -5,6 +5,20 @@ module OmniAI
     class Thread
       # An OpenAI run within a thread.
       class Run
+        module Status
+          CANCELLED = 'cancelled'
+          FAILED = 'failed'
+          COMPLETED = 'completed'
+          EXPIRED = 'expired'
+        end
+
+        TERMINATED_STATUSES = [
+          Status::CANCELLED,
+          Status::FAILED,
+          Status::COMPLETED,
+          Status::EXPIRED,
+        ].freeze
+
         # @!attribute [rw] id
         #   @return [String, nil]
         attr_accessor :id
@@ -143,6 +157,22 @@ module OmniAI
           self
         end
 
+        # @raise [HTTPError]
+        # @return [OmniAI::OpenAI::Thread]
+        def reload!
+          raise Error, 'unable to fetch! without an ID' unless @id
+
+          response = @client.connection
+            .accept(:json)
+            .headers(HEADERS)
+            .get(path)
+
+          raise HTTPError, response.flush unless response.status.ok?
+
+          parse(data: response.parse)
+          self
+        end
+
         # @raise [OmniAI::Error]
         # @return [OmniAI::OpenAI::Thread]
         def cancel!
@@ -153,6 +183,23 @@ module OmniAI
           self
         end
 
+        # @param interval [Integer, Float, nil] optional (seconds)
+        #
+        # @return [OmniAI::OpenAI::Thread::Run]
+        def poll!(delay: 2)
+          loop do
+            reload!
+            break if terminated?
+
+            sleep(delay) if delay
+          end
+        end
+
+        # @return [Boolean]
+        def terminated?
+          TERMINATED_STATUSES.include?(@status)
+        end
+
         private
 
         class << self

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

@@ -14,7 +14,7 @@ module OmniAI
 
         # @param limit [Integer] optional
         # @return [Array<OmniAI::Thread::Message>]
-        def all(limit:)
+        def all(limit: nil)
           Run.all(thread_id: @thread.id, limit:, client: @client)
         end
 

data/lib/omniai/openai/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAI
   module OpenAI
-    VERSION = '1.3.1'
+    VERSION = '1.3.2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniai-openai
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Kevin Sylvestre