Skip to content

Improve docs for Azure env vars #175

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
gvanrossum-ms merged 1 commit into from
Jan 29, 2026
Merged

Improve docs for Azure env vars #175

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
12 changes: 7 additions & 5 deletions docs/env-vars.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,15 @@ The (public) OpenAI environment variables include the following:
If you are using the OpenAI service hosted by Azure, you need different
environment variables, starting with:

- `AZURE_OPENAI_API_KEY`: Your Azure OpenAI API key.
- `AZURE_OPENAI_API_KEY`: Your Azure OpenAI API key (or in some cases `identity`).
- `AZURE_OPENAI_ENDPOINT`: The full URL of the Azure OpenAI REST API
(e.g. https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2023-05-15).
- `AZURE_OPENAI_ENDPOINT_EMBEDDING`: The full URL of the Azure OpenAI REST API for embeddings (e.g. https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_EMBEDDING_DEPLOYMENT_NAME/embeddings?api-version=2024-08-01-preview).
(e.g. `https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2023-05-15`).
- `AZURE_OPENAI_ENDPOINT_EMBEDDING`:
The full URL of the Azure OpenAI REST API for embeddings
(e.g. `https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_EMBEDDING_DEPLOYMENT_NAME/embeddings?api-version=2024-08-01-preview`).

- If you use Azure OpenAI you will know where to get these
(or ask your sysadmin).
If you use Azure OpenAI you will know where to get these
(or ask your sysadmin).

## Conflicts

Expand Down
Loading