diff --git a/README.md b/README.md index 958ba03..ae040a2 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,16 @@ $ OPENAI_API_KEY= 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 index cda9b74..05522c4 100644 --- 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