Skip to content

Commit 07fcca2

Browse files
committed
docs: update Readme
1 parent 1700d48 commit 07fcca2

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,11 @@ Tenere can be configured using a TOML configuration file. The file should be loc
5252
Here are the available general settings:
5353

5454
- `archive_file_name`: the file name where the chat will be saved. By default it is set to `tenere.archive`
55+
- `model`: the llm model name. Currently only `chatgpt` is supported.
5556

5657
```toml
5758
archive_file_name = "tenere.archive"
59+
model = "chatgpt"
5860

5961
```
6062

@@ -72,7 +74,7 @@ new_chat = 'n'
7274
save_chat = 's'
7375
```
7476

75-
### Chatgpt API
77+
## Chatgpt
7678

7779
To use Tenere's chat functionality, you'll need to provide an API key for OpenAI. There are two ways to do this:
7880

@@ -85,9 +87,10 @@ export OPENAI_API_KEY="YOUTR KEY HERE"
8587
2. Include your API key in the configuration file:
8688

8789
```toml
88-
[gpt]
90+
[chatgpt]
8991
openai_api_key = "Your API key here"
90-
model = "the chat model name" # <- Optional field
92+
model = "gpt-3.5-turbo"
93+
url = "https://api.openai.com/v1/chat/completions"
9194
```
9295

9396
The default model is set to `gpt-3.5-turbo`. check out the [OpenAI documentation](https://platform.openai.com/docs/models/gpt-3-5) for more info.

0 commit comments

Comments
 (0)