azure-functions-durable 1.4.0rc2__tar.gz → 1.5.0__tar.gz

{azure-functions-durable-1.4.0rc2 → azure-functions-durable-1.5.0}/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+## Unreleased
+
+### Added
+
+- Client operation correlation logging: `FunctionInvocationId` is now propagated via HTTP headers to the host for client operations, enabling correlation with host logs.
+
 ## 1.0.0b6
 
 - [Create timer](https://github.com/Azure/azure-functions-durable-python/issues/35) functionality available

{azure-functions-durable-1.4.0rc2/azure_functions_durable.egg-info → azure-functions-durable-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: azure-functions-durable
-Version: 1.4.0rc2
+Version: 1.5.0
 Summary: Durable Functions For Python
 Home-page: https://github.com/Azure/azure-functions-durable-python
 Author: Azure Functions team at Microsoft Corp.
@@ -51,7 +51,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 Agent SDK Integration with Azure Durable 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).
 

{azure-functions-durable-1.4.0rc2 → azure-functions-durable-1.5.0}/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 Agent SDK Integration with Azure Durable 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).
 

{azure-functions-durable-1.4.0rc2 → azure-functions-durable-1.5.0}/azure/durable_functions/decorators/durable_app.py

@@ -195,7 +195,14 @@ class Blueprint(TriggerApi, BindingApi, SettingsApi):
             # construct rich object from it,
             # and assign parameter to that rich object
             starter = kwargs[parameter_name]
-            client = client_constructor(starter)
+
+            # Try to extract the function invocation ID from the context for correlation
+            function_invocation_id = None
+            context = kwargs.get('context')
+            if context is not None and hasattr(context, 'invocation_id'):
+                function_invocation_id = context.invocation_id
+
+            client = client_constructor(starter, function_invocation_id)
             kwargs[parameter_name] = client
 
             # Invoke user code with rich DF Client binding

{azure-functions-durable-1.4.0rc2 → azure-functions-durable-1.5.0}/azure/durable_functions/models/DurableOrchestrationClient.py

@@ -26,7 +26,16 @@ class DurableOrchestrationClient:
     orchestration instances.
     """
 
-    def __init__(self, context: str):
+    def __init__(self, context: str, function_invocation_id: Optional[str] = None):
+        """Initialize a DurableOrchestrationClient.
+
+        Parameters
+        ----------
+        context : str
+            The JSON-encoded client binding context.
+        function_invocation_id : Optional[str]
+            The function invocation ID for correlation with host-side logs.
+        """
         self.task_hub_name: str
         self._uniqueWebHookOrigins: List[str]
         self._event_name_placeholder: str = "{eventName}"
@@ -39,6 +48,7 @@ class DurableOrchestrationClient:
         self._show_history_query_key: str = "showHistory"
         self._show_history_output_query_key: str = "showHistoryOutput"
         self._show_input_query_key: str = "showInput"
+        self._function_invocation_id: Optional[str] = function_invocation_id
         self._orchestration_bindings: DurableOrchestrationBindings = \
             DurableOrchestrationBindings.from_json(context)
         self._post_async_request = post_async_request
@@ -48,7 +58,8 @@ class DurableOrchestrationClient:
     async def start_new(self,
                         orchestration_function_name: str,
                         instance_id: Optional[str] = None,
-                        client_input: Optional[Any] = None) -> str:
+                        client_input: Optional[Any] = None,
+                        version: Optional[str] = None) -> str:
         """Start a new instance of the specified orchestrator function.
 
         If an orchestration instance with the specified ID already exists, the
@@ -63,6 +74,9 @@ class DurableOrchestrationClient:
             the Durable Functions extension will generate a random GUID (recommended).
         client_input : Optional[Any]
             JSON-serializable input value for the orchestrator function.
+        version : Optional[str]
+            The version to assign to the orchestration instance. If not specified,
+            the defaultVersion from host.json will be used.
 
         Returns
         -------
@@ -70,7 +84,9 @@ class DurableOrchestrationClient:
             The ID of the new orchestration instance if successful, None if not.
         """
         request_url = self._get_start_new_url(
-            instance_id=instance_id, orchestration_function_name=orchestration_function_name)
+            instance_id=instance_id,
+            orchestration_function_name=orchestration_function_name,
+            version=version)
 
         trace_parent, trace_state = DurableOrchestrationClient._get_current_activity_context()
 
@@ -78,7 +94,8 @@ class DurableOrchestrationClient:
             request_url,
             self._get_json_input(client_input),
             trace_parent,
-            trace_state)
+            trace_state,
+            self._function_invocation_id)
 
         status_code: int = response[0]
         if status_code <= 202 and response[1]:
@@ -250,7 +267,10 @@ class DurableOrchestrationClient:
         request_url = self._get_raise_event_url(
             instance_id, event_name, task_hub_name, connection_name)
 
-        response = await self._post_async_request(request_url, json.dumps(event_data))
+        response = await self._post_async_request(
+            request_url,
+            json.dumps(event_data),
+            function_invocation_id=self._function_invocation_id)
 
         switch_statement = {
             202: lambda: None,
@@ -439,7 +459,10 @@ class DurableOrchestrationClient:
         """
         request_url = f"{self._orchestration_bindings.rpc_base_url}instances/{instance_id}/" \
                       f"terminate?reason={quote(reason)}"
-        response = await self._post_async_request(request_url, None)
+        response = await self._post_async_request(
+            request_url,
+            None,
+            function_invocation_id=self._function_invocation_id)
         switch_statement = {
             202: lambda: None,  # instance in progress
             410: lambda: None,  # instance failed or terminated
@@ -558,7 +581,8 @@ class DurableOrchestrationClient:
             request_url,
             json.dumps(operation_input) if operation_input else None,
             trace_parent,
-            trace_state)
+            trace_state,
+            self._function_invocation_id)
 
         switch_statement = {
             202: lambda: None  # signal accepted
@@ -639,10 +663,15 @@ class DurableOrchestrationClient:
             raise Exception(result)
 
     def _get_start_new_url(
-            self, instance_id: Optional[str], orchestration_function_name: str) -> str:
+            self, instance_id: Optional[str], orchestration_function_name: str,
+            version: Optional[str] = None) -> str:
         instance_path = f'/{instance_id}' if instance_id is not None else ''
         request_url = f'{self._orchestration_bindings.rpc_base_url}orchestrators/' \
                       f'{orchestration_function_name}{instance_path}'
+
+        if version is not None:
+            request_url += f'?version={quote(version)}'
+
         return request_url
 
     def _get_raise_event_url(
@@ -703,7 +732,10 @@ class DurableOrchestrationClient:
             raise Exception("The Python SDK only supports RPC endpoints."
                             + "Please remove the `localRpcEnabled` setting from host.json")
 
-        response = await self._post_async_request(request_url, None)
+        response = await self._post_async_request(
+            request_url,
+            None,
+            function_invocation_id=self._function_invocation_id)
         status: int = response[0]
         ex_msg: str = ""
         if status == 200 or status == 202:
@@ -742,7 +774,10 @@ class DurableOrchestrationClient:
         """
         request_url = f"{self._orchestration_bindings.rpc_base_url}instances/{instance_id}/" \
                       f"suspend?reason={quote(reason)}"
-        response = await self._post_async_request(request_url, None)
+        response = await self._post_async_request(
+            request_url,
+            None,
+            function_invocation_id=self._function_invocation_id)
         switch_statement = {
             202: lambda: None,  # instance is suspended
             410: lambda: None,  # instance completed
@@ -777,7 +812,10 @@ class DurableOrchestrationClient:
         """
         request_url = f"{self._orchestration_bindings.rpc_base_url}instances/{instance_id}/" \
                       f"resume?reason={quote(reason)}"
-        response = await self._post_async_request(request_url, None)
+        response = await self._post_async_request(
+            request_url,
+            None,
+            function_invocation_id=self._function_invocation_id)
         switch_statement = {
             202: lambda: None,  # instance is resumed
             410: lambda: None,  # instance completed

{azure-functions-durable-1.4.0rc2 → azure-functions-durable-1.5.0}/azure/durable_functions/models/DurableOrchestrationContext.py

@@ -246,8 +246,10 @@ class DurableOrchestrationContext:
             The HTTP request method.
         uri: str
             The HTTP request uri.
-        content: Optional[str]
-            The HTTP request content.
+        content: str or dict, optional
+            The HTTP request content. Can be a string or a JSON-serializable dictionary.
+            Note: Although the type hint says 'str', a dictionary is accepted
+            and will be serialized to JSON.
         headers: Optional[Dict[str, str]]
             The HTTP request headers.
         token_source: TokenSource
@@ -285,7 +287,8 @@ class DurableOrchestrationContext:
 
     def call_sub_orchestrator(self,
                               name: Union[str, Callable], input_: Optional[Any] = None,
-                              instance_id: Optional[str] = None) -> TaskBase:
+                              instance_id: Optional[str] = None,
+                              version: Optional[str] = None) -> TaskBase:
         """Schedule sub-orchestration function named `name` for execution.
 
         Parameters
@@ -296,6 +299,9 @@ class DurableOrchestrationContext:
             The JSON-serializable input to pass to the orchestrator function.
         instance_id: Optional[str]
             A unique ID to use for the sub-orchestration instance.
+        version: Optional[str]
+            The version to assign to the sub-orchestration instance. If not specified,
+            the defaultVersion from host.json will be used.
 
         Returns
         -------
@@ -313,14 +319,15 @@ class DurableOrchestrationContext:
         if isinstance(name, FunctionBuilder):
             name = self._get_function_name(name, OrchestrationTrigger)
 
-        action = CallSubOrchestratorAction(name, input_, instance_id)
+        action = CallSubOrchestratorAction(name, input_, instance_id, version)
         task = self._generate_task(action)
         return task
 
     def call_sub_orchestrator_with_retry(self,
                                          name: Union[str, Callable], retry_options: RetryOptions,
                                          input_: Optional[Any] = None,
-                                         instance_id: Optional[str] = None) -> TaskBase:
+                                         instance_id: Optional[str] = None,
+                                         version: Optional[str] = None) -> TaskBase:
         """Schedule sub-orchestration function named `name` for execution, with retry-options.
 
         Parameters
@@ -333,6 +340,9 @@ class DurableOrchestrationContext:
             The JSON-serializable input to pass to the activity function. Defaults to None.
         instance_id: str
             The instance ID of the sub-orchestrator to call.
+        version: Optional[str]
+            The version to assign to the sub-orchestration instance. If not specified,
+            the defaultVersion from host.json will be used.
 
         Returns
         -------
@@ -350,7 +360,8 @@ class DurableOrchestrationContext:
         if isinstance(name, FunctionBuilder):
             name = self._get_function_name(name, OrchestrationTrigger)
 
-        action = CallSubOrchestratorWithRetryAction(name, retry_options, input_, instance_id)
+        action = CallSubOrchestratorWithRetryAction(
+            name, retry_options, input_, instance_id, version)
         task = self._generate_task(action, retry_options)
         return task
 

{azure-functions-durable-1.4.0rc2 → azure-functions-durable-1.5.0}/azure/durable_functions/models/TaskOrchestrationExecutor.py

@@ -276,7 +276,7 @@ class TaskOrchestrationExecutor:
             message contains in it the string representation of the orchestration's
             state
         """
-        if(self.output is not None):
+        if (self.output is not None):
             try:
                 # Attempt to serialize the output. If serialization fails, raise an
                 # error indicating that the orchestration output is not serializable,

{azure-functions-durable-1.4.0rc2 → azure-functions-durable-1.5.0}/azure/durable_functions/models/actions/CallSubOrchestratorAction.py

@@ -11,10 +11,11 @@ class CallSubOrchestratorAction(Action):
     """Defines the structure of the Call SubOrchestrator object."""
 
     def __init__(self, function_name: str, _input: Optional[Any] = None,
-                 instance_id: Optional[str] = None):
+                 instance_id: Optional[str] = None, version: Optional[str] = None):
         self.function_name: str = function_name
         self._input: str = dumps(_input, default=_serialize_custom_object)
         self.instance_id: Optional[str] = instance_id
+        self.version: Optional[str] = version
 
         if not self.function_name:
             raise ValueError("function_name cannot be empty")
@@ -37,4 +38,5 @@ class CallSubOrchestratorAction(Action):
         add_attrib(json_dict, self, 'function_name', 'functionName')
         add_attrib(json_dict, self, '_input', 'input')
         add_attrib(json_dict, self, 'instance_id', 'instanceId')
+        add_attrib(json_dict, self, 'version', 'version')
         return json_dict

{azure-functions-durable-1.4.0rc2 → azure-functions-durable-1.5.0}/azure/durable_functions/models/actions/CallSubOrchestratorWithRetryAction.py

@@ -13,11 +13,12 @@ class CallSubOrchestratorWithRetryAction(Action):
 
     def __init__(self, function_name: str, retry_options: RetryOptions,
                  _input: Optional[Any] = None,
-                 instance_id: Optional[str] = None):
+                 instance_id: Optional[str] = None, version: Optional[str] = None):
         self.function_name: str = function_name
         self._input: str = dumps(_input, default=_serialize_custom_object)
         self.retry_options: RetryOptions = retry_options
         self.instance_id: Optional[str] = instance_id
+        self.version: Optional[str] = version
 
         if not self.function_name:
             raise ValueError("function_name cannot be empty")
@@ -41,4 +42,5 @@ class CallSubOrchestratorWithRetryAction(Action):
         add_attrib(json_dict, self, '_input', 'input')
         add_json_attrib(json_dict, self, 'retry_options', 'retryOptions')
         add_attrib(json_dict, self, 'instance_id', 'instanceId')
+        add_attrib(json_dict, self, 'version', 'version')
         return json_dict

azure-functions-durable-1.5.0/azure/durable_functions/models/utils/http_utils.py

@@ -0,0 +1,189 @@
+from typing import Any, List, Union, Optional
+import asyncio
+
+import aiohttp
+
+
+# Global session and lock for thread-safe initialization
+_client_session: Optional[aiohttp.ClientSession] = None
+_session_lock: asyncio.Lock = asyncio.Lock()
+
+
+async def _get_session() -> aiohttp.ClientSession:
+    """Get or create the shared ClientSession.
+
+    Returns
+    -------
+    aiohttp.ClientSession
+        The shared client session with configured timeout and connection pooling.
+    """
+    global _client_session
+
+    # Double-check locking pattern for async
+    if _client_session is None or _client_session.closed:
+        async with _session_lock:
+            # Check again after acquiring lock
+            if _client_session is None or _client_session.closed:
+                # Configure timeout optimized for localhost IPC
+                timeout = aiohttp.ClientTimeout(
+                    total=240,  # 4-minute total timeout for slow operations
+                    sock_connect=10,  # Fast connection over localhost
+                    sock_read=None  # Covered by total timeout
+                )
+
+                # Configure TCP connector optimized for localhost IPC
+                connector = aiohttp.TCPConnector(
+                    limit=30,  # Maximum connections for single host
+                    limit_per_host=30,  # Maximum connections per host
+                    enable_cleanup_closed=True  # Enable cleanup of closed connections
+                )
+
+                _client_session = aiohttp.ClientSession(
+                    timeout=timeout,
+                    connector=connector
+                )
+
+    return _client_session
+
+
+async def _handle_request_error():
+    """Handle connection errors by closing and resetting the session.
+
+    This handles cases where the remote host process recycles.
+    """
+    global _client_session
+    async with _session_lock:
+        if _client_session is not None and not _client_session.closed:
+            try:
+                await _client_session.close()
+            finally:
+                _client_session = None
+
+
+async def _close_session() -> None:
+    """Close the shared ClientSession if it exists.
+
+    Note: This function is currently only called by _handle_request_error().
+    There is no worker shutdown hook available, but process shutdown will
+    clean up all resources automatically.
+    """
+    global _client_session
+
+    async with _session_lock:
+        if _client_session is not None and not _client_session.closed:
+            try:
+                await _client_session.close()
+            finally:
+                _client_session = None
+
+
+async def post_async_request(url: str,
+                             data: Any = None,
+                             trace_parent: str = None,
+                             trace_state: str = None,
+                             function_invocation_id: str = None) -> List[Union[int, Any]]:
+    """Post request with the data provided to the url provided.
+
+    Parameters
+    ----------
+    url: str
+        url to make the post to
+    data: Any
+        object to post
+    trace_parent: str
+        traceparent header to send with the request
+    trace_state: str
+        tracestate header to send with the request
+    function_invocation_id: str
+        function invocation ID header to send for correlation
+
+    Returns
+    -------
+    [int, Any]
+        Tuple with the Response status code and the data returned from the request
+    """
+    session = await _get_session()
+    headers = {}
+    if trace_parent:
+        headers["traceparent"] = trace_parent
+    if trace_state:
+        headers["tracestate"] = trace_state
+    if function_invocation_id:
+        headers["X-Azure-Functions-InvocationId"] = function_invocation_id
+
+    try:
+        async with session.post(url, json=data, headers=headers) as response:
+            # We disable aiohttp's input type validation
+            # as the server may respond with alternative
+            # data encodings. This is potentially unsafe.
+            # More here: https://docs.aiohttp.org/en/stable/client_advanced.html
+            data = await response.json(content_type=None)
+            return [response.status, data]
+    except (aiohttp.ClientError, asyncio.TimeoutError):
+        # On connection errors, close and recreate session for next request
+        await _handle_request_error()
+        raise
+
+
+async def get_async_request(url: str,
+                            function_invocation_id: str = None) -> List[Any]:
+    """Get the data from the url provided.
+
+    Parameters
+    ----------
+    url: str
+        url to get the data from
+    function_invocation_id: str
+        function invocation ID header to send for correlation
+
+    Returns
+    -------
+    [int, Any]
+        Tuple with the Response status code and the data returned from the request
+    """
+    session = await _get_session()
+    headers = {}
+    if function_invocation_id:
+        headers["X-Azure-Functions-InvocationId"] = function_invocation_id
+
+    try:
+        async with session.get(url, headers=headers) as response:
+            data = await response.json(content_type=None)
+            if data is None:
+                data = ""
+            return [response.status, data]
+    except (aiohttp.ClientError, asyncio.TimeoutError):
+        # On connection errors, close and recreate session for next request
+        await _handle_request_error()
+        raise
+
+
+async def delete_async_request(url: str,
+                               function_invocation_id: str = None) -> List[Union[int, Any]]:
+    """Delete the data from the url provided.
+
+    Parameters
+    ----------
+    url: str
+        url to delete the data from
+    function_invocation_id: str
+        function invocation ID header to send for correlation
+
+    Returns
+    -------
+    [int, Any]
+        Tuple with the Response status code and the data returned from the request
+    """
+    session = await _get_session()
+    headers = {}
+    if function_invocation_id:
+        headers["X-Azure-Functions-InvocationId"] = function_invocation_id
+
+    try:
+        async with session.delete(url, headers=headers) as response:
+            data = await response.json(content_type=None)
+            return [response.status, data]
+    except (aiohttp.ClientError, asyncio.TimeoutError):
+        # On connection errors, close and recreate session for next request
+        await _handle_request_error()
+        raise

{azure-functions-durable-1.4.0rc2 → azure-functions-durable-1.5.0/azure_functions_durable.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: azure-functions-durable
-Version: 1.4.0rc2
+Version: 1.5.0
 Summary: Durable Functions For Python
 Home-page: https://github.com/Azure/azure-functions-durable-python
 Author: Azure Functions team at Microsoft Corp.
@@ -51,7 +51,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 Agent SDK Integration with Azure Durable 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).
 

{azure-functions-durable-1.4.0rc2 → azure-functions-durable-1.5.0}/azure_functions_durable.egg-info/SOURCES.txt

@@ -153,6 +153,9 @@ samples-v2/openai_agents/basic/non_strict_output_type.py
 samples-v2/openai_agents/basic/previous_response_id.py
 samples-v2/openai_agents/basic/remote_image.py
 samples-v2/openai_agents/basic/tools.py
+samples-v2/openai_agents/customer_service/README.md
+samples-v2/openai_agents/customer_service/customer_service.py
+samples-v2/openai_agents/customer_service/customer_service_client.py
 samples-v2/openai_agents/handoffs/message_filter.py
 samples-v2/orchestration_versioning/.funcignore
 samples-v2/orchestration_versioning/.gitignore
@@ -336,4 +339,5 @@ tests/test_utils/constants.py
 tests/test_utils/json_utils.py
 tests/test_utils/testClasses.py
 tests/utils/__init__.py
-tests/utils/test_entity_utils.py
+tests/utils/test_entity_utils.py
+tests/utils/test_http_utils.py

{azure-functions-durable-1.4.0rc2 → azure-functions-durable-1.5.0}/azure_functions_durable.egg-info/requires.txt

@@ -1,5 +1,5 @@
 azure-functions>=1.12.0
-aiohttp>=3.12.14
+aiohttp>=3.13.3
 requests==2.*
 python-dateutil>=2.8.0
 furl>=2.1.0

{azure-functions-durable-1.4.0rc2 → azure-functions-durable-1.5.0}/docs/openai_agents/README.md

@@ -1,10 +1,10 @@
-# Durable OpenAI Agents
+# OpenAI Agent SDK Integration with Azure Durable 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 Agent SDK Integration with Azure Durable 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 Agent SDK Integration with Azure Durable 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.

{azure-functions-durable-1.4.0rc2 → azure-functions-durable-1.5.0}/docs/openai_agents/getting-started.md

@@ -1,4 +1,4 @@
-# Getting Started with Durable OpenAI Agents
+# Getting Started with the OpenAI Agent SDK Integration with Azure Durable 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 Agent SDK Integration with Azure Durable 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)
@@ -35,7 +35,7 @@ python -m venv venv
 # On macOS/Linux:
 source venv/bin/activate
 # On Windows:
-# venv\Scripts\activate
+venv\Scripts\activate
 ```
 
 ### Install Dependencies
@@ -56,12 +56,24 @@ 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
 
 **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.
 
+IMPORTANT: Ensure your function app is using the *preview* extension bundle version 4.34.0 or higher by specifying it in `host.json`:
+
+```json
+{
+  "version": "2.0",
+  "extensionBundle": {
+    "id": "Microsoft.Azure.Functions.ExtensionBundle.Preview",
+    "version": "[4.34.0, 5.0.0)"
+  }
+}
+```
+
 There are two ways to configure the backend locally:
 
 #### Using the Emulator (Recommended)
@@ -126,8 +138,9 @@ Update `local.settings.json` with your service configuration:
     "FUNCTIONS_WORKER_RUNTIME": "python",
     "AZURE_OPENAI_ENDPOINT": "https://<resource-name>.openai.azure.com/",
     "AZURE_OPENAI_DEPLOYMENT": "<deployment-name>",
+    "OPENAI_DEFAULT_MODEL": "<deployment-name>",
     "AZURE_OPENAI_API_VERSION": "2024-10-01-preview",
-    "DURABLE_TASK_SCHEDULER_CONNECTION_STRING": "http://localhost:8080;Authentication=None;",
+    "DURABLE_TASK_SCHEDULER_CONNECTION_STRING": "Endpoint=http://localhost:8080;Authentication=None;",
     "TASKHUB": "default"
   }
 }

{azure-functions-durable-1.4.0rc2 → azure-functions-durable-1.5.0}/docs/openai_agents/reference.md

@@ -1,6 +1,6 @@
 # Reference Documentation
 
-Complete reference for Durable OpenAI Agents integration.
+Complete reference for the OpenAI Agent SDK Integration with Azure Durable Functions (Preview) integration.
 
 ## Durable Orchestration