omniai-openai 1.6.2 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99efbb2cd49fcc32c8c4934ad0081b18b0e6eba09056b5418e9040d1c62a649a
-  data.tar.gz: 44bebce8f96c0203a3a9a64d5f1661e5c247dbb1030eff85c75cdc641fc72534
+  metadata.gz: 41461329b48f40e24c8d2f69a58ece1a8e07726c7d45deda20c83fc58d6a1a54
+  data.tar.gz: 6699b15afe94e512ddec9c1919d74b121a2044f5d50c390fd7899f4498b7cf19
 SHA512:
-  metadata.gz: 22ca0c4580a73126a7e5fee444b52da77d4dbbac6442d04d9ff848bc0f1b5eb00acc249f9db6671fdf0474ec273adf0cc57f5edc8ca0e90792686b40e574a692
-  data.tar.gz: 49ab6aec6a2d795c052a9cd3a546061028367e5d18a0e60281525c02d6e9a62e6fad12733d914c4bf2326c154738a7cb8857611dbf945986f0db49924649fceb
+  metadata.gz: c30e7ded2ee30804f3cc6b9d1dcb2ca62c52d7454fe722caedf518d96f019183a73265d81803a526453b3b6044c210260b6c0ef4c8e0909fead982ebe59ae3bb
+  data.tar.gz: f99a44a88ad1c564101cb9caff9d57e33214d93c5716cad13ab0fabc3792bf3196f693ec3783eaeadfef121db785ff5d38d1c7ebd6b32d5b2f1150c10ec2687f

data/README.md

@@ -441,3 +441,12 @@ run.status # 'cancelled' / 'failed' / 'completed' / 'expired'
 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:
+
+```ruby
+response = client.embed('The quick brown fox jumps over a lazy dog.')
+response.embedding # [0.0, ...]
+```

data/lib/omniai/openai/chat.rb

@@ -16,6 +16,7 @@ module OmniAI
 
       module Model
         GPT_4O = 'gpt-4o'
+        GPT_4O_MINI = 'gpt-4o-mini'
         GPT_4 = 'gpt-4'
         GPT_4_TURBO = 'gpt-4-turbo'
         GPT_3_5_TURBO = 'gpt-3.5-turbo'

data/lib/omniai/openai/client.rb

@@ -77,6 +77,14 @@ module OmniAI
         Chat.process!(messages, model:, temperature:, format:, stream:, tools:, client: self, &)
       end
 
+      # @raise [OmniAI::Error]
+      #
+      # @param input [String, Array<String>, Array<Integer>] required
+      # @param model [String] optional
+      def embed(input, model: Embed::DEFAULT_MODEL)
+        Embed.process!(input, model:, client: self)
+      end
+
       # @raise [OmniAI::Error]
       #
       # @param path [String]

data/lib/omniai/openai/embed.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module OpenAI
+    # An OpenAI embed implementation.
+    #
+    # Usage:
+    #
+    #   input = "..."
+    #   response = OmniAI::OpenAI::Embed.process!(input, client: client)
+    #   response.embedding [0.0, ...]
+    class Embed < OmniAI::Embed
+      module Model
+        SMALL = 'text-embedding-3-small'
+        LARGE = 'text-embedding-3-large'
+        ADA = 'text-embedding-ada-002'
+      end
+
+      DEFAULT_MODEL = Model::LARGE
+
+      protected
+
+      # @return [Hash]
+      def payload
+        { model: @model, input: arrayify(@input) }
+      end
+
+      # @return [String]
+      def path
+        "/#{OmniAI::OpenAI::Client::VERSION}/embeddings"
+      end
+
+      # @param [Object] value
+      # @return [Array]
+      def arrayify(value)
+        value.is_a?(Array) ? value : [value]
+      end
+    end
+  end
+end

data/lib/omniai/openai/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAI
   module OpenAI
-    VERSION = '1.6.2'
+    VERSION = '1.7.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniai-openai
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.7.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-18 00:00:00.000000000 Z
+date: 2024-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -67,6 +67,7 @@ files:
 - lib/omniai/openai/chat.rb
 - lib/omniai/openai/client.rb
 - lib/omniai/openai/config.rb
+- lib/omniai/openai/embed.rb
 - lib/omniai/openai/file.rb
 - lib/omniai/openai/files.rb
 - lib/omniai/openai/speak.rb