summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoricebaker <icebaker@proton.me>2023-11-29 08:26:06 -0300
committericebaker <icebaker@proton.me>2023-11-29 08:26:06 -0300
commit29ad81139f2df66c577f4b77fe4dff8ebead2237 (patch)
tree3e963dc3ae3e37cc7c62bff79fe671d22774888a
parent2bbd1f00d16dd3443a037e3a2779d32dd3a29004 (diff)
updating README
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
index 131af7f..6fea915 100644
--- a/README.md
+++ b/README.md
@@ -299,6 +299,19 @@ The randomly generated number is 59.
🤖> |
```
+To successfully use Tools (Functions), you need to specify a provider and a model that support them. As of the writing of this README, the provider that supports them is OpenAI, with models `gpt-3.5-turbo-1106` and `gpt-4-1106-preview`:
+
+```yaml
+provider:
+ id: openai
+ credentials:
+ address: ENV/OPENAI_API_ADDRESS
+ access-token: ENV/OPENAI_API_KEY
+ settings:
+ user: ENV/NANO_BOTS_END_USER
+ model: gpt-4-1106-preview
+```
+
Check the [Nano Bots specification](https://spec.nbots.io/#/README?id=tools-functions-2) to learn more about them.
#### Experimental Clojure Support
@@ -329,6 +342,15 @@ bb -e '{:hello "world"}'
# => {:hello "world"}
```
+We don't have sandbox support for Clojure; this means that you need to disable it to be able to run Clojure code, which you do at your own risk:
+
+```yaml
+---
+safety:
+ functions:
+ sandboxed: false
+```
+
### Marketplace
You can explore the Nano Bots [Marketplace](https://nbots.io) to discover new Cartridges that can help you.