Skip to content

Commit fe83da2

Browse files
authored
Add OpenAI compatibility note (#575)
* Add compatibility notes for OpenAI package versions in README and getting started guide * Add section for Durable OpenAI Agents in README at the root
1 parent 4bef7ce commit fe83da2

File tree

3 files changed

+10
-1
lines changed

3 files changed

+10
-1
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,8 @@ Follow these instructions to get started with Durable Functions in Python:
2828
## Tooling
2929

3030
* Python Durable Functions requires [Azure Functions Core Tools](https://docs.microsoft.com/en-us/azure/azure-functions/functions-run-local) version 3.0.2630 or higher.
31+
32+
## Durable OpenAI Agents (Preview)
33+
34+
Build resilient, stateful AI agents backed by Durable Functions orchestration—see the full documentation at [docs/openai_agents/README.md](docs/openai_agents/README.md).
35+

docs/openai_agents/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,6 @@ The Durable OpenAI Agents integration combines the familiar OpenAI Agents SDK wi
1717
## Documentation
1818

1919
- [Getting Started](getting-started.md) - Setup and your first durable agent
20-
- [Reference](reference.md) - Complete reference documentation
20+
- [Reference](reference.md) - Complete reference documentation
21+
22+
> Dependency & compatibility: The `azure-functions-durable` package does NOT declare `openai` or `openai-agents` as dependencies. If you need Durable OpenAI Agents, explicitly add `openai` and `openai-agents` to your `requirements.txt` (see `samples-v2/openai_agents/requirements.txt`). This integration is validated with the versions currently pinned there (`openai==1.107.3`, `openai-agents==0.3.0`). Because the OpenAI ecosystem changes rapidly, if you encounter issues, first pin to these versions to rule out a version mismatch before filing an issue.

docs/openai_agents/getting-started.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ Then install them:
5656
pip install -r requirements.txt
5757
```
5858

59+
> Dependency & compatibility: The `azure-functions-durable` package does NOT declare `openai` or `openai-agents` as dependencies. If you need Durable OpenAI Agents, explicitly add `openai` and `openai-agents` to your `requirements.txt` (see `samples-v2/openai_agents/requirements.txt`). This integration is validated with the versions currently pinned there (`openai==1.107.3`, `openai-agents==0.3.0`). Because the OpenAI ecosystem changes rapidly, if you encounter issues, first pin to these versions to rule out a version mismatch before filing an issue.
60+
5961
### Configuring Durable Task Scheduler Backend
6062

6163
**Durable Task Scheduler is the preferred backend** for this integration as it provides enhanced performance, better observability, and simplified local development. While not a hard requirement, it's strongly recommended for production workloads.

0 commit comments

Comments
 (0)