omniai-openai 1.6.3 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dceac1ba096564c04a795101feeebde7e5014b901d6cb1dd479cc7701d38bd3c
-  data.tar.gz: a1ef0a834eec86b0a5072811580259700b704abadedd29965b649b127f2aba50
+  metadata.gz: 41461329b48f40e24c8d2f69a58ece1a8e07726c7d45deda20c83fc58d6a1a54
+  data.tar.gz: 6699b15afe94e512ddec9c1919d74b121a2044f5d50c390fd7899f4498b7cf19
 SHA512:
-  metadata.gz: 51e5373e55921c3768a1d245fd9e9b14b2c0e7a842088504ce51e9b23627df9df640b4fcbc633f34f89a53bc0079d4516fed4074c0ab445be1fb67d8ff008a49
-  data.tar.gz: aebd0db9486e9df3ae9370e6c089bdd211f745bcb6146e457c80417325fc4004492050dcefa667284963379915030ac20c84dfeb8e831ce135542d2aa2a7eaec
+  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/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.3'
+    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.3
+  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