README.md in nano-bots-3.0.1 vs README.md in nano-bots-3.2.0
- old
+ new
@@ -7,11 +7,11 @@
https://user-images.githubusercontent.com/113217272/238141567-c58a240c-7b67-4b3b-864a-0f49bbf6e22f.mp4
## TL;DR and Quick Start
```sh
-gem install nano-bots -v 3.0.1
+gem install nano-bots -v 3.2.0
```
```bash
nb - - eval "hello"
# => Hello! How may I assist you today?
@@ -48,20 +48,20 @@
id: openai
credentials:
access-token: ENV/OPENAI_API_KEY
settings:
user: ENV/NANO_BOTS_END_USER
- model: gpt-4-1106-preview
+ model: gpt-4o
```
```bash
nb gpt.yml - eval "hi"
# => Hello! How can I assist you today?
```
```ruby
-gem 'nano-bots', '~> 3.0.1'
+gem 'nano-bots', '~> 3.2.0'
```
```ruby
require 'nano-bots'
@@ -74,47 +74,47 @@
# => Hello! How can I assist you today?
```
- [TL;DR and Quick Start](#tldr-and-quick-start)
- [Usage](#usage)
- - [Command Line](#command-line)
- - [Debugging](#debugging)
- - [Library](#library)
+ - [Command Line](#command-line)
+ - [Debugging](#debugging)
+ - [Library](#library)
- [Setup](#setup)
- - [Cohere Command](#cohere-command)
- - [Maritaca AI MariTalk](#maritaca-ai-maritalk)
- - [Mistral AI](#mistral-ai)
- - [Ollama](#ollama)
- - [OpenAI ChatGPT](#openai-chatgpt)
- - [Google Gemini](#google-gemini)
- - [Option 1: API Key (Generative Language API)](#option-1-api-key-generative-language-api)
- - [Option 2: Service Account Credentials File (Vertex AI API)](#option-2-service-account-credentials-file-vertex-ai-api)
- - [Option 3: Application Default Credentials (Vertex AI API)](#option-3-application-default-credentials-vertex-ai-api)
- - [Custom Project ID](#custom-project-id)
+ - [Cohere Command](#cohere-command)
+ - [Maritaca AI MariTalk](#maritaca-ai-maritalk)
+ - [Mistral AI](#mistral-ai)
+ - [Ollama](#ollama)
+ - [OpenAI ChatGPT](#openai-chatgpt)
+ - [Google Gemini](#google-gemini)
+ - [Option 1: API Key (Generative Language API)](#option-1-api-key-generative-language-api)
+ - [Option 2: Service Account Credentials File (Vertex AI API)](#option-2-service-account-credentials-file-vertex-ai-api)
+ - [Option 3: Application Default Credentials (Vertex AI API)](#option-3-application-default-credentials-vertex-ai-api)
+ - [Custom Project ID](#custom-project-id)
- [Cartridges](#cartridges)
- - [Tools (Functions)](#tools-functions)
- - [Experimental Clojure Support](#experimental-clojure-support)
- - [Marketplace](#marketplace)
+ - [Tools (Functions)](#tools-functions)
+ - [Experimental Clojure Support](#experimental-clojure-support)
+ - [Marketplace](#marketplace)
- [Security and Privacy](#security-and-privacy)
- - [Cryptography](#cryptography)
- - [End-user IDs](#end-user-ids)
- - [Decrypting](#decrypting)
+ - [Cryptography](#cryptography)
+ - [End-user IDs](#end-user-ids)
+ - [Decrypting](#decrypting)
- [Supported Providers](#supported-providers)
- [Docker](#docker)
- - [Cohere Command Container](#cohere-command-container)
- - [Maritaca AI MariTalk Container](#maritaca-ai-maritalk-container)
- - [Mistral AI Container](#mistral-ai-container)
- - [Ollama Container](#ollama-container)
- - [OpenAI ChatGPT Container](#openai-chatgpt-container)
- - [Google Gemini Container](#google-gemini-container)
- - [Option 1: API Key (Generative Language API) Config](#option-1-api-key-generative-language-api-config)
- - [Option 2: Service Account Credentials File (Vertex AI API) Config](#option-2-service-account-credentials-file-vertex-ai-api-config)
- - [Option 3: Application Default Credentials (Vertex AI API) Config](#option-3-application-default-credentials-vertex-ai-api-config)
- - [Custom Project ID Config](#custom-project-id-config)
- - [Running the Container](#running-the-container)
+ - [Cohere Command Container](#cohere-command-container)
+ - [Maritaca AI MariTalk Container](#maritaca-ai-maritalk-container)
+ - [Mistral AI Container](#mistral-ai-container)
+ - [Ollama Container](#ollama-container)
+ - [OpenAI ChatGPT Container](#openai-chatgpt-container)
+ - [Google Gemini Container](#google-gemini-container)
+ - [Option 1: API Key (Generative Language API) Config](#option-1-api-key-generative-language-api-config)
+ - [Option 2: Service Account Credentials File (Vertex AI API) Config](#option-2-service-account-credentials-file-vertex-ai-api-config)
+ - [Option 3: Application Default Credentials (Vertex AI API) Config](#option-3-application-default-credentials-vertex-ai-api-config)
+ - [Custom Project ID Config](#custom-project-id-config)
+ - [Running the Container](#running-the-container)
- [Development](#development)
- - [Publish to RubyGems](#publish-to-rubygems)
+ - [Publish to RubyGems](#publish-to-rubygems)
## Usage
### Command Line
@@ -248,17 +248,17 @@
## Setup
To install the CLI on your system:
```sh
-gem install nano-bots -v 3.0.1
+gem install nano-bots -v 3.2.0
```
To use it in a Ruby project as a library, add to your `Gemfile`:
```ruby
-gem 'nano-bots', '~> 3.0.1'
+gem 'nano-bots', '~> 3.2.0'
```
```sh
bundle install
```
@@ -370,11 +370,11 @@
provider:
id: maritaca
credentials:
api-key: ENV/MARITACA_API_KEY
settings:
- model: maritalk
+ model: sabia-2-medium
```
Read the [full specification](https://spec.nbots.io/#/README?id=mistral-ai) for Mistral AI.
```bash
@@ -422,11 +422,11 @@
provider:
id: mistral
credentials:
api-key: ENV/MISTRAL_API_KEY
settings:
- model: mistral-medium
+ model: mistral-medium-latest
```
Read the [full specification](https://spec.nbots.io/#/README?id=mistral-ai) for Mistral AI.
```bash
@@ -474,11 +474,11 @@
provider:
id: ollama
credentials:
address: ENV/OLLAMA_API_ADDRESS
settings:
- model: llama2
+ model: llama3
```
Read the [full specification](https://spec.nbots.io/#/README?id=ollama) for Ollama.
```bash
@@ -527,11 +527,11 @@
id: openai
credentials:
access-token: ENV/OPENAI_API_KEY
settings:
user: ENV/NANO_BOTS_END_USER
- model: gpt-4-1106-preview
+ model: gpt-4o
```
Read the [full specification](https://spec.nbots.io/#/README?id=openai-chatgpt) for OpenAI ChatGPT.
```bash
@@ -756,11 +756,11 @@
id: openai
credentials:
access-token: ENV/OPENAI_API_KEY
settings:
user: ENV/NANO_BOTS_END_USER
- model: gpt-4-1106-preview
+ model: gpt-4o
```
### Tools (Functions)
Nano Bots can also be powered by _Tools_ (Functions):
@@ -784,11 +784,11 @@
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 `vertex-ai-api` service and the model `gemini-pro`. Other providers do not yet have support.
+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-4o`, 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`. Other providers do not yet have support.
Check the [Nano Bots specification](https://spec.nbots.io/#/README?id=tools-functions-2) to learn more about Tools (Functions).
#### Experimental Clojure Support
@@ -943,14 +943,14 @@
- [x] [Cohere Command](https://cohere.com)
- [x] [Google Gemini](https://deepmind.google/technologies/gemini)
- [x] [Maritaca AI MariTalk](https://www.maritaca.ai)
- [x] [Mistral AI](https://mistral.ai)
- [x] [Ollama](https://ollama.ai)
- - [x] [01.AI Yi](https://01.ai)
- - [x] [LMSYS Vicuna](https://github.com/lm-sys/FastChat)
- - [x] [Meta Llama](https://ai.meta.com/llama/)
- - [x] [WizardLM](https://wizardlm.github.io)
+ - [x] [01.AI Yi](https://01.ai)
+ - [x] [LMSYS Vicuna](https://github.com/lm-sys/FastChat)
+ - [x] [Meta Llama](https://ai.meta.com/llama/)
+ - [x] [WizardLM](https://wizardlm.github.io)
- [x] [Open AI ChatGPT](https://openai.com/chatgpt)
01.AI Yi, LMSYS Vicuna, Meta Llama, and WizardLM are open-source models that are supported through [Ollama](https://ollama.ai).
## Docker
@@ -969,12 +969,12 @@
```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 3.0.1 && bash"
+ image: ruby:3.3.3-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 3.2.0 && bash"
environment:
COHERE_API_KEY: your-api-key
NANO_BOTS_ENCRYPTION_PASSWORD: UNSAFE
NANO_BOTS_END_USER: your-user
volumes:
@@ -986,12 +986,12 @@
```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 3.0.1 && bash"
+ image: ruby:3.3.3-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 3.2.0 && bash"
environment:
MARITACA_API_KEY: your-api-key
NANO_BOTS_ENCRYPTION_PASSWORD: UNSAFE
NANO_BOTS_END_USER: your-user
volumes:
@@ -1003,12 +1003,12 @@
```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 3.0.1 && bash"
+ image: ruby:3.3.3-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 3.2.0 && bash"
environment:
MISTRAL_API_KEY: your-api-key
NANO_BOTS_ENCRYPTION_PASSWORD: UNSAFE
NANO_BOTS_END_USER: your-user
volumes:
@@ -1022,12 +1022,12 @@
```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 3.0.1 && bash"
+ image: ruby:3.3.3-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 3.2.0 && bash"
environment:
OLLAMA_API_ADDRESS: http://localhost:11434
NANO_BOTS_ENCRYPTION_PASSWORD: UNSAFE
NANO_BOTS_END_USER: your-user
volumes:
@@ -1041,12 +1041,12 @@
```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 3.0.1 && bash"
+ image: ruby:3.3.3-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 3.2.0 && bash"
environment:
OPENAI_API_KEY: your-access-token
NANO_BOTS_ENCRYPTION_PASSWORD: UNSAFE
NANO_BOTS_END_USER: your-user
volumes:
@@ -1060,12 +1060,12 @@
```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 3.0.1 && bash"
+ image: ruby:3.3.3-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 3.2.0 && bash"
environment:
GOOGLE_API_KEY: your-api-key
NANO_BOTS_ENCRYPTION_PASSWORD: UNSAFE
NANO_BOTS_END_USER: your-user
volumes:
@@ -1077,12 +1077,12 @@
```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 3.0.1 && bash"
+ image: ruby:3.3.3-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 3.2.0 && bash"
environment:
GOOGLE_CREDENTIALS_FILE_PATH: /root/.config/google-credentials.json
GOOGLE_REGION: us-east4
NANO_BOTS_ENCRYPTION_PASSWORD: UNSAFE
NANO_BOTS_END_USER: your-user
@@ -1096,12 +1096,12 @@
```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 3.0.1 && bash"
+ image: ruby:3.3.3-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 3.2.0 && bash"
environment:
GOOGLE_REGION: us-east4
NANO_BOTS_ENCRYPTION_PASSWORD: UNSAFE
NANO_BOTS_END_USER: your-user
volumes:
@@ -1159,7 +1159,7 @@
```bash
gem build nano-bots.gemspec
gem signin
-gem push nano-bots-3.0.1.gem
+gem push nano-bots-3.2.0.gem
```