Skip to content

Commit

Permalink
Update environment variables
Browse files Browse the repository at this point in the history
  • Loading branch information
linjungz committed Aug 5, 2023
1 parent 705042a commit 95bc0be
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,10 +64,25 @@ pip install -r requirements.txt

## Configuration

> In this project we're supporting both API from OpenAI and Azure OpenAI Service. There're some environmnet variables that are common for the two APIs while some are unique. The following table lists all the env vars that're supported:
| Environment Variables | Azure OpenAI Service | OpenAI |
| --- | --- | --- |
| OPENAI_API_BASE | :white_check_mark: | |
| OPENAI_API_KEY | :white_check_mark: | :white_check_mark: |
| OPENAI_GPT_DEPLOYMENT_NAME | :white_check_mark: | |
| OPENAI_EMBEDDING_DEPLOYMENT_NAME | :white_check_mark: | :white_check_mark: |
| CHAT_MODEL_NAME | | :white_check_mark: |
| REQUEST_TIMEOUT | :white_check_mark: | :white_check_mark: |
| VECTORDB_PATH | :white_check_mark: | :white_check_mark: |
| TEMPERATURE | :white_check_mark: | :white_check_mark: |
| CHUNK_SIZE | :white_check_mark: | :white_check_mark: |
| CHUNK_OVERLAP | :white_check_mark: | :white_check_mark: |


### Azure OpenAI Services

1. Obtain your Azure OpenAI API key, Endpoint and Deployment Name from the [Azure Portal](https://portal.azure.com/).

2. Create `.env` in the root dir and set the environment variables in the file:

```
Expand All @@ -82,16 +97,11 @@ Here's where you can find the deployment names for GPT and Embedding:
### OpenAI

1. Obtain your OpenAI API key from the [platform.openai.com](https://platform.openai.com/account/api-keys).

2. Create `.env` in the root dir and set the environment variable in the file:

```
OPENAI_API_KEY=your-key-here
CHAT_MODEL_NAME="gpt-4-0314"
OPENAI_EMBEDDING_DEPLOYMENT_NAME="text-embedding-ada-002"
REQUEST_TIMEOUT=60
VECTORDB_PATH = "./data/vector_store"
TEMPERATURE = 0
```

## Usage: Web
Expand Down

0 comments on commit 95bc0be

Please sign in to comment.