diff --git a/README.md b/README.md index 47b4966..3c0d104 100644 --- a/README.md +++ b/README.md @@ -14,28 +14,9 @@ Expect frequent improvements. **Next up:** -- [ ] Delete messages -- [ ] More model settings -- [ ] Plugins - -**Recent updates:** - -- [x] Prompt templates (3/27/23) -- [x] Regenerate & edit responses (3/25/23) -- [x] Folders (3/24/23) -- [x] Search chat content (3/23/23) -- [x] Stop message generation (3/22/23) -- [x] Import/Export chats (3/22/23) -- [x] Custom system prompt (3/21/23) -- [x] Error handling (3/20/23) -- [x] GPT-4 support (access required) (3/20/23) -- [x] Search conversations (3/19/23) -- [x] Code syntax highlighting (3/18/23) -- [x] Toggle sidebar (3/18/23) -- [x] Conversation naming (3/18/23) -- [x] Github flavored markdown (3/18/23) -- [x] Add OpenAI API key in app (3/18/23) -- [x] Markdown support (3/17/23) +- [ ] Import/Export prompts +- [ ] "Bots" +- [ ] Sharing ## Modifications @@ -112,18 +93,18 @@ You should be able to start chatting. When deploying the application, the following environment variables can be set: -| Environment Variable | Default value | Description | -| --------------------- | ------------------------------ | ------------------------------------------------------- | -| OPENAI_API_KEY | | The default API key used for authentication with OpenAI | -| OPENAI_API_HOST | `https://api.openai.com` | The base url, for Azure use `https://.openai.azure.com` | -| OPENAI_API_TYPE | `openai` | The API type, options are `openai` or `azure` | -| OPENAI_API_VERSION | `2023-03-15-preview` | Only applicable for Azure OpenAI | -| AZURE_DEPLOYMENT_ID | | Needed when Azure OpenAI, Ref [Azure OpenAI API](https://learn.microsoft.com/zh-cn/azure/cognitive-services/openai/reference#completions) | -| OPENAI_ORGANIZATION | | Your OpenAI organization ID | -| DEFAULT_MODEL | `gpt-3.5-turbo` | The default model to use on new conversations, for Azure use `gpt-35-turbo` | -| NEXT_PUBLIC_DEFAULT_SYSTEM_PROMPT | [see here](utils/app/const.ts) | The default system prompt to use on new conversations | -| GOOGLE_API_KEY | | See [Custom Search JSON API documentation][GCSE] | -| GOOGLE_CSE_ID | | See [Custom Search JSON API documentation][GCSE] | +| Environment Variable | Default value | Description | +| --------------------------------- | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | +| OPENAI_API_KEY | | The default API key used for authentication with OpenAI | +| OPENAI_API_HOST | `https://api.openai.com` | The base url, for Azure use `https://.openai.azure.com` | +| OPENAI_API_TYPE | `openai` | The API type, options are `openai` or `azure` | +| OPENAI_API_VERSION | `2023-03-15-preview` | Only applicable for Azure OpenAI | +| AZURE_DEPLOYMENT_ID | | Needed when Azure OpenAI, Ref [Azure OpenAI API](https://learn.microsoft.com/zh-cn/azure/cognitive-services/openai/reference#completions) | +| OPENAI_ORGANIZATION | | Your OpenAI organization ID | +| DEFAULT_MODEL | `gpt-3.5-turbo` | The default model to use on new conversations, for Azure use `gpt-35-turbo` | +| NEXT_PUBLIC_DEFAULT_SYSTEM_PROMPT | [see here](utils/app/const.ts) | The default system prompt to use on new conversations | +| GOOGLE_API_KEY | | See [Custom Search JSON API documentation][GCSE] | +| GOOGLE_CSE_ID | | See [Custom Search JSON API documentation][GCSE] | If you do not provide an OpenAI API key with `OPENAI_API_KEY`, users will have to provide their own key. If you don't have an OpenAI API key, you can get one [here](https://platform.openai.com/account/api-keys).