nano-bots 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73bb77d7db0d570b10ac2b267c6fc2c550c19933bd68c96bc56c926ff4df013d
-  data.tar.gz: 4a945487832c8deef8513d6cb16c518b078e075b50435b4e5ae898a80090dd2b
+  metadata.gz: 6d496441fb846ecb3deb69ecfaee74d929ee7cfab8d8f7ad779da9ebc84dd970
+  data.tar.gz: 6d96a3b14b471f8b5f3e616c036a95e4fba9a36f1f608d0eddf263b4401a5b3d
 SHA512:
-  metadata.gz: 777872e14cb28d72597b4734f1ccd0ecf57b3613b5a4da451662120bb6e2eb7ce8530e86c009b5f3cbff1e8ae10c5e15016551afe75f0cfd773ad0df44f657a0
-  data.tar.gz: 4e7dcf5b6087c2387660e379ae2c4c9dc5cd247a146f25fc4a97b472a9467e5ca8d7fab7e0629c2f5698a4851a4fe73eca5c248cbfb3ac18ccbb26678ba72547
+  metadata.gz: 9c04eec85e715e87030ae6b9e3f070ee760392b78719747215f12adf1ac0368452a4f9c6381a8382246ecc11b50830ede50a879c191212006b3593bf3e2bd92e
+  data.tar.gz: '08de387499a77c6e955d90d5f53f02a8fd5197b30df520952d9abbaa9731e324b3e73ccaae8f0c8da29325955319bb727a8790a68103273d12dd0953e7e64e5e'

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    nano-bots (0.0.7)
+    nano-bots (0.0.8)
       babosa (~> 2.0)
       dotenv (~> 2.8, >= 2.8.1)
-      faraday (~> 2.7, >= 2.7.4)
+      faraday (~> 2.7, >= 2.7.5)
       pry (~> 0.14.2)
       rainbow (~> 3.1, >= 3.1.1)
       ruby-openai (~> 4.0)
@@ -18,7 +18,7 @@ GEM
     coderay (1.1.3)
     diff-lcs (1.5.0)
     dotenv (2.8.1)
-    faraday (2.7.4)
+    faraday (2.7.5)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-multipart (1.0.4)

data/README.md

@@ -23,13 +23,13 @@ https://user-images.githubusercontent.com/113217272/238141567-c58a240c-7b67-4b3b
 For a system usage:
 
 ```sh
-gem install nano-bots -v 0.0.7
+gem install nano-bots -v 0.0.8
 ```
 
 To use it in a project, add it to your `Gemfile`:
 
 ```ruby
-gem 'nano-bots', '~> 0.0.7'
+gem 'nano-bots', '~> 0.0.8'
 ```
 
 ```sh
@@ -76,7 +76,7 @@ version: '3.7'
 services:
   nano-bots:
     image: ruby:3.2.2-slim-bullseye
-    command: sh -c "gem install nano-bots -v 0.0.7 && bash"
+    command: sh -c "gem install nano-bots -v 0.0.8 && bash"
     environment:
       OPENAI_API_ADDRESS: https://api.openai.com
       OPENAI_API_ACCESS_TOKEN: your-token
@@ -193,13 +193,40 @@ NanoBot.repl(cartridge: 'cartridge.yml') # Starts a new REPL.
 
 bot = NanoBot.new(cartridge: 'cartridge.yml')
 
+bot = NanoBot.new(
+  cartridge: YAML.safe_load(File.read('cartridge.yml'), permitted_classes: [Symbol])
+)
+
+bot = NanoBot.new(
+  cartridge: { ... } # Parsed Cartridge Hash
+)
+
 bot.eval('Hello')
 
+bot.eval('Hello', as: 'eval')
+bot.eval('Hello', as: 'repl')
+
+# When stream is enabled and available:
+bot.eval('Hi!') do |content, fragment, finished|
+  print fragment unless fragment.nil?
+end
+
 bot.repl # Starts a new REPL.
 
 NanoBot.repl(cartridge: 'cartridge.yml', state: '6ea6c43c42a1c076b1e3c36fa349ac2c')
 
 bot = NanoBot.new(cartridge: 'cartridge.yml', state: '6ea6c43c42a1c076b1e3c36fa349ac2c')
+
+bot.prompt # => "🤖\u001b[34m> \u001b[0m"
+
+bot.boot
+
+bot.boot(as: 'eval')
+bot.boot(as: 'repl')
+
+bot.boot do |content, fragment, finished|
+  print fragment unless fragment.nil?
+end
 ```
 
 ## Cartridges
@@ -209,9 +236,12 @@ Here's what a Nano Bot Cartridge looks like:
 ```yaml
 ---
 meta:
+  symbol: 🤖
   name: Nano Bot Name
   author: Your Name
-  version: 0.0.1
+  version: 1.0.0
+  license: CC0-1.0
+  description: A helpful assistant.
 
 behaviors:
   interaction:
@@ -227,18 +257,22 @@ provider:
       user-identifier: ENV/OPENAI_API_USER_IDENTIFIER
 ```
 
-Check the Nano Bots specification to learn more about [how to build cartridges](https://icebaker.github.io/nano-bots/#/README?id=cartridges).
+Check the Nano Bots specification to learn more about [how to build cartridges](https://spec.nbots.io/#/README?id=cartridges).
+
+Try the [Nano Bots Clinic (Live Editor)](https://clinic.nbots.io) to learn about creating Cartridges.
 
 ## Providers
 
 Currently supported providers:
 
-- [ ] [Vicuna](https://github.com/lm-sys/FastChat)
+- [x] [FastChat (Vicuna)](https://github.com/lm-sys/FastChat)
 - [x] [Open AI](https://platform.openai.com/docs/api-reference)
 - [ ] [Google PaLM](https://developers.generativeai.google/)
 - [ ] [Alpaca](https://github.com/tatsu-lab/stanford_alpaca)
 - [ ] [LLaMA](https://github.com/facebookresearch/llama)
 
+Although only OpenAI has been officially tested, some of the open-source providers offer APIs that are compatible with OpenAI, such as [FastChat](https://github.com/lm-sys/FastChat#openai-compatible-restful-apis--sdk). Therefore, it is highly probable that they will work just fine.
+
 ## Development
 
 ```bash
@@ -254,5 +288,5 @@ gem build nano-bots.gemspec
 
 gem signin
 
-gem push nano-bots-0.0.7.gem
+gem push nano-bots-0.0.8.gem
 ```

data/controllers/instance.rb

@@ -31,10 +31,24 @@ module NanoBot
         @session.state
       end
 
-      def eval(input, &block)
+      def boot(as: 'eval', &block)
         @stream.callback = block if block && @stream.is_a?(Components::Stream)
 
-        Interfaces::Eval.evaluate(input, @cartridge, @session)
+        Interfaces::REPL.boot(@cartridge, @session, as:)
+
+        return unless @stream.is_a?(Components::Stream)
+
+        @stream.finish
+      end
+
+      def prompt
+        Interfaces::REPL.prompt(@cartridge)
+      end
+
+      def eval(input, as: 'eval', &block)
+        @stream.callback = block if block && @stream.is_a?(Components::Stream)
+
+        Interfaces::Eval.evaluate(input, @cartridge, @session, as)
 
         return unless @stream.is_a?(Components::Stream)
 

data/controllers/interfaces/eval.rb

@@ -10,13 +10,13 @@ module NanoBot
   module Controllers
     module Interfaces
       module Eval
-        def self.evaluate(input, cartridge, session)
-          prefix = Logic::Cartridge::Affixes.get(cartridge, :eval, :output, :prefix)
-          suffix = Logic::Cartridge::Affixes.get(cartridge, :eval, :output, :suffix)
+        def self.evaluate(input, cartridge, session, mode)
+          prefix = Logic::Cartridge::Affixes.get(cartridge, mode.to_sym, :output, :prefix)
+          suffix = Logic::Cartridge::Affixes.get(cartridge, mode.to_sym, :output, :suffix)
 
           session.print(prefix) unless prefix.nil?
 
-          session.evaluate_and_print(input, mode: 'eval')
+          session.evaluate_and_print(input, mode:)
 
           session.print(suffix) unless suffix.nil?
         end

data/controllers/interfaces/repl.rb

@@ -10,18 +10,26 @@ module NanoBot
   module Controllers
     module Interfaces
       module REPL
+        def self.boot(cartridge, session, prefix = nil, suffix = nil, as: 'repl')
+          return unless Logic::Helpers::Hash.fetch(cartridge, %i[behaviors boot instruction])
+
+          prefix ||= Logic::Cartridge::Affixes.get(cartridge, as.to_sym, :output, :prefix)
+          suffix ||= Logic::Cartridge::Affixes.get(cartridge, as.to_sym, :output, :suffix)
+
+          session.print(prefix) unless prefix.nil?
+          session.boot(mode: as)
+          session.print(suffix) unless suffix.nil?
+        end
+
         def self.start(cartridge, session)
           prefix = Logic::Cartridge::Affixes.get(cartridge, :repl, :output, :prefix)
           suffix = Logic::Cartridge::Affixes.get(cartridge, :repl, :output, :suffix)
 
-          if Logic::Helpers::Hash.fetch(cartridge, %i[behaviors boot instruction])
-            session.print(prefix) unless prefix.nil?
-            session.boot(mode: 'repl')
-            session.print(suffix) unless suffix.nil?
-            session.print("\n")
-          end
+          boot(cartridge, session, prefix, suffix)
+
+          session.print("\n") if Logic::Helpers::Hash.fetch(cartridge, %i[behaviors boot instruction])
 
-          prompt = build_prompt(Logic::Helpers::Hash.fetch(cartridge, %i[interfaces repl prompt]))
+          prompt = self.prompt(cartridge)
 
           Pry.config.prompt = Pry::Prompt.new(
             'REPL',
@@ -40,7 +48,8 @@ module NanoBot
           Pry.start
         end
 
-        def self.build_prompt(prompt)
+        def self.prompt(cartridge)
+          prompt = Logic::Helpers::Hash.fetch(cartridge, %i[interfaces repl prompt])
           result = ''
 
           if prompt.is_a?(Array)

data/controllers/session.rb

@@ -61,6 +61,8 @@ module NanoBot
 
         @state[:history] << {
           who: 'user',
+          mode: mode.to_s,
+          input: message,
           message: Components::Adapter.apply(
             :input, Logic::Cartridge::Interaction.input(@cartridge, mode.to_sym, message)
           )
@@ -72,6 +74,9 @@ module NanoBot
       end
 
       def process(input, mode:)
+        prefix = Logic::Cartridge::Affixes.get(@cartridge, mode.to_sym, :output, :prefix)
+        suffix = Logic::Cartridge::Affixes.get(@cartridge, mode.to_sym, :output, :suffix)
+
         interface = Logic::Helpers::Hash.fetch(@cartridge, [:interfaces, mode.to_sym]) || {}
 
         streaming = Logic::Cartridge::Streaming.enabled?(@cartridge, mode.to_sym)
@@ -85,7 +90,7 @@ module NanoBot
           updated_at = Time.now
 
           if finished
-            @state[:history] << Marshal.load(Marshal.dump(output))
+            event = Marshal.load(Marshal.dump(output))
 
             output = Logic::Cartridge::Interaction.output(
               @cartridge, mode.to_sym, output, streaming, finished
@@ -93,6 +98,11 @@ module NanoBot
 
             output[:message] = Components::Adapter.apply(:output, output[:message])
 
+            event[:mode] = mode.to_s
+            event[:output] = "#{prefix}#{output[:message]}#{suffix}"
+
+            @state[:history] << event
+
             self.print(output[:message]) unless streaming
 
             ready = true

data/docker-compose.example.yml

@@ -3,7 +3,7 @@ version: '3.7'
 services:
   nano-bots:
     image: ruby:3.2.2-slim-bullseye
-    command: sh -c "apt-get update && apt-get install -y --no-install-recommends build-essential libffi-dev lua5.4-dev && gem install nano-bots -v 0.0.7 && bash"
+    command: sh -c "apt-get update && apt-get install -y --no-install-recommends build-essential libffi-dev lua5.4-dev && gem install nano-bots -v 0.0.8 && bash"
     environment:
       OPENAI_API_ADDRESS: https://api.openai.com
       OPENAI_API_ACCESS_TOKEN: your-token

data/nano-bots.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'babosa', '~> 2.0'
   spec.add_dependency 'dotenv', '~> 2.8', '>= 2.8.1'
-  spec.add_dependency 'faraday', '~> 2.7', '>= 2.7.4'
+  spec.add_dependency 'faraday', '~> 2.7', '>= 2.7.5'
   spec.add_dependency 'pry', '~> 0.14.2'
   spec.add_dependency 'rainbow', '~> 3.1', '>= 3.1.1'
   spec.add_dependency 'ruby-openai', '~> 4.0'

data/static/gem.rb

@@ -3,7 +3,7 @@
 module NanoBot
   GEM = {
     name: 'nano-bots',
-    version: '0.0.7',
+    version: '0.0.8',
     author: 'icebaker',
     summary: 'Ruby Implementation of Nano Bots: small, AI-powered bots',
     description: 'Ruby Implementation of Nano Bots: small, AI-powered bots easily shared as a single file, designed to support multiple providers such as Vicuna, OpenAI ChatGPT, Google PaLM, Alpaca, and LLaMA.',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nano-bots
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - icebaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-21 00:00:00.000000000 Z
+date: 2023-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: babosa
@@ -53,7 +53,7 @@ dependencies:
         version: '2.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.4
+        version: 2.7.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -63,7 +63,7 @@ dependencies:
         version: '2.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.4
+        version: 2.7.5
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement