gemini-ai 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0504f65df629365e53197cbf3710261a01a5a6bd0bdc72d7ed86ae8435d97c92
-  data.tar.gz: f5bb325cc4eb668a8d2b0d6e8c4b76b0a3ae88dbc97ba76d329cbdc45a73a93a
+  metadata.gz: 790a1c353ecc9e3122fc096f674d50fbd0ef36b4b0f9ab56ef66d180b0a5d4de
+  data.tar.gz: 2eac84cb99804362eea89063ea6ed66467af1ffb3a7d4ffd1ab186f7a2842157
 SHA512:
-  metadata.gz: 1d2f70d87440b5e6a4cad3f29a961ab53a708c2e5519c600b7dfe6a7335291571bd69b320057bcd4d2dd32e2f60f48fd5a85e55e6e6ece0334b05517fb57415c
-  data.tar.gz: 004bddaf41f4a3e7a04f496ca31847f44193dd0b12d2446d92a1176241d29ee4d5a20ee7f0b246945f8f1f5277e8032136fc4f4d607042e5c748c0bcec339a0d
+  metadata.gz: d82d466e8272ab1919c153d3f68ffb3ab4ebd5a750a3822daef4394a814b36c08c0f114e691cb52a5c830a74a0e9d208cd3d4407227592812f0534655dc5afc1
+  data.tar.gz: 7141a1bff79ea92aac09105b84fd9c2d5b68efe5184bf1ca0588dc420c0180ea65cd2fcca000ab0ea2cd00c1be188877f3f97ec6c7410f61bea4c8acf52b475c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gemini-ai (1.0.0)
+    gemini-ai (2.0.0)
       event_stream_parser (~> 1.0)
       faraday (~> 2.7, >= 2.7.12)
       googleauth (~> 1.9, >= 1.9.1)

data/README.md

@@ -1,21 +1,38 @@
 # Gemini AI
 
-A Ruby Gem for interacting with [Gemini](https://deepmind.google/technologies/gemini/) through [Vertex AI](https://cloud.google.com/vertex-ai), Google's generative AI service.
+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.
+
+![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)
 
 > _This Gem is designed to provide low-level access to Gemini, enabling people to build abstractions on top of it. If you are interested in more high-level abstractions or more user-friendly tools, you may want to consider [Nano Bots](https://github.com/icebaker/ruby-nano-bots) 💎 🤖._
 
 ## TL;DR and Quick Start
 
 ```ruby
-gem 'gemini-ai', '~> 1.0'
+gem 'gemini-ai', '~> 2.0'
 ```
 
 ```ruby
 require 'gemini-ai'
 
+# With an API key
+client = Gemini.new(
+  credentials: {
+    service: 'generative-language-api',
+    api_key: ENV['GOOGLE_API_KEY']
+  },
+  options: { model: 'gemini-pro', stream: false }
+)
+
+# With a Service Account
 client = Gemini.new(
-  credentials: { file_path: 'google-credentials.json', project_id: 'PROJECT_ID', region: 'us-east4' },
-  settings: { model: 'gemini-pro', stream: false }
+  credentials: {
+    service: 'vertex-ai-api',
+    file_path: 'google-credentials.json',
+    project_id: 'PROJECT_ID',
+    region: 'us-east4'
+  },
+  options: { model: 'gemini-pro', stream: false }
 )
 
 result = client.stream_generate_content({
@@ -48,7 +65,10 @@ Result:
 - [TL;DR and Quick Start](#tldr-and-quick-start)
 - [Index](#index)
 - [Setup](#setup)
+    - [Installing](#installing)
     - [Credentials](#credentials)
+        - [Option 1: API Key](#option-1-api-key)
+        - [Option 2: Service Account](#option-2-service-account)
         - [Required Data](#required-data)
 - [Usage](#usage)
     - [Client](#client)
@@ -68,18 +88,31 @@ Result:
 
 ## Setup
 
+### Installing
+
 ```sh
-gem install gemini-ai -v 1.0.0
+gem install gemini-ai -v 2.0.0
 ```
 
 ```sh
-gem 'gemini-ai', '~> 1.0'
+gem 'gemini-ai', '~> 2.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
+
+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).
+
+You also need to enable the _Generative Language API_ service in your Google Cloud Console, which can be done [here](https://console.cloud.google.com/apis/library/generativelanguage.googleapis.com).
+
+
+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
+
 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.
 
 After creating them, you need to enable the Vertex AI API for your project by clicking `Enable` here: [Vertex AI API](https://console.cloud.google.com/apis/library/aiplatform.googleapis.com).
@@ -132,14 +165,33 @@ gcloud projects add-iam-policy-binding PROJECT_ID \
   --role='roles/ml.admin'
 ```
 
-> ⚠️ 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.
-
 #### Required Data
 
-After this, you should have all the necessary data and access to use Gemini: a `google-credentials.json` file, a `PROJECT_ID`, and a `REGION`:
+After choosing an option, you should have all the necessary data and access to use Gemini.
+
+For API Key:
 
 ```ruby
 {
+  service: 'generative-language-api',
+  api_key: 'GOOGLE_API_KEY'
+}
+```
+
+Remember that hardcoding your API key in code is unsafe; it's preferable to use environment variables:
+
+```ruby
+{
+  service: 'generative-language-api',
+  api_key: ENV['GOOGLE_API_KEY']
+}
+```
+
+Alternativelly, for Service Account, a `google-credentials.json` file, a `PROJECT_ID`, and a `REGION`:
+
+```ruby
+{
+  service: 'vertex-ai-api',
   file_path: 'google-credentials.json',
   project_id: 'PROJECT_ID',
   region: 'us-east4'
@@ -169,9 +221,24 @@ Create a new client:
 ```ruby
 require 'gemini-ai'
 
+# With an API key
 client = Gemini.new(
-  credentials: { file_path: 'google-credentials.json', project_id: 'PROJECT_ID', region: 'us-east4' },
-  settings: { model: 'gemini-pro', stream: false }
+  credentials: {
+    service: 'generative-language-api',
+    api_key: ENV['GOOGLE_API_KEY']
+  },
+  options: { model: 'gemini-pro', stream: false }
+)
+
+# With a Service Account
+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 }
 )
 ```
 
@@ -210,8 +277,8 @@ Result:
 You can set up the client to use streaming for all supported endpoints:
 ```ruby
 client = Gemini.new(
-  credentials: { file_path: 'google-credentials.json', project_id: 'PROJECT_ID', region: 'us-east4' },
-  settings: { model: 'gemini-pro', stream: true }
+  credentials: { ... },
+  options: { model: 'gemini-pro', stream: true }
 )
 ```
 
@@ -500,11 +567,17 @@ gem build gemini-ai.gemspec
 
 gem signin
 
-gem push gemini-ai-1.0.0.gem
+gem push gemini-ai-2.0.0.gem
 ```
 
 ### Updating the README
 
+Install [Babashka](https://babashka.org):
+
+```sh
+curl -s https://raw.githubusercontent.com/babashka/babashka/master/install | sudo bash
+```
+
 Update the `template.md` file and then:
 
 ```sh
@@ -532,6 +605,8 @@ mlp README.md -p 8076
 
 These resources and references may be useful throughout your learning process.
 
+- [Google AI for Developers](https://ai.google.dev)
+- [Get started with the Gemini API ](https://ai.google.dev/docs)
 - [Getting Started with the Vertex AI Gemini API with cURL](https://github.com/GoogleCloudPlatform/generative-ai/blob/main/gemini/getting-started/intro_gemini_curl.ipynb)
 - [Gemini API Documentation](https://cloud.google.com/vertex-ai/docs/generative-ai/model-reference/gemini)
 - [Vertex AI API Documentation](https://cloud.google.com/vertex-ai/docs/reference)
@@ -544,4 +619,4 @@ These resources and references may be useful throughout your learning process.
 
 This is not an official Google project, nor is it affiliated with Google in any way.
 
-The software is distributed under the MIT License, which can be found at [https://github.com/gbaptista/gemini-ai/blob/main/LICENSE](https://github.com/gbaptista/gemini-ai/blob/main/LICENSE). This license includes a disclaimer of warranty. Moreover, the authors assume no responsibility for any damage or costs that may result from using this project. Use the Gemini AI Ruby Gem at your own risk.
+This software is distributed under the [MIT License](https://github.com/gbaptista/gemini-ai/blob/main/LICENSE). This license includes a disclaimer of warranty. Moreover, the authors assume no responsibility for any damage or costs that may result from using this project. Use the Gemini AI Ruby Gem at your own risk.

data/controllers/client.rb

@@ -9,14 +9,27 @@ module Gemini
   module Controllers
     class Client
       def initialize(config)
-        @authorizer = ::Google::Auth::ServiceAccountCredentials.make_creds(
-          json_key_io: File.open(config[:credentials][:file_path]),
-          scope: 'https://www.googleapis.com/auth/cloud-platform'
-        )
+        if config[:credentials][:api_key]
+          @authentication = :api_key
+          @api_key = config[:credentials][:api_key]
+        else
+          @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'
+          )
+        end
 
-        @address = "https://#{config[:credentials][:region]}-aiplatform.googleapis.com/v1/projects/#{config[:credentials][:project_id]}/locations/#{config[:credentials][:region]}/publishers/google/models/#{config[:settings][:model]}"
+        @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]}"
+                   when 'generative-language-api'
+                     "https://generativelanguage.googleapis.com/v1/models/#{config[:options][:model]}"
+                   else
+                     raise StandardError, "Unsupported service: #{config[:credentials][:service]}"
+                   end
 
-        @stream = config[:settings][:stream]
+        @stream = config[:options][:stream]
       end
 
       def stream_generate_content(payload, stream: nil, &callback)
@@ -26,7 +39,12 @@ module Gemini
       def request(path, payload, stream: nil, &callback)
         stream_enabled = stream.nil? ? @stream : stream
         url = "#{@address}:#{path}"
-        url += '?alt=sse' if stream_enabled
+        params = []
+
+        params << 'alt=sse' if stream_enabled
+        params << "key=#{@api_key}" if @authentication == :api_key
+
+        url += "?#{params.join('&')}" if params.size.positive?
 
         if !callback.nil? && !stream_enabled
           raise StandardError, 'You are trying to use a block without stream enabled."'
@@ -37,7 +55,10 @@ module Gemini
         response = Faraday.new.post do |request|
           request.url url
           request.headers['Content-Type'] = 'application/json'
-          request.headers['Authorization'] = "Bearer #{@authorizer.fetch_access_token!['access_token']}"
+          if @authentication == :service_account
+            request.headers['Authorization'] = "Bearer #{@authorizer.fetch_access_token!['access_token']}"
+          end
+
           request.body = payload.to_json
 
           if stream_enabled

data/static/gem.rb

@@ -3,10 +3,10 @@
 module Gemini
   GEM = {
     name: 'gemini-ai',
-    version: '1.0.0',
+    version: '2.0.0',
     author: 'gbaptista',
     summary: "Interact with Google's Gemini AI.",
-    description: "A Ruby Gem for interacting with Gemini through Vertex AI, Google's generative AI service.",
+    description: "A Ruby Gem for interacting with Gemini through Vertex AI 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,21 +1,38 @@
 # Gemini AI
 
-A Ruby Gem for interacting with [Gemini](https://deepmind.google/technologies/gemini/) through [Vertex AI](https://cloud.google.com/vertex-ai), Google's generative AI service.
+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.
+
+![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)
 
 > _This Gem is designed to provide low-level access to Gemini, enabling people to build abstractions on top of it. If you are interested in more high-level abstractions or more user-friendly tools, you may want to consider [Nano Bots](https://github.com/icebaker/ruby-nano-bots) 💎 🤖._
 
 ## TL;DR and Quick Start
 
 ```ruby
-gem 'gemini-ai', '~> 1.0'
+gem 'gemini-ai', '~> 2.0'
 ```
 
 ```ruby
 require 'gemini-ai'
 
+# With an API key
+client = Gemini.new(
+  credentials: {
+    service: 'generative-language-api',
+    api_key: ENV['GOOGLE_API_KEY']
+  },
+  options: { model: 'gemini-pro', stream: false }
+)
+
+# With a Service Account
 client = Gemini.new(
-  credentials: { file_path: 'google-credentials.json', project_id: 'PROJECT_ID', region: 'us-east4' },
-  settings: { model: 'gemini-pro', stream: false }
+  credentials: {
+    service: 'vertex-ai-api',
+    file_path: 'google-credentials.json',
+    project_id: 'PROJECT_ID',
+    region: 'us-east4'
+  },
+  options: { model: 'gemini-pro', stream: false }
 )
 
 result = client.stream_generate_content({
@@ -49,18 +66,31 @@ Result:
 
 ## Setup
 
+### Installing
+
 ```sh
-gem install gemini-ai -v 1.0.0
+gem install gemini-ai -v 2.0.0
 ```
 
 ```sh
-gem 'gemini-ai', '~> 1.0'
+gem 'gemini-ai', '~> 2.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
+
+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).
+
+You also need to enable the _Generative Language API_ service in your Google Cloud Console, which can be done [here](https://console.cloud.google.com/apis/library/generativelanguage.googleapis.com).
+
+
+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
+
 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.
 
 After creating them, you need to enable the Vertex AI API for your project by clicking `Enable` here: [Vertex AI API](https://console.cloud.google.com/apis/library/aiplatform.googleapis.com).
@@ -113,14 +143,33 @@ gcloud projects add-iam-policy-binding PROJECT_ID \
   --role='roles/ml.admin'
 ```
 
-> ⚠️ 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.
-
 #### Required Data
 
-After this, you should have all the necessary data and access to use Gemini: a `google-credentials.json` file, a `PROJECT_ID`, and a `REGION`:
+After choosing an option, you should have all the necessary data and access to use Gemini.
+
+For API Key:
 
 ```ruby
 {
+  service: 'generative-language-api',
+  api_key: 'GOOGLE_API_KEY'
+}
+```
+
+Remember that hardcoding your API key in code is unsafe; it's preferable to use environment variables:
+
+```ruby
+{
+  service: 'generative-language-api',
+  api_key: ENV['GOOGLE_API_KEY']
+}
+```
+
+Alternativelly, for Service Account, a `google-credentials.json` file, a `PROJECT_ID`, and a `REGION`:
+
+```ruby
+{
+  service: 'vertex-ai-api',
   file_path: 'google-credentials.json',
   project_id: 'PROJECT_ID',
   region: 'us-east4'
@@ -150,9 +199,24 @@ Create a new client:
 ```ruby
 require 'gemini-ai'
 
+# With an API key
 client = Gemini.new(
-  credentials: { file_path: 'google-credentials.json', project_id: 'PROJECT_ID', region: 'us-east4' },
-  settings: { model: 'gemini-pro', stream: false }
+  credentials: {
+    service: 'generative-language-api',
+    api_key: ENV['GOOGLE_API_KEY']
+  },
+  options: { model: 'gemini-pro', stream: false }
+)
+
+# With a Service Account
+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 }
 )
 ```
 
@@ -191,8 +255,8 @@ Result:
 You can set up the client to use streaming for all supported endpoints:
 ```ruby
 client = Gemini.new(
-  credentials: { file_path: 'google-credentials.json', project_id: 'PROJECT_ID', region: 'us-east4' },
-  settings: { model: 'gemini-pro', stream: true }
+  credentials: { ... },
+  options: { model: 'gemini-pro', stream: true }
 )
 ```
 
@@ -481,11 +545,17 @@ gem build gemini-ai.gemspec
 
 gem signin
 
-gem push gemini-ai-1.0.0.gem
+gem push gemini-ai-2.0.0.gem
 ```
 
 ### Updating the README
 
+Install [Babashka](https://babashka.org):
+
+```sh
+curl -s https://raw.githubusercontent.com/babashka/babashka/master/install | sudo bash
+```
+
 Update the `template.md` file and then:
 
 ```sh
@@ -513,6 +583,8 @@ mlp README.md -p 8076
 
 These resources and references may be useful throughout your learning process.
 
+- [Google AI for Developers](https://ai.google.dev)
+- [Get started with the Gemini API ](https://ai.google.dev/docs)
 - [Getting Started with the Vertex AI Gemini API with cURL](https://github.com/GoogleCloudPlatform/generative-ai/blob/main/gemini/getting-started/intro_gemini_curl.ipynb)
 - [Gemini API Documentation](https://cloud.google.com/vertex-ai/docs/generative-ai/model-reference/gemini)
 - [Vertex AI API Documentation](https://cloud.google.com/vertex-ai/docs/reference)
@@ -525,4 +597,4 @@ These resources and references may be useful throughout your learning process.
 
 This is not an official Google project, nor is it affiliated with Google in any way.
 
-The software is distributed under the MIT License, which can be found at [https://github.com/gbaptista/gemini-ai/blob/main/LICENSE](https://github.com/gbaptista/gemini-ai/blob/main/LICENSE). This license includes a disclaimer of warranty. Moreover, the authors assume no responsibility for any damage or costs that may result from using this project. Use the Gemini AI Ruby Gem at your own risk.
+This software is distributed under the [MIT License](https://github.com/gbaptista/gemini-ai/blob/main/LICENSE). This license includes a disclaimer of warranty. Moreover, the authors assume no responsibility for any damage or costs that may result from using this project. Use the Gemini AI Ruby Gem at your own risk.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gemini-ai
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - gbaptista
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-14 00:00:00.000000000 Z
+date: 2023-12-15 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, Google's generative
-  AI service.
+description: A Ruby Gem for interacting with Gemini through Vertex AI or AI Studio,
+  Google's generative AI services.
 email: 
 executables: []
 extensions: []
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Interact with Google's Gemini AI.