omniai-google 1.9.1 → 1.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b089582dd7e1f47ae072ca9b715b18606054255eb630dab423f66e394aba73a
-  data.tar.gz: e8efc5d1f56d1f1c7e0912edd1922da787d88a672a956c345499fbd63e4c432a
+  metadata.gz: 80e08395bc3710a72cc59b7c110cc50b1ba4a1dc64e15c622fcacb39448c1265
+  data.tar.gz: cccb64b57c0430caf449ebb1de2620e597409de0179379ef0cb26588d41418a2
 SHA512:
-  metadata.gz: 732b07daa138c03068b1123ff95781a49a953645e2a121fbb948cbd84888bd2323da0d889130bcadc9ef55e0c5b43fe06ab4a892b7b25d33d8c02915c8be4f62
-  data.tar.gz: 57692257e9c9dc10a62e2ad9019486eac432368cb9d6439c28837f3697f813e7733f1551fd2656af350f6638bba53f96f48c117efa3d234b535b2cf15a5657e2
+  metadata.gz: cf8a4e78c06a9808930300c1aa05b45211ab0f733a79bddc22bd5ac3ca2bfff1a00d075ca596122295c82aeb909372d2a9c7a66bc27566386d529428209beda7
+  data.tar.gz: 7324a4d99c3ce3a890129eb5a3091459facbd0acf5818b7ff0624d168d2fee94613656db1fe1c1091f8f001c6c34cc34c66a835b69fb7d90191075bde455de5b

data/Gemfile

@@ -4,6 +4,7 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'logger'
 gem 'rake'
 gem 'rspec'
 gem 'rspec_junit_formatter'

data/README.md

@@ -94,4 +94,38 @@ end
 client.chat('Be poetic.', stream:)
 ```
 
+### Upload
+
+An upload is especially useful when processing audio / image / video / text files. To use:
+
+```ruby
+CAT_URL = 'https://images.unsplash.com/photo-1472491235688-bdc81a63246e?fm=jpg'
+DOG_URL = 'https://images.unsplash.com/photo-1517849845537-4d257902454a?fm=jpg'
+
+begin
+  cat_upload = client.upload(CAT_URL)
+  dog_upload = client.upload(DOG_URL)
+
+  completion = client.chat(stream: $stdout) do |prompt|
+    prompt.user do |message|
+      message.text 'What are these photos of?'
+      message.url(cat_upload.uri, cat_upload.mime_type)
+      message.url(dog_upload.uri, dog_upload.mime_type)
+    end
+  end
+ensure
+  cat_upload.delete!
+  dog_upload.delete!
+end
+```
+
 [Google API Reference `stream`](https://ai.google.dev/gemini-api/docs/api-overview#stream)
+
+### 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/google/chat/media_serializer.rb

@@ -6,8 +6,21 @@ module OmniAI
       # Overrides media serialize / deserialize.
       module MediaSerializer
         # @param media [OmniAI::Chat::Media]
-        # @return [Hash]
-        def self.serialize(media, *)
+        #
+        # @return [hash]
+        def self.serialize_as_file_data(media)
+          {
+            fileData: {
+              mimeType: media.type,
+              fileUri: media.uri,
+            },
+          }
+        end
+
+        # @param media [OmniAI::Chat::Media]
+        #
+        # @return [hash]
+        def self.serialize_as_inline_data(media)
           {
             inlineData: {
               mimeType: media.type,
@@ -15,6 +28,24 @@ module OmniAI
             },
           }
         end
+
+        # @param media [OmniAI::Chat::Media]
+        #
+        # @return [Hash]
+        def self.serialize(media, *)
+          if media.is_a?(OmniAI::Chat::URL) && use_file_data?(URI.parse(media.uri))
+            serialize_as_file_data(media)
+          else
+            serialize_as_inline_data(media)
+          end
+        end
+
+        # @param uri [URI]
+        #
+        # @return [Boolean]
+        def self.use_file_data?(uri)
+          uri.host.eql?('generativelanguage.googleapis.com') || uri.scheme.eql?('gs')
+        end
       end
     end
   end

data/lib/omniai/google/client.rb

@@ -59,6 +59,32 @@ module OmniAI
       def chat(messages = nil, model: Chat::DEFAULT_MODEL, temperature: nil, format: nil, stream: nil, tools: nil, &)
         Chat.process!(messages, model:, temperature:, format:, stream:, tools:, client: self, &)
       end
+
+      # @param io [File, String] required - a file or URL
+      #
+      # @raise [OmniAI::Google::Upload::FetchError]
+      #
+      # @return [OmniAI::Google::Upload::File]
+      def upload(io)
+        Upload.process!(client: self, io:)
+      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
+
+      # @return [String]
+      def path
+        if @project_id
+          "/#{@version}/projects/#{@project_id}/locations/#{@location}/publishers/google"
+        else
+          "/#{@version}"
+        end
+      end
     end
   end
 end

data/lib/omniai/google/embed.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module Google
+    # An Google embed implementation.
+    #
+    # Usage:
+    #
+    #   input = "..."
+    #   response = OmniAI::Google::Embed.process!(input, client: client)
+    #   response.embedding [0.0, ...]
+    class Embed < OmniAI::Embed
+      module Model
+        TEXT_EMBEDDING_004 = 'text-embedding-004'
+        TEXT_MULTILINGUAL_EMBEDDING_002 = 'text-multilingual-embedding-002'
+        EMBEDDING = TEXT_EMBEDDING_004
+        MULTILINGUAL_EMBEDDING = TEXT_MULTILINGUAL_EMBEDDING_002
+      end
+
+      DEFAULT_MODEL = Model::EMBEDDING
+
+      EMBEDDINGS_DESERIALIZER = proc do |data, *|
+        data['embeddings'].map { |embedding| embedding['values'] }
+      end
+
+      # @return [Context]
+      CONTEXT = Context.build do |context|
+        context.deserializers[:embeddings] = EMBEDDINGS_DESERIALIZER
+      end
+
+      protected
+
+      # @param response [HTTP::Response]
+      # @return [Response]
+      def parse!(response:)
+        Response.new(data: response.parse, context: CONTEXT)
+      end
+
+      # @return [Array<Hash<{ text: String }>]
+      def requests
+        arrayify(@input).map do |text|
+          {
+            model: "models/#{@model}",
+            content: { parts: [{ text: text }] },
+          }
+        end
+      end
+
+      # @return [Hash]
+      def payload
+        { requests: }
+      end
+
+      # @return [String]
+      def path
+        "/#{@client.path}/models/#{@model}:batchEmbedContents?key=#{@client.api_key}"
+      end
+
+      def arrayify(input)
+        input.is_a?(Array) ? input : [input]
+      end
+    end
+  end
+end

data/lib/omniai/google/upload/file.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module Google
+    class Upload
+      # A file that can be used for generating chat completions.
+      class File
+        class DeleteError < HTTPError; end
+
+        # @!attribute [rw] name
+        #   @return [String]
+        attr_accessor :name
+
+        # @attribute [rw] uri
+        #   @return [String]
+        attr_accessor :uri
+
+        # @attribute [rw] state
+        #   @return [String]
+        attr_accessor :state
+
+        # @attribute [rw] mime_type
+        #   @return [String]
+        attr_accessor :mime_type
+
+        # @param client [Client]
+        # @param data [Hash]
+        #
+        # @return [File]
+        def self.parse(client:, data:)
+          new(
+            client: client,
+            name: data['name'],
+            uri: data['uri'],
+            state: data['state'],
+            mime_type: data['mimeType']
+          )
+        end
+
+        # @param client [Client]
+        # @param name [String]
+        # @param uri [String]
+        # @param state [String]
+        # @param mime_type [String]
+        def initialize(client:, name:, uri:, state:, mime_type:)
+          @client = client
+          @name = name
+          @uri = uri
+          @state = state
+          @mime_type = mime_type
+        end
+
+        # @raise [DeleteError]
+        def delete!
+          response = @client.connection
+            .delete("/#{@client.version}/#{@name}", params: { key: @client.api_key })
+
+          raise DeleteError, response unless response.status.success?
+        end
+      end
+    end
+  end
+end

data/lib/omniai/google/upload.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module Google
+    # Uploads a file to Google to be used when generating completions.
+    class Upload
+      class FetchError < HTTPError; end
+
+      # @param client [Client]
+      # @param io [IO]
+      # @param mime_type [String]
+      def self.process!(client:, io:)
+        new(client:, io:).process!
+      end
+
+      # @param client [Client]
+      # @param file [File]
+      # @param mime_type [String]
+      def initialize(client:, io:)
+        @client = client
+        @io = io
+      end
+
+      # @raise [HTTPError]
+      #
+      # @return [Upload::File]
+      def process!
+        response = io! do |io|
+          response = @client
+            .connection
+            .headers({ 'X-Goog-Upload-Protocol' => 'raw' })
+            .post("/upload/#{@client.version}/files?key=#{@client.api_key}", body: HTTP::FormData::File.new(io))
+        end
+
+        raise OmniAI::HTTPError, response.flush unless response.status.ok?
+
+        File.parse(client: @client, data: response.parse['file'])
+      end
+
+      protected
+
+      # @raise [FetchError]
+      #
+      # @yield [io]
+      # @yieldparam io [IO]
+      def io!(&block)
+        case @io
+        when File, IO then block.call(@io)
+        else fetch!(&block)
+        end
+      end
+
+      # @raise [FetchError]
+      #
+      # @yield [tempfile]
+      # @yieldparam tempfile [Tempfile]
+      def fetch!
+        tempfile = Tempfile.new
+        tempfile.binmode
+
+        response = HTTP.follow.get(@io)
+        raise FetchError, response.flush unless response.status.success?
+
+        response.body.each { |chunk| tempfile.write(chunk) }
+        tempfile.rewind
+
+        yield(tempfile)
+      ensure
+        tempfile.close
+        tempfile.unlink
+      end
+    end
+  end
+end

data/lib/omniai/google/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAI
   module Google
-    VERSION = '1.9.1'
+    VERSION = '1.9.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniai-google
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 1.9.3
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-05 00:00:00.000000000 Z
+date: 2024-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -76,6 +76,9 @@ files:
 - lib/omniai/google/chat/usage_serializer.rb
 - lib/omniai/google/client.rb
 - lib/omniai/google/config.rb
+- lib/omniai/google/embed.rb
+- lib/omniai/google/upload.rb
+- lib/omniai/google/upload/file.rb
 - lib/omniai/google/version.rb
 homepage: https://github.com/ksylvest/omniai-google
 licenses: