azure-functions-durable 1.3.2__py3-none-any.whl → 1.4.0__py3-none-any.whl

azure/durable_functions/openai_agents/tools.py

@@ -0,0 +1,148 @@
+#  Copyright (c) Microsoft Corporation. All rights reserved.
+#  Licensed under the MIT License.
+"""Tool conversion utilities for Azure Durable Functions OpenAI agent operations."""
+
+from typing import Any, Union
+
+from agents import (
+    CodeInterpreterTool,
+    FileSearchTool,
+    FunctionTool,
+    HostedMCPTool,
+    ImageGenerationTool,
+    Tool,
+    UserError,
+    WebSearchTool,
+)
+from openai.types.responses.tool_param import Mcp
+from pydantic import BaseModel
+
+
+# Built-in tool types that can be serialized directly without conversion
+BUILT_IN_TOOL_TYPES = (
+    FileSearchTool,
+    WebSearchTool,
+    ImageGenerationTool,
+    CodeInterpreterTool,
+)
+
+
+class DurableFunctionTool(BaseModel):
+    """Serializable representation of a FunctionTool.
+
+    Contains only the data needed by the model execution to
+    determine what tool to call, not the actual tool invocation.
+    """
+
+    name: str
+    description: str
+    params_json_schema: dict[str, Any]
+    strict_json_schema: bool = True
+
+
+class DurableMCPToolConfig(BaseModel):
+    """Serializable representation of a HostedMCPTool.
+
+    Contains only the data needed by the model execution to
+    determine what tool to call, not the actual tool invocation.
+    """
+
+    tool_config: Mcp
+
+
+DurableTool = Union[
+    DurableFunctionTool,
+    FileSearchTool,
+    WebSearchTool,
+    ImageGenerationTool,
+    CodeInterpreterTool,
+    DurableMCPToolConfig,
+]
+
+
+def create_tool_from_durable_tool(
+    durable_tool: DurableTool,
+) -> Tool:
+    """Convert a DurableTool to an OpenAI agent Tool for execution.
+
+    This function transforms Durable Functions tool definitions into actual
+    OpenAI agent Tool instances that can be used during model execution.
+
+    Parameters
+    ----------
+    durable_tool : DurableTool
+        The Durable tool definition to convert
+
+    Returns
+    -------
+    Tool
+        An OpenAI agent Tool instance ready for execution
+
+    Raises
+    ------
+    UserError
+        If the tool type is not supported
+    """
+    # Built-in tools that don't need conversion
+    if isinstance(durable_tool, BUILT_IN_TOOL_TYPES):
+        return durable_tool
+
+    # Convert Durable MCP tool configuration to HostedMCPTool
+    if isinstance(durable_tool, DurableMCPToolConfig):
+        return HostedMCPTool(
+            tool_config=durable_tool.tool_config,
+        )
+
+    # Convert Durable function tool to FunctionTool
+    if isinstance(durable_tool, DurableFunctionTool):
+        return FunctionTool(
+            name=durable_tool.name,
+            description=durable_tool.description,
+            params_json_schema=durable_tool.params_json_schema,
+            on_invoke_tool=lambda ctx, input: "",
+            strict_json_schema=durable_tool.strict_json_schema,
+        )
+
+    raise UserError(f"Unsupported tool type: {durable_tool}")
+
+
+def convert_tool_to_durable_tool(tool: Tool) -> DurableTool:
+    """Convert an OpenAI agent Tool to a DurableTool for serialization.
+
+    This function transforms OpenAI agent Tool instances into Durable Functions
+    tool definitions that can be serialized and passed to activities.
+
+    Parameters
+    ----------
+    tool : Tool
+        The OpenAI agent Tool to convert
+
+    Returns
+    -------
+    DurableTool
+        A serializable tool definition
+
+    Raises
+    ------
+    ValueError
+        If the tool type is not supported for conversion
+    """
+    # Built-in tools that can be serialized directly
+    if isinstance(tool, BUILT_IN_TOOL_TYPES):
+        return tool
+
+    # Convert HostedMCPTool to Durable MCP configuration
+    elif isinstance(tool, HostedMCPTool):
+        return DurableMCPToolConfig(tool_config=tool.tool_config)
+
+    # Convert FunctionTool to Durable function tool
+    elif isinstance(tool, FunctionTool):
+        return DurableFunctionTool(
+            name=tool.name,
+            description=tool.description,
+            params_json_schema=tool.params_json_schema,
+            strict_json_schema=tool.strict_json_schema,
+        )
+
+    else:
+        raise ValueError(f"Unsupported tool type for Durable Functions: {type(tool).__name__}")

azure/durable_functions/openai_agents/usage_telemetry.py

@@ -0,0 +1,69 @@
+#  Copyright (c) Microsoft Corporation. All rights reserved.
+#  Licensed under the MIT License.
+
+
+class UsageTelemetry:
+    """Handles telemetry logging for OpenAI Agents SDK integration usage."""
+
+    # Class-level flag to ensure logging happens only once across all instances
+    _usage_logged = False
+
+    @classmethod
+    def log_usage_once(cls):
+        """Log OpenAI Agents SDK integration usage exactly once.
+
+        Fails gracefully if metadata cannot be retrieved.
+        """
+        if cls._usage_logged:
+            return
+
+        # NOTE: Any log line beginning with the special prefix defined below will be
+        # captured by the Azure Functions host as a Language Worker console log and
+        # forwarded to internal telemetry pipelines.
+        # Do not change this constant value without coordinating with the Functions
+        # host team.
+        LANGUAGE_WORKER_CONSOLE_LOG_PREFIX = "LanguageWorkerConsoleLog"
+
+        package_versions = cls._collect_openai_agent_package_versions()
+        msg = (
+            f"{LANGUAGE_WORKER_CONSOLE_LOG_PREFIX}"  # Prefix captured by Azure Functions host
+            "Detected OpenAI Agents SDK integration with Durable Functions. "
+            f"Package versions: {package_versions}"
+        )
+        print(msg)
+
+        cls._usage_logged = True
+
+    @classmethod
+    def _collect_openai_agent_package_versions(cls) -> str:
+        """Collect versions of relevant packages for telemetry logging.
+
+        Returns
+        -------
+        str
+            Comma-separated list of name=version entries or "(unavailable)" if
+            versions could not be determined.
+        """
+        try:
+            try:
+                from importlib import metadata  # Python 3.8+
+            except ImportError:  # pragma: no cover - legacy fallback
+                import importlib_metadata as metadata  # type: ignore
+
+            package_names = [
+                "azure-functions-durable",
+                "openai",
+                "openai-agents",
+            ]
+
+            versions = []
+            for package_name in package_names:
+                try:
+                    ver = metadata.version(package_name)
+                    versions.append(f"{package_name}={ver}")
+                except Exception:  # noqa: BLE001 - swallow and continue
+                    versions.append(f"{package_name}=(not installed)")
+
+            return ", ".join(versions) if versions else "(unavailable)"
+        except Exception:  # noqa: BLE001 - never let version gathering break user code
+            return "(unavailable)"

{azure_functions_durable-1.3.2.dist-info → azure_functions_durable-1.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: azure-functions-durable
-Version: 1.3.2
+Version: 1.4.0
 Summary: Durable Functions For Python
 Home-page: https://github.com/Azure/azure-functions-durable-python
 Author: Azure Functions team at Microsoft Corp.
@@ -20,7 +20,7 @@ Requires-Python: >=3.9,<4
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: azure-functions>=1.12.0
-Requires-Dist: aiohttp>=3.12.9
+Requires-Dist: aiohttp>=3.12.14
 Requires-Dist: requests==2.*
 Requires-Dist: python-dateutil>=2.8.0
 Requires-Dist: furl>=2.1.0
@@ -58,4 +58,9 @@ 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.
 
+## 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).
+
+
 

{azure_functions_durable-1.3.2.dist-info → azure_functions_durable-1.4.0.dist-info}/RECORD

@@ -1,15 +1,15 @@
-azure/durable_functions/__init__.py,sha256=Syz9yrT8sHREVyxqvwjg8_c_h8yMTyuBHcDMsuQs1YM,2910
+azure/durable_functions/__init__.py,sha256=aTQRMnMb3zT3w28yEbYsEl-_f3x2Rf-kKp91E9nE8nk,3150
 azure/durable_functions/constants.py,sha256=JtknDhaVihMeo-ygY9QNofiO2KEqnQvopdfZ6Qatnik,414
 azure/durable_functions/entity.py,sha256=mUUzb1BZiDrUJjvxOTlnVURnKPyDGPJ3mXXMN0DKT7M,4649
 azure/durable_functions/orchestrator.py,sha256=SZni90Aweq0OZykHyMblfJpUndJ2woJmySarcsDiIK4,2554
 azure/durable_functions/decorators/__init__.py,sha256=wEubgP2rUUISwidZWgKx6mmzEeGKsSnpGmetjIUi1nw,150
-azure/durable_functions/decorators/durable_app.py,sha256=8K4gevZVYcDvifxXVuvTt8YzF8jx63c1PwdBBk1Vt0g,10114
+azure/durable_functions/decorators/durable_app.py,sha256=5ajbhMPKvZKZhYLCxsEn8J4sZO6Pql9j0nOTCxDaMuY,12599
 azure/durable_functions/decorators/metadata.py,sha256=p91rdCe6OSRYJaKAXnrfR0QCV3PoHK7aGy1m6WAnPIE,2828
 azure/durable_functions/models/DurableEntityContext.py,sha256=cyZmjjZu18oV9S4A2NpnXfjd1JQxPxp9EMmAR424UK0,5830
 azure/durable_functions/models/DurableHttpRequest.py,sha256=a5kgRdg4eA0sgyDcpmQWc0dbwP-o3BwWW2Ive0BYO_Q,2021
 azure/durable_functions/models/DurableOrchestrationBindings.py,sha256=_hp61WjN3bQYCqYFQuvUaDdRu7C14fPg7lFbaA9TRe4,2408
 azure/durable_functions/models/DurableOrchestrationClient.py,sha256=kQBqeKugvi2mi-7dDbCxlu67r20doEhDknlchYxcLBE,33018
-azure/durable_functions/models/DurableOrchestrationContext.py,sha256=Vrox-oX8QfSFmcPampUOTgMx85DuZs_HMQyzavqozEc,31256
+azure/durable_functions/models/DurableOrchestrationContext.py,sha256=fZNbUisN9vkublT2L7wYbj0CNfQNOyYcqRwZ9T-SgN8,32090
 azure/durable_functions/models/DurableOrchestrationStatus.py,sha256=BXWz9L7np4Q9k6z4NsfLX97i2U2IFh94TVeRSV2BjM4,6049
 azure/durable_functions/models/EntityStateResponse.py,sha256=f48W8gmlb-D5iJw3eDyUMYVwHpmIxP6k6a7o2TRHwII,674
 azure/durable_functions/models/FunctionContext.py,sha256=4gHTmIo8DZN-bZLM-hyjoQFlv-AbsfLMT1_X4WxWxqY,274
@@ -53,6 +53,17 @@ azure/durable_functions/models/utils/__init__.py,sha256=dQ6-HRUPsCtDIqGjRJ3TA6NX
 azure/durable_functions/models/utils/entity_utils.py,sha256=TqNTtRC8VuKFtqWLq9oEAloioV-FyinjgRYVKkCldHo,2881
 azure/durable_functions/models/utils/http_utils.py,sha256=AoCWjCapd_984J_4296iJ8cNJWEG8GIdhRttBPt0HnA,2551
 azure/durable_functions/models/utils/json_utils.py,sha256=zUn62pm3dQw054ZlK7F4uRP-UELjQC8EmZBU1WncHMg,3811
+azure/durable_functions/openai_agents/__init__.py,sha256=pAUkXR5ctS0leHiR0IwBC1aHurzOn70wasL-LDRcRnQ,374
+azure/durable_functions/openai_agents/context.py,sha256=tShhQmlMxvOGHvYu55e10xPp2mVHmeIUf37yUzzjE50,7551
+azure/durable_functions/openai_agents/event_loop.py,sha256=JxezIdw1TL-R77ITlarZZvk3F1IMXHqGUAuCgxKX5Wk,571
+azure/durable_functions/openai_agents/exceptions.py,sha256=AmbFAxpkrQ-LiU_LaU7-aWpb6dR-ETMs_XWkoCfZIoQ,394
+azure/durable_functions/openai_agents/handoffs.py,sha256=R8fuQ-FlZ3DQw1jI0WwU8gWwTlWdRLWW2EVrwsfDEuU,2195
+azure/durable_functions/openai_agents/model_invocation_activity.py,sha256=P94iMKVq9qfZyC_fUQWXb-tuOhvANaGhGvqVwUGfFVk,9783
+azure/durable_functions/openai_agents/orchestrator_generator.py,sha256=dvm5e2pk-wtpTog0XZ4iMy1eskLOgwHcMwswiZ3zCA8,2898
+azure/durable_functions/openai_agents/runner.py,sha256=qfsX52zaTDJpuU3_hxgkrEUtoHQ3GTMm5VYSgUXXsjA,3726
+azure/durable_functions/openai_agents/task_tracker.py,sha256=dBGIGlkIdbwxH2OJ3XJZBFazzC32JZ9hWpN4isxvYLQ,7749
+azure/durable_functions/openai_agents/tools.py,sha256=YahQOV1Duv0217tEwG6SX8gLLTvkQNLFi9E_6KUOjvI,4229
+azure/durable_functions/openai_agents/usage_telemetry.py,sha256=U4nqLJIv_vzxT2Y5FIUi9NkvCyHex1OY4eWY8flydNs,2646
 azure/durable_functions/testing/OrchestratorGeneratorWrapper.py,sha256=cjh-HAq5rVNCoR0pIbfGrqy6cKSf4S1KMQxrBMWU1-s,1728
 azure/durable_functions/testing/__init__.py,sha256=NLbltPtoPXK-0iMTwcKTKPjQlAWrEq55oDYmrhYz6vg,189
 tests/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -60,11 +71,15 @@ tests/models/test_DecoratorMetadata.py,sha256=0PeUDszF_gAJZMZR-K-Ro7c3I1D960amOL
 tests/models/test_Decorators.py,sha256=y2dhoSlP74J5uAVBDY2JfFkSA-AhyagVBZO5tGi6KaQ,2925
 tests/models/test_DurableOrchestrationBindings.py,sha256=pjuoKlpEc6KAIL-Nq2taoqW0HYWXoupgUxcsPwc1Psg,2961
 tests/models/test_DurableOrchestrationClient.py,sha256=7htzuMMfkRU9Hf-9Gr-rYHpJXJdpnAp0WheAFpMKHNo,31791
-tests/models/test_DurableOrchestrationContext.py,sha256=7fWdnvpSEces0VM4Xm11uLZmshXqGl7wtYo8ELixypc,3930
+tests/models/test_DurableOrchestrationContext.py,sha256=ewNEH2g8gn60bVftXT6zmI6nkANXB1u7XsC1l9vXFxg,4328
 tests/models/test_DurableOrchestrationStatus.py,sha256=fnUZxrHGy771OoaD5TInELhaG836aB8XqtMdNjnEFp8,2485
 tests/models/test_OrchestrationState.py,sha256=L-k8ScrqoDIZEqIUORbxXA7yCuMbVAUPr-7VmyuQkUc,1272
 tests/models/test_RpcManagementOptions.py,sha256=hvDzlJED8egJloju5nFvKYusgwLgy-o_avJAY6uzfdg,3190
 tests/models/test_TokenSource.py,sha256=wlRn-RPM72U6Ose4sa3Yvu2ng1VbAopDIbea90CYDjk,589
+tests/openai_agents/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/openai_agents/test_context.py,sha256=r5nGikUU2j23TmyknruR1ntP4UvxyvYrWil9Ap11qs4,21861
+tests/openai_agents/test_task_tracker.py,sha256=6vjalKmCb-CjpJysx7D0s_3CZaOPycE76TQpcX0ludU,13263
+tests/openai_agents/test_usage_telemetry.py,sha256=gB8efDTZhO9UvCwRTqmCELcgmtwbhSoA6_1Hy7kPCDQ,4825
 tests/orchestrator/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/orchestrator/orchestrator_test_utils.py,sha256=ldgQGGuOVALcI98enRU08nF_VJd5ypJl-hVG-q0kH1o,5359
 tests/orchestrator/test_call_http.py,sha256=CvemeCayrQLjmjl3lpB1fk_CpV-DRPgfxLgD4iNgStQ,9103
@@ -83,6 +98,8 @@ tests/orchestrator/test_sub_orchestrator.py,sha256=QUb5Q3nLcCdhFwGaEQlYdoNQLUvI8
 tests/orchestrator/test_sub_orchestrator_with_retry.py,sha256=bfufQnteEZ9i3q7wzCvd8EwFmaOh89KPOpTPSJvlP1I,6040
 tests/orchestrator/test_task_any.py,sha256=9PQalbQW-Qx7_iO4Yjl1MR2hhsBjst6k00_4veIt97g,2695
 tests/orchestrator/models/OrchestrationInstance.py,sha256=CQ3qyNumjksuFNMujbESsvjadntP3b9VtTpEuI4hzaE,491
+tests/orchestrator/openai_agents/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/orchestrator/openai_agents/test_openai_agents.py,sha256=qa8DLkJ1IZV9C5kP2mnFfchriv4ppl1nIu9J_3rNlhA,24221
 tests/orchestrator/schemas/OrchetrationStateSchema.py,sha256=EyTsDUZ3K-9mVljLIlg8f_h2zsK228E0PMvvtyEWw24,2718
 tests/tasks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/tasks/tasks_test_utils.py,sha256=Ymc5GESJpzybBq3n2mT4IABDRNTVCerAZrlMilv0Pdk,737
@@ -96,8 +113,8 @@ tests/test_utils/json_utils.py,sha256=B0q3COMya7TGxbH-7sD_0ypWDSuaF4fpD4QV_oJPgG
 tests/test_utils/testClasses.py,sha256=U_u5qKxC9U81SzjLo7ejjPjEn_cE5qjaqoq8edGD6l8,1521
 tests/utils/__init__.py,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
 tests/utils/test_entity_utils.py,sha256=kdk5_DV_-bFu_5q2mw9o1yjyzh8Lcxv1jo1Q7is_ukA,748
-azure_functions_durable-1.3.2.dist-info/LICENSE,sha256=-VS-Izmxdykuae1Xc4vHtVUx02rNQi6SSQlONvvuYeQ,1090
-azure_functions_durable-1.3.2.dist-info/METADATA,sha256=3zhhixYOOBegIn-AnvaaAfMzQtFs7s7X6ggHofdvrDQ,3523
-azure_functions_durable-1.3.2.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-azure_functions_durable-1.3.2.dist-info/top_level.txt,sha256=h-L8XDVPJ9YzBbHlPvM7FVo1cqNGToNK9ix99ySGOUY,12
-azure_functions_durable-1.3.2.dist-info/RECORD,,
+azure_functions_durable-1.4.0.dist-info/LICENSE,sha256=-VS-Izmxdykuae1Xc4vHtVUx02rNQi6SSQlONvvuYeQ,1090
+azure_functions_durable-1.4.0.dist-info/METADATA,sha256=UvSARgbXXpFbz_zAnWhFr10Zjm85VPBTkTgZTG7g2jw,3778
+azure_functions_durable-1.4.0.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+azure_functions_durable-1.4.0.dist-info/top_level.txt,sha256=h-L8XDVPJ9YzBbHlPvM7FVo1cqNGToNK9ix99ySGOUY,12
+azure_functions_durable-1.4.0.dist-info/RECORD,,

tests/models/test_DurableOrchestrationContext.py

@@ -100,3 +100,11 @@ def test_get_input_json_str():
     result = context.get_input()
 
     assert 'Seattle' == result['city']
+
+def test_version_equals_version_from_execution_started_event():
+    builder = ContextBuilder('test_function_context')
+    builder.history_events = []
+    builder.add_orchestrator_started_event()
+    builder.add_execution_started_event(name="TestOrchestrator", version="1.0")
+    context = DurableOrchestrationContext.from_json(builder.to_json_string())
+    assert context.version == "1.0"