omniai-openai 1.3.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cb12222b6c13b368f2f25d55c66ff57e98114830a32bdd54ee82947aaf38674
-  data.tar.gz: 7600584957b977be573321a25a995f720fde9e9112fdd3e1b8676ce3d75461e0
+  metadata.gz: 9541bdbe54c24be244b7bacd347eb4457d2f8686151cec1d4474889bf23bf6d0
+  data.tar.gz: 5fabc408441ca53da67d05f221d14cb74f6c178e30696ec1a76598adb18ec4c8
 SHA512:
-  metadata.gz: 75f8bdbfff09e789058e15bf962efcbbe0146b3e522e5efc701ca1303ef734b68f6d19094502c2e8fd89f5db213687b6c5001967e3dfd1b46eaab060b4c4e4c0
-  data.tar.gz: 5b206397432e32277bda4767bad41707699607cf93e9a396570cbe78ab668f42b5c34c75f99d26d93cccd042b9c08359a899a4f375fabae7fc6c55a587515550
+  metadata.gz: 48b237f8d606fff3d8db2aecac46633d6bebbae3c403ce2f68d9d87ecac0fe7beb101ada9be12d15e2d1bf734ef86dab92ff7cbf56298311634e44584b9b7cce
+  data.tar.gz: 4627a44685b895c4b2616de3a88ba8b4bb63b038efc7f0536aacc7b9108e373f78d690acdc5adc99635dc9c8e10c6b1e59161643fdf7c3db283a012f1166a9bb

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/lib/omniai/openai/chat.rb

@@ -25,6 +25,7 @@ module OmniAI
           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/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

@@ -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/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.2'
+    VERSION = '1.5.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniai-openai
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.5.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-24 00:00:00.000000000 Z
+date: 2024-07-11 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
@@ -101,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