Skip to content

Commit

Permalink
Adds DALL-E note to Azure OpenAI in v1 SDK (openai#766)
Browse files Browse the repository at this point in the history
* Adds DALL-E note to Azure OpenAI in v1 SDK

Adds important note for Azure OpenAI users.

* Updates DALL-E docs to include workaround

 Included a link to the workaround
  • Loading branch information
ashjeanbird authored and megamanics committed Aug 14, 2024
1 parent 8ae6bc7 commit 71749ed
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The API documentation can be found [here](https://platform.openai.com/docs).
## Installation

> [!IMPORTANT]
> The SDK was rewritten in v1, which was released November 6th 2023. See the [v1 migration guide](https://github.com/openai/openai-python/discussions/742), which includes scripts to automatically update your code.
> The SDK was rewritten in v1, which was released November 6th 2023. See the [v1 migration guide](https://github.com/openai/openai-python/discussions/742), which includes scripts to automatically update your code.
```sh
pip install openai
Expand Down Expand Up @@ -459,6 +459,10 @@ class instead of the `OpenAI` class.
> The Azure API shape differs from the core API shape which means that the static types for responses / params
> won't always be correct.
The latest release of the OpenAI Python library doesn't currently support DALL-E when used with Azure OpenAI. DALL-E with Azure OpenAI is still supported with 0.28.1. For those who can't wait for native support for DALL-E and Azure OpenAI we're providing [two code examples](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/migration?tabs=python%2Cdalle-fix#dall-e-fix) which can be used as a workaround.



```py
from openai import AzureOpenAI

Expand Down

0 comments on commit 71749ed

Please sign in to comment.