diff --git a/README.md b/README.md index 7f1e66b5..32987787 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ Follow these instructions to get started with Durable Functions in Python: * 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) +## OpenAI Agents Integration for Reliability on Azure Functions (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 fc3466d4..3b64fcad 100644 --- a/docs/openai_agents/README.md +++ b/docs/openai_agents/README.md @@ -1,10 +1,10 @@ -# Durable OpenAI Agents +# OpenAI Agents Integration for Reliability on Azure Functions (Preview) Build production-ready AI agents with automatic state persistence and failure recovery. ## Overview -The Durable OpenAI Agents integration combines the familiar OpenAI Agents SDK with Azure Durable Functions to create reliable, stateful AI agents that can survive any failure and continue exactly where they stopped. +The OpenAI Agents Integration for Reliability on Azure Functions (Preview) integration combines the familiar OpenAI Agents SDK with Azure Durable Functions to create reliable, stateful AI agents that can survive any failure and continue exactly where they stopped. ## Key Benefits @@ -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 -> 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. +> Dependency & compatibility: The `azure-functions-durable` package does NOT declare `openai` or `openai-agents` as dependencies. If you need the OpenAI Agents Integration for Reliability on Azure Functions (Preview), 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 77a6e4c2..f261f26b 100644 --- a/docs/openai_agents/getting-started.md +++ b/docs/openai_agents/getting-started.md @@ -1,4 +1,4 @@ -# Getting Started with Durable OpenAI Agents +# Getting Started with the OpenAI Agents Integration for Reliability on Azure Functions (Preview) Getting started guide for implementing stateful AI agents using Azure Durable Functions orchestration with automatic checkpointing and replay semantics. @@ -13,7 +13,7 @@ Getting started guide for implementing stateful AI agents using Azure Durable Fu ### Create an Azure Functions App -This framework is designed specifically for **Azure Functions applications**. You need to create a Python Functions app to use Durable OpenAI Agents. +This framework is designed specifically for **Azure Functions applications**. You need to create a Python Functions app to use the OpenAI Agents Integration for Reliability on Azure Functions (Preview). **For new users**: If you're new to Azure Functions, follow these guides to get started: - [Create your first Python function in Azure](https://learn.microsoft.com/en-us/azure/azure-functions/create-first-function-vs-code-python) @@ -56,7 +56,7 @@ 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. +> Dependency & compatibility: The `azure-functions-durable` package does NOT declare `openai` or `openai-agents` as dependencies. If you need the OpenAI Agents Integration for Reliability on Azure Functions (Preview), 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 diff --git a/docs/openai_agents/reference.md b/docs/openai_agents/reference.md index 720cdd3d..469683d4 100644 --- a/docs/openai_agents/reference.md +++ b/docs/openai_agents/reference.md @@ -1,6 +1,6 @@ # Reference Documentation -Complete reference for Durable OpenAI Agents integration. +Complete reference for the OpenAI Agents Integration for Reliability on Azure Functions (Preview) integration. ## Durable Orchestration