Skip to content
This repository has been archived by the owner on Jan 31, 2025. It is now read-only.

Commit

Permalink
Updated Readme about localAi and extra settings (#21)
Browse files Browse the repository at this point in the history
* Add files via upload

* Update README.md with info about LocalAI
  • Loading branch information
timonvanhasselt authored Mar 18, 2024
1 parent 0eeadb7 commit a7f604b
Showing 1 changed file with 30 additions and 6 deletions.
36 changes: 30 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ When in doubt, ask ChatGPT, powered by [OpenAI Solver](https://github.com/OpenVo

You need to configure a `key`, get it at https://platform.openai.com/api-keys

Or use a LocalAI (see example below)


## About

Capabilities:
Expand All @@ -19,26 +22,47 @@ Limitations:

## Configuration

Under skill settings you can tweak some parameters for chatGPT.

Under skill settings (`.config/mycroft/skills/skill-ovos-fallback-chatgpt.openvoiceos/settings.json`) you can tweak some parameters for chatGPT.
- `key` - your api_key to access OpenAI
- `persona` - can be used to create a "persona", give a personality to chatGPT
- `model` - LLM model to use, eg `gpt-3.5-turbo`, see all options [here](https://platform.openai.com/docs/models)
- `api_url: <your_local_LocalAI_server_url>` - an optional setting. For the use of OpenAI / ChatGPT it is not necessary. For the use of a LocalAI server instead of OpenAI, the URL can be pointed to an alternative/local server. When using LocalAI, the "key" can be anything, but it has to exist. Read more about it in the OVOS technical manual, page [persona server](https://openvoiceos.github.io/ovos-technical-manual/persona_server/#compatible-projects)
- `memory_enable` - true or false
- `memory_size` - default = 15


The default persona is `helpful, creative, clever, and very friendly.`

```shell
mkdir -p ~/.config/mycroft/skills/skill-ovos-fallback-chatgpt.openvoiceos
cat <<EOF>~/.config/mycroft/skills/skill-ovos-fallback-chatgpt.openvoiceos/settings.json
### Example for use with OpenAI/ ChatGPT:

`cat ~/.config/mycroft/skills/skill-ovos-fallback-chatgpt.openvoiceos/settings.json`

```
{
"key": "sk-XXXYYYZZZAAABBB123",
"model": "gpt-3.5-turbo",
"persona": "You are a helpful voice assistant with a friendly tone and fun sense of humor",
"enable_memory": true,
"memory_size": 15,
"__mycroft_skill_firstrun": false
}
```

### Example for use with LocalAI:
`cat ~/.config/mycroft/skills/skill-ovos-fallback-chatgpt.openvoiceos/settings.json`

```
{
"api_url": "https://llama.smartgic.io/v1",
"key": "sk-xxx",
"persona": "You are a helpful voice assistant with a friendly tone and fun sense of humor",
"enable_memory": true,
"memory_size": 15,
"__mycroft_skill_firstrun": false
}
EOF
```


## Examples

- "Explain quantum computing in simple terms"
Expand Down

0 comments on commit a7f604b

Please sign in to comment.