omniai 1.9.0 → 1.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2be85cf16b03f342e3432ac030833ab316f36de5e2d788a084b4c42776d4a848
-  data.tar.gz: c9d036b21d875a1b5daa672af6f21a92194e8d699a52c01d8d82fe73fff18f98
+  metadata.gz: 4f2dff570036129e4ae7b41a113f644a19a6dd1c75e71852721c5f7fc5fdd068
+  data.tar.gz: d48375ab7e70758ad7fc931d0ac70f739807e10cc35bc22161ddcb8a758fc0b7
 SHA512:
-  metadata.gz: 36434f2cf177a9fe41d17517604e4bb82df002af8174544d1256041b3b6bd08c522f2017a46e312ea96a151f4c39bb7023df2cb3fbcfde2b055cf625a99245e6
-  data.tar.gz: fc28ef3dec6bce8cc7607eb282bd8a0cd715c01775732aebbb1ad0f5139d3a3ff4de385ecf545aae6437ab7788a35c065ada364dbc1865dbe3a15bf962c1b579
+  metadata.gz: 537c4e16730332602dccfc9fb3011f99739fdfec133362b362fded6e2fb54ec66c7070872426f331f6160dd3fdd3e82c61b7bfb326c8c2a5399fe662eb51acfc
+  data.tar.gz: 79b2adcacba078cbd8aa72330a9d8f6a1e1895e5824cccbf89bab50a86a789fdd83f49d23a70f39785912273ce8826cbbc6eba40eee2d7d671ff52a34b1bb171

data/README.md

@@ -1,6 +1,10 @@
 # OmniAI
 
-[![CircleCI](https://circleci.com/gh/ksylvest/omniai.svg?style=svg)](https://circleci.com/gh/ksylvest/omniai)
+[![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ksylvest/omniai/blob/main/LICENSE)
+[![RubyGems](https://img.shields.io/gem/v/omniai)](https://rubygems.org/gems/omniai)
+[![GitHub](https://img.shields.io/badge/github-repo-blue.svg)](https://github.com/ksylvest/omniai)
+[![Yard](https://img.shields.io/badge/docs-site-blue.svg)](https://omniai.ksylvest.com)
+[![CircleCI](https://img.shields.io/circleci/build/github/ksylvest/omniai)](https://circleci.com/gh/ksylvest/omniai)
 
 OmniAI standardizes the APIs of various AI / LLM companies such as Anthropic, Google, Mistral and OpenAI for the generation of text, the conversion of text-to-speech, the conversion of speech-to-text, the generation of embeddings, and more. It offers a unified API regardless of the provider and task.
 
@@ -72,16 +76,38 @@ require 'omniai/google'
 
 CLIENT = OmniAI::Google::Client.new
 
+LOCATION = OmniAI::Tool::Property.object(
+  properties: {
+    city: OmniAI::Tool::Property.string(description: 'e.g. "Toronto"'),
+    country: OmniAI::Tool::Property.string(description: 'e.g. "Canada"'),
+  },
+  required: %i[city country]
+)
+
+LOCATIONS = OmniAI::Tool::Property.array(
+  min_items: 1,
+  max_items: 5,
+  items: LOCATION
+)
+
+UNIT = OmniAI::Tool::Property.string(enum: %w[celcius fahrenheit])
+
+WEATHER = proc do |locations:, unit: 'celsius'|
+  locations.map do |location|
+    "#{rand(20..50)}° #{unit} in #{location[:city]}, #{location[:country]}"
+  end.join("\n")
+end
+
 TOOL = OmniAI::Tool.new(
-  proc { |location:, unit: 'celsius'| "#{rand(20..50)}° #{unit} in #{location}" },
+  WEATHER,
   name: 'Weather',
   description: 'Lookup the weather in a location',
   parameters: OmniAI::Tool::Parameters.new(
     properties: {
-      location: OmniAI::Tool::Property.string(description: 'e.g. Toronto'),
-      unit: OmniAI::Tool::Property.string(enum: %w[celcius fahrenheit]),
+      locations: LOCATIONS,
+      unit: UNIT,
     },
-    required: %i[location]
+    required: %i[locations]
   )
 )
 

data/lib/omniai/tool/array.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Tool
+    # Represents a schema object.
+    #
+    # @example
+    #    array = OmniAI::Tool::Array.new(
+    #      description: 'A list of people.',
+    #      items: OmniAI::Tool::Object.new(
+    #        properties: {
+    #          name: OmniAI::Tool::Property.string(description: 'The name of the person.'),
+    #          age: OmniAI::Tool::Property.integer(description: 'The age of the person.'),
+    #        },
+    #        required: %i[name]
+    #      ),
+    #      min_items: 1,
+    #      max_items: 5,
+    #    })
+    class Array
+      TYPE = 'array'
+
+      # @!attribute [rw] items
+      #   @return [OmniAI::Tool::Object, OmniAI::Tool::Array, OmniAI::Tool::Property]
+      attr_accessor :items
+
+      # @!attribute [rw] max_items
+      #   @return [Integer, nil]
+      attr_accessor :max_items
+
+      # @!attribute [rw] min_items
+      #   @return [Integer, nil]
+      attr_accessor :min_items
+
+      # @!attribute [rw] description
+      #   @return [String, nil]
+      attr_accessor :description
+
+      # @param items [OmniAI::Tool::Object, OmniAI::Tool::Array, OmniAI::Tool::Property] required
+      # @param max_items [Integer] optional
+      # @param min_items [Integer] optional
+      # @param description [String] optional
+      def initialize(items:, max_items: nil, min_items: nil, description: nil)
+        @items = items
+        @description = description
+        @max_items = max_items
+        @min_items = min_items
+      end
+
+      # @example
+      #   array.serialize # => { type: 'array', items: { type: 'string' } }
+      #
+      # @return [Hash]
+      def serialize
+        {
+          type: TYPE,
+          description: @description,
+          items: @items.serialize,
+          maxItems: @max_items,
+          minItems: @min_items,
+        }.compact
+      end
+
+      # @example
+      #   array.parse(['1', '2', '3']) # => [1, 2, 3]
+      # @param args [Array]
+      #
+      # @return [Array]
+      def parse(args)
+        args.map { |arg| @items.parse(arg) }
+      end
+    end
+  end
+end

data/lib/omniai/tool/object.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Tool
+    # Represents a schema object.
+    #
+    # @example
+    #    object = OmniAI::Tool::Object.new(
+    #      properties: {
+    #        name: OmniAI::Tool::Property.string(description: 'The name of the person.'),
+    #        age: OmniAI::Tool::Property.integer(description: 'The age of the person.'),
+    #      },
+    #      required: %i[name]
+    #    })
+    class Object
+      TYPE = 'object'
+
+      # @!attribute [rw] properties
+      #   @return [Hash]
+      attr_accessor :properties
+
+      # @!attribute [rw] required
+      #   @return [Array<String>]
+      attr_accessor :required
+
+      # @!attribute [rw] description
+      #   @return [String, nil]
+      attr_accessor :description
+
+      # @param properties [Hash]
+      # @param required [Array<String>]
+      # @return [OmniAI::Tool::Parameters]
+      def initialize(properties: {}, required: [], description: nil)
+        @properties = properties
+        @required = required
+        @description = description
+      end
+
+      # @return [Hash]
+      def serialize
+        {
+          type: TYPE,
+          description: @description,
+          properties: @properties.transform_values(&:serialize),
+          required: @required,
+        }.compact
+      end
+
+      # @param args [Hash]
+      #
+      # @return [Hash]
+      def parse(args)
+        result = {}
+        @properties.each do |name, property|
+          value = args[String(name)]
+          result[name.intern] = property.parse(value) unless value.nil?
+        end
+        result
+      end
+    end
+  end
+end

data/lib/omniai/tool/parameters.rb

@@ -2,46 +2,22 @@
 
 module OmniAI
   class Tool
-    # Usage:
+    # Parameters are used to define the arguments for a tool.
     #
-    # parameters = OmniAI::Tool::Parameters.new(properties: {
-    #   n: OmniAI::Tool::Parameters.integer(description: 'The nth number to calculate.')
-    #   required: %i[n]
-    # })
-    class Parameters
-      module Type
-        OBJECT = 'object'
-      end
-
-      # @param type [String]
-      # @param properties [Hash]
-      # @param required [Array<String>]
-      # @return [OmniAI::Tool::Parameters]
-      def initialize(type: Type::OBJECT, properties: {}, required: [])
-        @type = type
-        @properties = properties
-        @required = required
-      end
-
-      # @return [Hash]
-      def serialize
-        {
-          type: @type,
-          properties: @properties.transform_values(&:serialize),
-          required: @required,
-        }.compact
-      end
-
-      # @param args [Hash]
-      # @return [Hash]
-      def parse(args)
-        result = {}
-        @properties.each do |name, property|
-          value = args[String(name)]
-          result[name.intern] = property.parse(value) if value
-        end
-        result
-      end
+    # @example
+    #    parameters = OmniAI::Tool::Parameters.new(properties: {
+    #      people: OmniAI::Tool::Parameters.array(
+    #        items: OmniAI::Tool::Parameters.object(
+    #          properties: {
+    #            name: OmniAI::Tool::Parameters.string(description: 'The name of the person.'),
+    #            age: OmniAI::Tool::Parameters.integer(description: 'The age of the person.'),
+    #            employeed: OmniAI::Tool::Parameters.boolean(description: 'Is the person employeed?'),
+    #          }
+    #      n: OmniAI::Tool::Parameters.integer(description: 'The nth number to calculate.')
+    #      required: %i[n]
+    #    })
+    #    tool = OmniAI::Tool.new(fibonacci, parameters: parameters)
+    class Parameters < Object
     end
   end
 end

data/lib/omniai/tool/property.rb

@@ -2,9 +2,15 @@
 
 module OmniAI
   class Tool
-    # Usage:
+    # A property used for a tool parameter.
     #
-    # property = OmniAI::Tool::Property.new(type: 'string', description: 'The nth number to calculate.')
+    # @example
+    #   OmniAI::Tool::Property.array(description: '...', items: ...)
+    #   OmniAI::Tool::Property.object(description: '...', properties: { ... }, required: %i[...])
+    #   OmniAI::Tool::Property.string(description: '...')
+    #   OmniAI::Tool::Property.integer(description: '...')
+    #   OmniAI::Tool::Property.number(description: '...')
+    #   OmniAI::Tool::Property.boolean(description: '...')
     class Property
       module Type
         BOOLEAN = 'boolean'
@@ -22,36 +28,80 @@ module OmniAI
       # @return [Array<String>, nil]
       attr_reader :enum
 
-      # @param description [String]
-      # @param enum [Array<String>]
+      # @example
+      #   property = OmniAI::Tool::Property.array(
+      #     items: OmniAI::Tool::Property.string(description: 'The name of the person.'),
+      #     description: 'A list of names.'
+      #     min_items: 1,
+      #     max_items: 5,
+      #   )
+      #
+      # @param items [OmniAI::Tool::Property] required - the items in the array
+      # @param min_items [Integer] optional - the minimum number of items
+      # @param max_items [Integer] optional - the maximum number of items
+      # @param description [String] optional - a description of the array
+      #
+      # @return [OmniAI::Tool::Array]
+      def self.array(items:, min_items: nil, max_items: nil, description: nil)
+        OmniAI::Tool::Array.new(items:, description:, min_items:, max_items:)
+      end
+
+      # @example
+      #   property = OmniAI::Tool::Property.object(
+      #     properties: {
+      #       name: OmniAI::Tool::Property.string(description: 'The name of the person.'),
+      #       age: OmniAI::Tool::Property.integer(description: 'The age of the person.'),
+      #       employeed: OmniAI::Tool::Property.boolean(description: 'Is the person employeed?'),
+      #     },
+      #     description: 'A person.'
+      #     required: %i[name]
+      #   )
+      #
+      # @param properties [Hash<String, OmniAI::Tool::Property>] required - the properties of the object
+      # @param requird [Array<Symbol>] optional - the required properties
+      # @param description [String] optional - a description of the object
+      #
+      # @return [OmniAI::Tool::Array]
+      def self.object(properties: {}, required: [], description: nil)
+        OmniAI::Tool::Object.new(properties:, required:, description:)
+      end
+
+      # @param description [String] optional - a description of the property
+      # @param enum [Array<Boolean>] optional - the possible values of the property
+      #
       # @return [OmniAI::Tool::Property]
       def self.boolean(description: nil, enum: nil)
         new(type: Type::BOOLEAN, description:, enum:)
       end
 
-      # @param description [String]
-      # @param enum [Array<String>]
+      # @param description [String] optional - a description of the property
+      # @param enum [Array<Integer>] optinoal - the possible values of the property
+      #
       # @return [OmniAI::Tool::Property]
       def self.integer(description: nil, enum: nil)
         new(type: Type::INTEGER, description:, enum:)
       end
 
-      # @param description [String]
-      # @param enum [Array<String>]
+      # @param description [String] optional - a description of the property
+      # @param enum [Array<String>] optional - the possible values of the property
+      #
       # @return [OmniAI::Tool::Property]
       def self.string(description: nil, enum: nil)
         new(type: Type::STRING, description:, enum:)
       end
 
-      # @param description [String]
-      # @param enum [Array<String>]
+      # @param description [String] optional - a description of the property
+      # @param enum [Array<Number>] optional - the possible values of the property
+      #
       # @return [OmniAI::Tool::Property]
       def self.number(description: nil, enum: nil)
         new(type: Type::NUMBER, description:, enum:)
       end
 
-      # @param description [String]
-      # @param enum [Array<String>]
+      # @param type [String] required - the type of the property
+      # @param description [String] optional - a description of the property
+      # @param enum [Array] optional - the possible values of the property
+      #
       # @return [OmniAI::Tool::Property]
       def initialize(type:, description: nil, enum: nil)
         @type = type
@@ -60,12 +110,7 @@ module OmniAI
       end
 
       # @example
-      #   property.serialize
-      #   # {
-      #   #   type: 'string',
-      #   #   description: 'The unit (e.g. "fahrenheit" or "celsius").'
-      #   #   enum: %w[fahrenheit celsius]
-      #   # }
+      #   property.serialize #=> { type: 'string' }
       #
       # @return [Hash]
       def serialize
@@ -76,6 +121,9 @@ module OmniAI
         }.compact
       end
 
+      # @example
+      #   property.parse('123') #=> 123
+      #
       # @return [String, Integer, Float, Boolean, Object]
       def parse(value)
         case @type

data/lib/omniai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OmniAI
-  VERSION = '1.9.0'
+  VERSION = '1.9.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniai
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.9.2
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-30 00:00:00.000000000 Z
+date: 2024-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -98,6 +98,8 @@ files:
 - lib/omniai/instrumentation.rb
 - lib/omniai/speak.rb
 - lib/omniai/tool.rb
+- lib/omniai/tool/array.rb
+- lib/omniai/tool/object.rb
 - lib/omniai/tool/parameters.rb
 - lib/omniai/tool/property.rb
 - lib/omniai/transcribe.rb