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). + diff --git a/docs/openai_agents/README.md b/docs/openai_agents/README.md index 09c831b4..fc3466d4 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 + +> 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 e68a27fc..77a6e4c2 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 ``` +> 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 **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.