Skip to content

fix: add clarity to azure usage docs #126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
keyallis merged 1 commit into from
Mar 7, 2024
Merged

fix: add clarity to azure usage docs #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,13 +81,13 @@ Download and install the archive for your platform and architecture from the [re
export OPENAI_API_KEY="your-api-key"
```

Alternatively Azure OpenAI can be utilized
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.

```shell
export OPENAI_API_KEY="your-api-key"
export OPENAI_BASE_URL="your-endpiont"
export OPENAI_BASE_URL="https://<your-endpoint>.openai.azure.com/"
export OPENAI_API_TYPE="AZURE"
export OPENAI_AZURE_DEPLOYMENT="your-deployment-name"
export OPENAI_AZURE_DEPLOYMENT="<your-deployment-name>"
```

#### Windows
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/02-getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ Download and install the archive for your platform and architecture from the [re
export OPENAI_API_KEY="your-api-key"
```

Alternatively Azure OpenAI can be utilized
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.

```shell
export OPENAI_API_KEY="your-api-key"
export OPENAI_BASE_URL="your-endpiont"
export OPENAI_BASE_URL="https://<your-endpoint>.openai.azure.com/"
export OPENAI_API_TYPE="AZURE"
export OPENAI_AZURE_DEPLOYMENT="your-deployment-name"
export OPENAI_AZURE_DEPLOYMENT="<your-deployment-name>"
```

#### Windows
Expand Down