omniai 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d531aa6fb65bf379e80e1ee381a9e0bcdc593ff50368023284516b1d63c12d2e
-  data.tar.gz: cfb766bb5a41be87fa2a24766f1a14ce03fb48bda3aeb5bf747f6f6d23cecc55
+  metadata.gz: 0ab654a67cbbe8a0fca968721a942c14a0e70a1bc0b0ca894c3b63c737e75bde
+  data.tar.gz: 7cea942027a5864ff5a62c7eeb9b53295fc8729d8b167360aff15b1c641ee8cb
 SHA512:
-  metadata.gz: 4128c986161424706af7cdd57ef1d2a23541761cebd94e798e15fcd5959d8e55b79c7c7bac3aa7a69efe6c65ebb24b47154f37077a28cc233f22e0ec7c7af1f9
-  data.tar.gz: e4d043eb1ca554d3da937b0a72b45ef659125f7d7e52adc855ffa4ee446f2735a3981f00e361fc75c55573bfc72e46c98403d459acc7b732579fe06f2bdaa658
+  metadata.gz: 8053636d067f6c1a09d746a3fcaa4b4d1a873d89ed105149a7eb9fa5a370c21f13bece4b7edf83f0529f442aa7abaaef860bb2e81309d25313c53eef92fbb32e
+  data.tar.gz: 4d59606ebee19692a25f68b58542105260770dc73ff97b4b96bd6171758b1c3981533e8b6b8e114310f1cc2de1a91be2978a2a7bf39bf77a3d0986e8bb39da5f

data/lib/omniai/chat/response.rb

@@ -4,15 +4,18 @@ module OmniAI
   class Chat
     # An `OmniAI::Chat::Response` encapsulates the result of generating a chat completion.
     class Response
-      # @return [Hash]
+      # @!attribute [data]
+      #   @return [Hash]
       attr_accessor :data
 
-      # @return [Array<Choice>]
-      attr_accessor :choices
-
-      # @return [Usage, nil]
+      # @!attribute [usage]
+      #   @return [Usage, nil]
       attr_accessor :usage
 
+      # @!attribute [choices]
+      #   @return [Array<Choice>]
+      attr_accessor :choices
+
       # @param data [Hash]
       # @param choices [Array<Choice>]
       # @param usage [Usage, nil]
@@ -24,7 +27,7 @@ module OmniAI
 
       # @return [String]
       def inspect
-        "#<#{self.class.name} choices=#{choices.inspect} usage=#{usage.inspect}>"
+        "#<#{self.class.name} choices=#{@choices.inspect} usage=#{@usage.inspect}>"
       end
 
       # @param data [Hash]
@@ -42,64 +45,38 @@ module OmniAI
       end
 
       # @param context [OmniAI::Context] optional
+      #
       # @return [Hash]
       def serialize(context:)
         serialize = context&.serializer(:response)
         return serialize.call(self, context:) if serialize
 
         {
-          choices: choices.map { |choice| choice.serialize(context:) },
-          usage: usage&.serialize(context:),
+          choices: @choices.map { |choice| choice.serialize(context:) },
+          usage: @usage&.serialize(context:),
         }
       end
 
-      # @param index [Integer]
-      #
-      # @return [Choice, nil]
-      def choice(index: 0)
-        @choices[index]
-      end
-
-      # @param index [Integer]
-      #
-      # @return [Boolean]
-      def choice?(index: 0)
-        !choice(index:).nil?
-      end
-
-      # @param index [Integer]
-      #
-      # @return [Message, nil]
-      def message(index: 0)
-        choice(index:)&.message
+      # @return [Array<Message>]
+      def messages
+        @choices.map(&:message).compact
       end
 
-      # @param index [Integer]
-      #
       # @return [Boolean]
-      def message?(index: 0)
-        !message(index:).nil?
-      end
-
-      # @return [Array<Message>]
-      def messages
-        @choices.map(&:message)
+      def messages?
+        messages.any?
       end
 
-      # @param index [Integer]
-      #
       # @return [String, nil]
-      def text(index: 0)
-        message(index:)&.text
+      def text
+        return unless text?
+
+        messages.filter(&:text?).map(&:text).join("\n\n")
       end
 
-      # @param index [Integer]
-      #
       # @return [Boolean]
-      def text?(index: 0)
-        message = message(index:)
-
-        !message.nil? && message.text?
+      def text?
+        messages.any?(&:text?)
       end
 
       # @return [ToolCallList, nil]

data/lib/omniai/chat/tool_call_list.rb

@@ -48,12 +48,16 @@ module OmniAI
         @entries.each(&)
       end
 
+      # @param index [Integer]
+      #
       # @return [ToolCall]
       def [](index)
         @entries[index]
       end
 
-      # @param [other] [ToolCallList]
+      # @param other [ToolCallList]
+      #
+      # @return [ToolCallList]
       def +(other)
         self.class.new(entries: entries + other.entries)
       end

data/lib/omniai/schema/array.rb

@@ -71,7 +71,7 @@ module OmniAI
       # @example
       #   array.serialize # => { type: "array", items: { type: "string" } }
       #
-      # @param options [Hash] optional
+      # @param additional_properties [Boolean, nil] optional
       #
       # @return [Hash]
       def serialize(additional_properties: false)

data/lib/omniai/schema/format.rb

@@ -51,7 +51,7 @@ module OmniAI
       # @example
       #   format.serialize # => { name: "...", schema: { ... } }
       #
-      # @param options [Hash] optional (e.g. `{ additional_properties: nil }``)
+      # @param additional_properties [Boolean, nil] optional
       #
       # @return [Hash]
       def serialize(additional_properties: false)

data/lib/omniai/schema/object.rb

@@ -74,7 +74,7 @@ module OmniAI
         )
       end
 
-      # @param options [Hash] optional
+      # @param additional_properties [Boolean, nil] optional
       #
       # @return [Hash]
       def serialize(additional_properties: false)

data/lib/omniai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OmniAI
-  VERSION = "3.0.1"
+  VERSION = "3.1.0"
 end

metadata

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