omniai 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 498fab4d1dc0776ca9b28f970145e9184dd503b7d3032fc45617c0459a442dee
-  data.tar.gz: b0ba0873060444dc59ceb5fe946eaa7b087eb0709a0bd47b80f22bfcc1d5a30c
+  metadata.gz: 0ab654a67cbbe8a0fca968721a942c14a0e70a1bc0b0ca894c3b63c737e75bde
+  data.tar.gz: 7cea942027a5864ff5a62c7eeb9b53295fc8729d8b167360aff15b1c641ee8cb
 SHA512:
-  metadata.gz: 820e63cbc2a5e4f2cc5d6729ae2d3a0fff1950a16bd22d80eab5fec420975ab79992a6cba1fb332dc0643f4ace515ed389d45be225774b7ae59f5ca911b77b12
-  data.tar.gz: 965a88b9114ee0b215d25a98bcdf4354ac60931154fe2d87859cf423b8d953fc679bdcdb3cb51d82a0118fab926553dffb19eb140cb43ff973e946b76f294549
+  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,12 +71,14 @@ module OmniAI
       # @example
       #   array.serialize # => { type: "array", items: { type: "string" } }
       #
+      # @param additional_properties [Boolean, nil] optional
+      #
       # @return [Hash]
-      def serialize
+      def serialize(additional_properties: false)
         {
           type: TYPE,
           description: @description,
-          items: @items.serialize,
+          items: @items.serialize(additional_properties:),
           maxItems: @max_items,
           minItems: @min_items,
         }.compact

data/lib/omniai/schema/format.rb

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

data/lib/omniai/schema/object.rb

@@ -74,15 +74,17 @@ module OmniAI
         )
       end
 
+      # @param additional_properties [Boolean, nil] optional
+      #
       # @return [Hash]
-      def serialize
+      def serialize(additional_properties: false)
         {
           type: TYPE,
           title: @title,
           description: @description,
-          properties: @properties.transform_values(&:serialize),
+          properties: @properties.transform_values { |value| value.serialize(additional_properties:) },
           required: @required,
-          additionalProperties: false,
+          additionalProperties: additional_properties,
         }.compact
       end
 

data/lib/omniai/schema/scalar.rb

@@ -91,7 +91,7 @@ module OmniAI
       #   property.serialize #=> { type: "string" }
       #
       # @return [Hash]
-      def serialize
+      def serialize(*)
         {
           type: @type,
           description: @description,

data/lib/omniai/version.rb

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

metadata

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