📝 Add OpenAI Endpoint + Org to README.md

maiqingqiang · Aug 9, 2023 · 4d6432b · 4d6432b
1 parent 00add33
commit 4d6432b
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 8 deletions.
diff --git a/README-zh_CN.md b/README-zh_CN.md
@@ -34,10 +34,12 @@ go get github.com/maiqingqiang/typechat-go
 目前，示例可以使用 OpenAI 或 Azure OpenAI。
 要使用 OpenAI，请使用以下环境变量：
 
-| 环境变量             | 值                                     |
-|------------------|---------------------------------------|
-| `OPENAI_MODEL`   | OpenAI 模型名称（例如 gpt-3.5-turbo 或 gpt-4） |
-| `OPENAI_API_KEY` | 你的 OpenAI 密钥                          |
+| 环境变量                  | 值                                                                        |
+|-----------------------|--------------------------------------------------------------------------|
+| `OPENAI_MODEL`        | OpenAI 模型名称（例如 gpt-3.5-turbo 或 gpt-4）                                    |
+| `OPENAI_API_KEY`      | 你的 OpenAI 密钥                                                             |
+| `OPENAI_ENDPOINT`     | OpenAI API 节点 - *可选*,  默认 `"https://api.openai.com/v1/chat/completions"` |
+| `OPENAI_ORGANIZATION` | OpenAI Organization - *可选*, 默认 `""`                                      |
 
 要使用 Azure OpenAI，请使用以下环境变量：
 

diff --git a/README.md b/README.md
@@ -59,10 +59,12 @@ Configure environment variables
 Currently, the examples are running on OpenAI or Azure OpenAI endpoints.
 To use an OpenAI endpoint, include the following environment variables:
 
-| Variable         | Value                                                   |
-|------------------|---------------------------------------------------------|
-| `OPENAI_MODEL`   | The OpenAI model name (e.g. `gpt-3.5-turbo` or `gpt-4`) |
-| `OPENAI_API_KEY` | Your OpenAI API key                                     |
+| Variable              | Value                                                                                         |
+|-----------------------|-----------------------------------------------------------------------------------------------|
+| `OPENAI_MODEL`        | The OpenAI model name (e.g. `gpt-3.5-turbo` or `gpt-4`)                                       |
+| `OPENAI_API_KEY`      | Your OpenAI API key                                                                           |
+| `OPENAI_ENDPOINT`     | OpenAI API Endpoint - *optional*,  defaults to `"https://api.openai.com/v1/chat/completions"` |
+| `OPENAI_ORGANIZATION` | OpenAI Organization - *optional*, defaults to `""`                                            |
 
 To use an Azure OpenAI endpoint, include the following environment variables: