Skip to content

Commit 4909c51

Browse files
authored
fix: add clarity to azure usage docs (#126)
1 parent 10b19e2 commit 4909c51

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,13 +81,13 @@ Download and install the archive for your platform and architecture from the [re
8181
export OPENAI_API_KEY="your-api-key"
8282
```
8383

84-
Alternatively Azure OpenAI can be utilized
84+
Alternatively Azure OpenAI can be utilized. If the [Azure deployment name is different than the model being used](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/switching-endpoints#keyword-argument-for-model), be sure to include the `OPENAI_AZURE_DEPLOYMENT` argument.
8585

8686
```shell
8787
export OPENAI_API_KEY="your-api-key"
88-
export OPENAI_BASE_URL="your-endpiont"
88+
export OPENAI_BASE_URL="https://<your-endpoint>.openai.azure.com/"
8989
export OPENAI_API_TYPE="AZURE"
90-
export OPENAI_AZURE_DEPLOYMENT="your-deployment-name"
90+
export OPENAI_AZURE_DEPLOYMENT="<your-deployment-name>"
9191
```
9292

9393
#### Windows

docs/docs/02-getting-started.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ Download and install the archive for your platform and architecture from the [re
3232
export OPENAI_API_KEY="your-api-key"
3333
```
3434

35-
Alternatively Azure OpenAI can be utilized
35+
Alternatively Azure OpenAI can be utilized. If the [Azure deployment name is different than the model being used](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/switching-endpoints#keyword-argument-for-model), be sure to include the `OPENAI_AZURE_DEPLOYMENT` argument.
3636

3737
```shell
3838
export OPENAI_API_KEY="your-api-key"
39-
export OPENAI_BASE_URL="your-endpiont"
39+
export OPENAI_BASE_URL="https://<your-endpoint>.openai.azure.com/"
4040
export OPENAI_API_TYPE="AZURE"
41-
export OPENAI_AZURE_DEPLOYMENT="your-deployment-name"
41+
export OPENAI_AZURE_DEPLOYMENT="<your-deployment-name>"
4242
```
4343

4444
#### Windows

0 commit comments

Comments
 (0)