Skip to content

Commit 6e7d854

Browse files
scottaddiestainless-app[bot]
authored andcommitted
Update Microsoft Azure OpenAI docs in README (#1439)
* Update Microsoft Azure OpenAI docs in README * React to feedback
1 parent bb0b38d commit 6e7d854

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

Diff for: README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -581,7 +581,7 @@ By default the library closes underlying HTTP connections whenever the client is
581581

582582
## Microsoft Azure OpenAI
583583

584-
To use this library with [Azure OpenAI](https://learn.microsoft.com/en-us/azure/ai-services/openai/overview), use the `AzureOpenAI`
584+
To use this library with [Azure OpenAI](https://learn.microsoft.com/azure/ai-services/openai/overview), use the `AzureOpenAI`
585585
class instead of the `OpenAI` class.
586586

587587
> [!IMPORTANT]
@@ -593,9 +593,9 @@ from openai import AzureOpenAI
593593

594594
# gets the API Key from environment variable AZURE_OPENAI_API_KEY
595595
client = AzureOpenAI(
596-
# https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#rest-api-versioning
596+
# https://learn.microsoft.com/azure/ai-services/openai/reference#rest-api-versioning
597597
api_version="2023-07-01-preview",
598-
# https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal#create-a-resource
598+
# https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal#create-a-resource
599599
azure_endpoint="https://example-endpoint.openai.azure.com",
600600
)
601601

@@ -619,7 +619,7 @@ In addition to the options provided in the base `OpenAI` client, the following o
619619
- `azure_ad_token` (or the `AZURE_OPENAI_AD_TOKEN` environment variable)
620620
- `azure_ad_token_provider`
621621

622-
An example of using the client with Azure Active Directory can be found [here](https://github.com/openai/openai-python/blob/main/examples/azure_ad.py).
622+
An example of using the client with Microsoft Entra ID (formerly known as Azure Active Directory) can be found [here](https://github.com/openai/openai-python/blob/main/examples/azure_ad.py).
623623

624624
## Versioning
625625

0 commit comments

Comments
 (0)