From 34937f3ea88ef6d916a5b7a16a1e06407fb4c265 Mon Sep 17 00:00:00 2001 From: Anatoli Beliaev Date: Mon, 22 Sep 2025 16:32:42 -0700 Subject: [PATCH 1/4] Add compatibility notes for OpenAI package versions in README and getting started guide --- docs/openai_agents/README.md | 4 +++- docs/openai_agents/getting-started.md | 2 ++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/openai_agents/README.md b/docs/openai_agents/README.md index 09c831b4..1e91df99 100644 --- a/docs/openai_agents/README.md +++ b/docs/openai_agents/README.md @@ -17,4 +17,6 @@ The Durable OpenAI Agents integration combines the familiar OpenAI Agents SDK wi ## Documentation - [Getting Started](getting-started.md) - Setup and your first durable agent -- [Reference](reference.md) - Complete reference documentation \ No newline at end of file +- [Reference](reference.md) - Complete reference documentation + +> Compatibility note: The Durable OpenAI Agents integration has been validated with the OpenAI packages pinned in the sample application's `samples-v2/openai_agents/requirements.txt` (currently `openai==1.107.3` and `openai-agents==0.3.0`). Because the OpenAI packages release frequently and may introduce breaking API or behavioral changes, we recommend pinning to those versions if you face unexpected issues before reporting a bug. diff --git a/docs/openai_agents/getting-started.md b/docs/openai_agents/getting-started.md index e68a27fc..25479249 100644 --- a/docs/openai_agents/getting-started.md +++ b/docs/openai_agents/getting-started.md @@ -56,6 +56,8 @@ Then install them: pip install -r requirements.txt ``` +> Compatibility note: This integration has been tested with the exact OpenAI package versions defined in the sample app at `samples-v2/openai_agents/requirements.txt` (currently `openai==1.107.3` and `openai-agents==0.3.0`). The OpenAI ecosystem evolves quickly and newer releases may introduce breaking changes. If you encounter unexpected errors, try pinning to those specific versions first to verify whether the issue is due to a version mismatch before filing an issue. + ### Configuring Durable Task Scheduler Backend **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. From 6cea4712a68ad63dd0bc0200adaf49f856b10103 Mon Sep 17 00:00:00 2001 From: Anatoli Beliaev Date: Mon, 22 Sep 2025 16:48:39 -0700 Subject: [PATCH 2/4] Add section for Durable OpenAI Agents in README at the root --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 5beb634e..7f1e66b5 100644 --- a/README.md +++ b/README.md @@ -28,3 +28,8 @@ Follow these instructions to get started with Durable Functions in Python: ## Tooling * 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. + +## Durable OpenAI Agents (Preview) + +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). + From 4cd702248ff7468f509566216b0f5d3ac07f9abd Mon Sep 17 00:00:00 2001 From: Anatoli Beliaev Date: Mon, 22 Sep 2025 16:53:56 -0700 Subject: [PATCH 3/4] Unify compatibility notes text --- docs/openai_agents/README.md | 2 +- docs/openai_agents/getting-started.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/openai_agents/README.md b/docs/openai_agents/README.md index 1e91df99..b86891b9 100644 --- a/docs/openai_agents/README.md +++ b/docs/openai_agents/README.md @@ -19,4 +19,4 @@ The Durable OpenAI Agents integration combines the familiar OpenAI Agents SDK wi - [Getting Started](getting-started.md) - Setup and your first durable agent - [Reference](reference.md) - Complete reference documentation -> Compatibility note: The Durable OpenAI Agents integration has been validated with the OpenAI packages pinned in the sample application's `samples-v2/openai_agents/requirements.txt` (currently `openai==1.107.3` and `openai-agents==0.3.0`). Because the OpenAI packages release frequently and may introduce breaking API or behavioral changes, we recommend pinning to those versions if you face unexpected issues before reporting a bug. +> Compatibility note: This integration is validated with the exact OpenAI package versions pinned in the sample app at `samples-v2/openai_agents/requirements.txt` (currently `openai==1.107.3` and `openai-agents==0.3.0`). The OpenAI ecosystem evolves quickly; if you hit unexpected issues, first pin to these versions to rule out a version mismatch before filing an issue. diff --git a/docs/openai_agents/getting-started.md b/docs/openai_agents/getting-started.md index 25479249..79a107a0 100644 --- a/docs/openai_agents/getting-started.md +++ b/docs/openai_agents/getting-started.md @@ -56,7 +56,7 @@ Then install them: pip install -r requirements.txt ``` -> Compatibility note: This integration has been tested with the exact OpenAI package versions defined in the sample app at `samples-v2/openai_agents/requirements.txt` (currently `openai==1.107.3` and `openai-agents==0.3.0`). The OpenAI ecosystem evolves quickly and newer releases may introduce breaking changes. If you encounter unexpected errors, try pinning to those specific versions first to verify whether the issue is due to a version mismatch before filing an issue. +> Compatibility note: This integration is validated with the exact OpenAI package versions pinned in the sample app at `samples-v2/openai_agents/requirements.txt` (currently `openai==1.107.3` and `openai-agents==0.3.0`). The OpenAI ecosystem evolves quickly; if you hit unexpected issues, first pin to these versions to rule out a version mismatch before filing an issue. ### Configuring Durable Task Scheduler Backend From 60d537af79fae26089797e719ef5a5bd438f6d16 Mon Sep 17 00:00:00 2001 From: Anatoli Beliaev Date: Mon, 22 Sep 2025 17:08:03 -0700 Subject: [PATCH 4/4] Update compatibility notes in README and getting started guide for Durable OpenAI Agents --- docs/openai_agents/README.md | 2 +- docs/openai_agents/getting-started.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/openai_agents/README.md b/docs/openai_agents/README.md index b86891b9..fc3466d4 100644 --- a/docs/openai_agents/README.md +++ b/docs/openai_agents/README.md @@ -19,4 +19,4 @@ The Durable OpenAI Agents integration combines the familiar OpenAI Agents SDK wi - [Getting Started](getting-started.md) - Setup and your first durable agent - [Reference](reference.md) - Complete reference documentation -> Compatibility note: This integration is validated with the exact OpenAI package versions pinned in the sample app at `samples-v2/openai_agents/requirements.txt` (currently `openai==1.107.3` and `openai-agents==0.3.0`). The OpenAI ecosystem evolves quickly; if you hit unexpected issues, first pin to these versions to rule out a version mismatch before filing an issue. +> 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. diff --git a/docs/openai_agents/getting-started.md b/docs/openai_agents/getting-started.md index 79a107a0..77a6e4c2 100644 --- a/docs/openai_agents/getting-started.md +++ b/docs/openai_agents/getting-started.md @@ -56,7 +56,7 @@ Then install them: pip install -r requirements.txt ``` -> Compatibility note: This integration is validated with the exact OpenAI package versions pinned in the sample app at `samples-v2/openai_agents/requirements.txt` (currently `openai==1.107.3` and `openai-agents==0.3.0`). The OpenAI ecosystem evolves quickly; if you hit unexpected issues, first pin to these versions to rule out a version mismatch before filing an issue. +> 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. ### Configuring Durable Task Scheduler Backend