Skip to content

Commit 1407cf7

Browse files
committed
docs(readme): add OpenAI configuration options
- Add options to `.codegpt.yaml` file for `openai.org_id`, `openai.model`, `openai.lang`, and `openai.proxy` - Update README.md to reflect new options in `.codegpt.yaml` file
1 parent a75ed83 commit 1407cf7

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,12 @@ Please first create your OpenAI API Key. The [OpenAI Platform](https://platform.
5353
codegpt config set openai.api_key sk-xxxxxxx
5454
```
5555

56-
This will create a `.codegpt.yaml` file in your home directory ($HOME/.config/codegpt/.codegpt.yaml).
56+
This will create a `.codegpt.yaml` file in your home directory ($HOME/.config/codegpt/.codegpt.yaml). The following options are available.
57+
58+
* **openai.org_id**: Identifier for this organization sometimes used in API requests. see [organization settings](https://platform.openai.com/account/org-settings).
59+
* **openai.model**: default model is `gpt-3.5-turbo`, you can change to `text-davinci-003` or [other available model list](https://github.com/appleboy/CodeGPT/blob/a75ed831ce30c5c593613b9c0792954586d7f399/openai/openai.go#L16-L29).
60+
* **openai.lang**: default language is `en` and available languages `zh-tw`, `zh-tw`, `ja`.
61+
* **openai.proxy**: set http client proxy.
5762

5863
## Usage
5964

0 commit comments

Comments
 (0)