omniai-openai 1.3.1 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32b555cd7f80abb2cc11a12986a0a8df15e5c1d9b6d31113f5e00b47174f4ec6
-  data.tar.gz: 81046a31442f6f2b1a1eb5d37723deefbb82cf7c145907ae0bb72db738e09080
+  metadata.gz: c5f48cc11134ffb023a4d1797a637ee1a0a6ae0365da799df07c484f177a58cb
+  data.tar.gz: 971a2c0524376bd64cf4c1e04b82ab0373b20314d11a06eb0ebc7113f6b9515f
 SHA512:
-  metadata.gz: '0939f67a3bc54221fc1141b00ab8eb1c38323178da2c3c78057cd25a288df776397eb204c18f5425005a92f05556a67b28b902b6520716c359b7901a70d7e183'
-  data.tar.gz: 7611023c850321bec21b71dfb626b5c308905e55a1485d5c965d1e31f2e9ced8fa09929ada98eff681a933499e5735b88243c404cf7452c2fbf0aab3fd515606
+  metadata.gz: c3765f6900534a23d7dc6033f0dc73dc31845494b938e33d345374e4e76ba16e300083cf1c2bedfc82ccc727a29636327092ea86b05f265eae40881de43fe0e8
+  data.tar.gz: b37e93448e1b3314724af029fcdca1f472b6a4e55b027a864079881d5139211b4f8001c0b805479af24ff6f69e586fd919d78bf10843d7de046ca525805e75e3

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/annotation.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module OpenAI
+    class Thread
+      # An OpenAI content w/ annotations.
+      class Annotation
+        # @!attribute [rw] data
+        #   @return [Hash, nil]
+        attr_accessor :data
+
+        # @param data [Hash] required
+        # @param client [OmniAI::OpenAI::Client] optional
+        def initialize(data:, client: Client.new)
+          @data = data
+          @client = client
+        end
+
+        # @return [String] "file_citation" or "file_path"
+        def type
+          @data['type']
+        end
+
+        # @return [String]
+        def text
+          @data['text']
+        end
+
+        # @return [Integer]
+        def start_index
+          @data['start_index']
+        end
+
+        # @return [Integer]
+        def end_index
+          @data['end_index']
+        end
+
+        # @return [Range<Integer>]
+        def range
+          start_index..end_index
+        end
+
+        # @return [String]
+        def file_id
+          @file_id ||= (@data['file_citation'] || @data['file_path'])['file_id']
+        end
+
+        # Present if type is "file_citation" or "file_path".
+        #
+        # @return [OmniAI::OpenAI::File, nil]
+        def file!
+          @file ||= @client.files.find(id: file_id)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module OpenAI
+    class Thread
+      # An OpenAI attachment.
+      class Attachment
+        # @!attribute [rw] data
+        #   @return [Hash, nil]
+        attr_accessor :data
+
+        # @param data [Array]
+        # @param client [OmniAI::OpenAI::Client]
+        #
+        # @return [Array<OmniAI::OpenAI::Thread::Content>, String, nil]
+        def self.for(data:, client: Client.new)
+          return data unless data.is_a?(Enumerable)
+
+          data.map { |attachment| new(data: attachment, client:) }
+        end
+
+        # @param data [Hash]
+        # @param client [OmniAI::OpenAI::Client]
+        def initialize(data:, client: Client.new)
+          @data = data
+          @client = client
+        end
+
+        # @return [String] e.g. "text"
+        def file_id
+          @file_id ||= @data['file_id']
+        end
+
+        # @return [Array<Hash>]
+        def tools
+          @tools ||= @data['tools']
+        end
+
+        # @return [OmniAI::OpenAI::File]
+        def file!
+          @file ||= @client.files.find(id: file_id)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module OpenAI
+    class Thread
+      # An OpenAI content w/ annotations.
+      class Content
+        module Type
+          TEXT = 'text'
+        end
+
+        # @param data [Array]
+        # @param client [OmniAI::OpenAI::Client]
+        #
+        # @return [Array<OmniAI::OpenAI::Thread::Content>, String, nil]
+        def self.for(data:, client: Client.new)
+          return data unless data.is_a?(Enumerable)
+
+          data.map { |attachment| new(data: attachment, client:) }
+        end
+
+        # @!attribute [rw] data
+        #   @return [Hash, nil]
+        attr_accessor :data
+
+        # @param data [Hash]
+        def initialize(data:, client:)
+          @data = data
+          @client = client
+        end
+
+        # @return [String] e.g. "text"
+        def type
+          @type ||= @data['type']
+        end
+
+        # @return [Boolean]
+        def text?
+          type.eql?(Type::TEXT)
+        end
+
+        # @return [OmniAI::OpenAI::Thread::Text]
+        def text
+          @text ||= Text.new(data: @data['text'], client: @client) if @data['text']
+        end
+      end
+    end
+  end
+end

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

@@ -168,8 +168,8 @@ module OmniAI
               thread_id: data['thread_id'],
               run_id: data['run_id'],
               role: data['role'],
-              content: data['content'],
-              attachments: data['attachments'],
+              content: Content.for(data: data['content'], client:),
+              attachments: Attachment.for(data: data['attachments'], client:),
               metadata: data['metadata']
             )
           end
@@ -181,9 +181,9 @@ module OmniAI
           @assistant_id = data['assistant_id']
           @thread_id =  data['thread_id']
           @run_id =  data['run_id']
-          @role =  data['role']
-          @content = data['content']
-          @attachments = data['attachments']
+          @role = data['role']
+          @content = Content.for(data: data['content'], client: @client)
+          @attachments = Attachment.for(data: data['content'], client: @client)
           @metadata =  data['metadata']
         end
 

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/thread/text.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module OpenAI
+    class Thread
+      # An OpenAI text w/ annotations.
+      class Text
+        # @!attribute [rw] data
+        #   @return [Hash, nil]
+        attr_accessor :data
+
+        # @param data [Hash]
+        # @param client [OmniAI::OpenAI::Client]
+        def initialize(data:, client:)
+          @data = data
+          @client = client
+        end
+
+        # @return [String]
+        def annotate!
+          text = value
+
+          annotations.each do |annotation|
+            file = annotation.file!
+            text = text.gsub(annotation.text, "[#{file.filename}:#{annotation.range}]")
+          end
+
+          text
+        end
+
+        # @return [String] e.g. "text"
+        def type
+          @data['type']
+        end
+
+        # @return [String]
+        def value
+          @data['value']
+        end
+
+        # @return [Array<OmniAI::OpenAI::Thread::Annotation>]
+        def annotations
+          @annotations ||= @data['annotations'].map { |data| Annotation.new(data:, client: @client) }
+        end
+      end
+    end
+  end
+end

data/lib/omniai/openai/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniai-openai
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.3
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-24 00:00:00.000000000 Z
+date: 2024-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -71,10 +71,14 @@ files:
 - lib/omniai/openai/files.rb
 - lib/omniai/openai/speak.rb
 - lib/omniai/openai/thread.rb
+- lib/omniai/openai/thread/annotation.rb
+- lib/omniai/openai/thread/attachment.rb
+- lib/omniai/openai/thread/content.rb
 - lib/omniai/openai/thread/message.rb
 - lib/omniai/openai/thread/messages.rb
 - lib/omniai/openai/thread/run.rb
 - lib/omniai/openai/thread/runs.rb
+- lib/omniai/openai/thread/text.rb
 - lib/omniai/openai/threads.rb
 - lib/omniai/openai/tool.rb
 - lib/omniai/openai/transcribe.rb