gemini-ai 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 790a1c353ecc9e3122fc096f674d50fbd0ef36b4b0f9ab56ef66d180b0a5d4de
-  data.tar.gz: 2eac84cb99804362eea89063ea6ed66467af1ffb3a7d4ffd1ab186f7a2842157
+  metadata.gz: 3c6743cedf074b42aed890203de2d5db7697b6302c349c66bae9ac538bf2c680
+  data.tar.gz: ad0c8dd1ba69f58c0e37ed170bbd758231adea02245a63eb10fffa9a57fa2400
 SHA512:
-  metadata.gz: d82d466e8272ab1919c153d3f68ffb3ab4ebd5a750a3822daef4394a814b36c08c0f114e691cb52a5c830a74a0e9d208cd3d4407227592812f0534655dc5afc1
-  data.tar.gz: 7141a1bff79ea92aac09105b84fd9c2d5b68efe5184bf1ca0588dc420c0180ea65cd2fcca000ab0ea2cd00c1be188877f3f97ec6c7410f61bea4c8acf52b475c
+  metadata.gz: 558e2a13c12931f6bfbde1d625cb38b7779e08d8eb5bc0a845861902f50fbcbc43b64c67348220f35316b4a37504daa220c334b0479fb5493973bc49ab34e77c
+  data.tar.gz: 2df9f463de540a3d76f86252bd178ca5638caca7e172d59ea244f5f12d04c86d22dcbe2e219049a33ad318ffecc9aaff07c28ffe30aa69ebc109befa08acbcca

data/.gitignore

@@ -1 +1,2 @@
 *.gem
+.devcontainer

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gemini-ai (2.0.0)
+    gemini-ai (2.1.0)
       event_stream_parser (~> 1.0)
       faraday (~> 2.7, >= 2.7.12)
       googleauth (~> 1.9, >= 1.9.1)
@@ -36,7 +36,7 @@ GEM
     method_source (1.0.0)
     multi_json (1.15.0)
     os (1.1.4)
-    parallel (1.23.0)
+    parallel (1.24.0)
     parser (3.2.2.4)
       ast (~> 2.4.1)
       racc

data/README.md

@@ -1,6 +1,6 @@
 # Gemini AI
 
-A Ruby Gem for interacting with [Gemini](https://deepmind.google/technologies/gemini/) through [Vertex AI](https://cloud.google.com/vertex-ai) or [AI Studio](https://makersuite.google.com), Google's generative AI services.
+A Ruby Gem for interacting with [Gemini](https://deepmind.google/technologies/gemini/) through [Vertex AI](https://cloud.google.com/vertex-ai), [Generative Language API](https://ai.google.dev/api/rest), or [AI Studio](https://makersuite.google.com), Google's generative AI services.
 
 ![The logo shows a gemstone split into red and blue halves, symbolizing Ruby programming and Gemini AI. It's surrounded by a circuit-like design on a dark blue backdrop.](https://raw.githubusercontent.com/gbaptista/assets/main/gemini-ai/ruby-gemini-ai.png)
 
@@ -9,7 +9,7 @@ A Ruby Gem for interacting with [Gemini](https://deepmind.google/technologies/ge
 ## TL;DR and Quick Start
 
 ```ruby
-gem 'gemini-ai', '~> 2.0'
+gem 'gemini-ai', '~> 2.1.0'
 ```
 
 ```ruby
@@ -24,12 +24,20 @@ client = Gemini.new(
   options: { model: 'gemini-pro', stream: false }
 )
 
-# With a Service Account
+# With a Service Account Credentials File
 client = Gemini.new(
   credentials: {
     service: 'vertex-ai-api',
     file_path: 'google-credentials.json',
-    project_id: 'PROJECT_ID',
+    region: 'us-east4'
+  },
+  options: { model: 'gemini-pro', stream: false }
+)
+
+# With Application Default Credentials
+client = Gemini.new(
+  credentials: {
+    service: 'vertex-ai-api',
     region: 'us-east4'
   },
   options: { model: 'gemini-pro', stream: false }
@@ -67,8 +75,9 @@ Result:
 - [Setup](#setup)
     - [Installing](#installing)
     - [Credentials](#credentials)
-        - [Option 1: API Key](#option-1-api-key)
-        - [Option 2: Service Account](#option-2-service-account)
+        - [Option 1: API Key (Generative Language API)](#option-1-api-key-generative-language-api)
+        - [Option 2: Service Account Credentials File (Vertex AI API)](#option-2-service-account-credentials-file-vertex-ai-api)
+        - [Option 3: Application Default Credentials (Vertex AI API)](#option-3-application-default-credentials-vertex-ai-api)
         - [Required Data](#required-data)
 - [Usage](#usage)
     - [Client](#client)
@@ -91,18 +100,18 @@ Result:
 ### Installing
 
 ```sh
-gem install gemini-ai -v 2.0.0
+gem install gemini-ai -v 2.1.0
 ```
 
 ```sh
-gem 'gemini-ai', '~> 2.0'
+gem 'gemini-ai', '~> 2.1.0'
 ```
 
 ### Credentials
 
 > ⚠️ DISCLAIMER: Be careful with what you are doing, and never trust others' code related to this. These commands and instructions alter the level of access to your Google Cloud Account, and running them naively can lead to security risks as well as financial risks. People with access to your account can use it to steal data or incur charges. Run these commands at your own responsibility and due diligence; expect no warranties from the contributors of this project.
 
-#### Option 1: API Key
+#### Option 1: API Key (Generative Language API)
 
 You need a [Google Cloud](https://console.cloud.google.com) [_Project_](https://cloud.google.com/resource-manager/docs/creating-managing-projects), and then you can generate an API Key through the Google Cloud Console [here](https://console.cloud.google.com/apis/credentials).
 
@@ -111,7 +120,7 @@ You also need to enable the _Generative Language API_ service in your Google Clo
 
 Alternatively, you can generate an API Key through _Google AI Studio_ [here](https://makersuite.google.com/app/apikey). However, this approach will automatically create a project for you in your Google Cloud Account.
 
-#### Option 2: Service Account
+#### Option 2: Service Account Credentials File (Vertex AI API)
 
 You need a [Google Cloud](https://console.cloud.google.com) [_Project_](https://cloud.google.com/resource-manager/docs/creating-managing-projects) and a [_Service Account_](https://cloud.google.com/iam/docs/service-account-overview) to use [Vertex AI](https://cloud.google.com/vertex-ai) API.
 
@@ -165,11 +174,24 @@ gcloud projects add-iam-policy-binding PROJECT_ID \
   --role='roles/ml.admin'
 ```
 
+#### Option 3: Application Default Credentials (Vertex AI API)
+
+Similar to [Option 2](#option-2-service-account-credentials-file-vertex-ai-api), but you don't need to download a `google-credentials.json`. [_Application Default Credentials_](https://cloud.google.com/docs/authentication/application-default-credentials) automatically find credentials based on the application environment.
+
+For local development, you can generate your default credentials using the [gcloud CLI](https://cloud.google.com/sdk/gcloud) as follows:
+
+```sh
+gcloud auth application-default login 
+```
+
+For more details about alternative methods and different environments, check the official documentation:
+[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc)
+
 #### Required Data
 
 After choosing an option, you should have all the necessary data and access to use Gemini.
 
-For API Key:
+**Option 1**, for API Key:
 
 ```ruby
 {
@@ -187,13 +209,21 @@ Remember that hardcoding your API key in code is unsafe; it's preferable to use
 }
 ```
 
-Alternativelly, for Service Account, a `google-credentials.json` file, a `PROJECT_ID`, and a `REGION`:
+**Option 2**: For the Service Account, provide a `google-credentials.json` file and a `REGION`:
 
 ```ruby
 {
   service: 'vertex-ai-api',
   file_path: 'google-credentials.json',
-  project_id: 'PROJECT_ID',
+  region: 'us-east4'
+}
+```
+
+**Option 3**: For _Application Default Credentials_, omit both the `api_key` and the `file_path`:
+
+```ruby
+{
+  service: 'vertex-ai-api',
   region: 'us-east4'
 }
 ```
@@ -212,6 +242,15 @@ Tokyo, Japan (asia-northeast1)
 
 You can follow here if new regions are available: [Gemini API](https://cloud.google.com/vertex-ai/docs/generative-ai/model-reference/gemini)
 
+You might want to explicitly set a Google Cloud Project ID, which you can do as follows:
+
+```ruby
+{
+  service: 'vertex-ai-api',
+  project_id: 'PROJECT_ID'
+}
+```
+
 ## Usage
 
 ### Client
@@ -230,12 +269,20 @@ client = Gemini.new(
   options: { model: 'gemini-pro', stream: false }
 )
 
-# With a Service Account
+# With a Service Account Credentials File
 client = Gemini.new(
   credentials: {
     service: 'vertex-ai-api',
     file_path: 'google-credentials.json',
-    project_id: 'PROJECT_ID',
+    region: 'us-east4'
+  },
+  options: { model: 'gemini-pro', stream: false }
+)
+
+# With Application Default Credentials
+client = Gemini.new(
+  credentials: {
+    service: 'vertex-ai-api',
     region: 'us-east4'
   },
   options: { model: 'gemini-pro', stream: false }
@@ -395,7 +442,7 @@ Result:
 
 ### Tools (Functions) Calling
 
-> As of the writing of this README, only the `gemini-pro` model [supports](https://cloud.google.com/vertex-ai/docs/generative-ai/multimodal/function-calling#supported_models) tools (functions) calls.
+> As of the writing of this README, only the `vertex-ai-api` service and the `gemini-pro` model [supports](https://cloud.google.com/vertex-ai/docs/generative-ai/multimodal/function-calling#supported_models) tools (functions) calls.
 
 You can provide specifications for [tools (functions)](https://cloud.google.com/vertex-ai/docs/generative-ai/multimodal/function-calling) using [JSON Schema](https://json-schema.org) to generate potential calls to them:
 
@@ -567,7 +614,7 @@ gem build gemini-ai.gemspec
 
 gem signin
 
-gem push gemini-ai-2.0.0.gem
+gem push gemini-ai-2.1.0.gem
 ```
 
 ### Updating the README

data/controllers/client.rb

@@ -12,17 +12,30 @@ module Gemini
         if config[:credentials][:api_key]
           @authentication = :api_key
           @api_key = config[:credentials][:api_key]
-        else
+        elsif config[:credentials][:file_path]
           @authentication = :service_account
           @authorizer = ::Google::Auth::ServiceAccountCredentials.make_creds(
             json_key_io: File.open(config[:credentials][:file_path]),
             scope: 'https://www.googleapis.com/auth/cloud-platform'
           )
+        else
+          @authentication = :default_credentials
+          @authorizer = ::Google::Auth.get_application_default
+        end
+
+        if @authentication == :service_account || @authentication == :default_credentials
+          @project_id = if config[:credentials][:project_id].nil?
+                          @authorizer.project_id || @authorizer.quota_project_id
+                        else
+                          config[:credentials][:project_id]
+                        end
+
+          raise StandardError, 'Could not determine project_id, which is required.' if @project_id.nil?
         end
 
         @address = case config[:credentials][:service]
                    when 'vertex-ai-api'
-                     "https://#{config[:credentials][:region]}-aiplatform.googleapis.com/v1/projects/#{config[:credentials][:project_id]}/locations/#{config[:credentials][:region]}/publishers/google/models/#{config[:options][:model]}"
+                     "https://#{config[:credentials][:region]}-aiplatform.googleapis.com/v1/projects/#{@project_id}/locations/#{config[:credentials][:region]}/publishers/google/models/#{config[:options][:model]}"
                    when 'generative-language-api'
                      "https://generativelanguage.googleapis.com/v1/models/#{config[:options][:model]}"
                    else
@@ -55,7 +68,7 @@ module Gemini
         response = Faraday.new.post do |request|
           request.url url
           request.headers['Content-Type'] = 'application/json'
-          if @authentication == :service_account
+          if @authentication == :service_account || @authentication == :default_credentials
             request.headers['Authorization'] = "Bearer #{@authorizer.fetch_access_token!['access_token']}"
           end
 

data/static/gem.rb

@@ -3,10 +3,10 @@
 module Gemini
   GEM = {
     name: 'gemini-ai',
-    version: '2.0.0',
+    version: '2.1.0',
     author: 'gbaptista',
     summary: "Interact with Google's Gemini AI.",
-    description: "A Ruby Gem for interacting with Gemini through Vertex AI or AI Studio, Google's generative AI services.",
+    description: "A Ruby Gem for interacting with Gemini through Vertex AI, Generative Language API, or AI Studio, Google's generative AI services.",
     github: 'https://github.com/gbaptista/gemini-ai',
     gem_server: 'https://rubygems.org',
     license: 'MIT',

data/template.md

@@ -1,6 +1,6 @@
 # Gemini AI
 
-A Ruby Gem for interacting with [Gemini](https://deepmind.google/technologies/gemini/) through [Vertex AI](https://cloud.google.com/vertex-ai) or [AI Studio](https://makersuite.google.com), Google's generative AI services.
+A Ruby Gem for interacting with [Gemini](https://deepmind.google/technologies/gemini/) through [Vertex AI](https://cloud.google.com/vertex-ai), [Generative Language API](https://ai.google.dev/api/rest), or [AI Studio](https://makersuite.google.com), Google's generative AI services.
 
 ![The logo shows a gemstone split into red and blue halves, symbolizing Ruby programming and Gemini AI. It's surrounded by a circuit-like design on a dark blue backdrop.](https://raw.githubusercontent.com/gbaptista/assets/main/gemini-ai/ruby-gemini-ai.png)
 
@@ -9,7 +9,7 @@ A Ruby Gem for interacting with [Gemini](https://deepmind.google/technologies/ge
 ## TL;DR and Quick Start
 
 ```ruby
-gem 'gemini-ai', '~> 2.0'
+gem 'gemini-ai', '~> 2.1.0'
 ```
 
 ```ruby
@@ -24,12 +24,20 @@ client = Gemini.new(
   options: { model: 'gemini-pro', stream: false }
 )
 
-# With a Service Account
+# With a Service Account Credentials File
 client = Gemini.new(
   credentials: {
     service: 'vertex-ai-api',
     file_path: 'google-credentials.json',
-    project_id: 'PROJECT_ID',
+    region: 'us-east4'
+  },
+  options: { model: 'gemini-pro', stream: false }
+)
+
+# With Application Default Credentials
+client = Gemini.new(
+  credentials: {
+    service: 'vertex-ai-api',
     region: 'us-east4'
   },
   options: { model: 'gemini-pro', stream: false }
@@ -69,18 +77,18 @@ Result:
 ### Installing
 
 ```sh
-gem install gemini-ai -v 2.0.0
+gem install gemini-ai -v 2.1.0
 ```
 
 ```sh
-gem 'gemini-ai', '~> 2.0'
+gem 'gemini-ai', '~> 2.1.0'
 ```
 
 ### Credentials
 
 > ⚠️ DISCLAIMER: Be careful with what you are doing, and never trust others' code related to this. These commands and instructions alter the level of access to your Google Cloud Account, and running them naively can lead to security risks as well as financial risks. People with access to your account can use it to steal data or incur charges. Run these commands at your own responsibility and due diligence; expect no warranties from the contributors of this project.
 
-#### Option 1: API Key
+#### Option 1: API Key (Generative Language API)
 
 You need a [Google Cloud](https://console.cloud.google.com) [_Project_](https://cloud.google.com/resource-manager/docs/creating-managing-projects), and then you can generate an API Key through the Google Cloud Console [here](https://console.cloud.google.com/apis/credentials).
 
@@ -89,7 +97,7 @@ You also need to enable the _Generative Language API_ service in your Google Clo
 
 Alternatively, you can generate an API Key through _Google AI Studio_ [here](https://makersuite.google.com/app/apikey). However, this approach will automatically create a project for you in your Google Cloud Account.
 
-#### Option 2: Service Account
+#### Option 2: Service Account Credentials File (Vertex AI API)
 
 You need a [Google Cloud](https://console.cloud.google.com) [_Project_](https://cloud.google.com/resource-manager/docs/creating-managing-projects) and a [_Service Account_](https://cloud.google.com/iam/docs/service-account-overview) to use [Vertex AI](https://cloud.google.com/vertex-ai) API.
 
@@ -143,11 +151,24 @@ gcloud projects add-iam-policy-binding PROJECT_ID \
   --role='roles/ml.admin'
 ```
 
+#### Option 3: Application Default Credentials (Vertex AI API)
+
+Similar to [Option 2](#option-2-service-account-credentials-file-vertex-ai-api), but you don't need to download a `google-credentials.json`. [_Application Default Credentials_](https://cloud.google.com/docs/authentication/application-default-credentials) automatically find credentials based on the application environment.
+
+For local development, you can generate your default credentials using the [gcloud CLI](https://cloud.google.com/sdk/gcloud) as follows:
+
+```sh
+gcloud auth application-default login 
+```
+
+For more details about alternative methods and different environments, check the official documentation:
+[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc)
+
 #### Required Data
 
 After choosing an option, you should have all the necessary data and access to use Gemini.
 
-For API Key:
+**Option 1**, for API Key:
 
 ```ruby
 {
@@ -165,13 +186,21 @@ Remember that hardcoding your API key in code is unsafe; it's preferable to use
 }
 ```
 
-Alternativelly, for Service Account, a `google-credentials.json` file, a `PROJECT_ID`, and a `REGION`:
+**Option 2**: For the Service Account, provide a `google-credentials.json` file and a `REGION`:
 
 ```ruby
 {
   service: 'vertex-ai-api',
   file_path: 'google-credentials.json',
-  project_id: 'PROJECT_ID',
+  region: 'us-east4'
+}
+```
+
+**Option 3**: For _Application Default Credentials_, omit both the `api_key` and the `file_path`:
+
+```ruby
+{
+  service: 'vertex-ai-api',
   region: 'us-east4'
 }
 ```
@@ -190,6 +219,15 @@ Tokyo, Japan (asia-northeast1)
 
 You can follow here if new regions are available: [Gemini API](https://cloud.google.com/vertex-ai/docs/generative-ai/model-reference/gemini)
 
+You might want to explicitly set a Google Cloud Project ID, which you can do as follows:
+
+```ruby
+{
+  service: 'vertex-ai-api',
+  project_id: 'PROJECT_ID'
+}
+```
+
 ## Usage
 
 ### Client
@@ -208,12 +246,20 @@ client = Gemini.new(
   options: { model: 'gemini-pro', stream: false }
 )
 
-# With a Service Account
+# With a Service Account Credentials File
 client = Gemini.new(
   credentials: {
     service: 'vertex-ai-api',
     file_path: 'google-credentials.json',
-    project_id: 'PROJECT_ID',
+    region: 'us-east4'
+  },
+  options: { model: 'gemini-pro', stream: false }
+)
+
+# With Application Default Credentials
+client = Gemini.new(
+  credentials: {
+    service: 'vertex-ai-api',
     region: 'us-east4'
   },
   options: { model: 'gemini-pro', stream: false }
@@ -373,7 +419,7 @@ Result:
 
 ### Tools (Functions) Calling
 
-> As of the writing of this README, only the `gemini-pro` model [supports](https://cloud.google.com/vertex-ai/docs/generative-ai/multimodal/function-calling#supported_models) tools (functions) calls.
+> As of the writing of this README, only the `vertex-ai-api` service and the `gemini-pro` model [supports](https://cloud.google.com/vertex-ai/docs/generative-ai/multimodal/function-calling#supported_models) tools (functions) calls.
 
 You can provide specifications for [tools (functions)](https://cloud.google.com/vertex-ai/docs/generative-ai/multimodal/function-calling) using [JSON Schema](https://json-schema.org) to generate potential calls to them:
 
@@ -545,7 +591,7 @@ gem build gemini-ai.gemspec
 
 gem signin
 
-gem push gemini-ai-2.0.0.gem
+gem push gemini-ai-2.1.0.gem
 ```
 
 ### Updating the README

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gemini-ai
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - gbaptista
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-15 00:00:00.000000000 Z
+date: 2023-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -64,8 +64,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.9.1
-description: A Ruby Gem for interacting with Gemini through Vertex AI or AI Studio,
-  Google's generative AI services.
+description: A Ruby Gem for interacting with Gemini through Vertex AI, Generative
+  Language API, or AI Studio, Google's generative AI services.
 email: 
 executables: []
 extensions: []