omniai-openai 2.6.1 → 2.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2a82f5aa43b981c17fb2464d2df62118de751be2bc3ac29b12c07a67f500f84
-  data.tar.gz: a2260b1de24f96c58ed2611ecbe6b477c7da4ab8f3a378b1535c8140eb4156d4
+  metadata.gz: e5e61a00ff0433efbc924958d49f273d17a9182420e8fcf4c1469078333243d2
+  data.tar.gz: bf8cd59ce36c89ad864e1c0b1a2ff69b1a38a9bc062d3ca7135851c80639956d
 SHA512:
-  metadata.gz: f70f8eecfb376ccf582628139e992cf5f52de35e1cc3886da01400fb4cf2d086df4c97637df20c9e6b2d92d09159719b970e8c623876621b690c8226c74d74e3
-  data.tar.gz: 7cb2a40052bd07117d660755e6827639ba11ed9cac4fffae8b473b07fd5f5677d9c8b72f969c826b91ff5ee07ae3daadb6b7431af37c2d0e0007dff850086dcd
+  metadata.gz: fe597fd91aab8aad25c3ad3b3f38cb59f3424b821bc15894fba58285c53262b96c850d194a8f32172b8308481e0c57786ffe72601dfd3e64fd0bdb8f2a4e5de0
+  data.tar.gz: f41c7dee9afb44c963b2eee6e091650848cb0d1ae3581d179c9b36875b5358bf66f14ef871d44876b52c4a38c1d49181ac984fcc8760151f0e2cb32323a14367

data/README.md

@@ -306,160 +306,6 @@ end
 client.files.destroy!('file_...')
 ```
 
-## Assistants
-
-### Finding an Assistant
-
-```ruby
-client.assistants.find(id: 'asst_...')
-```
-
-### Listing all Assistants
-
-```ruby
-client.assistants.all
-```
-
-### Creating an Assistant
-
-```ruby
-assistant = client.assistants.build
-assistant.name = 'Ringo'
-assistant.model = OmniAI::OpenAI::Chat::Model::GPT_4
-assistant.description = 'The drummer for the Beatles.'
-assistant.save!
-```
-
-### Updating an Assistant
-
-```ruby
-assistant = client.assistants.find(id: 'asst_...')
-assistant.name = 'George'
-assistant.model = OmniAI::OpenAI::Chat::Model::GPT_4
-assistant.description = 'A guitarist for the Beatles.'
-assistant.save!
-```
-
-### Destroying an Assistant
-
-```ruby
-client.assistants.destroy!('asst_...')
-```
-
-## Threads
-
-### Finding a Thread
-
-```ruby
-client.threads.find(id: 'thread_...')
-```
-
-### Creating a Thread
-
-```ruby
-thread = client.threads.build
-thread.metadata = { user: 'Ringo' }
-thread.save!
-```
-
-### Updating a Thread
-
-```ruby
-thread = client.threads.find(id: 'thread_...')
-thread.metadata = { user: 'Ringo' }
-thread.save!
-```
-
-### Destroying a Threads
-
-```ruby
-client.threads.destroy!('thread_...')
-```
-
-### Messages
-
-#### Finding a Message
-
-```ruby
-thread = client.threads.find(id: 'thread_...')
-message = thread.messages.find(id: 'msg_...')
-message.save!
-```
-
-#### Listing all Messages
-
-```ruby
-thread = client.threads.find(id: 'thread_...')
-thread.messages.all
-```
-
-#### Creating a Message
-
-```ruby
-thread = client.threads.find(id: 'thread_...')
-message = thread.messages.build(role: 'user', content: 'Hello?')
-message.save!
-```
-
-#### Updating a Message
-
-```ruby
-thread = client.threads.find(id: 'thread_...')
-message = thread.messages.build(role: 'user', content: 'Hello?')
-message.save!
-```
-
-### Runs
-
-#### Finding a Run
-
-```ruby
-thread = client.threads.find(id: 'thread_...')
-run = thread.runs.find(id: 'run_...')
-run.save!
-```
-
-#### Listing all Runs
-
-```ruby
-thread = client.threads.find(id: 'thread_...')
-thread.runs.all
-```
-
-#### Creating a Run
-
-```ruby
-run = client.runs.find(id: 'thread_...')
-run = thread.runs.build
-run.metadata = { user: 'Ringo' }
-run.save!
-```
-
-#### Updating a Run
-
-```ruby
-thread = client.threads.find(id: 'thread_...')
-run = thread.messages.find(id: 'run_...')
-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
-thread = client.threads.find(id: 'thread_...')
-run = thread.runs.cancel!(id: 'run_...')
-```
-
 ### Embed
 
 Text can be converted into a vector embedding for similarity comparison usage via:

data/lib/omniai/openai/chat.rb

@@ -20,7 +20,21 @@ module OmniAI
         SCHEMA_TYPE = "json_schema"
       end
 
+      module ReasoningEffort
+        NONE = "none"
+        LOW = "low"
+        MEDIUM = "medium"
+        HIGH = "high"
+      end
+
+      module VerbosityText
+        LOW = "low"
+        MEDIUM = "medium"
+        HIGH = "high"
+      end
+
       module Model
+        GPT_5_1 = "gpt-5.1"
         GPT_5 = "gpt-5"
         GPT_5_MINI = "gpt-5-mini"
         GPT_5_NANO = "gpt-5-nano"
@@ -65,7 +79,9 @@ module OmniAI
           stream_options: (DEFAULT_STREAM_OPTIONS if stream?),
           temperature:,
           tools: (@tools.map(&:serialize) if @tools&.any?),
-        }).compact
+          reasoning: reasoning_payload,
+          verbosity: verbosity_payload,
+        }.merge(@kwargs || {})).compact
       end
 
       # @return [String]
@@ -86,6 +102,42 @@ module OmniAI
         else raise ArgumentError, "unknown format=#{@format}"
         end
       end
+
+      # @raise [ArgumentError]
+      #
+      # @return [Hash, nil]
+      def reasoning_payload
+        return if @reasoning.nil?
+
+        effort = @reasoning[:effort] || @reasoning["effort"]
+        return if effort.nil?
+
+        valid_efforts = [ReasoningEffort::NONE, ReasoningEffort::LOW, ReasoningEffort::MEDIUM, ReasoningEffort::HIGH]
+        unless valid_efforts.include?(effort)
+          raise ArgumentError,
+            "reasoning effort must be one of #{valid_efforts.join(', ')}"
+        end
+
+        { effort: }
+      end
+
+      # @raise [ArgumentError]
+      #
+      # @return [Hash, nil]
+      def verbosity_payload
+        return if @verbosity.nil?
+
+        text = @verbosity[:text] || @verbosity["text"]
+        return if text.nil?
+
+        valid_text_levels = [VerbosityText::LOW, VerbosityText::MEDIUM, VerbosityText::HIGH]
+        unless valid_text_levels.include?(text)
+          raise ArgumentError,
+            "verbosity text must be one of #{valid_text_levels.join(', ')}"
+        end
+
+        { text: }
+      end
     end
   end
 end

data/lib/omniai/openai/client.rb

@@ -77,13 +77,16 @@ module OmniAI
       # @param temperature [Float, nil] optional
       # @param stream [Proc, nil] optional
       # @param tools [Array<OmniAI::Tool>, nil] optional
+      # @param reasoning [Hash, nil] optional reasoning configuration
+      # @param verbosity [Hash, nil] optional verbosity configuration
       #
       # @yield [prompt]
       # @yieldparam prompt [OmniAI::Chat::Prompt]
       #
       # @return [OmniAI::Chat::Completion]
-      def chat(messages = nil, model: Chat::DEFAULT_MODEL, temperature: nil, format: nil, stream: nil, tools: nil, &)
-        Chat.process!(messages, model:, temperature:, format:, stream:, tools:, client: self, &)
+      def chat(messages = nil, model: Chat::DEFAULT_MODEL, temperature: nil, format: nil, stream: nil, tools: nil,
+        reasoning: nil, verbosity: nil, &)
+        Chat.process!(messages, model:, temperature:, format:, stream:, tools:, reasoning:, verbosity:, client: self, &)
       end
 
       # @raise [OmniAI::Error]
@@ -133,16 +136,6 @@ module OmniAI
       def files
         Files.new(client: self)
       end
-
-      # @return [OmniAI::OpenAI::Assistants]
-      def assistants
-        Assistants.new(client: self)
-      end
-
-      # @return [OmniAI::OpenAI::Threads]
-      def threads
-        Threads.new(client: self)
-      end
     end
   end
 end

data/lib/omniai/openai/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAI
   module OpenAI
-    VERSION = "2.6.1"
+    VERSION = "2.6.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniai-openai
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.6.3
 platform: ruby
 authors:
 - Kevin Sylvestre
@@ -61,8 +61,6 @@ files:
 - Gemfile
 - README.md
 - lib/omniai/openai.rb
-- lib/omniai/openai/assistant.rb
-- lib/omniai/openai/assistants.rb
 - lib/omniai/openai/chat.rb
 - lib/omniai/openai/client.rb
 - lib/omniai/openai/config.rb
@@ -70,16 +68,6 @@ files:
 - lib/omniai/openai/file.rb
 - 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
 - lib/omniai/openai/version.rb
@@ -104,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.2
 specification_version: 4
 summary: A generalized framework for interacting with OpenAI
 test_files: []

data/lib/omniai/openai/assistant.rb

@@ -1,185 +0,0 @@
-# frozen_string_literal: true
-
-module OmniAI
-  module OpenAI
-    # An OpenAI assistants implementation.
-    class Assistant
-      HEADERS = { "OpenAI-Beta": "assistants=v2" }.freeze
-
-      # @!attribute [rw] id
-      #   @return [String, nil]
-      attr_accessor :id
-
-      # @!attribute [rw] name
-      #   @return [String, nil]
-      attr_accessor :name
-
-      # @!attribute [rw] model
-      #   @return [String, nil]
-      attr_accessor :model
-
-      # @!attribute [rw] description
-      #   @return [String, nil]
-      attr_accessor :description
-
-      # @!attribute [rw] instructions
-      # @return [String, nil]
-      attr_accessor :instructions
-
-      # @!attribute [rw] metadata
-      #   @return [Hash]
-      attr_accessor :metadata
-
-      # @!attribute [rw] deleted
-      #   @return [Boolean, nil]
-      attr_accessor :deleted
-
-      # @!attribute [r] tools
-      #   @return [Array<Hash>, nil]
-      attr_accessor :tools
-
-      # @param client [OmniAI::OpenAI::Client] optional
-      # @param id [String]
-      # @param name [String]
-      # @param model [String]
-      # @param description [String, nil] optional
-      # @param instructions [String,nil] optional
-      # @param metadata [Hash] optional
-      def initialize(
-        client: Client.new,
-        id: nil,
-        name: nil,
-        model: OmniAI::Chat::DEFAULT_MODEL,
-        description: nil,
-        instructions: nil,
-        metadata: {},
-        tools: []
-      )
-        @client = client
-        @id = id
-        @name = name
-        @model = model
-        @description = description
-        @instructions = instructions
-        @metadata = metadata
-        @tools = tools
-      end
-
-      # @return [String]
-      def inspect
-        "#<#{self.class.name} id=#{@id.inspect} name=#{@name.inspect} model=#{@model.inspect}>"
-      end
-
-      # @param id [String] required
-      # @param client [OmniAI::OpenAI::Client] optional
-      # @return [OmniAI::OpenAI::Assistant]
-      def self.find(id:, client: Client.new)
-        response = client.connection
-          .accept(:json)
-          .headers(HEADERS)
-          .get("/#{OmniAI::OpenAI::Client::VERSION}/assistants/#{id}")
-
-        raise HTTPError, response.flush unless response.status.ok?
-
-        parse(data: response.parse)
-      end
-
-      # @param limit [Integer] optional
-      # @param client [OmniAI::OpenAI::Client] optional
-      # @return [Array<OmniAI::OpenAI::Assistant>]
-      def self.all(limit: nil, client: Client.new)
-        response = client.connection
-          .accept(:json)
-          .headers(HEADERS)
-          .get("/#{OmniAI::OpenAI::Client::VERSION}/assistants", params: { limit: }.compact)
-
-        raise HTTPError, response.flush unless response.status.ok?
-
-        response.parse["data"].map { |data| parse(data:, client:) }
-      end
-
-      # @param id [String] required
-      # @param client [OmniAI::OpenAI::Client] optional
-      # @return [void]
-      def self.destroy!(id:, client: Client.new)
-        response = client.connection
-          .accept(:json)
-          .headers(HEADERS)
-          .delete("/#{OmniAI::OpenAI::Client::VERSION}/assistants/#{id}")
-
-        raise HTTPError, response.flush unless response.status.ok?
-
-        response.parse
-      end
-
-      # @raise [HTTPError]
-      # @return [OmniAI::OpenAI::Assistant]
-      def save!
-        response = @client.connection
-          .accept(:json)
-          .headers(HEADERS)
-          .post("/#{OmniAI::OpenAI::Client::VERSION}/assistants#{"/#{@id}" if @id}", json: payload)
-        raise HTTPError, response.flush unless response.status.ok?
-
-        parse(data: response.parse)
-        self
-      end
-
-      # @raise [OmniAI::Error]
-      # @return [OmniAI::OpenAI::Assistant]
-      def destroy!
-        raise OmniAI::Error, "cannot destroy a non-persisted assistant" unless @id
-
-        data = self.class.destroy!(id: @id, client: @client)
-        @deleted = data["deleted"]
-        self
-      end
-
-    private
-
-      class << self
-      private
-
-        # @param data [Hash] required
-        # @param client [OmniAI::OpenAI::Client] required
-        # @return [OmniAI::OpenAI::Assistant]
-        def parse(data:, client: Client.new)
-          new(
-            client:,
-            id: data["id"],
-            name: data["name"],
-            model: data["model"],
-            description: data["description"],
-            instructions: data["instructions"],
-            metadata: data["metadata"],
-            tools: data["tools"]
-          )
-        end
-      end
-
-      # @param data [Hash] required
-      # @return [OmniAI::OpenAI::Assistant]
-      def parse(data:)
-        @id = data["id"]
-        @name = data["name"]
-        @model = data["model"]
-        @description = data["description"]
-        @instructions = data["instructions"]
-        @metadata = data["metadata"]
-        @tools = data["tools"]
-      end
-
-      # @return [Hash]
-      def payload
-        {
-          name: @name,
-          model: @model,
-          description: @description,
-          instructions: @instructions,
-          metadata: @metadata,
-          tools: @tools,
-        }.compact
-      end
-    end
-  end
-end

data/lib/omniai/openai/assistants.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module OmniAI
-  module OpenAI
-    # An OpenAI scope for establishing assistants.
-    class Assistants
-      # @param client [OmniAI::OpenAI::Client] required
-      def initialize(client:)
-        @client = client
-      end
-
-      # @param id [String] required
-      def find(id:)
-        Assistant.find(id:, client: @client)
-      end
-
-      # @param limit [Integer] optional
-      def all(limit: nil)
-        Assistant.all(limit:, client: @client)
-      end
-
-      # @param id [String] required
-      def destroy!(id:)
-        Assistant.destroy!(id:, client: @client)
-      end
-
-      # @param name [String]
-      # @param model [String]
-      # @param description [String, nil] optional
-      # @param instructions [String,nil] optional
-      # @param metadata [Hash] optional
-      # @param tools [Array<Hash>] optional
-      def build(name: nil, description: nil, instructions: nil, model: Chat::Model, metadata: {}, tools: [])
-        Assistant.new(name:, model:, description:, instructions:, metadata:, tools:, client: @client)
-      end
-    end
-  end
-end

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

@@ -1,58 +0,0 @@
-# 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

@@ -1,46 +0,0 @@
-# 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