azure-ai-evaluation 1.0.0b2__py3-none-any.whl → 1.13.3__py3-none-any.whl

azure/ai/evaluation/_http_utils.py

@@ -3,12 +3,11 @@
 # ---------------------------------------------------------
 
 
-from functools import wraps
-from typing import Any, Awaitable, Callable, Dict, MutableMapping, Optional
+from typing import Any, Dict, MutableMapping, Optional, TypedDict, cast
 
-from typing_extensions import Self
+from typing_extensions import Self, Unpack
 
-from azure.ai.evaluation._user_agent import USER_AGENT
+from azure.ai.evaluation._user_agent import UserAgentSingleton
 from azure.core.configuration import Configuration
 from azure.core.pipeline import AsyncPipeline, Pipeline
 from azure.core.pipeline.policies import (
@@ -33,78 +32,25 @@ from azure.core.rest import AsyncHttpResponse, HttpRequest, HttpResponse
 from azure.core.rest._rest_py3 import ContentType, FilesType, ParamsType
 
 
-def _request_fn(f: Callable[["HttpPipeline"], None]):
-    """Decorator to generate convenience methods for HTTP method.
+class RequestKwargs(TypedDict, total=False):
+    """Keyword arguments for request-style http request functions
 
-    :param Callable[["HttpPipeline"],None] f: A HttpPipeline classmethod to wrap.
-        The f.__name__ is the HTTP method used
-    :return: A wrapped callable that sends a `f.__name__` request
-    :rtype: Callable
-    """
+    .. note::
 
-    @wraps(f)
-    def request_fn(
-        self: "HttpPipeline",
-        url: str,
-        *,
-        params: Optional[ParamsType] = None,
-        headers: Optional[MutableMapping[str, str]] = None,
-        json: Any = None,
-        content: Optional[ContentType] = None,
-        data: Optional[Dict[str, Any]] = None,
-        files: Optional[FilesType] = None,
-        **kwargs,
-    ) -> HttpResponse:
-        return self.request(
-            f.__name__.upper(),
-            url,
-            params=params,
-            headers=headers,
-            json=json,
-            content=content,
-            data=data,
-            files=files,
-            **kwargs,
-        )
+        Ideally, we'd be able to express that these are the known subset of kwargs, but it's possible to provide
+        others. But that currently isn't possible; there's no way currently to express a TypedDict that expects
+        a known set of keys and an unknown set of keys.
 
-    return request_fn
-
-
-def _async_request_fn(f: Callable[["AsyncHttpPipeline"], Awaitable[None]]):
-    """Decorator to generate convenience methods for HTTP method.
-
-    :param Callable[["HttpPipeline"],None] f: A HttpPipeline classmethod to wrap.
-        The f.__name__ is the HTTP method used
-    :return: A wrapped callable that sends a `f.__name__` request
-    :rtype: Callable
+        PEP 728 - TypedDict with Typed Extra Items (https://peps.python.org/pep-0728/) would rectify this but it's
+        still in Draft status.
     """
 
-    @wraps(f)
-    async def request_fn(
-        self: "AsyncHttpPipeline",
-        url: str,
-        *,
-        params: Optional[ParamsType] = None,
-        headers: Optional[MutableMapping[str, str]] = None,
-        json: Any = None,
-        content: Optional[ContentType] = None,
-        data: Optional[Dict[str, Any]] = None,
-        files: Optional[FilesType] = None,
-        **kwargs,
-    ) -> AsyncHttpResponse:
-        return await self.request(
-            f.__name__.upper(),
-            url,
-            params=params,
-            headers=headers,
-            json=json,
-            content=content,
-            data=data,
-            files=files,
-            **kwargs,
-        )
-
-    return request_fn
+    params: ParamsType
+    headers: MutableMapping[str, str]
+    json: Any
+    content: ContentType
+    data: Dict[str, Any]
+    files: FilesType
 
 
 class HttpPipeline(Pipeline):
@@ -145,14 +91,32 @@ class HttpPipeline(Pipeline):
         :param RedirectPolicy redirect_policy:
         """
         config = config or Configuration()
-        config.headers_policy = headers_policy or config.headers_policy or HeadersPolicy(**kwargs)
-        config.proxy_policy = proxy_policy or config.proxy_policy or ProxyPolicy(**kwargs)
-        config.redirect_policy = redirect_policy or config.redirect_policy or RedirectPolicy(**kwargs)
-        config.retry_policy = retry_policy or config.retry_policy or RetryPolicy(**kwargs)
-        config.custom_hook_policy = custom_hook_policy or config.custom_hook_policy or CustomHookPolicy(**kwargs)
-        config.logging_policy = logging_policy or config.logging_policy or NetworkTraceLoggingPolicy(**kwargs)
-        config.http_logging_policy = http_logging_policy or config.http_logging_policy or HttpLoggingPolicy(**kwargs)
-        config.user_agent_policy = user_agent_policy or config.user_agent_policy or UserAgentPolicy(**kwargs)
+        config.headers_policy = (
+            headers_policy or cast(Optional[HeadersPolicy], config.headers_policy) or HeadersPolicy(**kwargs)
+        )
+        config.proxy_policy = proxy_policy or cast(Optional[ProxyPolicy], config.proxy_policy) or ProxyPolicy(**kwargs)
+        config.redirect_policy = (
+            redirect_policy or cast(Optional[RedirectPolicy], config.redirect_policy) or RedirectPolicy(**kwargs)
+        )
+        config.retry_policy = retry_policy or cast(Optional[RetryPolicy], config.retry_policy) or RetryPolicy(**kwargs)
+        config.custom_hook_policy = (
+            custom_hook_policy
+            or cast(Optional[CustomHookPolicy], config.custom_hook_policy)
+            or CustomHookPolicy(**kwargs)
+        )
+        config.logging_policy = (
+            logging_policy
+            or cast(Optional[NetworkTraceLoggingPolicy], config.logging_policy)
+            or NetworkTraceLoggingPolicy(**kwargs)
+        )
+        config.http_logging_policy = (
+            http_logging_policy
+            or cast(Optional[HttpLoggingPolicy], config.http_logging_policy)
+            or HttpLoggingPolicy(**kwargs)
+        )
+        config.user_agent_policy = (
+            user_agent_policy or cast(Optional[UserAgentPolicy], config.user_agent_policy) or UserAgentPolicy(**kwargs)
+        )
         config.polling_interval = kwargs.get("polling_interval", 30)
 
         super().__init__(
@@ -166,7 +130,6 @@ class HttpPipeline(Pipeline):
                 config.proxy_policy,
                 config.redirect_policy,
                 config.retry_policy,
-                config.authentication_policy,
                 config.custom_hook_policy,
                 config.logging_policy,
             ],
@@ -199,7 +162,6 @@ class HttpPipeline(Pipeline):
         files: Optional[FilesType] = None,
         **kwargs,
     ) -> HttpResponse:
-
         request = HttpRequest(
             method,
             url,
@@ -213,33 +175,78 @@ class HttpPipeline(Pipeline):
 
         return self.run(request, **kwargs).http_response
 
-    @_request_fn
-    def delete(self) -> None:
-        """Send a DELETE request."""
+    def delete(self: "HttpPipeline", url: str, **kwargs: Unpack[RequestKwargs]) -> HttpResponse:
+        """Send a DELETE request.
 
-    @_request_fn
-    def put(self) -> None:
-        """Send a PUT request."""
+        :param str url: The request url
+        :returns: The request response
+        :rtype: HttpResponse
+        """
 
-    @_request_fn
-    def get(self) -> None:
-        """Send a GET request."""
+        return self.request(self.delete.__name__.upper(), url, **kwargs)
 
-    @_request_fn
-    def post(self) -> None:
-        """Send a POST request."""
+    def put(self: "HttpPipeline", url: str, **kwargs: Unpack[RequestKwargs]) -> HttpResponse:
+        """Send a PUT request.
 
-    @_request_fn
-    def head(self) -> None:
-        """Send a HEAD request."""
+        :param str url: The request url
+        :returns: The request response
+        :rtype: HttpResponse
+        """
 
-    @_request_fn
-    def options(self) -> None:
-        """Send a OPTIONS request."""
+        return self.request(self.put.__name__.upper(), url, **kwargs)
 
-    @_request_fn
-    def patch(self) -> None:
-        """Send a PATCH request."""
+    def get(self: "HttpPipeline", url: str, **kwargs: Unpack[RequestKwargs]) -> HttpResponse:
+        """Send a GET request.
+
+        :param str url: The request url
+        :returns: The request response
+        :rtype: HttpResponse
+        """
+
+        return self.request(self.get.__name__.upper(), url, **kwargs)
+
+    def post(self: "HttpPipeline", url: str, **kwargs: Unpack[RequestKwargs]) -> HttpResponse:
+        """Send a POST request.
+
+        :param str url: The request url
+        :returns: The request response
+        :rtype: HttpResponse
+        """
+
+        return self.request(self.post.__name__.upper(), url, **kwargs)
+
+    def head(self: "HttpPipeline", url: str, **kwargs: Unpack[RequestKwargs]) -> HttpResponse:
+        """Send a HEAD request.
+
+        :param str url: The request url
+        :returns: The request response
+        :rtype: HttpResponse
+        """
+
+        return self.request(self.head.__name__.upper(), url, **kwargs)
+
+    def options(self: "HttpPipeline", url: str, **kwargs: Unpack[RequestKwargs]) -> HttpResponse:
+        """Send a OPTIONS request.
+
+        :param str url: The request url
+        :returns: The request response
+        :rtype: HttpResponse
+        """
+
+        return self.request(self.options.__name__.upper(), url, **kwargs)
+
+    def patch(self: "HttpPipeline", url: str, **kwargs: Unpack[RequestKwargs]) -> HttpResponse:
+        """Send a PATCH request.
+
+        :param str url: The request url
+        :returns: The request response
+        :rtype: HttpResponse
+        """
+
+        return self.request(self.patch.__name__.upper(), url, **kwargs)
+
+    def __enter__(self) -> Self:
+        return cast(Self, super().__enter__())
 
 
 class AsyncHttpPipeline(AsyncPipeline):
@@ -280,14 +287,36 @@ class AsyncHttpPipeline(AsyncPipeline):
         :param AsyncRedirectPolicy redirect_policy:
         """
         config = config or Configuration()
-        config.headers_policy = headers_policy or config.headers_policy or HeadersPolicy(**kwargs)
-        config.proxy_policy = proxy_policy or config.proxy_policy or ProxyPolicy(**kwargs)
-        config.redirect_policy = redirect_policy or config.redirect_policy or AsyncRedirectPolicy(**kwargs)
-        config.retry_policy = retry_policy or config.retry_policy or AsyncRetryPolicy(**kwargs)
-        config.custom_hook_policy = custom_hook_policy or config.custom_hook_policy or CustomHookPolicy(**kwargs)
-        config.logging_policy = logging_policy or config.logging_policy or NetworkTraceLoggingPolicy(**kwargs)
-        config.http_logging_policy = http_logging_policy or config.http_logging_policy or HttpLoggingPolicy(**kwargs)
-        config.user_agent_policy = user_agent_policy or config.user_agent_policy or UserAgentPolicy(**kwargs)
+        config.headers_policy = (
+            headers_policy or cast(Optional[HeadersPolicy], config.headers_policy) or HeadersPolicy(**kwargs)
+        )
+        config.proxy_policy = proxy_policy or cast(Optional[ProxyPolicy], config.proxy_policy) or ProxyPolicy(**kwargs)
+        config.redirect_policy = (
+            redirect_policy
+            or cast(Optional[AsyncRedirectPolicy], config.redirect_policy)
+            or AsyncRedirectPolicy(**kwargs)
+        )
+        config.retry_policy = (
+            retry_policy or cast(Optional[AsyncRetryPolicy], config.retry_policy) or AsyncRetryPolicy(**kwargs)
+        )
+        config.custom_hook_policy = (
+            custom_hook_policy
+            or cast(Optional[CustomHookPolicy], config.custom_hook_policy)
+            or CustomHookPolicy(**kwargs)
+        )
+        config.logging_policy = (
+            logging_policy
+            or cast(Optional[NetworkTraceLoggingPolicy], config.logging_policy)
+            or NetworkTraceLoggingPolicy(**kwargs)
+        )
+        config.http_logging_policy = (
+            http_logging_policy
+            or cast(Optional[HttpLoggingPolicy], config.http_logging_policy)
+            or HttpLoggingPolicy(**kwargs)
+        )
+        config.user_agent_policy = (
+            user_agent_policy or cast(Optional[UserAgentPolicy], config.user_agent_policy) or UserAgentPolicy(**kwargs)
+        )
         config.polling_interval = kwargs.get("polling_interval", 30)
 
         super().__init__(
@@ -301,7 +330,6 @@ class AsyncHttpPipeline(AsyncPipeline):
                 config.proxy_policy,
                 config.redirect_policy,
                 config.retry_policy,
-                config.authentication_policy,
                 config.custom_hook_policy,
                 config.logging_policy,
             ],
@@ -334,7 +362,6 @@ class AsyncHttpPipeline(AsyncPipeline):
         files: Optional[FilesType] = None,
         **kwargs,
     ) -> AsyncHttpResponse:
-
         request = HttpRequest(
             method,
             url,
@@ -348,48 +375,94 @@ class AsyncHttpPipeline(AsyncPipeline):
 
         return (await self.run(request, **kwargs)).http_response
 
-    @_async_request_fn
-    async def delete(self) -> None:
-        """Send a DELETE request."""
+    async def delete(self: "AsyncHttpPipeline", url: str, **kwargs: Unpack[RequestKwargs]) -> AsyncHttpResponse:
+        """Send a DELETE request.
+
+        :param str url: The request url
+        :returns: The request response
+        :rtype: AsyncHttpResponse
+        """
+        return await self.request(self.delete.__name__.upper(), url, **kwargs)
+
+    async def put(self: "AsyncHttpPipeline", url: str, **kwargs: Unpack[RequestKwargs]) -> AsyncHttpResponse:
+        """Send a PUT request.
+
+        :param str url: The request url
+        :returns: The request response
+        :rtype: AsyncHttpResponse
+        """
+
+        return await self.request(self.put.__name__.upper(), url, **kwargs)
+
+    async def get(self: "AsyncHttpPipeline", url: str, **kwargs: Unpack[RequestKwargs]) -> AsyncHttpResponse:
+        """Send a GET request.
+
+        :param str url: The request url
+        :returns: The request response
+        :rtype: AsyncHttpResponse
+        """
+
+        return await self.request(self.get.__name__.upper(), url, **kwargs)
+
+    async def post(self: "AsyncHttpPipeline", url: str, **kwargs: Unpack[RequestKwargs]) -> AsyncHttpResponse:
+        """Send a POST request.
+
+        :param str url: The request url
+        :returns: The request response
+        :rtype: AsyncHttpResponse
+        """
+
+        return await self.request(self.post.__name__.upper(), url, **kwargs)
+
+    async def head(self: "AsyncHttpPipeline", url: str, **kwargs: Unpack[RequestKwargs]) -> AsyncHttpResponse:
+        """Send a HEAD request.
 
-    @_async_request_fn
-    async def put(self) -> None:
-        """Send a PUT request."""
+        :param str url: The request url
+        :returns: The request response
+        :rtype: AsyncHttpResponse
+        """
+
+        return await self.request(self.head.__name__.upper(), url, **kwargs)
+
+    async def options(self: "AsyncHttpPipeline", url: str, **kwargs: Unpack[RequestKwargs]) -> AsyncHttpResponse:
+        """Send a OPTIONS request.
 
-    @_async_request_fn
-    async def get(self) -> None:
-        """Send a GET request."""
+        :param str url: The request url
+        :returns: The request response
+        :rtype: AsyncHttpResponse
+        """
+
+        return await self.request(self.options.__name__.upper(), url, **kwargs)
 
-    @_async_request_fn
-    async def post(self) -> None:
-        """Send a POST request."""
+    async def patch(self: "AsyncHttpPipeline", url: str, **kwargs: Unpack[RequestKwargs]) -> AsyncHttpResponse:
+        """Send a PATCH request.
 
-    @_async_request_fn
-    async def head(self) -> None:
-        """Send a HEAD request."""
+        :param str url: The request url
+        :returns: The request response
+        :rtype: AsyncHttpResponse
+        """
 
-    @_async_request_fn
-    async def options(self) -> None:
-        """Send a OPTIONS request."""
+        return await self.request(self.patch.__name__.upper(), url, **kwargs)
 
-    @_async_request_fn
-    async def patch(self) -> None:
-        """Send a PATCH request."""
+    async def __aenter__(self) -> Self:
+        return cast(Self, await super().__aenter__())
 
 
-def get_http_client() -> HttpPipeline:
+def get_http_client(**kwargs: Any) -> HttpPipeline:
     """Get an HttpPipeline configured with common policies.
 
     :returns: An HttpPipeline with a set of applied policies:
     :rtype: HttpPipeline
     """
-    return HttpPipeline(user_agent_policy=UserAgentPolicy(base_user_agent=USER_AGENT))
+    kwargs.setdefault("user_agent_policy", UserAgentPolicy(base_user_agent=UserAgentSingleton().value))
+    return HttpPipeline(**kwargs)
 
 
-def get_async_http_client() -> AsyncHttpPipeline:
+def get_async_http_client(**kwargs: Any) -> AsyncHttpPipeline:
     """Get an AsyncHttpPipeline configured with common policies.
 
     :returns: An AsyncHttpPipeline with a set of applied policies:
     :rtype: AsyncHttpPipeline
     """
-    return AsyncHttpPipeline(user_agent_policy=UserAgentPolicy(base_user_agent=USER_AGENT))
+    kwargs.setdefault("user_agent_policy", UserAgentPolicy(base_user_agent=UserAgentSingleton().value))
+    return AsyncHttpPipeline(**kwargs)

azure/ai/evaluation/_legacy/__init__.py

@@ -0,0 +1,3 @@
+# ---------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# ---------------------------------------------------------

azure/ai/evaluation/_legacy/_adapters/__init__.py

@@ -0,0 +1,7 @@
+# ---------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# ---------------------------------------------------------
+
+# NOTE: This contains adapters that make the Promptflow dependency optional. In the first phase,
+#       Promptflow will still be installed as part of the azure-ai-evaluation dependencies. This
+#       will be removed in the future once the code migration is complete.

azure/ai/evaluation/_legacy/_adapters/_check.py

@@ -0,0 +1,17 @@
+# ---------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# ---------------------------------------------------------
+
+from typing import Final
+
+
+_has_legacy = False
+try:
+    from promptflow._constants import FlowType
+
+    _has_legacy = True
+except ImportError:
+    pass
+
+HAS_LEGACY_SDK: Final[bool] = _has_legacy
+MISSING_LEGACY_SDK: Final[bool] = not _has_legacy

azure/ai/evaluation/_legacy/_adapters/_configuration.py

@@ -0,0 +1,45 @@
+# ---------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# ---------------------------------------------------------
+
+from pathlib import Path
+from typing import Any, Dict, Final, Optional
+from typing_extensions import TypeAlias
+
+
+try:
+    from promptflow._sdk._configuration import Configuration as _Configuration
+except ImportError:
+    _global_config: Final[Dict[str, Any]] = {}
+
+    class _Configuration:
+        TRACE_DESTINATION: Final[str] = "trace.destination"
+        _instance = None
+
+        def __init__(self, *, override_config: Optional[Dict[str, Any]] = None) -> None:
+            self._config = override_config or {}
+
+        @classmethod
+        def get_instance(cls) -> "_Configuration":
+            """Use this to get instance to avoid multiple copies of same global config."""
+            if cls._instance is None:
+                cls._instance = Configuration(override_config=_global_config)
+            return cls._instance
+
+        def set_config(self, key: str, value: Any) -> None:
+            # Simulated config storage
+            self._config[key] = value
+
+        def get_config(self, key: str) -> Any:
+            # Simulated config storage
+            if key in self._config:
+                return self._config[key]
+            return _global_config.get(key, None)
+
+        def get_trace_destination(self, path: Optional[Path] = None) -> Optional[str]:
+            if path:
+                raise NotImplementedError("Setting trace destination with a path is not supported.")
+            return self._config.get("trace.destination", None)
+
+
+Configuration: TypeAlias = _Configuration

azure/ai/evaluation/_legacy/_adapters/_constants.py

@@ -0,0 +1,10 @@
+# ---------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# ---------------------------------------------------------
+
+from typing import Final
+
+
+PF_FLOW_ENTRY_IN_TMP: Final[str] = "PF_FLOW_ENTRY_IN_TMP"
+PF_FLOW_META_LOAD_IN_SUBPROCESS: Final[str] = "PF_FLOW_META_LOAD_IN_SUBPROCESS"
+LINE_NUMBER: Final[str] = "line_number"

azure/ai/evaluation/_legacy/_adapters/_errors.py

@@ -0,0 +1,29 @@
+# ---------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# ---------------------------------------------------------
+
+from typing import Any
+from typing_extensions import TypeAlias
+
+
+try:
+    from promptflow.core._errors import MissingRequiredPackage as _MissingRequiredPackage
+except ImportError:
+    from azure.ai.evaluation._exceptions import ErrorBlame, ErrorCategory, ErrorTarget, EvaluationException
+
+    class _MissingRequiredPackage(EvaluationException):
+        """Raised when a required package is missing.
+
+        :param message: A message describing the error. This is the error message the user will see.
+        :type message: str
+        """
+
+        def __init__(self, message: str, **kwargs: Any):
+            kwargs.setdefault("category", ErrorCategory.MISSING_PACKAGE)
+            kwargs.setdefault("blame", ErrorBlame.SYSTEM_ERROR)
+            kwargs.setdefault("target", ErrorTarget.EVALUATE)
+            kwargs.setdefault("internal_message", "Missing required package.")
+            super().__init__(message=message, **kwargs)
+
+
+MissingRequiredPackage: TypeAlias = _MissingRequiredPackage

azure/ai/evaluation/_legacy/_adapters/_flows.py

@@ -0,0 +1,28 @@
+# ---------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# ---------------------------------------------------------
+
+from typing_extensions import TypeAlias
+
+
+try:
+    from promptflow.core._flow import AsyncPrompty as _AsyncPrompty
+    from promptflow._sdk.entities._flows import FlexFlow as _FlexFlow
+    from promptflow._sdk.entities._flows.dag import Flow as _Flow
+except ImportError:
+    from azure.ai.evaluation._legacy.prompty import AsyncPrompty as _AsyncPrompty
+
+    class _FlexFlow:
+        pass
+
+    _FlexFlow.__name__ = "FlexFlow"
+
+    class _Flow:
+        name: str
+
+    _Flow.__name__ = "Flow"
+
+
+AsyncPrompty: TypeAlias = _AsyncPrompty
+FlexFlow: TypeAlias = _FlexFlow
+Flow: TypeAlias = _Flow

azure/ai/evaluation/_legacy/_adapters/_service.py

@@ -0,0 +1,16 @@
+# ---------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# ---------------------------------------------------------
+
+from typing import Callable, Final
+
+
+try:
+    from promptflow._cli._pf._service import stop_service as _stop_service
+except ImportError:
+
+    def _stop_service() -> None:
+        pass
+
+
+stop_service: Final[Callable[[], None]] = _stop_service

azure/ai/evaluation/_legacy/_adapters/client.py

@@ -0,0 +1,51 @@
+# ---------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# ---------------------------------------------------------
+
+from os import PathLike
+from typing import Any, Callable, Dict, Optional, Union
+from typing_extensions import TypeAlias
+
+import pandas as pd
+
+from ._errors import MissingRequiredPackage
+from ._configuration import Configuration
+from .entities import Run
+
+
+try:
+    from promptflow.client import PFClient as _PFClient
+except ImportError:
+
+    class _PFClient:
+        def __init__(self, **kwargs):
+            self._config = Configuration(override_config=kwargs.pop("config", None))
+
+        def run(
+            self,
+            flow: Union[str, PathLike, Callable],
+            *,
+            data: Union[str, PathLike],
+            run: Optional[Union[str, Run]] = None,
+            column_mapping: Optional[dict] = None,
+            variant: Optional[str] = None,
+            connections: Optional[dict] = None,
+            environment_variables: Optional[dict] = None,
+            name: Optional[str] = None,
+            display_name: Optional[str] = None,
+            tags: Optional[Dict[str, str]] = None,
+            resume_from: Optional[Union[str, Run]] = None,
+            code: Optional[Union[str, PathLike]] = None,
+            init: Optional[dict] = None,
+            **kwargs,
+        ) -> Run:
+            raise MissingRequiredPackage("Please install 'promptflow' package to use PFClient")
+
+        def get_details(self, run: Union[str, Run], max_results: int = 100, all_results: bool = False) -> pd.DataFrame:
+            return pd.DataFrame()
+
+        def get_metrics(self, run: Union[str, Run]) -> Dict[str, Any]:
+            return {}
+
+
+PFClient: TypeAlias = _PFClient