omniai-google 2.2.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c0e81a12702acac4c59da29e174f77c053d068856063a0752e7f1e86dfa9870
-  data.tar.gz: 05e0cc7cc84038408a94769eb8d1b30c5fdbccd3f4ee21847d50721d64e8e41f
+  metadata.gz: e870633ad811d978c7d3e70313d96d646a2ec03bd2ca989c24ebf84dfe9a1bbc
+  data.tar.gz: 5bdd175f1a6ec4299a76f02d00c66e6e8615f05408c3c77edbad2aca096c67f9
 SHA512:
-  metadata.gz: 769fd0c52d6e83fb4bd90e5075e0cc332aca7deb6c56b16808175a0abf0cef97cef55c8991702550747e1b0672e0aec057ad9c8b98c94065f8943ea4a40904d9
-  data.tar.gz: 8b4f33b903fb5acc6744a85869f8be69113c3b7f0c4b5e0150aed8283aa2747a5c174e564a956963f0d152e27177ff159aa36776bedf7ade83f4fb5bb89f6382
+  metadata.gz: bf8f59a91eff99a9b266f9d487b580999322e27107bc0591c12fe070ffe61b1a177452c3504f3f20a2cdcf38aec642a121a4212715c5f6ba594701b5c8f4ec94
+  data.tar.gz: 8ea4b0be462ce5df1e502323d2230df7652e83bc57afe8706517fe1c9188680c318ffcfc90a9e6728bd0f238339ab4aaba642dd05c0cd8d31ee7d3b365cadb09

data/README.md

@@ -27,21 +27,45 @@ 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.
+
+#### Configuration w/ Gemini
+
+**w/ `api_key`**
+
+If using Gemini simply provide an `api_key`:
+
+```ruby
+OmniAI::Google.configure do |config|
+  config.api_key = 'sk-...' # defaults is `ENV['GOOGLE_API_KEY']`
+end
+```
+
+#### Configuration w/ Vertex
+
+If using Vertex supply the `credentials`, `host`, `location_id` and `project_id`:
 
 ```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'
+  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
 ```
 
+Credentials may be configured using:
+
+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
 
 A chat completion is generated by passing in a simple text prompt:

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,15 +109,9 @@ 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.version}/models/#{@model}:#{operation}"
+        "#{@client.path}/models/#{@model}:#{operation}"
       end
 
       # @return [String]

data/lib/omniai/google/client.rb

@@ -24,22 +24,33 @@ 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 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`
+      # @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,
+        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,
         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:)
 
+        @project_id = project_id
+        @location_id = location_id
+        @credentials = credentials
         @version = version
       end
 
@@ -79,12 +90,32 @@ module OmniAI
 
       # @return [String]
       def path
-        if @project_id
-          "/#{@version}/projects/#{@project_id}/locations/#{@location}/publishers/google"
+        if @project_id && @location_id
+          "/#{@version}/projects/#{@project_id}/locations/#{@location_id}/publishers/google"
         else
           "/#{@version}"
         end
       end
+
+      # @return [HTTP::Client]
+      def connection
+        http = super
+        http = http.auth(auth) if credentials?
+        http
+      end
+
+      # @return [Boolean]
+      def credentials?
+        !@credentials.nil?
+      end
+
+    private
+
+      # @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

@@ -10,26 +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] location_id
+      #   @return [String, nil]
+      attr_accessor :location_id
 
       # @param api_key [String, nil] optional - defaults to `ENV['GOOGLE_API_KEY']`
+      # @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 - defaults to
+      # @param logger [Logger, nil] optional
       # @param timeout [Integer, Hash, nil] optional
       def initialize(
         api_key: ENV.fetch("GOOGLE_API_KEY", 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:)
-        @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/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.2"
   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.2
 platform: ruby
 authors:
 - Kevin Sylvestre
 bindir: exe
 cert_chain: []
-date: 2025-03-27 00:00:00.000000000 Z
+date: 2025-04-03 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
@@ -76,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