docs: refactor model naming and update docs (#166)

- Update documentation to reflect the change from `gpt-3.5-turbo` to `gpt-4-turbo` and add mention of custom models
- Remove references to `openai.model_name` in README and code, replacing with `openai.model`
- Delete the `openai.model_name` configuration option from `config_list.go`
- Remove the `model_name` flag binding from `config_set.go`

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>

Author: appleboy

README.md

@@ -83,7 +83,7 @@ This will create a `.codegpt.yaml` file in your home directory ($HOME/.config/co
 * **openai.base_url**: replace the default base URL (`https://api.openai.com/v1`).
 * **openai.api_key**: generate API key from [openai platform page](https://platform.openai.com/account/api-keys).
 * **openai.org_id**: Identifier for this organization sometimes used in API requests. see [organization settings](https://platform.openai.com/account/org-settings). only for `openai` service.
-* **openai.model**: default model is `gpt-3.5-turbo`, you can change to `gpt-4` or [other available model list](https://github.com/appleboy/CodeGPT/blob/bf28f000463cfc6dfa2572df61e1b160c5c680f7/openai/openai.go#L18-L38).
+* **openai.model**: default model is `gpt-3.5-turbo`, you can change to `gpt-4-turbo` or other custom model (Groq or OpenRouter provider).
 * **openai.proxy**: http/https client proxy.
 * **openai.socks**: socks client proxy.
 * **openai.timeout**: default http timeout is `10s` (ten seconds).
@@ -92,7 +92,6 @@ This will create a `.codegpt.yaml` file in your home directory ($HOME/.config/co
 * **git.diff_unified**: generate diffs with `<n>` lines of context, default is `3`.
 * **git.exclude_list**: exclude file from `git diff` command.
 * **openai.provider**: default service provider is `openai`, you can change to `azure`.
-* **openai.model_name**: model deployment name (for azure).
 * **output.lang**: default language is `en` and available languages `zh-tw`, `zh-cn`, `ja`.
 * **openai.top_p**: default top_p is `1.0`. see reference [top_p](https://platform.openai.com/docs/api-reference/completions/create#completions/create-top_p).
 * **openai.frequency_penalty**: default frequency_penalty is `0.0`. see reference [frequency_penalty](https://platform.openai.com/docs/api-reference/completions/create#completions/create-frequency_penalty).
@@ -112,7 +111,7 @@ Update your config file.
 codegpt config set openai.provider azure
 codegpt config set openai.base_url https://xxxxxxxxx.openai.azure.com/
 codegpt config set openai.api_key xxxxxxxxxxxxxxxx
-codegpt config set openai.model_name xxxxx-gpt-35-turbo
+codegpt config set openai.model xxxxx-gpt-35-turbo
 ```
 
 ### How to change to [Groq][30] API Service

cmd/config_list.go

@@ -30,7 +30,6 @@ var availableKeys = map[string]string{
 	"openai.max_tokens":        "the maximum number of tokens to generate in the chat completion.",
 	"openai.temperature":       "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.",
 	"openai.provider":          "service provider, only support 'openai' or 'azure'",
-	"openai.model_name":        "model deployment name for Azure cognitive service",
 	"openai.skip_verify":       "skip verify TLS certificate",
 	"openai.headers":           "custom headers for openai request",
 	"openai.api_version":       "openai api version",

cmd/config_set.go

@@ -29,7 +29,6 @@ func init() {
 	configSetCmd.Flags().Float32P("frequency_penalty", "", 0.0, availableKeys["openai.frequency_penalty"])
 	configSetCmd.Flags().Float32P("presence_penalty", "", 0.0, availableKeys["openai.presence_penalty"])
 	configSetCmd.Flags().StringP("provider", "", "openai", availableKeys["openai.provider"])
-	configSetCmd.Flags().StringP("model_name", "", "", availableKeys["openai.model_name"])
 	configSetCmd.Flags().BoolP("skip_verify", "", false, availableKeys["openai.skip_verify"])
 	configSetCmd.Flags().StringP("headers", "", "", availableKeys["openai.headers"])
 	configSetCmd.Flags().StringP("api_version", "", "", availableKeys["openai.api_version"])
@@ -48,7 +47,6 @@ func init() {
 	_ = viper.BindPFlag("git.template_file", configSetCmd.Flags().Lookup("template_file"))
 	_ = viper.BindPFlag("git.template_string", configSetCmd.Flags().Lookup("template_string"))
 	_ = viper.BindPFlag("openai.provider", configSetCmd.Flags().Lookup("provider"))
-	_ = viper.BindPFlag("openai.model_name", configSetCmd.Flags().Lookup("model_name"))
 	_ = viper.BindPFlag("openai.skip_verify", configSetCmd.Flags().Lookup("skip_verify"))
 	_ = viper.BindPFlag("openai.headers", configSetCmd.Flags().Lookup("headers"))
 	_ = viper.BindPFlag("openai.api_version", configSetCmd.Flags().Lookup("api_version"))