omniai-google 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c0e81a12702acac4c59da29e174f77c053d068856063a0752e7f1e86dfa9870
-  data.tar.gz: 05e0cc7cc84038408a94769eb8d1b30c5fdbccd3f4ee21847d50721d64e8e41f
+  metadata.gz: b09fe2dc85e70bef186e70d5e6da204bf003fab07907147c9de01fcc86cfe5e2
+  data.tar.gz: 2869a79e69a256b7420eccc72f33f9cabae2683d12c8f6fc8911fdbfd2e9ccbd
 SHA512:
-  metadata.gz: 769fd0c52d6e83fb4bd90e5075e0cc332aca7deb6c56b16808175a0abf0cef97cef55c8991702550747e1b0672e0aec057ad9c8b98c94065f8943ea4a40904d9
-  data.tar.gz: 8b4f33b903fb5acc6744a85869f8be69113c3b7f0c4b5e0150aed8283aa2747a5c174e564a956963f0d152e27177ff159aa36776bedf7ade83f4fb5bb89f6382
+  metadata.gz: a9b7cce4e8fb35a74e7b03e63a819a4bec124b07d232931e5ceb52ddab3b500b10d881edec565e73c1d92c1657cc6ea8903683484092933d219b93458e054591
+  data.tar.gz: 7b3f222ddf9d002b9467ed9a54a177257c6981a1d6f70fbaaddecce939920e5d5f4b4c9fa419bd1cc8b3b0bb8c03d39c37e59ed2ba70e5ccf523d72a5a3a3516

data/README.md

@@ -27,21 +27,66 @@ client = OmniAI::Google::Client.new
 A client may also be passed the following options:
 
 - `api_key` (required - default is `ENV['GOOGLE_API_KEY']`)
+- `credentials` (optional)
 - `host` (optional)
 - `version` (optional - options are `v1` or `v1beta`)
 
 ### Configuration
 
-Global configuration is supported for 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
+
+**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']
-  config.host = '...' # default: 'https://generativelanguage.googleapis.com'
-  config.version = OmniAI::Google::Config::Version::BETA # either 'v1' or 'v1beta'
 end
 ```
 
+**w/ `credentials`**
+
+An alternative approach for authentication (required if using Vertex AI) is to use credentials directly:
+
+```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
+end
+```
+
+#### Host
+
+The host (defaults to `https://generativelanguage.googleapis.com`) may be changed (required if using Vertex AI) using:
+
+```ruby
+OmniAI::Google.configure do |config|
+  config.host = 'https://us-east4-aiplatform.googleapis.com' # see https://cloud.google.com/vertex-ai/docs/general/locations
+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
+```
+
+_The default API version is configured to **v1beta** instead of **v1** due to various missing features in **v1**._
+
 ### Chat
 
 A chat completion is generated by passing in a simple text prompt:

data/lib/omniai/google/chat.rb

@@ -117,7 +117,7 @@ module OmniAI
 
       # @return [String]
       def path
-        "/#{@client.version}/models/#{@model}:#{operation}"
+        "#{@client.path}/models/#{@model}:#{operation}"
       end
 
       # @return [String]

data/lib/omniai/google/client.rb

@@ -24,22 +24,27 @@ module OmniAI
       #   @return [String, nil]
       attr_accessor :version
 
-      # @param api_key [String] optional - defaults to `OmniAI::Google.config.api_key`
-      # @param host [String] optional - defaults to `OmniAI::Google.config.host`
-      # @param version [String] optional - defaults to `OmniAI::Google.config.version`
-      # @param logger [Logger] optional - defaults to `OmniAI::Google.config.logger`
-      # @param timeout [Integer] optional - defaults to `OmniAI::Google.config.timeout`
+      # @param api_key [String] default is `OmniAI::Google.config.api_key`
+      # @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`
+      # @param logger [Logger] default is `OmniAI::Google.config.logger`
+      # @param timeout [Integer] default is `OmniAI::Google.config.timeout`
       def initialize(
         api_key: OmniAI::Google.config.api_key,
+        credentials: OmniAI::Google.config.credentials,
         logger: OmniAI::Google.config.logger,
         host: OmniAI::Google.config.host,
         version: OmniAI::Google.config.version,
         timeout: OmniAI::Google.config.timeout
       )
-        raise(ArgumentError, %(ENV['GOOGLE_API_KEY'] must be defined or `api_key` must be passed)) if api_key.nil?
+        if api_key.nil? && credentials.nil?
+          raise(ArgumentError, "either an `api_key` or `credentials` must be provided")
+        end
 
         super(api_key:, host:, logger:, timeout:)
 
+        @credentials = credentials
         @version = version
       end
 
@@ -79,12 +84,45 @@ module OmniAI
 
       # @return [String]
       def path
-        if @project_id
-          "/#{@version}/projects/#{@project_id}/locations/#{@location}/publishers/google"
+        if project && location
+          "/#{@version}/projects/#{project}/locations/#{location}/publishers/google"
         else
           "/#{@version}"
         end
       end
+
+      # @return [HTTP::Client]
+      def connection
+        http = super
+        http = http.auth(auth) if auth?
+        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
+      end
+
+      # @return [Boolean]
+      def auth?
+        !@credentials.nil?
+      end
+
+      # @return [String] e.g. "Bearer ..."
+      def auth
+        @credentials.fetch_access_token!
+        "Bearer #{@credentials.access_token}"
+      end
     end
   end
 end

data/lib/omniai/google/config.rb

@@ -16,19 +16,26 @@ module OmniAI
       #   @return [String, nil]
       attr_accessor :version
 
+      # @!attribute [rw] credentials
+      #   @return [String, nil]
+      attr_accessor :credentials
+
       # @param api_key [String, nil] optional - defaults to `ENV['GOOGLE_API_KEY']`
+      # @param credentials [Google::Auth::ServiceAccountCredentials, nil] optional
       # @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 - defaults to
+      # @param logger [Logger, nil] optional
       # @param timeout [Integer, Hash, nil] optional
       def initialize(
         api_key: ENV.fetch("GOOGLE_API_KEY", nil),
+        credentials: 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
       end
     end

data/lib/omniai/google/upload.rb

@@ -27,7 +27,9 @@ module OmniAI
           response = @client
             .connection
             .headers({ "X-Goog-Upload-Protocol" => "raw" })
-            .post("/upload/#{@client.version}/files?key=#{@client.api_key}", body: HTTP::FormData::File.new(io))
+            .post("/upload/#{@client.version}/files",
+              params: { key: @client.api_key }.compact,
+              body: HTTP::FormData::File.new(io))
         end
 
         raise OmniAI::HTTPError, response.flush unless response.status.ok?

data/lib/omniai/google/version.rb

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

data/lib/omniai/google.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "googleauth"
 require "event_stream_parser"
 require "omniai"
 require "zeitwerk"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: omniai-google
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Kevin Sylvestre
 bindir: exe
 cert_chain: []
-date: 2025-03-27 00:00:00.000000000 Z
+date: 2025-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -23,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: googleauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: omniai
   requirement: !ruby/object:Gem::Requirement