nano-bots 1.2.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32f9bfa761f2b8f34c638d86f207b804a1861873b6ff09dc09202e815fb60943
-  data.tar.gz: 274c62930860eef8ba3bedff9d169513627160539fd7c30077e883b882fb5330
+  metadata.gz: 1cfd38c6461b14483fc0478d31b73ed3e4890f1c534b3c7a4ead6f9412466674
+  data.tar.gz: 11f3e82a196f8b27ac1313ee2e653c93521ed7c081ef68bacf15015c8392db34
 SHA512:
-  metadata.gz: 7eb6dd2df0d4cbc9a7d7ad880b7ffa633a8ed3ebb52367f1e379efbc78f142a9675603bbcb26c05aa8a2533f3ca9aa5b120faea83843bcc4120a4f01895fa38f
-  data.tar.gz: a7451773e12f9c25362ffcb04f1c8ce78f7aff0988fec4178d0456d4f91bf70feffa631232a7e182b0cefd6d015ee5fd52ab19448eeeefb77ff821bf2f34d4ea
+  metadata.gz: b6a7dbb69afead0f718e2b3c688edb35dfce6f68f138ddd5168c9d72b5eaaedbdcf973b99be873709c4f6b63f71a3f35c9a5d06a0ca4efd32800c52b6de3ccc0
+  data.tar.gz: 24bf5641942d008e7afbad2ae37fec1a4f37d28c68b3ab0ab3f560849f8b427a246f5c9c29ddc9221852bbb3cd5e86bb958c9fbff392a0cca0fab81d9c3b0171

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    nano-bots (1.2.0)
+    nano-bots (2.1.0)
       babosa (~> 2.0)
       concurrent-ruby (~> 1.2, >= 1.2.2)
       dotenv (~> 2.8, >= 2.8.1)
-      gemini-ai (~> 1.0)
+      gemini-ai (~> 2.1)
       pry (~> 0.14.2)
       rainbow (~> 3.1, >= 3.1.1)
       rbnacl (~> 7.1, >= 7.1.1)
@@ -34,7 +34,7 @@ GEM
       multipart-post (~> 2)
     faraday-net_http (3.0.2)
     ffi (1.16.3)
-    gemini-ai (1.0.0)
+    gemini-ai (2.1.0)
       event_stream_parser (~> 1.0)
       faraday (~> 2.7, >= 2.7.12)
       googleauth (~> 1.9, >= 1.9.1)
@@ -54,7 +54,7 @@ GEM
     multi_json (1.15.0)
     multipart-post (2.3.0)
     os (1.1.4)
-    parallel (1.23.0)
+    parallel (1.24.0)
     parser (3.2.2.4)
       ast (~> 2.4.1)
       racc
@@ -131,4 +131,4 @@ DEPENDENCIES
   rubocop-rspec (~> 2.25)
 
 BUNDLED WITH
-   2.4.13
+   2.4.22

data/README.md

@@ -36,13 +36,13 @@ https://user-images.githubusercontent.com/113217272/238141567-c58a240c-7b67-4b3b
 For a system usage:
 
 ```sh
-gem install nano-bots -v 1.2.0
+gem install nano-bots -v 2.1.0
 ```
 
 To use it in a project, add it to your `Gemfile`:
 
 ```ruby
-gem 'nano-bots', '~> 1.2.0'
+gem 'nano-bots', '~> 2.1.0'
 ```
 
 ```sh
@@ -81,9 +81,34 @@ NANO_BOTS_END_USER=your-user
 
 Click [here](https://github.com/gbaptista/gemini-ai#credentials) to learn how to obtain your credentials.
 
+#### Option 1: API Key (Generative Language API)
+
+```sh
+export GOOGLE_API_KEY=your-api-key
+
+export NANO_BOTS_ENCRYPTION_PASSWORD=UNSAFE
+export NANO_BOTS_END_USER=your-user
+
+# export NANO_BOTS_STATE_DIRECTORY=/home/user/.local/state/nano-bots
+# export NANO_BOTS_CARTRIDGES_DIRECTORY=/home/user/.local/share/nano-bots/cartridges
+```
+
+Alternatively, if your current directory has a `.env` file with the environment variables, they will be automatically loaded:
+
+```sh
+GOOGLE_API_KEY=your-api-key
+
+NANO_BOTS_ENCRYPTION_PASSWORD=UNSAFE
+NANO_BOTS_END_USER=your-user
+
+# NANO_BOTS_STATE_DIRECTORY=/home/user/.local/state/nano-bots
+# NANO_BOTS_CARTRIDGES_DIRECTORY=/home/user/.local/share/nano-bots/cartridges
+```
+
+#### Option 2: Service Account Credentials File (Vertex AI API)
+
 ```sh
 export GOOGLE_CREDENTIALS_FILE_PATH=google-credentials.json
-export GOOGLE_PROJECT_ID=your-project-id
 export GOOGLE_REGION=us-east4
 
 export NANO_BOTS_ENCRYPTION_PASSWORD=UNSAFE
@@ -97,7 +122,6 @@ Alternatively, if your current directory has a `.env` file with the environment
 
 ```sh
 GOOGLE_CREDENTIALS_FILE_PATH=google-credentials.json
-GOOGLE_PROJECT_ID=your-project-id
 GOOGLE_REGION=us-east4
 
 NANO_BOTS_ENCRYPTION_PASSWORD=UNSAFE
@@ -107,6 +131,44 @@ NANO_BOTS_END_USER=your-user
 # NANO_BOTS_CARTRIDGES_DIRECTORY=/home/user/.local/share/nano-bots/cartridges
 ```
 
+#### Option 3: Application Default Credentials (Vertex AI API)
+
+```sh
+export GOOGLE_REGION=us-east4
+
+export NANO_BOTS_ENCRYPTION_PASSWORD=UNSAFE
+export NANO_BOTS_END_USER=your-user
+
+# export NANO_BOTS_STATE_DIRECTORY=/home/user/.local/state/nano-bots
+# export NANO_BOTS_CARTRIDGES_DIRECTORY=/home/user/.local/share/nano-bots/cartridges
+```
+
+Alternatively, if your current directory has a `.env` file with the environment variables, they will be automatically loaded:
+
+```sh
+GOOGLE_REGION=us-east4
+
+NANO_BOTS_ENCRYPTION_PASSWORD=UNSAFE
+NANO_BOTS_END_USER=your-user
+
+# NANO_BOTS_STATE_DIRECTORY=/home/user/.local/state/nano-bots
+# NANO_BOTS_CARTRIDGES_DIRECTORY=/home/user/.local/share/nano-bots/cartridges
+```
+
+#### Custom Project ID
+
+If you need to manually set a Google Project ID:
+
+```sh
+export GOOGLE_PROJECT_ID=your-project-id
+```
+
+Alternatively, if your current directory has a `.env` file with the environment variables, they will be automatically loaded:
+
+```sh
+GOOGLE_PROJECT_ID=your-project-id
+```
+
 ## Docker
 
 Clone the repository and copy the Docker Compose template:
@@ -126,7 +188,7 @@ Set your provider credentials and choose your desired directory for the cartridg
 services:
   nano-bots:
     image: ruby:3.2.2-slim-bookworm
-    command: sh -c "apt-get update && apt-get install -y --no-install-recommends build-essential libffi-dev libsodium-dev lua5.4-dev curl && curl -s https://raw.githubusercontent.com/babashka/babashka/master/install | bash && gem install nano-bots -v 1.2.0 && bash"
+    command: sh -c "apt-get update && apt-get install -y --no-install-recommends build-essential libffi-dev libsodium-dev lua5.4-dev curl && curl -s https://raw.githubusercontent.com/babashka/babashka/master/install | bash && gem install nano-bots -v 2.1.0 && bash"
     environment:
       OPENAI_API_ADDRESS: https://api.openai.com
       OPENAI_API_KEY: your-access-token
@@ -139,15 +201,33 @@ services:
 
 ### Google Gemini
 
+#### Option 1: API Key (Generative Language API)
+
+```yaml
+---
+services:
+  nano-bots:
+    image: ruby:3.2.2-slim-bookworm
+    command: sh -c "apt-get update && apt-get install -y --no-install-recommends build-essential libffi-dev libsodium-dev lua5.4-dev curl && curl -s https://raw.githubusercontent.com/babashka/babashka/master/install | bash && gem install nano-bots -v 2.1.0 && bash"
+    environment:
+      GOOGLE_API_KEY: your-api-key
+      NANO_BOTS_ENCRYPTION_PASSWORD: UNSAFE
+      NANO_BOTS_END_USER: your-user
+    volumes:
+      - ./your-cartridges:/root/.local/share/nano-bots/cartridges
+      - ./your-state-path:/root/.local/state/nano-bots
+```
+
+#### Option 2: Service Account Credentials File (Vertex AI API)
+
 ```yaml
 ---
 services:
   nano-bots:
     image: ruby:3.2.2-slim-bookworm
-    command: sh -c "apt-get update && apt-get install -y --no-install-recommends build-essential libffi-dev libsodium-dev lua5.4-dev curl && curl -s https://raw.githubusercontent.com/babashka/babashka/master/install | bash && gem install nano-bots -v 1.2.0 && bash"
+    command: sh -c "apt-get update && apt-get install -y --no-install-recommends build-essential libffi-dev libsodium-dev lua5.4-dev curl && curl -s https://raw.githubusercontent.com/babashka/babashka/master/install | bash && gem install nano-bots -v 2.1.0 && bash"
     environment:
       GOOGLE_CREDENTIALS_FILE_PATH: /root/.config/google-credentials.json
-      GOOGLE_PROJECT_ID: your-project-id
       GOOGLE_REGION: us-east4
       NANO_BOTS_ENCRYPTION_PASSWORD: UNSAFE
       NANO_BOTS_END_USER: your-user
@@ -157,6 +237,31 @@ services:
       - ./your-state-path:/root/.local/state/nano-bots
 ```
 
+#### Option 3: Application Default Credentials (Vertex AI API)
+
+```yaml
+---
+services:
+  nano-bots:
+    image: ruby:3.2.2-slim-bookworm
+    command: sh -c "apt-get update && apt-get install -y --no-install-recommends build-essential libffi-dev libsodium-dev lua5.4-dev curl && curl -s https://raw.githubusercontent.com/babashka/babashka/master/install | bash && gem install nano-bots -v 2.1.0 && bash"
+    environment:
+      GOOGLE_REGION: us-east4
+      NANO_BOTS_ENCRYPTION_PASSWORD: UNSAFE
+      NANO_BOTS_END_USER: your-user
+    volumes:
+      - ./your-cartridges:/root/.local/share/nano-bots/cartridges
+      - ./your-state-path:/root/.local/state/nano-bots
+```
+
+#### Custom Project ID
+If you need to manually set a Google Project ID:
+
+```yaml
+environment:
+  GOOGLE_PROJECT_ID=your-project-id
+```
+
 ### Container
 
 Enter the container:
@@ -346,6 +451,8 @@ provider:
 
 Read the [full specification](https://spec.nbots.io/#/README?id=google-gemini) for Google Gemini.
 
+#### Option 1: API Key (Generative Language API)
+
 ```yaml
 ---
 meta:
@@ -363,13 +470,75 @@ behaviors:
 provider:
   id: google
   credentials:
-    project-id: ENV/GOOGLE_PROJECT_ID
+    service: generative-language-api
+    api-key: ENV/GOOGLE_API_KEY
+  options:
+    model: gemini-pro
+```
+
+#### Option 2: Service Account Credentials File (Vertex AI API)
+
+```yaml
+---
+meta:
+  symbol: 🤖
+  name: Nano Bot Name
+  author: Your Name
+  version: 1.0.0
+  license: CC0-1.0
+  description: A helpful assistant.
+
+behaviors:
+  interaction:
+    directive: You are a helpful assistant.
+
+provider:
+  id: google
+  credentials:
+    service: vertex-ai-api
     file-path: ENV/GOOGLE_CREDENTIALS_FILE_PATH
     region: ENV/GOOGLE_REGION
   options:
     model: gemini-pro
 ```
 
+#### Option 3: Application Default Credentials (Vertex AI API)
+
+```yaml
+---
+meta:
+  symbol: 🤖
+  name: Nano Bot Name
+  author: Your Name
+  version: 1.0.0
+  license: CC0-1.0
+  description: A helpful assistant.
+
+behaviors:
+  interaction:
+    directive: You are a helpful assistant.
+
+provider:
+  id: google
+  credentials:
+    service: vertex-ai-api
+    region: ENV/GOOGLE_REGION
+  options:
+    model: gemini-pro
+```
+
+#### Custom Project ID
+
+If you need to manually set a Google Project ID:
+
+```yaml
+---
+provider:
+  id: google
+  credentials:
+    project-id: ENV/GOOGLE_PROJECT_ID
+```
+
 ### Tools (Functions)
 
 Nano Bots can also be powered by _Tools_ (Functions):
@@ -395,7 +564,7 @@ The randomly generated number is 59.
 
 🤖> |
 ```
-To successfully use Tools (Functions), you need to specify a provider and a model that supports them. As of the writing of this README, the provider that supports them is [OpenAI](https://platform.openai.com/docs/models), with models `gpt-3.5-turbo-1106` and `gpt-4-1106-preview`, and [Google](https://cloud.google.com/vertex-ai/docs/generative-ai/multimodal/function-calling#supported_models), with the model `gemini-pro`.
+To successfully use Tools (Functions), you need to specify a provider and a model that supports them. As of the writing of this README, the provider that supports them is [OpenAI](https://platform.openai.com/docs/models), with models `gpt-3.5-turbo-1106` and `gpt-4-1106-preview`, and [Google](https://cloud.google.com/vertex-ai/docs/generative-ai/multimodal/function-calling#supported_models), with the `vertex-ai-api` service and the model `gemini-pro`.
 
 Check the [Nano Bots specification](https://spec.nbots.io/#/README?id=tools-functions-2) to learn more about Tools (Functions).
 
@@ -418,7 +587,7 @@ Unlike Lua and Fennel, Clojure support is not _embedded_ in this implementation.
 Here's [how to install Babashka](https://github.com/babashka/babashka#quickstart):
 
 ```sh
-curl -s https://raw.githubusercontent.com/babashka/babashka/master/install | bash
+curl -s https://raw.githubusercontent.com/babashka/babashka/master/install | sudo bash
 ```
 
 This is a quick check to ensure that it is available and working:
@@ -576,5 +745,5 @@ gem build nano-bots.gemspec
 
 gem signin
 
-gem push nano-bots-1.2.0.gem
+gem push nano-bots-2.1.0.gem
 ```

data/components/provider.rb

@@ -9,7 +9,7 @@ module NanoBot
       def self.new(provider, environment: {})
         case provider[:id]
         when 'openai'
-          Providers::OpenAI.new(provider[:settings], provider[:credentials], environment:)
+          Providers::OpenAI.new(nil, provider[:settings], provider[:credentials], environment:)
         when 'google'
           Providers::Google.new(provider[:options], provider[:settings], provider[:credentials], environment:)
         else

data/components/providers/base.rb

@@ -6,7 +6,7 @@ module NanoBot
   module Components
     module Providers
       class Base
-        def initialize(_settings, _credentials, _environment: {})
+        def initialize(_options, _settings, _credentials, _environment: {})
           raise NoMethodError, "The 'initialize' method is not implemented for the current provider."
         end
 

data/components/providers/google.rb

@@ -13,26 +13,22 @@ module NanoBot
   module Components
     module Providers
       class Google < Base
+        SAFETY_SETTINGS = %i[category threshold].freeze
+
         SETTINGS = {
           generationConfig: %i[
             temperature topP topK candidateCount maxOutputTokens stopSequences
           ].freeze
         }.freeze
 
-        SAFETY_SETTINGS = %i[category threshold].freeze
-
         attr_reader :settings
 
         def initialize(options, settings, credentials, _environment)
           @settings = settings
 
           @client = Gemini.new(
-            credentials: {
-              file_path: credentials[:'file-path'],
-              project_id: credentials[:'project-id'],
-              region: credentials[:region]
-            },
-            settings: { model: options[:model], stream: options[:stream] }
+            credentials: credentials.transform_keys { |key| key.to_s.gsub('-', '_').to_sym },
+            options: options.transform_keys { |key| key.to_s.gsub('-', '_').to_sym }
           )
         end
 
@@ -58,12 +54,18 @@ module NanoBot
             end
           end
 
+          # TODO: Does Gemini have system messages?
           %i[backdrop directive].each do |key|
             next unless input[:behavior][key]
 
-            # TODO: Does Gemini have system messages?
             messages.prepend(
-              { role: key == :directive ? 'user' : 'user',
+              { role: 'model',
+                parts: { text: 'Understood.' },
+                _meta: { at: Time.now } }
+            )
+
+            messages.prepend(
+              { role: 'user',
                 parts: { text: input[:behavior][key] },
                 _meta: { at: Time.now } }
             )
@@ -122,24 +124,9 @@ module NanoBot
               end
 
               if event.dig('candidates', 0, 'finishReason')
-                if tools&.size&.positive?
-                  feedback.call(
-                    { should_be_stored: true,
-                      needs_another_round: true,
-                      interaction: { who: 'AI', message: nil, meta: { tool_calls: tools } } }
-                  )
-                  Tools.apply(
-                    cartridge, input[:tools], tools, feedback, Logic::Google::Tools
-                  ).each do |interaction|
-                    feedback.call({ should_be_stored: true, needs_another_round: true, interaction: })
-                  end
-                end
-
-                feedback.call(
-                  { should_be_stored: !(content.nil? || content == ''),
-                    interaction: content.nil? || content == '' ? nil : { who: 'AI', message: content },
-                    finished: true }
-                )
+                # TODO: This does not have the same behavior as OpenAI, so you should
+                #       not use it as a reference for the end of the streaming.
+                #       Is this a bug from the Google Gemini REST API or expected behavior?
               end
             end
 
@@ -148,6 +135,25 @@ module NanoBot
                 Logic::Google::Tokens.apply_policies!(cartridge, payload),
                 stream: true, &stream_call_back
               )
+
+              if tools&.size&.positive?
+                feedback.call(
+                  { should_be_stored: true,
+                    needs_another_round: true,
+                    interaction: { who: 'AI', message: nil, meta: { tool_calls: tools } } }
+                )
+                Tools.apply(
+                  cartridge, input[:tools], tools, feedback, Logic::Google::Tools
+                ).each do |interaction|
+                  feedback.call({ should_be_stored: true, needs_another_round: true, interaction: })
+                end
+              end
+
+              feedback.call(
+                { should_be_stored: !(content.nil? || content == ''),
+                  interaction: content.nil? || content == '' ? nil : { who: 'AI', message: content },
+                  finished: true }
+              )
             rescue StandardError => e
               raise e.class, e.response[:body] if e.response && e.response[:body]
 

data/components/providers/openai.rb

@@ -17,13 +17,14 @@ module NanoBot
         DEFAULT_ADDRESS = 'https://api.openai.com'
 
         CHAT_SETTINGS = %i[
-          model stream temperature top_p n stop max_tokens
-          presence_penalty frequency_penalty logit_bias seed response_format
+          model stream frequency_penalty logit_bias logprobs top_logprobs
+          max_tokens n presence_penalty response_format seed stop temperature
+          top_p tool_choice
         ].freeze
 
         attr_reader :settings
 
-        def initialize(settings, credentials, environment: {})
+        def initialize(_options, settings, credentials, environment: {})
           @settings = settings
           @credentials = credentials
           @environment = environment

data/docker-compose.example.yml

@@ -2,12 +2,21 @@
 services:
   nano-bots:
     image: ruby:3.2.2-slim-bookworm
-    command: sh -c "apt-get update && apt-get install -y --no-install-recommends build-essential libffi-dev libsodium-dev lua5.4-dev curl && curl -s https://raw.githubusercontent.com/babashka/babashka/master/install | bash && gem install nano-bots -v 1.2.0 && bash"
+    command: sh -c "apt-get update && apt-get install -y --no-install-recommends build-essential libffi-dev libsodium-dev lua5.4-dev curl && curl -s https://raw.githubusercontent.com/babashka/babashka/master/install | bash && gem install nano-bots -v 2.1.0 && bash"
     environment:
       OPENAI_API_ADDRESS: https://api.openai.com
       OPENAI_API_KEY: your-access-token
+
+      GOOGLE_API_KEY: your-api-key
+
+      GOOGLE_CREDENTIALS_FILE_PATH: /root/.config/google-credentials.json
+      GOOGLE_PROJECT_ID: your-project-id
+      GOOGLE_REGION: us-east4
+
       NANO_BOTS_ENCRYPTION_PASSWORD: UNSAFE
       NANO_BOTS_END_USER: your-user
+
     volumes:
+      - ./google-credentials.json:/root/.config/google-credentials.json
       - ./your-cartridges:/root/.local/share/nano-bots/cartridges
       - ./your-state-path:/root/.local/state/nano-bots

data/nano-bots.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'babosa', '~> 2.0'
   spec.add_dependency 'concurrent-ruby', '~> 1.2', '>= 1.2.2'
   spec.add_dependency 'dotenv', '~> 2.8', '>= 2.8.1'
-  spec.add_dependency 'gemini-ai', '~> 1.0'
+  spec.add_dependency 'gemini-ai', '~> 2.1'
   spec.add_dependency 'pry', '~> 0.14.2'
   spec.add_dependency 'rainbow', '~> 3.1', '>= 3.1.1'
   spec.add_dependency 'rbnacl', '~> 7.1', '>= 7.1.1'

data/ports/dsl/nano-bots.rb

@@ -40,4 +40,8 @@ module NanoBot
   def self.version
     NanoBot::GEM[:version]
   end
+
+  def self.specification
+    NanoBot::GEM[:specification]
+  end
 end

data/static/gem.rb

@@ -3,7 +3,8 @@
 module NanoBot
   GEM = {
     name: 'nano-bots',
-    version: '1.2.0',
+    version: '2.1.0',
+    specification: '2.0.1',
     author: 'icebaker',
     summary: 'Ruby Implementation of Nano Bots: small, AI-powered bots for OpenAI ChatGPT and Google Gemini.',
     description: 'Ruby Implementation of Nano Bots: small, AI-powered bots that can be easily shared as a single file, designed to support multiple providers such as OpenAI ChatGPT and Google Gemini, with support for calling Tools (Functions).',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nano-bots
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.1.0
 platform: ruby
 authors:
 - icebaker
 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: babosa
@@ -70,14 +70,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -248,7 +248,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: 'Ruby Implementation of Nano Bots: small, AI-powered bots for OpenAI ChatGPT