omniai-google 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b09fe2dc85e70bef186e70d5e6da204bf003fab07907147c9de01fcc86cfe5e2
-  data.tar.gz: 2869a79e69a256b7420eccc72f33f9cabae2683d12c8f6fc8911fdbfd2e9ccbd
+  metadata.gz: ef7814ad2fd60f7d89dd87a2350c23496d4846e172393bb0b8fbf3ffde48347f
+  data.tar.gz: 7ead40b0168c010885d0af4fb8633d5da67ef187508777aa506528a5946bef75
 SHA512:
-  metadata.gz: a9b7cce4e8fb35a74e7b03e63a819a4bec124b07d232931e5ceb52ddab3b500b10d881edec565e73c1d92c1657cc6ea8903683484092933d219b93458e054591
-  data.tar.gz: 7b3f222ddf9d002b9467ed9a54a177257c6981a1d6f70fbaaddecce939920e5d5f4b4c9fa419bd1cc8b3b0bb8c03d39c37e59ed2ba70e5ccf523d72a5a3a3516
+  metadata.gz: f49152ce0896a0c4ed9668dcc5f4abce7363d4dfe907fd79a7511363fa5e8b7ec1797d1449653c22fb5dfbb9f49054359d7d57102607ec59699c113975d7fdb4
+  data.tar.gz: 8a88be48a793faefd52d98928fc57b9b1acdc84e1ad0d82735ca6605e63cfdfb7119c6835dc88c51d323cb4d0155a61d5c49995ae2f7b546b937ab333bb90471

data/README.md

@@ -35,57 +35,34 @@ A client may also be passed the following options:
 
 Vertex AI and Google AI offer different options for interacting w/ Google's AI APIs. Checkout the [Vertex AI and Google AI differences](https://cloud.google.com/vertex-ai/generative-ai/docs/overview#how-gemini-vertex-different-gemini-aistudio) to determine which option best fits your requirements.
 
-#### Authentication
+#### Configuration w/ Google AI
 
-**w/ `api_key`**
-
-The quickest way to authenticate (available if using Google AI) is by using an API key:
-
-```ruby
-OmniAI::Google.configure do |config|
-  config.api_key = 'sk-...' # default: ENV['GOOGLE_API_KEY']
-end
-```
-
-**w/ `credentials`**
-
-An alternative approach for authentication (required if using Vertex AI) is to use credentials directly:
+If using Gemini simply provide an `api_key`:
 
 ```ruby
-require 'googleauth'
-
-credentials = Google::Auth::ServiceAccountCredentials.make_creds(
-  json_key_io: File.open('credentials.json'),
-  scope: 'https://www.googleapis.com/auth/cloud-platform'
-)
-
 OmniAI::Google.configure do |config|
-  config.credentials = credentials
+  config.api_key = 'sk-...' # defaults is `ENV['GOOGLE_API_KEY']`
 end
 ```
 
-#### Host
+#### Configuration w/ Vertex AI
 
-The host (defaults to `https://generativelanguage.googleapis.com`) may be changed (required if using Vertex AI) using:
+If using Vertex supply the `credentials`, `host`, `location_id` and `project_id`:
 
 ```ruby
 OmniAI::Google.configure do |config|
-  config.host = 'https://us-east4-aiplatform.googleapis.com' # see https://cloud.google.com/vertex-ai/docs/general/locations
+  config.credentials = File.open("./credentials.json") # default is `ENV['GOOGLE_CREDENTIALS_PATH']` / `ENV['GOOGLE_CREDENTIALS_JSON']`
+  config.host = 'https://us-east4-aiplatform.googleapis.com' # default is `ENV['GOOGLE_HOST']`
+  config.location_id = 'us-east4' # defaults is `ENV['GOOGLE_LOCATION_ID']`
+  config.project_id = '...' # defaults is `ENV['GOOGLE_PROJECT_ID']`
 end
 ```
 
-#### Version
-
-The version (defaults to `v1beta`) may be changed using:
-
-```ruby
-OmniAI::Google.configure do |config|
-  # ...
-  config.version = OmniAI::Google::Config::Version::STABLE # see https://ai.google.dev/gemini-api/docs/api-versions
-end
-```
+Credentials may be configured using:
 
-_The default API version is configured to **v1beta** instead of **v1** due to various missing features in **v1**._
+1. A `File` / `String` / `Pathname`.
+2. Assigning `ENV['GOOGLE_CREDENTIALS_PATH']` as the path to the `credentials.json`.
+3. Assigning `ENV['GOOGLE_CREDENTIALS_JSON']` to the contents of `credentials.json`.
 
 ### Chat
 

data/lib/omniai/google/chat.rb

@@ -73,7 +73,7 @@ module OmniAI
           .connection
           .accept(:json)
           .post(path, params: {
-            key: @client.api_key,
+            key: (@client.api_key unless @client.credentials?),
             alt: ("sse" if stream?),
           }.compact, json: payload)
       end
@@ -99,7 +99,7 @@ module OmniAI
 
       # @return [Hash]
       def generation_config
-        response_mime_type = (JSON_MIME_TYPE if json_mime_type?)
+        response_mime_type = (JSON_MIME_TYPE if @format.eql?(:json))
 
         return unless @temperature || response_mime_type
 
@@ -109,12 +109,6 @@ module OmniAI
         }.compact
       end
 
-      # Checks if setting a jsonMimeType is supported
-      # @return [Boolean]
-      def json_mime_type?
-        @client.version == OmniAI::Google::Config::Version::BETA && @format.eql?(:json)
-      end
-
       # @return [String]
       def path
         "#{@client.path}/models/#{@model}:#{operation}"

data/lib/omniai/google/client.rb

@@ -25,6 +25,8 @@ module OmniAI
       attr_accessor :version
 
       # @param api_key [String] default is `OmniAI::Google.config.api_key`
+      # @param project_id [String] default is `OmniAI::Google.config.project_id`
+      # @param location_id [String] default is `OmniAI::Google.config.location_id`
       # @param credentials [Google::Auth::ServiceAccountCredentials] default is `OmniAI::Google.config.credentials`
       # @param host [String] default is `OmniAI::Google.config.host`
       # @param version [String] default is `OmniAI::Google.config.version`
@@ -32,6 +34,8 @@ module OmniAI
       # @param timeout [Integer] default is `OmniAI::Google.config.timeout`
       def initialize(
         api_key: OmniAI::Google.config.api_key,
+        project_id: OmniAI::Google.config.project_id,
+        location_id: OmniAI::Google.config.location_id,
         credentials: OmniAI::Google.config.credentials,
         logger: OmniAI::Google.config.logger,
         host: OmniAI::Google.config.host,
@@ -44,6 +48,8 @@ module OmniAI
 
         super(api_key:, host:, logger:, timeout:)
 
+        @project_id = project_id
+        @location_id = location_id
         @credentials = credentials
         @version = version
       end
@@ -84,8 +90,8 @@ module OmniAI
 
       # @return [String]
       def path
-        if project && location
-          "/#{@version}/projects/#{project}/locations/#{location}/publishers/google"
+        if @project_id && @location_id
+          "/#{@version}/projects/#{@project_id}/locations/#{@location_id}/publishers/google"
         else
           "/#{@version}"
         end
@@ -94,30 +100,22 @@ module OmniAI
       # @return [HTTP::Client]
       def connection
         http = super
-        http = http.auth(auth) if auth?
+        http = http.auth(auth) if credentials?
         http
       end
 
-    private
-
-      # @return [String, nil]
-      def location
-        @location ||= begin
-          match = @host.match(%r{//(?<location>[\w\-]+)-aiplatform\.googleapis\.com})
-          match[:location] if match
-        end
-      end
-
-      # @return [String, nil]
-      def project
-        @credentials&.project_id
+      # @return [Boolean]
+      def credentials?
+        !@credentials.nil?
       end
 
       # @return [Boolean]
-      def auth?
-        !@credentials.nil?
+      def vertex?
+        @host.include?("aiplatform.googleapis.com")
       end
 
+    private
+
       # @return [String] e.g. "Bearer ..."
       def auth
         @credentials.fetch_access_token!

data/lib/omniai/google/config.rb

@@ -10,33 +10,50 @@ module OmniAI
       end
 
       DEFAULT_HOST = "https://generativelanguage.googleapis.com"
-      DEFAULT_VERSION = Version::BETA
 
-      # @!attribute [rw] version
+      # @!attribute [rw] project_id
       #   @return [String, nil]
-      attr_accessor :version
+      attr_accessor :project_id
 
-      # @!attribute [rw] credentials
+      # @!attribute [rw] location_id
       #   @return [String, nil]
-      attr_accessor :credentials
+      attr_accessor :location_id
 
       # @param api_key [String, nil] optional - defaults to `ENV['GOOGLE_API_KEY']`
-      # @param credentials [Google::Auth::ServiceAccountCredentials, nil] optional
+      # @param project_id [String, nil] optional - defaults to `ENV['GOOGLE_PROJECT_ID']`
+      # @param location_id [String, nil] optional - defaults to `ENV['GOOGLE_LOCATION_ID']`
       # @param host [String, nil] optional - defaults to `ENV['GOOGLE_HOST'] w/ fallback to `DEFAULT_HOST`
       # @param version [String, nil] optional - defaults to `ENV['GOOGLE_VERSION'] w/ fallback to `DEFAULT_VERSION`
       # @param logger [Logger, nil] optional
       # @param timeout [Integer, Hash, nil] optional
       def initialize(
         api_key: ENV.fetch("GOOGLE_API_KEY", nil),
-        credentials: nil,
+        project_id: ENV.fetch("GOOGLE_PROJECT_ID", nil),
+        location_id: ENV.fetch("GOOGLE_LOCATION_ID", nil),
         host: ENV.fetch("GOOGLE_HOST", DEFAULT_HOST),
-        version: ENV.fetch("GOOGLE_VERSION", DEFAULT_VERSION),
         logger: nil,
         timeout: nil
       )
         super(api_key:, host:, logger:, timeout:)
-        @credentials = credentials
-        @version = version
+        @project_id = project_id
+        @location_id = location_id
+      end
+
+      # @return [String]
+      def version
+        @host.eql?(DEFAULT_HOST) ? Version::BETA : Version::STABLE
+      end
+
+      # @return [Google::Auth::ServiceAccountCredentials, nil]
+      def credentials
+        return @credentials if defined?(@credentials)
+
+        Credentials.detect
+      end
+
+      # @param value [String, File, Google::Auth::ServiceAccountCredentials, nil]
+      def credentials=(value)
+        @credentials = Credentials.parse(value)
       end
     end
   end

data/lib/omniai/google/credentials.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module Google
+    # @example
+    #   OmniAI::Google::Credentials.parse(Google::Auth::ServiceAccountCredentials.make_creds(...))
+    #   OmniAI::Google::Credentials.parse(File.open("./credentials.json"))
+    #   OmniAI::Google::Credentials.parse("./credentials.json")
+    module Credentials
+      SCOPE = %w[https://www.googleapis.com/auth/cloud-platform].join(",")
+
+      # @return [Google::Auth::ServiceAccountCredentials, nil]
+      def self.detect
+        case
+        when ENV.key?("GOOGLE_CREDENTIALS_PATH") then parse(Pathname.new(ENV.fetch("GOOGLE_CREDENTIALS_PATH")))
+        when ENV.key?("GOOGLE_CREDENTIALS_JSON") then parse(StringIO.new(ENV.fetch("GOOGLE_CREDENTIALS_JSON")))
+        end
+      end
+
+      # @param value [Google::Auth::ServiceAccountCredentials, IO, Pathname, String nil]
+      # @return [Google::Auth::ServiceAccountCredentials]
+      def self.parse(value)
+        case value
+        when ::Google::Auth::ServiceAccountCredentials then value
+        when IO, StringIO then ::Google::Auth::ServiceAccountCredentials.make_creds(json_key_io: value, scope: SCOPE)
+        when Pathname then parse(File.open(value))
+        when String then parse(StringIO.new(value))
+        end
+      end
+    end
+  end
+end

data/lib/omniai/google/embed.rb

@@ -12,6 +12,7 @@ module OmniAI
     class Embed < OmniAI::Embed
       module Model
         TEXT_EMBEDDING_004 = "text-embedding-004"
+        TEXT_EMBEDDING_005 = "text-embedding-005"
         TEXT_MULTILINGUAL_EMBEDDING_002 = "text-multilingual-embedding-002"
         EMBEDDING = TEXT_EMBEDDING_004
         MULTILINGUAL_EMBEDDING = TEXT_MULTILINGUAL_EMBEDDING_002
@@ -19,24 +20,48 @@ module OmniAI
 
       DEFAULT_MODEL = Model::EMBEDDING
 
-      EMBEDDINGS_DESERIALIZER = proc do |data, *|
+      DEFAULT_EMBEDDINGS_DESERIALIZER = proc do |data, *|
         data["embeddings"].map { |embedding| embedding["values"] }
       end
 
+      VERTEX_EMBEDDINGS_DESERIALIZER = proc do |data, *|
+        data["predictions"].map { |prediction| prediction["embeddings"]["values"] }
+      end
+
+      # @return [Context]
+      DEFAULT_CONTEXT = Context.build do |context|
+        context.deserializers[:embeddings] = DEFAULT_EMBEDDINGS_DESERIALIZER
+      end
+
       # @return [Context]
-      CONTEXT = Context.build do |context|
-        context.deserializers[:embeddings] = EMBEDDINGS_DESERIALIZER
+      VERTEX_CONTEXT = Context.build do |context|
+        context.deserializers[:embeddings] = VERTEX_EMBEDDINGS_DESERIALIZER
       end
 
     protected
 
+      # @return [Boolean]
+      def vertex?
+        @client.vertex?
+      end
+
+      # @return [Context]
+      def context
+        vertex? ? VERTEX_CONTEXT : DEFAULT_CONTEXT
+      end
+
       # @param response [HTTP::Response]
       # @return [Response]
       def parse!(response:)
-        Response.new(data: response.parse, context: CONTEXT)
+        Response.new(data: response.parse, context:)
+      end
+
+      # @return [Array[Hash]]
+      def instances
+        arrayify(@input).map { |content| { content: } }
       end
 
-      # @return [Array<Hash<{ text: String }>]
+      # @return [Array[Hash]]
       def requests
         arrayify(@input).map do |text|
           {
@@ -48,14 +73,26 @@ module OmniAI
 
       # @return [Hash]
       def payload
-        { requests: }
+        vertex? ? { instances: } : { requests: }
+      end
+
+      # @return [Hash]
+      def params
+        { key: (@client.api_key unless @client.credentials?) }.compact
       end
 
       # @return [String]
       def path
-        "/#{@client.path}/models/#{@model}:batchEmbedContents?key=#{@client.api_key}"
+        "/#{@client.path}/models/#{@model}:#{procedure}"
+      end
+
+      # @return [String]
+      def procedure
+        vertex? ? "predict" : "batchEmbedContents"
       end
 
+      # @param input [Object]
+      # @return [Array]
       def arrayify(input)
         input.is_a?(Array) ? input : [input]
       end

data/lib/omniai/google/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAI
   module Google
-    VERSION = "2.2.1"
+    VERSION = "2.3.0"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: omniai-google
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 bindir: exe
 cert_chain: []
-date: 2025-03-31 00:00:00.000000000 Z
+date: 2025-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -43,14 +43,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -90,6 +90,7 @@ files:
 - lib/omniai/google/chat/usage_serializer.rb
 - lib/omniai/google/client.rb
 - lib/omniai/google/config.rb
+- lib/omniai/google/credentials.rb
 - lib/omniai/google/embed.rb
 - lib/omniai/google/upload.rb
 - lib/omniai/google/upload/file.rb