Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: icebaker/nano-bots-spec
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v3.0.0
Choose a base ref
...
head repository: icebaker/nano-bots-spec
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: main
Choose a head ref
  • 7 commits
  • 4 files changed
  • 2 contributors

Commits on Jun 23, 2024

  1. upgrading-apis

    icebaker committed Jun 23, 2024

    Verified

    This commit was signed with the committer’s verified signature.
    Copy the full SHA
    fc553a5 View commit details
  2. upgrading parameters

    icebaker committed Jun 23, 2024

    Verified

    This commit was signed with the committer’s verified signature.
    Copy the full SHA
    cb93430 View commit details
  3. typo

    icebaker committed Jun 23, 2024

    Verified

    This commit was signed with the committer’s verified signature.
    Copy the full SHA
    6ec265f View commit details
  4. Merge pull request #5 from icebaker/ib-upgrading-apis

    Upgrading APIs
    icebaker authored Jun 23, 2024

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature.
    Copy the full SHA
    2c0a7de View commit details
  5. updating README

    icebaker committed Jun 23, 2024

    Verified

    This commit was signed with the committer’s verified signature.
    Copy the full SHA
    3730dec View commit details
  6. updating README

    icebaker committed Jun 23, 2024

    Verified

    This commit was signed with the committer’s verified signature.
    Copy the full SHA
    4b87286 View commit details
  7. bump to 3.2.0

    icebaker committed Jun 23, 2024

    Verified

    This commit was signed with the committer’s verified signature.
    Copy the full SHA
    10c23e5 View commit details
Showing with 109 additions and 39 deletions.
  1. +1 −1 README.md
  2. +106 −36 docs/README.md
  3. +1 −1 docs/cover.md
  4. +1 −1 docs/index.html
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -52,7 +52,7 @@ provider:
access-token: ENV/OPENAI_API_KEY
settings:
user: ENV/NANO_BOTS_END_USER
model: gpt-4-1106-preview
model: gpt-4o
```
Here's what a fully-functional implementation of Nano Bots feels like:
142 changes: 106 additions & 36 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -28,7 +28,7 @@ provider:
access-token: ENV/OPENAI_API_KEY
settings:
user: ENV/NANO_BOTS_END_USER
model: gpt-4-1106-preview
model: gpt-4o
```
Here's what a fully-functional implementation of Nano Bots feels like:
@@ -144,7 +144,7 @@ provider:
access-token: ENV/OPENAI_API_KEY
settings:
user: ENV/NANO_BOTS_END_USER
model: gpt-4-1106-preview
model: gpt-4o
```
## Meta
@@ -818,8 +818,6 @@ This level of access would allow aslo the execution of [system calls](https://en

#### Predictability

As the execution requests for the tools are generated by the Nano Bot through providers, their outcomes are unpredictable, meaning that when not sandboxed and with a function that offers this possibility, they may perform unexpected [system calls](https://en.wikipedia.org/wiki/System_call), which could be dangerous, especially without confirmability.

As execution requests for the tools are generated by the Nano Bot through providers, their outcomes are unpredictable. This means that without being sandboxed and having a function that offers this possibility, they may perform unexpected [system calls](https://en.wikipedia.org/wiki/System_call), which could be dangerous, especially without [confirmability](?id=tools).

#### Portability
@@ -841,7 +839,7 @@ Examples of popular providers include:
- [Cohere Command](https://cohere.com)
- [Google Gemini](https://deepmind.google/technologies/gemini)
- [LMSYS Vicuna](https://github.com/lm-sys/FastChat)
- [Maritaca AI MariTalk](https://www.maritaca.ai)
- [Maritaca AI Sabiá](https://www.maritaca.ai)
- [Meta Llama](https://ai.meta.com/llama/)
- [Mistral AI](https://mistral.ai)
- [Ollama](https://ollama.ai)
@@ -861,7 +859,7 @@ provider:
access-token: ENV/OPENAI_API_KEY
settings:
user: ENV/NANO_BOTS_END_USER
model: gpt-4-1106-preview
model: gpt-4o
```

### Credentials
@@ -870,9 +868,36 @@ Although it is possible to set credentials directly in the cartridge YAML, it is

Implementations should apply the regular expression `^ENV.` and replace data with prefixes like `ENV/` or `ENV-` with the corresponding environment variable value. For example, `ENV/OPENAI_API_KEY` should load the environment variable `OPENAI_API_KEY`.

### Anthropic Claude

API Documentation: https://docs.anthropic.com/en/api/messages

```yaml
---
provider:
id: anthropic
credentials:
api-key: ENV/ANTHROPIC_API_KEY
anthropic-version: '2023-06-01'
settings:
model: claude-3-5-sonnet-20240620
stream: true
max_tokens: 4096
temperature: 1.0
top_k: null
top_p: null
tool_choice:
type: auto
name: null
metadata:
user_id: ENV/NANO_BOTS_END_USER
stop_sequences:
- .
```

### Cohere Command

API Documentation: https://docs.cohere.com/reference/about
API Documentation: https://docs.cohere.com/reference/chat

```yaml
---
@@ -882,17 +907,27 @@ provider:
address: ENV/COHERE_API_ADDRESS
api-key: ENV/COHERE_API_KEY
settings:
model: command
model: command-r-plus
stream: true
prompt_truncation: AUTO
prompt_truncation: 'OFF'
connectors:
- id: web-search
search_queries_only: false
documents:
- title: Tall penguins
snippet: Emperor penguins are the tallest.
text: Emperor penguins are the tallest.
citation_quality: accurate
temperature: 0.3
max_tokens: null
max_input_tokens: null
k: 0
p: 0.75
seed: null
stop_sequences:
- .
frequency_penalty: 0.0
presence_penalty: 0.0
force_single_step: false
```

### Google Gemini
@@ -913,28 +948,41 @@ provider:
service: vertex-ai-api
region: ENV/GOOGLE_REGION
file-path: ENV/GOOGLE_CREDENTIALS_FILE_PATH
credentials:
service: vertex-ai-api
region: ENV/GOOGLE_REGION
file_contents: ENV/GOOGLE_CREDENTIALS_FILE_CONTENTS
credentials:
service: vertex-ai-api
region: ENV/GOOGLE_REGION
file-path: ENV/GOOGLE_CREDENTIALS_FILE_PATH
project-id: ENV/GOOGLE_PROJECT_ID
options:
model: gemini-pro
model: gemini-1.5-pro
stream: true
settings:
safetySettings:
- category: HARM_CATEGORY_DANGEROUS_CONTENT
threshold: BLOCK_NONE
generationConfig:
temperature: 0.9
maxOutputTokens: 8192
maxOutputTokens: null
candidateCount: 1
presencePenalty: null
frequencyPenalty: null
topK: null
topP: 1.0
stopSequences:
- .
responseMimeType: application/json
responseSchema:
type: object
properties:
name:
type: string
```

### Maritaca AI MariTalk
### Maritaca AI Sabiá

API Documentation: https://chat.maritaca.ai/docs

@@ -946,12 +994,14 @@ provider:
address: ENV/MARITACA_API_ADDRESS
api-key: ENV/MARITACA_API_KEY
settings:
model: maritalk
stream: true
model: sabia-2-medium
max_tokens: null
do_sample: true
temperature: 0.7
top_p: 0.95
repetition_penalty: 1
num_tokens_per_message: null
stopping_tokens:
- .
@@ -969,12 +1019,12 @@ provider:
address: ENV/MISTRAL_API_ADDRESS
api-key: ENV/MISTRAL_API_KEY
settings:
model: mistral-medium
model: mistral-large
temperature: 0.7
top_p: 1
max_tokens: null
stream: true
safe_mode: false
safe_prompt: false
random_seed: null
```

@@ -991,24 +1041,40 @@ provider:
credentials:
address: ENV/OLLAMA_API_ADDRESS
settings:
model: llama2
model: llama3
format: json
raw: false
options:
mirostat: 0
mirostat_eta: 0.1
mirostat_tau: 5.0
num_ctx: 2048
num_gqa: null
num_gpu: null
num_thread: null
repeat_last_n: 64
repeat_penalty: 1.1
temperature: 0.8
seed: 0
stop: null
tfs_z: 1
num_predict: 128
top_k: 40
num_keep: 5
seed: 42
num_predict: 100
top_k: 20
top_p: 0.9
tfs_z: 0.5
typical_p: 0.7
repeat_last_n: 33
temperature: 0.8
repeat_penalty: 1.2
presence_penalty: 1.5
frequency_penalty: 1.0
mirostat: 1
mirostat_tau: 0.8
mirostat_eta: 0.6
penalize_newline: true
numa: false
num_ctx: 1024
num_batch: 2
num_gpu: 1
main_gpu: 0
low_vram: false
f16_kv: true
vocab_only: false
use_mmap: true
use_mlock: false
num_thread: 8
stop:
- "\n"
- "user:"
```

### OpenAI ChatGPT
@@ -1024,8 +1090,10 @@ provider:
access-token: ENV/OPENAI_API_KEY
settings:
user: ENV/NANO_BOTS_END_USER
model: gpt-4-1106-preview
model: gpt-4o
stream: true
stream_options:
include_usage: false
frequency_penalty: 0
logit_bias: null
logprobs: false
@@ -1036,11 +1104,13 @@ provider:
response_format:
type: json_object
seed: null
service_tier: null
stop:
- .
temperature: 1
top_p: 1
tool_choice: auto
parallel_tool_calls: true
```

## Miscellaneous
@@ -1186,7 +1256,7 @@ provider:
access-token: ENV/OPENAI_API_KEY
settings:
user: ENV/NANO_BOTS_END_USER
model: gpt-4-1106-preview
model: gpt-4o
```

These are the default values when the following keys are not specified in the Cartridge file:
@@ -1256,7 +1326,7 @@ provider:
access-token: ENV/OPENAI_API_KEY
settings:
user: ENV/NANO_BOTS_END_USER
model: gpt-4-1106-preview
model: gpt-4o
```

### Full Specification
@@ -1461,7 +1531,7 @@ provider:
access-token: ENV/OPENAI_API_KEY
settings:
user: ENV/NANO_BOTS_END_USER
model: gpt-4-1106-preview
model: gpt-4o
stream: true
frequency_penalty: 0
logit_bias: null
2 changes: 1 addition & 1 deletion docs/cover.md
Original file line number Diff line number Diff line change
@@ -8,7 +8,7 @@
- Effortlessly integrate multiple bots to achieve your goals.
- Share your Nano Bots and enable others to benefit from their abilities.

Version 3.0.0
Version 3.2.0

[Specification](README)
[GitHub](https://github.com/icebaker/nano-bots-spec)
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
@@ -19,7 +19,7 @@
<script>
window.$docsify = {
coverpage: { '/': 'cover.md' },
name: 'Nano Bots Specification 3.0.0',
name: 'Nano Bots Specification 3.2.0',
repo: 'https://github.com/icebaker/nano-bots-spec'
}
</script>