Update README and docs for model naming

ThatcherC · Oct 4, 2023 · 17a07e3 · 17a07e3 · ThatcherC · Oct 4, 2023
1 parent b742b34
commit 17a07e3
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -80,6 +80,16 @@ $ OPENAI_API_KEY=<key goes here> julia
 
 Note that when the environment variable is used, the key is **not** saved to the `LocalPreferences.toml` file.
 
+## Selecting a Model
+The OpenAI model name can be selected with the `ReplGPT.setmodelname(...)` function:
+```julia
+# Select gpt-3.5-turbo (default):
+ReplGPT.setmodelname("gpt-3.5-turbo")
+
+# Select gpt-4
+ReplGPT.setmodelname("gpt-4")
+```
+
 ---
 
 Inspiration drawn from 

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -17,6 +17,16 @@ ReplGPT.setAPIkey(key::String)
 ReplGPT.clearAPIkey()
 ```
 
+## Model Selection
+
+```@docs
+ReplGPT.setmodelname(model::String)
+
+ReplGPT.getmodelname()
+
+ReplGPT.clearmodelname()
+```
+
 ## Conversation Management
 
 ```@docs