RubyGems - gemini-ai - Versions diffs - 4.0.0 → 4.2.0 - Mend

gemini-ai 4.0.0 → 4.2.0

Files changed (12) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b66c146b7230d838c888d5f90107f07bcc2827c7710b77c1284c52315b3c9515
-  data.tar.gz: c125664051e260270bb08b81ecc932a3e4b730ea1c69601ba93af4749af54fcf
+  metadata.gz: 7fa034b81983b8925267cdc2bb4cbf6170b7d5ecccfb26a705d70a1643f1e7ad
+  data.tar.gz: 077eec4e066836c80d8e0d6e26940086588876548f8d0e38b01a0a89aaf74646
 SHA512:
-  metadata.gz: dd67f092295620ff45cb75f07b67dc0753d54c92ff598284a0f10ce4a45e7f395aad0235320fb95ab86bb12f9033c21e4b3fe776bb99bd6d98f8228054bc6bca
-  data.tar.gz: c03ab797796745870124159762e11f0ea5a56ee9cb033f97c7b62088dd0a2d2dae85f1fa874245ddc3fa3482ae7739f1a311546807ee78e1dbd17e7f5807cc52
+  metadata.gz: e2be4160caa66645c8baa9519f69059caa36e4c699098e2138e713736d1f7a1aaba27d6ca9a62ba64ee350e313cea5c0bee27eaf9685f576a33527c0f837d563
+  data.tar.gz: f4561c6e6cef7cfc3daa6e2c8c534d03624993cfbce3f9a75ae4eff55b081de694aa30d261c891eaf0acf463b3fd883b48317d142856131fc8253957d0ef9ef5

data/.rspec ADDED Viewed

	@@ -0,0 +1 @@
1	+ --require spec_helper

data/.rubocop.yml CHANGED Viewed

@@ -4,3 +4,6 @@ AllCops:
 Style/Documentation:
   Enabled: false
+require:
+ - rubocop-rspec

data/Gemfile CHANGED Viewed

@@ -7,5 +7,7 @@ gemspec
 group :test, :development do
   gem 'dotenv', '~> 3.1', '>= 3.1.2'
   gem 'pry-byebug', '~> 3.10', '>= 3.10.1'
-  gem 'rubocop', '~> 1.63', '>= 1.63.5'
+  gem 'rspec', '~> 3.13'
+  gem 'rubocop', '~> 1.65'
+  gem 'rubocop-rspec', '~> 3.0', '>= 3.0.3'
 end

data/Gemfile.lock CHANGED Viewed

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    gemini-ai (4.0.0)
+    gemini-ai (4.2.0)
       event_stream_parser (~> 1.0)
-      faraday (~> 2.9)
+      faraday (~> 2.10)
       faraday-typhoeus (~> 1.1)
       googleauth (~> 1.8)
       typhoeus (~> 1.4, >= 1.4.1)
@@ -11,24 +11,26 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.6)
-      public_suffix (>= 2.0.2, < 6.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.2)
     base64 (0.2.0)
     byebug (11.1.3)
     coderay (1.1.3)
+    diff-lcs (1.5.1)
     dotenv (3.1.2)
     ethon (0.16.0)
       ffi (>= 1.15.0)
     event_stream_parser (1.0.0)
-    faraday (2.9.0)
+    faraday (2.10.0)
       faraday-net_http (>= 2.0, < 3.2)
+      logger
     faraday-net_http (3.1.0)
       net-http
     faraday-typhoeus (1.1.0)
       faraday (~> 2.0)
       typhoeus (~> 1.4)
-    ffi (1.16.3)
+    ffi (1.17.0)
     google-cloud-env (2.1.1)
       faraday (>= 1.0, < 3.a)
     googleauth (1.11.0)
@@ -39,16 +41,17 @@ GEM
       os (>= 0.9, < 2.0)
       signet (>= 0.16, < 2.a)
     json (2.7.2)
-    jwt (2.8.1)
+    jwt (2.8.2)
       base64
     language_server-protocol (3.17.0.3)
+    logger (1.6.0)
     method_source (1.1.0)
     multi_json (1.15.0)
     net-http (0.4.1)
       uri
     os (1.1.4)
-    parallel (1.24.0)
-    parser (3.3.1.0)
+    parallel (1.25.1)
+    parser (3.3.4.0)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -57,25 +60,40 @@ GEM
     pry-byebug (3.10.1)
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
-    public_suffix (5.0.5)
-    racc (1.7.3)
+    public_suffix (6.0.0)
+    racc (1.8.0)
     rainbow (3.1.1)
     regexp_parser (2.9.2)
-    rexml (3.2.8)
-      strscan (>= 3.0.9)
-    rubocop (1.63.5)
+    rexml (3.3.2)
+      strscan
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.65.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
+      regexp_parser (>= 2.4, < 3.0)
       rexml (>= 3.2.5, < 4.0)
       rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.31.3)
       parser (>= 3.3.1.0)
+    rubocop-rspec (3.0.3)
+      rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
     signet (0.19.0)
       addressable (~> 2.8)
@@ -95,7 +113,9 @@ DEPENDENCIES
   dotenv (~> 3.1, >= 3.1.2)
   gemini-ai!
   pry-byebug (~> 3.10, >= 3.10.1)
-  rubocop (~> 1.63, >= 1.63.5)
+  rspec (~> 3.13)
+  rubocop (~> 1.65)
+  rubocop-rspec (~> 3.0, >= 3.0.3)
 BUNDLED WITH
    2.4.22

data/README.md CHANGED Viewed

@@ -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', '~> 4.0.0'
+gem 'gemini-ai', '~> 4.2.0'
 ```
 ```ruby
@@ -34,6 +34,17 @@ client = Gemini.new(
   options: { model: 'gemini-pro', server_sent_events: true }
 )
+# With the Service Account Credentials File contents
+client = Gemini.new(
+  credentials: {
+    service: 'vertex-ai-api',
+    file_contents: File.read('google-credentials.json'),
+    # file_contents: ENV['GOOGLE_CREDENTIALS_FILE_CONTENTS'],
+    region: 'us-east4'
+  },
+  options: { model: 'gemini-pro', server_sent_events: true }
+)
 # With Application Default Credentials
 client = Gemini.new(
   credentials: {
@@ -100,6 +111,12 @@ Result:
     - [Server-Sent Events (SSE) Hang](#server-sent-events-sse-hang)
     - [Non-Streaming](#non-streaming)
   - [Back-and-Forth Conversations](#back-and-forth-conversations)
+  - [Safety Settings](#safety-settings)
+  - [System Instructions](#system-instructions)
+  - [Counting Tokens](#counting-tokens)
+  - [JSON Format Responses](#json-format-responses)
+    - [JSON Schema](#json-schema)
+    - [Models That Support JSON](#models-that-support-json)
   - [Tools (Functions) Calling](#tools-functions-calling)
   - [New Functionalities and APIs](#new-functionalities-and-apis)
   - [Request Options](#request-options)
@@ -121,11 +138,11 @@ Result:
 ### Installing
 ```sh
-gem install gemini-ai -v 4.0.0
+gem install gemini-ai -v 4.2.0
 ```
 ```sh
-gem 'gemini-ai', '~> 4.0.0'
+gem 'gemini-ai', '~> 4.2.0'
 ```
 ### Credentials
@@ -207,7 +224,7 @@ Similar to [Option 2](#option-2-service-account-credentials-file-vertex-ai-api),
 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
+gcloud auth application-default login
 ```
 For more details about alternative methods and different environments, check the official documentation:
@@ -245,6 +262,23 @@ Remember that hardcoding your API key in code is unsafe; it's preferable to use
 }
 ```
+Alternatively, you can pass the file contents instead of the path:
+```ruby
+{
+  service: 'vertex-ai-api',
+  file_contents: File.read('google-credentials.json'),
+  region: 'us-east4'
+}
+```
+```ruby
+{
+  service: 'vertex-ai-api',
+  file_contents: ENV['GOOGLE_CREDENTIALS_FILE_CONTENTS'],
+  region: 'us-east4'
+}
+```
 **Option 3**: For _Application Default Credentials_, omit both the `api_key` and the `file_path`:
 ```ruby
@@ -303,6 +337,17 @@ client = Gemini.new(
   options: { model: 'gemini-pro', server_sent_events: true }
 )
+# With the Service Account Credentials File contents
+client = Gemini.new(
+  credentials: {
+    service: 'vertex-ai-api',
+    file_contents: File.read('google-credentials.json'),
+    # file_contents: ENV['GOOGLE_CREDENTIALS_FILE_CONTENTS'],
+    region: 'us-east4'
+  },
+  options: { model: 'gemini-pro', server_sent_events: true }
+)
 # With Application Default Credentials
 client = Gemini.new(
   credentials: {
@@ -316,7 +361,7 @@ client = Gemini.new(
 ## Available Models
-These models are accessible to the repository **author** as of May 2025 in the `us-east4` region. Access to models may vary by region, user, and account. All models here are expected to work, if you can access them. This is just a reference of what a "typical" user may expect to have access to right away:
+These models are accessible to the repository **author** as of June 2025 in the `us-east4` region. Access to models may vary by region, user, and account. All models here are expected to work, if you can access them. This is just a reference of what a "typical" user may expect to have access to right away:
 | Model                                    | Vertex AI | Generative Language |
 |------------------------------------------|:---------:|:-------------------:|
@@ -324,9 +369,9 @@ These models are accessible to the repository **author** as of May 2025 in the `
 | gemini-pro                               |    ✅     |          ✅         |
 | gemini-1.5-pro-preview-0514              |    ✅     |          🔒         |
 | gemini-1.5-pro-preview-0409              |    ✅     |          🔒         |
-| gemini-1.5-pro                           |    🔒     |          🔒         |
+| gemini-1.5-pro                           |    ✅     |          ✅         |
 | gemini-1.5-flash-preview-0514            |    ✅     |          🔒         |
-| gemini-1.5-flash                         |    🔒     |          🔒         |
+| gemini-1.5-flash                         |    ✅     |          ✅         |
 | gemini-1.0-pro-vision-latest             |    🔒     |          🔒         |
 | gemini-1.0-pro-vision-001                |    ✅     |          🔒         |
 | gemini-1.0-pro-vision                    |    ✅     |          🔒         |
@@ -334,6 +379,11 @@ These models are accessible to the repository **author** as of May 2025 in the `
 | gemini-1.0-pro-002                       |    ✅     |          🔒         |
 | gemini-1.0-pro-001                       |    ✅     |          ✅         |
 | gemini-1.0-pro                           |    ✅     |          ✅         |
+| gemini-ultra                             |    🔒     |          🔒         |
+| gemini-1.0-ultra                         |    🔒     |          🔒         |
+| gemini-1.0-ultra-001                     |    🔒     |          🔒         |
+| text-embedding-preview-0514              |    🔒     |          🔒         |
+| text-embedding-preview-0409              |    🔒     |          🔒         |
 | text-embedding-004                       |    ✅     |          ✅         |
 | embedding-001                            |    🔒     |          ✅         |
 | text-multilingual-embedding-002          |    ✅     |          🔒         |
@@ -379,6 +429,17 @@ client = Gemini.new(
   options: { model: 'gemini-pro', server_sent_events: true }
 )
+# With the Service Account Credentials File contents
+client = Gemini.new(
+  credentials: {
+    service: 'vertex-ai-api',
+    file_contents: File.read('google-credentials.json'),
+    # file_contents: ENV['GOOGLE_CREDENTIALS_FILE_CONTENTS'],
+    region: 'us-east4'
+  },
+  options: { model: 'gemini-pro', server_sent_events: true }
+)
 # With Application Default Credentials
 client = Gemini.new(
   credentials: {
@@ -853,6 +914,229 @@ Result:
    } }]
 ```
+### Safety Settings
+You can [configure safety attributes](https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/configure-safety-attributes) for your requests.
+Harm Categories:
+> `HARM_CATEGORY_UNSPECIFIED`, `HARM_CATEGORY_HARASSMENT`, `HARM_CATEGORY_HATE_SPEECH`, `HARM_CATEGORY_SEXUALLY_EXPLICIT`, `HARM_CATEGORY_DANGEROUS_CONTENT`.
+Thresholds:
+> `BLOCK_NONE`, `BLOCK_ONLY_HIGH`, `BLOCK_MEDIUM_AND_ABOVE`, `BLOCK_LOW_AND_ABOVE`, `HARM_BLOCK_THRESHOLD_UNSPECIFIED`.
+Example:
+```ruby
+client.stream_generate_content(
+  {
+    contents: { role: 'user', parts: { text: 'hi!' } },
+    safetySettings: [
+      {
+        category: 'HARM_CATEGORY_UNSPECIFIED',
+        threshold: 'BLOCK_ONLY_HIGH'
+      },
+      {
+        category: 'HARM_CATEGORY_HARASSMENT',
+        threshold: 'BLOCK_ONLY_HIGH'
+      },
+      {
+        category: 'HARM_CATEGORY_HATE_SPEECH',
+        threshold: 'BLOCK_ONLY_HIGH'
+      },
+      {
+        category: 'HARM_CATEGORY_SEXUALLY_EXPLICIT',
+        threshold: 'BLOCK_ONLY_HIGH'
+      },
+      {
+        category: 'HARM_CATEGORY_DANGEROUS_CONTENT',
+        threshold: 'BLOCK_ONLY_HIGH'
+      }
+    ]
+  }
+)
+```
+Google started to block the usage of `BLOCK_NONE` unless:
+> _User has requested a restricted HarmBlockThreshold setting BLOCK_NONE. You can get access either (a) through an allowlist via your Google account team, or (b) by switching your account type to monthly invoiced billing via this instruction: https://cloud.google.com/billing/docs/how-to/invoiced-billing_
+### System Instructions
+Some models support [system instructions](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions):
+```ruby
+client.stream_generate_content(
+  { contents: { role: 'user', parts: { text: 'Hi! Who are you?' } },
+    system_instruction: { role: 'user', parts: { text: 'Your name is Neko.' } } }
+)
+```
+Output:
+```text
+Hi! I'm  Neko, a factual language model from Google AI.
+```
+```ruby
+client.stream_generate_content(
+  { contents: { role: 'user', parts: { text: 'Hi! Who are you?' } },
+    system_instruction: {
+      role: 'user', parts: [
+        { text: 'You are a cat.' },
+        { text: 'Your name is Neko.' }
+      ]
+    } }
+)
+```
+Output:
+```text
+Meow! I'm Neko, a fluffy and playful cat. :3
+```
+### Counting Tokens
+You can [count tokens](https://ai.google.dev/gemini-api/docs/tokens#count-tokens) and preview how many tokens a request is expected to consume:
+```ruby
+client.count_tokens(
+  { contents: { role: 'user', parts: { text: 'hi!' } } }
+)
+```
+Output for Generative Language API:
+```ruby
+{ 'totalTokens' => 3 }
+```
+Output for Vertex AI API:
+```ruby
+{ 'totalTokens' => 2, 'totalBillableCharacters' => 3 }
+```
+### JSON Format Responses
+> _As of the writing of this README, only the `vertex-ai-api` service and `gemini` models version `1.5` support this feature._
+The Gemini API provides a configuration parameter to [request a response in JSON](https://ai.google.dev/gemini-api/docs/api-overview#json) format:
+```ruby
+require 'json'
+result = client.stream_generate_content(
+  {
+    contents: {
+      role: 'user',
+      parts: {
+        text: 'List 3 random colors.'
+      }
+    },
+    generation_config: {
+      response_mime_type: 'application/json'
+    }
+  }
+)
+json_string = result
+              .map { |response| response.dig('candidates', 0, 'content', 'parts') }
+              .map { |parts| parts.map { |part| part['text'] }.join }
+              .join
+puts JSON.parse(json_string).inspect
+```
+Output:
+```ruby
+{ 'colors' => ['Dark Salmon', 'Indigo', 'Lavender'] }
+```
+#### JSON Schema
+> _While Gemini 1.5 Flash models only accept a text description of the JSON schema you want returned, the Gemini 1.5 Pro models let you pass a schema object (or a Python type equivalent), and the model output will strictly follow that schema. This is also known as controlled generation or constrained decoding._
+You can also provide a [JSON Schema](https://json-schema.org) for the expected JSON output:
+```ruby
+require 'json'
+result = client.stream_generate_content(
+  {
+    contents: {
+      role: 'user',
+      parts: {
+        text: 'List 3 random colors.'
+      }
+    },
+    generation_config: {
+      response_mime_type: 'application/json',
+      response_schema: {
+        type: 'object',
+        properties: {
+          colors: {
+            type: 'array',
+            items: {
+              type: 'object',
+              properties: {
+                name: {
+                  type: 'string'
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+)
+json_string = result
+              .map { |response| response.dig('candidates', 0, 'content', 'parts') }
+              .map { |parts| parts.map { |part| part['text'] }.join }
+              .join
+puts JSON.parse(json_string).inspect
+```
+Output:
+```ruby
+{ 'colors' => [
+  { 'name' => 'Lavender Blush' },
+  { 'name' => 'Medium Turquoise' },
+  { 'name' => 'Dark Slate Gray' }
+] }
+```
+#### Models That Support JSON
+These models are accessible to the repository **author** as of June 2025 in the `us-east4` region. Access to models may vary by region, user, and account.
+- ❌ Does not support JSON mode.
+- 🟡 Supports JSON mode but not Schema.
+- ✅ Supports JSON mode and Schema.
+- 🔒 I don't have access to the model.
+| Model                                    | Vertex AI | Generative Language |
+|------------------------------------------|:---------:|:-------------------:|
+| gemini-pro-vision                        |    ❌     |          🔒         |
+| gemini-pro                               |    🟡     |          ❌         |
+| gemini-1.5-pro-preview-0514              |    ✅     |          🔒         |
+| gemini-1.5-pro-preview-0409              |    ✅     |          🔒         |
+| gemini-1.5-pro                           |    ✅     |          ❌         |
+| gemini-1.5-flash-preview-0514            |    🟡     |          🔒         |
+| gemini-1.5-flash                         |    🟡     |          ❌         |
+| gemini-1.0-pro-vision-latest             |    🔒     |          🔒         |
+| gemini-1.0-pro-vision-001                |    ❌     |          🔒         |
+| gemini-1.0-pro-vision                    |    ❌     |          🔒         |
+| gemini-1.0-pro-latest                    |    🔒     |          ❌         |
+| gemini-1.0-pro-002                       |    🟡     |          🔒         |
+| gemini-1.0-pro-001                       |    ❌     |          ❌         |
+| gemini-1.0-pro                           |    🟡     |          ❌         |
+| gemini-ultra                             |    🔒     |          🔒         |
+| gemini-1.0-ultra                         |    🔒     |          🔒         |
+| gemini-1.0-ultra-001                     |    🔒     |          🔒         |
 ### Tools (Functions) Calling
 > 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.
@@ -1123,6 +1407,7 @@ GeminiError
 MissingProjectIdError
 UnsupportedServiceError
+ConflictingCredentialsError
 BlockWithoutServerSentEventsError
 RequestError
@@ -1134,7 +1419,14 @@ RequestError
 bundle
 rubocop -A
-bundle exec ruby spec/tasks/run-client.rb
+rspec
+bundle exec ruby spec/tasks/run-available-models.rb
+bundle exec ruby spec/tasks/run-embed.rb
+bundle exec ruby spec/tasks/run-generate.rb
+bundle exec ruby spec/tasks/run-json.rb
+bundle exec ruby spec/tasks/run-safety.rb
+bundle exec ruby spec/tasks/run-system.rb
 ```
 ### Purpose
@@ -1148,7 +1440,7 @@ gem build gemini-ai.gemspec
 gem signin
-gem push gemini-ai-4.0.0.gem
+gem push gemini-ai-4.2.0.gem
 ```
 ### Updating the README
@@ -1193,6 +1485,8 @@ These resources and references may be useful throughout your learning process.
 - [Vertex AI API Documentation](https://cloud.google.com/vertex-ai/docs/reference)
   - [REST Documentation](https://cloud.google.com/vertex-ai/docs/reference/rest)
   - [Get text embeddings](https://cloud.google.com/vertex-ai/generative-ai/docs/embeddings/get-text-embeddings)
+  - [Use system instructions](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions)
+  - [Configure safety attributes](https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/configure-safety-attributes)
 - [Google models](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models)
   - [Model versions and lifecycle](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/model-versioning)
 - [Google DeepMind Gemini](https://deepmind.google/technologies/gemini/)

data/components/errors.rb CHANGED Viewed

@@ -4,12 +4,13 @@ module Gemini
   module Errors
     class GeminiError < StandardError
       def initialize(message = nil)
-        super(message)
+        super
       end
     end
     class MissingProjectIdError < GeminiError; end
     class UnsupportedServiceError < GeminiError; end
+    class ConflictingCredentialsError < GeminiError; end
     class BlockWithoutServerSentEventsError < GeminiError; end
     class RequestError < GeminiError

data/controllers/client.rb CHANGED Viewed

@@ -21,16 +21,24 @@ module Gemini
         @service = config[:credentials][:service]
         unless %w[vertex-ai-api generative-language-api].include?(@service)
-          raise Errors::UnsupportedServiceError, "Unsupported service: #{@service}"
+          raise Errors::UnsupportedServiceError, "Unsupported service: '#{@service}'."
         end
+        avoid_conflicting_credentials!(config[:credentials])
         if config[:credentials][:api_key]
           @authentication = :api_key
           @api_key = config[:credentials][:api_key]
-        elsif config[:credentials][:file_path]
+        elsif config[:credentials][:file_path] || config[:credentials][:file_contents]
           @authentication = :service_account
+          json_key_io = if config[:credentials][:file_path]
+                          File.open(config[:credentials][:file_path])
+                        else
+                          StringIO.new(config[:credentials][:file_contents])
+                        end
           @authorizer = ::Google::Auth::ServiceAccountCredentials.make_creds(
-            json_key_io: File.open(config[:credentials][:file_path]),
+            json_key_io:,
             scope: 'https://www.googleapis.com/auth/cloud-platform'
           )
         else
@@ -75,6 +83,21 @@ module Gemini
                            end
       end
+      def avoid_conflicting_credentials!(credentials)
+        conflicting_keys = %i[api_key file_path file_contents]
+        found = credentials.keys.filter { |key| conflicting_keys.include?(key) }
+        return unless found.size > 1
+        message = found.sort.each_with_index.map do |key, i|
+          i == found.size - 1 ? "or '#{key}'" : "'#{key}'"
+        end.join(', ')
+        raise Errors::ConflictingCredentialsError,
+              "You must choose either #{message}."
+      end
       def predict(payload, server_sent_events: nil, &callback)
         result = request(
           "#{@model_address}:predict", payload,
@@ -86,6 +109,17 @@ module Gemini
         result
       end
+      def count_tokens(payload, server_sent_events: nil, &callback)
+        result = request(
+          "#{@model_address}:countTokens", payload,
+          server_sent_events:, &callback
+        )
+        return result.first if result.is_a?(Array) && result.size == 1
+        result
+      end
       def embed_content(payload, server_sent_events: nil, &callback)
         result = request(
           "#{@model_address}:embedContent", payload,

data/gemini-ai.gemspec CHANGED Viewed

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['ports/dsl']
   spec.add_dependency 'event_stream_parser', '~> 1.0'
-  spec.add_dependency 'faraday', '~> 2.9'
+  spec.add_dependency 'faraday', '~> 2.10'
   spec.add_dependency 'faraday-typhoeus', '~> 1.1'
   # Before upgrading, check this:

data/static/gem.rb CHANGED Viewed

@@ -3,7 +3,7 @@
 module Gemini
   GEM = {
     name: 'gemini-ai',
-    version: '4.0.0',
+    version: '4.2.0',
     author: 'gbaptista',
     summary: "Interact with Google's Gemini AI.",
     description: "A Ruby Gem for interacting with Gemini through Vertex AI, Generative Language API, or AI Studio, Google's generative AI services.",

data/template.md CHANGED Viewed

@@ -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', '~> 4.0.0'
+gem 'gemini-ai', '~> 4.2.0'
 ```
 ```ruby
@@ -34,6 +34,17 @@ client = Gemini.new(
   options: { model: 'gemini-pro', server_sent_events: true }
 )
+# With the Service Account Credentials File contents
+client = Gemini.new(
+  credentials: {
+    service: 'vertex-ai-api',
+    file_contents: File.read('google-credentials.json'),
+    # file_contents: ENV['GOOGLE_CREDENTIALS_FILE_CONTENTS'],
+    region: 'us-east4'
+  },
+  options: { model: 'gemini-pro', server_sent_events: true }
+)
 # With Application Default Credentials
 client = Gemini.new(
   credentials: {
@@ -77,11 +88,11 @@ Result:
 ### Installing
 ```sh
-gem install gemini-ai -v 4.0.0
+gem install gemini-ai -v 4.2.0
 ```
 ```sh
-gem 'gemini-ai', '~> 4.0.0'
+gem 'gemini-ai', '~> 4.2.0'
 ```
 ### Credentials
@@ -163,7 +174,7 @@ Similar to [Option 2](#option-2-service-account-credentials-file-vertex-ai-api),
 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
+gcloud auth application-default login
 ```
 For more details about alternative methods and different environments, check the official documentation:
@@ -201,6 +212,23 @@ Remember that hardcoding your API key in code is unsafe; it's preferable to use
 }
 ```
+Alternatively, you can pass the file contents instead of the path:
+```ruby
+{
+  service: 'vertex-ai-api',
+  file_contents: File.read('google-credentials.json'),
+  region: 'us-east4'
+}
+```
+```ruby
+{
+  service: 'vertex-ai-api',
+  file_contents: ENV['GOOGLE_CREDENTIALS_FILE_CONTENTS'],
+  region: 'us-east4'
+}
+```
 **Option 3**: For _Application Default Credentials_, omit both the `api_key` and the `file_path`:
 ```ruby
@@ -259,6 +287,17 @@ client = Gemini.new(
   options: { model: 'gemini-pro', server_sent_events: true }
 )
+# With the Service Account Credentials File contents
+client = Gemini.new(
+  credentials: {
+    service: 'vertex-ai-api',
+    file_contents: File.read('google-credentials.json'),
+    # file_contents: ENV['GOOGLE_CREDENTIALS_FILE_CONTENTS'],
+    region: 'us-east4'
+  },
+  options: { model: 'gemini-pro', server_sent_events: true }
+)
 # With Application Default Credentials
 client = Gemini.new(
   credentials: {
@@ -272,7 +311,7 @@ client = Gemini.new(
 ## Available Models
-These models are accessible to the repository **author** as of May 2025 in the `us-east4` region. Access to models may vary by region, user, and account. All models here are expected to work, if you can access them. This is just a reference of what a "typical" user may expect to have access to right away:
+These models are accessible to the repository **author** as of June 2025 in the `us-east4` region. Access to models may vary by region, user, and account. All models here are expected to work, if you can access them. This is just a reference of what a "typical" user may expect to have access to right away:
 | Model                                    | Vertex AI | Generative Language |
 |------------------------------------------|:---------:|:-------------------:|
@@ -280,9 +319,9 @@ These models are accessible to the repository **author** as of May 2025 in the `
 | gemini-pro                               |    ✅     |          ✅         |
 | gemini-1.5-pro-preview-0514              |    ✅     |          🔒         |
 | gemini-1.5-pro-preview-0409              |    ✅     |          🔒         |
-| gemini-1.5-pro                           |    🔒     |          🔒         |
+| gemini-1.5-pro                           |    ✅     |          ✅         |
 | gemini-1.5-flash-preview-0514            |    ✅     |          🔒         |
-| gemini-1.5-flash                         |    🔒     |          🔒         |
+| gemini-1.5-flash                         |    ✅     |          ✅         |
 | gemini-1.0-pro-vision-latest             |    🔒     |          🔒         |
 | gemini-1.0-pro-vision-001                |    ✅     |          🔒         |
 | gemini-1.0-pro-vision                    |    ✅     |          🔒         |
@@ -290,6 +329,11 @@ These models are accessible to the repository **author** as of May 2025 in the `
 | gemini-1.0-pro-002                       |    ✅     |          🔒         |
 | gemini-1.0-pro-001                       |    ✅     |          ✅         |
 | gemini-1.0-pro                           |    ✅     |          ✅         |
+| gemini-ultra                             |    🔒     |          🔒         |
+| gemini-1.0-ultra                         |    🔒     |          🔒         |
+| gemini-1.0-ultra-001                     |    🔒     |          🔒         |
+| text-embedding-preview-0514              |    🔒     |          🔒         |
+| text-embedding-preview-0409              |    🔒     |          🔒         |
 | text-embedding-004                       |    ✅     |          ✅         |
 | embedding-001                            |    🔒     |          ✅         |
 | text-multilingual-embedding-002          |    ✅     |          🔒         |
@@ -335,6 +379,17 @@ client = Gemini.new(
   options: { model: 'gemini-pro', server_sent_events: true }
 )
+# With the Service Account Credentials File contents
+client = Gemini.new(
+  credentials: {
+    service: 'vertex-ai-api',
+    file_contents: File.read('google-credentials.json'),
+    # file_contents: ENV['GOOGLE_CREDENTIALS_FILE_CONTENTS'],
+    region: 'us-east4'
+  },
+  options: { model: 'gemini-pro', server_sent_events: true }
+)
 # With Application Default Credentials
 client = Gemini.new(
   credentials: {
@@ -809,6 +864,229 @@ Result:
    } }]
 ```
+### Safety Settings
+You can [configure safety attributes](https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/configure-safety-attributes) for your requests.
+Harm Categories:
+> `HARM_CATEGORY_UNSPECIFIED`, `HARM_CATEGORY_HARASSMENT`, `HARM_CATEGORY_HATE_SPEECH`, `HARM_CATEGORY_SEXUALLY_EXPLICIT`, `HARM_CATEGORY_DANGEROUS_CONTENT`.
+Thresholds:
+> `BLOCK_NONE`, `BLOCK_ONLY_HIGH`, `BLOCK_MEDIUM_AND_ABOVE`, `BLOCK_LOW_AND_ABOVE`, `HARM_BLOCK_THRESHOLD_UNSPECIFIED`.
+Example:
+```ruby
+client.stream_generate_content(
+  {
+    contents: { role: 'user', parts: { text: 'hi!' } },
+    safetySettings: [
+      {
+        category: 'HARM_CATEGORY_UNSPECIFIED',
+        threshold: 'BLOCK_ONLY_HIGH'
+      },
+      {
+        category: 'HARM_CATEGORY_HARASSMENT',
+        threshold: 'BLOCK_ONLY_HIGH'
+      },
+      {
+        category: 'HARM_CATEGORY_HATE_SPEECH',
+        threshold: 'BLOCK_ONLY_HIGH'
+      },
+      {
+        category: 'HARM_CATEGORY_SEXUALLY_EXPLICIT',
+        threshold: 'BLOCK_ONLY_HIGH'
+      },
+      {
+        category: 'HARM_CATEGORY_DANGEROUS_CONTENT',
+        threshold: 'BLOCK_ONLY_HIGH'
+      }
+    ]
+  }
+)
+```
+Google started to block the usage of `BLOCK_NONE` unless:
+> _User has requested a restricted HarmBlockThreshold setting BLOCK_NONE. You can get access either (a) through an allowlist via your Google account team, or (b) by switching your account type to monthly invoiced billing via this instruction: https://cloud.google.com/billing/docs/how-to/invoiced-billing_
+### System Instructions
+Some models support [system instructions](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions):
+```ruby
+client.stream_generate_content(
+  { contents: { role: 'user', parts: { text: 'Hi! Who are you?' } },
+    system_instruction: { role: 'user', parts: { text: 'Your name is Neko.' } } }
+)
+```
+Output:
+```text
+Hi! I'm  Neko, a factual language model from Google AI.
+```
+```ruby
+client.stream_generate_content(
+  { contents: { role: 'user', parts: { text: 'Hi! Who are you?' } },
+    system_instruction: {
+      role: 'user', parts: [
+        { text: 'You are a cat.' },
+        { text: 'Your name is Neko.' }
+      ]
+    } }
+)
+```
+Output:
+```text
+Meow! I'm Neko, a fluffy and playful cat. :3
+```
+### Counting Tokens
+You can [count tokens](https://ai.google.dev/gemini-api/docs/tokens#count-tokens) and preview how many tokens a request is expected to consume:
+```ruby
+client.count_tokens(
+  { contents: { role: 'user', parts: { text: 'hi!' } } }
+)
+```
+Output for Generative Language API:
+```ruby
+{ 'totalTokens' => 3 }
+```
+Output for Vertex AI API:
+```ruby
+{ 'totalTokens' => 2, 'totalBillableCharacters' => 3 }
+```
+### JSON Format Responses
+> _As of the writing of this README, only the `vertex-ai-api` service and `gemini` models version `1.5` support this feature._
+The Gemini API provides a configuration parameter to [request a response in JSON](https://ai.google.dev/gemini-api/docs/api-overview#json) format:
+```ruby
+require 'json'
+result = client.stream_generate_content(
+  {
+    contents: {
+      role: 'user',
+      parts: {
+        text: 'List 3 random colors.'
+      }
+    },
+    generation_config: {
+      response_mime_type: 'application/json'
+    }
+  }
+)
+json_string = result
+              .map { |response| response.dig('candidates', 0, 'content', 'parts') }
+              .map { |parts| parts.map { |part| part['text'] }.join }
+              .join
+puts JSON.parse(json_string).inspect
+```
+Output:
+```ruby
+{ 'colors' => ['Dark Salmon', 'Indigo', 'Lavender'] }
+```
+#### JSON Schema
+> _While Gemini 1.5 Flash models only accept a text description of the JSON schema you want returned, the Gemini 1.5 Pro models let you pass a schema object (or a Python type equivalent), and the model output will strictly follow that schema. This is also known as controlled generation or constrained decoding._
+You can also provide a [JSON Schema](https://json-schema.org) for the expected JSON output:
+```ruby
+require 'json'
+result = client.stream_generate_content(
+  {
+    contents: {
+      role: 'user',
+      parts: {
+        text: 'List 3 random colors.'
+      }
+    },
+    generation_config: {
+      response_mime_type: 'application/json',
+      response_schema: {
+        type: 'object',
+        properties: {
+          colors: {
+            type: 'array',
+            items: {
+              type: 'object',
+              properties: {
+                name: {
+                  type: 'string'
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+)
+json_string = result
+              .map { |response| response.dig('candidates', 0, 'content', 'parts') }
+              .map { |parts| parts.map { |part| part['text'] }.join }
+              .join
+puts JSON.parse(json_string).inspect
+```
+Output:
+```ruby
+{ 'colors' => [
+  { 'name' => 'Lavender Blush' },
+  { 'name' => 'Medium Turquoise' },
+  { 'name' => 'Dark Slate Gray' }
+] }
+```
+#### Models That Support JSON
+These models are accessible to the repository **author** as of June 2025 in the `us-east4` region. Access to models may vary by region, user, and account.
+- ❌ Does not support JSON mode.
+- 🟡 Supports JSON mode but not Schema.
+- ✅ Supports JSON mode and Schema.
+- 🔒 I don't have access to the model.
+| Model                                    | Vertex AI | Generative Language |
+|------------------------------------------|:---------:|:-------------------:|
+| gemini-pro-vision                        |    ❌     |          🔒         |
+| gemini-pro                               |    🟡     |          ❌         |
+| gemini-1.5-pro-preview-0514              |    ✅     |          🔒         |
+| gemini-1.5-pro-preview-0409              |    ✅     |          🔒         |
+| gemini-1.5-pro                           |    ✅     |          ❌         |
+| gemini-1.5-flash-preview-0514            |    🟡     |          🔒         |
+| gemini-1.5-flash                         |    🟡     |          ❌         |
+| gemini-1.0-pro-vision-latest             |    🔒     |          🔒         |
+| gemini-1.0-pro-vision-001                |    ❌     |          🔒         |
+| gemini-1.0-pro-vision                    |    ❌     |          🔒         |
+| gemini-1.0-pro-latest                    |    🔒     |          ❌         |
+| gemini-1.0-pro-002                       |    🟡     |          🔒         |
+| gemini-1.0-pro-001                       |    ❌     |          ❌         |
+| gemini-1.0-pro                           |    🟡     |          ❌         |
+| gemini-ultra                             |    🔒     |          🔒         |
+| gemini-1.0-ultra                         |    🔒     |          🔒         |
+| gemini-1.0-ultra-001                     |    🔒     |          🔒         |
 ### Tools (Functions) Calling
 > 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.
@@ -1079,6 +1357,7 @@ GeminiError
 MissingProjectIdError
 UnsupportedServiceError
+ConflictingCredentialsError
 BlockWithoutServerSentEventsError
 RequestError
@@ -1090,7 +1369,14 @@ RequestError
 bundle
 rubocop -A
-bundle exec ruby spec/tasks/run-client.rb
+rspec
+bundle exec ruby spec/tasks/run-available-models.rb
+bundle exec ruby spec/tasks/run-embed.rb
+bundle exec ruby spec/tasks/run-generate.rb
+bundle exec ruby spec/tasks/run-json.rb
+bundle exec ruby spec/tasks/run-safety.rb
+bundle exec ruby spec/tasks/run-system.rb
 ```
 ### Purpose
@@ -1104,7 +1390,7 @@ gem build gemini-ai.gemspec
 gem signin
-gem push gemini-ai-4.0.0.gem
+gem push gemini-ai-4.2.0.gem
 ```
 ### Updating the README
@@ -1149,6 +1435,8 @@ These resources and references may be useful throughout your learning process.
 - [Vertex AI API Documentation](https://cloud.google.com/vertex-ai/docs/reference)
   - [REST Documentation](https://cloud.google.com/vertex-ai/docs/reference/rest)
   - [Get text embeddings](https://cloud.google.com/vertex-ai/generative-ai/docs/embeddings/get-text-embeddings)
+  - [Use system instructions](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions)
+  - [Configure safety attributes](https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/configure-safety-attributes)
 - [Google models](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models)
   - [Model versions and lifecycle](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/model-versioning)
 - [Google DeepMind Gemini](https://deepmind.google/technologies/gemini/)

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gemini-ai
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.2.0
 platform: ruby
 authors:
 - gbaptista
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-19 00:00:00.000000000 Z
+date: 2024-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '2.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '2.10'
 - !ruby/object:Gem::Dependency
   name: faraday-typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
 - Gemfile