arize-phoenix 11.23.1__py3-none-any.whl → 12.28.1__py3-none-any.whl

phoenix/server/templates/index.html

@@ -110,14 +110,20 @@
               authenticationEnabled: Boolean("{{authentication_enabled}}" == "True"),
               oAuth2Idps: {{ oauth2_idps | tojson }},
               basicAuthDisabled: Boolean("{{basic_auth_disabled}}" == "True"),
+              ldapEnabled: Boolean("{{ldap_enabled}}" == "True"),
+              ldapManualUserCreationEnabled: Boolean("{{ldap_manual_user_creation_enabled}}" == "True"),
               managementUrl: {{management_url | tojson}},
               supportEmail: {{support_email | tojson}},
               hasDbThreshold: Boolean("{{has_db_threshold}}" == "True"),
               allowExternalResources: Boolean("{{allow_external_resources}}" == "True"),
+              authErrorMessages: {{auth_error_messages | tojson}},
           }),
           writable: false
       });
   })()</script>
+    {% if scarf_sh_pixel_id -%}
+      <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid={{scarf_sh_pixel_id}}" />
+    {%- endif %}
     {% if is_development -%}
       <script type="module">
         import RefreshRuntime from 'http://localhost:5173/@react-refresh'
@@ -131,5 +137,5 @@
     {%- else -%}
       {{- render_js() -}}
     {%- endif -%}
-  </body>
+   </body>
 </html>

phoenix/server/thread_server.py

@@ -6,7 +6,6 @@ from time import sleep, time
 
 from fastapi import FastAPI
 from uvicorn import Config, Server
-from uvicorn.config import LoopSetupType
 
 
 def _nest_asyncio_applied() -> bool:
@@ -31,7 +30,7 @@ class ThreadServer(Server):
     ) -> None:
         # Must use asyncio loop if nest_asyncio is applied
         # Otherwise the app crashes when the server is run in a thread
-        loop: LoopSetupType = "asyncio" if _nest_asyncio_applied() else "auto"
+        loop = "asyncio" if _nest_asyncio_applied() else "auto"
         config = Config(
             app=app,
             host=host,

phoenix/server/utils.py

@@ -0,0 +1,74 @@
+from typing import Any, Mapping
+
+
+def prepend_root_path(scope: Mapping[str, Any], path: str) -> str:
+    """
+    Prepends the ASGI root path to the given path if one is configured.
+
+    Normalizes the input path by ensuring it has a leading slash and removing
+    trailing slashes. The root path is already normalized by get_root_path().
+
+    Args:
+        scope: The ASGI scope dictionary containing the root_path key
+        path: The path to prepend the root path to (e.g., "/login", "logout")
+
+    Returns:
+        The normalized path with root path prepended if configured,
+        otherwise just the normalized path. Never has a trailing slash
+        except when the result is just "/".
+
+    Examples:
+        With root_path="/apps/phoenix":
+        - prepend_root_path(request.scope, "/login") -> "/apps/phoenix/login"
+        - prepend_root_path(request.scope, "login") -> "/apps/phoenix/login"
+        - prepend_root_path(request.scope, "/") -> "/apps/phoenix"
+        - prepend_root_path(request.scope, "") -> "/apps/phoenix"
+        - prepend_root_path(request.scope, "login/") -> "/apps/phoenix/login"
+        - prepend_root_path(request.scope, "/login/") -> "/apps/phoenix/login"
+        - prepend_root_path(request.scope, "abc/def/") -> "/apps/phoenix/abc/def"
+
+        With no root_path:
+        - prepend_root_path(request.scope, "/login") -> "/login"
+        - prepend_root_path(request.scope, "login") -> "/login"
+        - prepend_root_path(request.scope, "/") -> "/"
+        - prepend_root_path(request.scope, "") -> "/"
+        - prepend_root_path(request.scope, "login/") -> "/login"
+        - prepend_root_path(request.scope, "/login/") -> "/login"
+        - prepend_root_path(request.scope, "abc/def/") -> "/abc/def"
+    """
+    path = path if path.startswith("/") else f"/{path}"
+    path = path.rstrip("/") or "/"
+    root_path = get_root_path(scope)
+    if path == "/":
+        return root_path or "/"
+    return f"{root_path}{path}"
+
+
+def get_root_path(scope: Mapping[str, Any]) -> str:
+    """
+    Extracts and normalizes the root path from the ASGI scope.
+
+    The root path is typically set by reverse proxies or when the application
+    is mounted at a sub-path (e.g., "/apps/phoenix" when behind a proxy).
+    If present, ensures the path has a leading slash and removes trailing slashes.
+
+    Args:
+        scope: The ASGI scope dictionary containing the root_path key
+
+    Returns:
+        The normalized root path as a string (with leading slash, no trailing slash)
+        if configured, otherwise empty string.
+
+    Examples:
+        - Behind proxy at "/apps/phoenix": returns "/apps/phoenix"
+        - Missing leading slash "apps/phoenix": returns "/apps/phoenix"
+        - With trailing slash "/apps/phoenix/": returns "/apps/phoenix"
+        - Direct deployment: returns ""
+        - None in scope: returns ""
+    """
+    root_path = str(scope.get("root_path") or "")
+    if not root_path:
+        return ""
+    if not root_path.startswith("/"):
+        root_path = f"/{root_path}"
+    return root_path.rstrip("/")

phoenix/session/client.py

@@ -19,7 +19,7 @@ from opentelemetry.proto.common.v1.common_pb2 import AnyValue, KeyValue
 from opentelemetry.proto.resource.v1.resource_pb2 import Resource
 from opentelemetry.proto.trace.v1.trace_pb2 import ResourceSpans, ScopeSpans
 from pyarrow import ArrowInvalid, Table
-from typing_extensions import TypeAlias, assert_never
+from typing_extensions import TypeAlias, assert_never, deprecated
 
 from phoenix.config import (
     get_env_collector_endpoint,
@@ -110,6 +110,7 @@ class Client(TraceDataExtractor):
             return session.url
         return str(self._client.base_url)
 
+    @deprecated("Migrate to using client.spans.get_spans_dataframe via arize-phoenix-client")
     def query_spans(
         self,
         *queries: SpanQuery,
@@ -124,6 +125,11 @@ class Client(TraceDataExtractor):
         orphan_span_as_root_span: bool = True,
     ) -> Optional[Union[pd.DataFrame, list[pd.DataFrame]]]:
         """
+        .. deprecated::
+            This method is deprecated. Use ``client.spans.get_spans_dataframe()`` via
+            arize-phoenix-client instead.
+            See https://arize-phoenix.readthedocs.io/projects/client/en/latest/
+
         Queries spans from the Phoenix server or active session based on specified criteria.
 
         Args:
@@ -222,6 +228,7 @@ class Client(TraceDataExtractor):
             return None if df.shape == (0, 0) else df
         return results
 
+    @deprecated("Migrate to using client.spans.get_span_annotations via arize-phoenix-client")
     def get_evaluations(
         self,
         project_name: Optional[str] = None,
@@ -229,6 +236,11 @@ class Client(TraceDataExtractor):
         timeout: Optional[int] = DEFAULT_TIMEOUT_IN_SECONDS,
     ) -> list[Evaluations]:
         """
+        .. deprecated::
+            This method is deprecated. Use ``client.spans.get_span_annotations()`` via
+            arize-phoenix-client instead.
+            See https://arize-phoenix.readthedocs.io/projects/client/en/latest/
+
         Retrieves evaluations for a given project from the Phoenix server or active session.
 
         Args:
@@ -276,6 +288,7 @@ class Client(TraceDataExtractor):
                 f"with `import phoenix as px; px.launch_app()`"
             )
 
+    @deprecated("Migrate to using client.spans.log_span_annotations via arize-phoenix-client")
     def log_evaluations(
         self,
         *evals: Evaluations,
@@ -283,6 +296,11 @@ class Client(TraceDataExtractor):
         **kwargs: Any,
     ) -> None:
         """
+        .. deprecated::
+            This method is deprecated. Use ``client.spans.log_span_annotations()`` via
+            arize-phoenix-client instead.
+            See https://arize-phoenix.readthedocs.io/projects/client/en/latest/
+
         Logs evaluation data to the Phoenix server.
 
         Args:
@@ -309,8 +327,14 @@ class Client(TraceDataExtractor):
                 timeout=timeout,
             ).raise_for_status()
 
+    @deprecated("Migrate to using client.spans.log_spans via arize-phoenix-client")
     def log_traces(self, trace_dataset: TraceDataset, project_name: Optional[str] = None) -> None:
         """
+        .. deprecated::
+            This method is deprecated. Use ``client.spans.log_spans()`` via
+            arize-phoenix-client instead.
+            See https://arize-phoenix.readthedocs.io/projects/client/en/latest/
+
         Logs traces from a TraceDataset to the Phoenix server.
 
         Args:
@@ -379,6 +403,7 @@ class Client(TraceDataExtractor):
         dataset = records[0]
         return str(dataset["id"])
 
+    @deprecated("Migrate to using client.datasets.get_dataset via arize-phoenix-client")
     def get_dataset(
         self,
         *,
@@ -387,6 +412,11 @@ class Client(TraceDataExtractor):
         version_id: Optional[str] = None,
     ) -> Dataset:
         """
+        .. deprecated::
+            This method is deprecated. Use ``client.datasets.get_dataset()`` via
+            arize-phoenix-client instead.
+            See https://arize-phoenix.readthedocs.io/projects/client/en/latest/
+
         Gets the dataset for a specific version, or gets the latest version of
         the dataset if no version is specified.
 
@@ -433,6 +463,7 @@ class Client(TraceDataExtractor):
             examples=examples,
         )
 
+    @deprecated("Migrate to using client.datasets.get_dataset_versions via arize-phoenix-client")
     def get_dataset_versions(
         self,
         dataset_id: str,
@@ -440,6 +471,11 @@ class Client(TraceDataExtractor):
         limit: Optional[int] = 100,
     ) -> pd.DataFrame:
         """
+        .. deprecated::
+            This method is deprecated. Use ``client.datasets.get_dataset_versions()`` via
+            arize-phoenix-client instead.
+            See https://arize-phoenix.readthedocs.io/projects/client/en/latest/
+
         Get dataset versions as pandas DataFrame.
 
         Args:
@@ -459,6 +495,7 @@ class Client(TraceDataExtractor):
         df["created_at"] = df["created_at"].apply(datetime.fromisoformat)
         return df
 
+    @deprecated("Migrate to using client.datasets.create_dataset via arize-phoenix-client")
     def upload_dataset(
         self,
         *,
@@ -474,6 +511,11 @@ class Client(TraceDataExtractor):
         dataset_description: Optional[str] = None,
     ) -> Dataset:
         """
+        .. deprecated::
+            This method is deprecated. Use ``client.datasets.create_dataset()`` via
+            arize-phoenix-client instead.
+            See https://arize-phoenix.readthedocs.io/projects/client/en/latest/
+
         Upload examples as dataset to the Phoenix server. If `dataframe` or
         `csv_file_path` are provided, must also provide `input_keys` (and
         optionally with `output_keys` or `metadata_keys` or both), which is a
@@ -535,6 +577,7 @@ class Client(TraceDataExtractor):
             dataset_description=dataset_description,
         )
 
+    @deprecated("Migrate to using client.datasets.add_examples_to_dataset via arize-phoenix-client")
     def append_to_dataset(
         self,
         *,
@@ -549,6 +592,11 @@ class Client(TraceDataExtractor):
         metadata: Iterable[Mapping[str, Any]] = (),
     ) -> Dataset:
         """
+        .. deprecated::
+            This method is deprecated. Use ``client.datasets.add_examples_to_dataset()`` via
+            arize-phoenix-client instead.
+            See https://arize-phoenix.readthedocs.io/projects/client/en/latest/
+
         Append examples to dataset on the Phoenix server. If `dataframe` or
         `csv_file_path` are provided, must also provide `input_keys` (and
         optionally with `output_keys` or `metadata_keys` or both), which is a
@@ -609,8 +657,14 @@ class Client(TraceDataExtractor):
             action="append",
         )
 
+    @deprecated("Migrate to using client.experiments.get_experiment via arize-phoenix-client")
     def get_experiment(self, *, experiment_id: str) -> Experiment:
         """
+        .. deprecated::
+            This method is deprecated. Use ``client.experiments.get_experiment()`` via
+            arize-phoenix-client instead.
+            See https://arize-phoenix.readthedocs.io/projects/client/en/latest/
+
         Get an experiment by ID.
 
         Retrieve an Experiment object by ID, enables running `evaluate_experiment` after finishing

phoenix/session/data_extractor.py

@@ -3,6 +3,7 @@ from datetime import datetime
 from typing import Optional, Union, cast
 
 import pandas as pd
+from typing_extensions import deprecated
 
 from phoenix.trace import Evaluations
 from phoenix.trace.dsl import SpanQuery
@@ -18,6 +19,7 @@ class TraceDataExtractor(ABC):
     `Session` so that they both implement the same methods.
     """
 
+    @deprecated("Migrate to client.spans.get_spans_dataframe() from arize-phoenix-client")
     @abstractmethod
     def query_spans(
         self,
@@ -30,6 +32,7 @@ class TraceDataExtractor(ABC):
         timeout: Optional[int] = DEFAULT_TIMEOUT_IN_SECONDS,
     ) -> Optional[Union[pd.DataFrame, list[pd.DataFrame]]]: ...
 
+    @deprecated("Migrate to client.spans.get_spans_dataframe() from arize-phoenix-client")
     def get_spans_dataframe(
         self,
         filter_condition: Optional[str] = None,
@@ -55,11 +58,13 @@ class TraceDataExtractor(ABC):
         )
 
     @abstractmethod
+    @deprecated("Migrate to client.spans.get_span_annotations() from arize-phoenix-client")
     def get_evaluations(
         self,
         project_name: Optional[str] = None,
     ) -> list[Evaluations]: ...
 
+    @deprecated("Migrate to client.spans.get_spans() from arize-phoenix-client")
     def get_trace_dataset(
         self,
         project_name: Optional[str] = None,

phoenix/session/evaluation.py

@@ -19,6 +19,7 @@ from typing import (
 
 import pandas as pd
 from google.protobuf.wrappers_pb2 import DoubleValue, StringValue
+from typing_extensions import deprecated
 
 import phoenix.trace.v1 as pb
 from phoenix.config import get_env_collector_endpoint, get_env_host, get_env_port
@@ -136,16 +137,19 @@ def _extract_result(row: "pd.Series[Any]") -> Optional[pb.Evaluation.Result]:
     )
 
 
+@deprecated("Migrate to using client.spans.log_span_annotations via arize-phoenix-client")
 def log_evaluations(
     *evals: Evaluations,
     endpoint: Optional[str] = None,
     host: Optional[str] = None,
     port: Optional[int] = None,
 ) -> None:
-    logger.warning(
-        "This `log_evaluations` function is deprecated and will be removed in a future release. "
-        "Please use `px.Client().log_evaluations(*evaluations)` instead."
-    )
+    """
+    .. deprecated::
+        This function is deprecated. Use ``client.spans.log_span_annotations()`` via
+        arize-phoenix-client instead.
+        See https://arize-phoenix.readthedocs.io/projects/client/en/latest/
+    """
     host = host or get_env_host()
     if host == "0.0.0.0":
         host = "127.0.0.1"

phoenix/session/session.py

@@ -12,10 +12,11 @@ from importlib.util import find_spec
 from itertools import chain
 from pathlib import Path
 from tempfile import TemporaryDirectory
-from typing import TYPE_CHECKING, Any, NamedTuple, Optional, Union
+from typing import TYPE_CHECKING, Any, Awaitable, Callable, NamedTuple, Optional, Union
 from urllib.parse import urljoin
 
 import pandas as pd
+from typing_extensions import deprecated
 
 from phoenix.config import (
     ENV_NOTEBOOK_ENV,
@@ -25,6 +26,7 @@ from phoenix.config import (
     ensure_working_dir_if_needed,
     get_env_database_connection_str,
     get_env_host,
+    get_env_host_root_path,
     get_env_port,
     get_exported_files,
     get_working_dir,
@@ -117,6 +119,7 @@ class Session(TraceDataExtractor, ABC):
         default_umap_parameters: Optional[Mapping[str, Any]] = None,
         host: Optional[str] = None,
         port: Optional[int] = None,
+        root_path: Optional[str] = None,
         notebook_env: Optional[NotebookEnvironment] = None,
     ):
         self._database_url = database_url
@@ -132,12 +135,21 @@ class Session(TraceDataExtractor, ABC):
         self.export_path.mkdir(parents=True, exist_ok=True)
         self.exported_data = ExportedData()
         self.notebook_env = notebook_env or _get_notebook_environment()
-        self.root_path = _get_root_path(self.notebook_env, self.port)
+        self.root_path = (
+            (get_env_host_root_path() or _get_root_path(self.notebook_env, self.port))
+            if root_path is None
+            else root_path
+        )
+        if self.root_path and self.root_path != "/":
+            if not self.root_path.startswith("/"):
+                self.root_path = f"/{self.root_path}"
+            self.root_path = self.root_path.rstrip("/")
         host = "127.0.0.1" if self.host == "0.0.0.0" else self.host
         self._client = Client(
             endpoint=f"http://{host}:{self.port}", warn_if_server_not_running=False
         )
 
+    @deprecated("Migrate to using client.spans.get_spans_dataframe via arize-phoenix-client")
     def query_spans(
         self,
         *queries: SpanQuery,
@@ -151,6 +163,11 @@ class Session(TraceDataExtractor, ABC):
         timeout: Optional[int] = DEFAULT_TIMEOUT_IN_SECONDS,
     ) -> Optional[Union[pd.DataFrame, list[pd.DataFrame]]]:
         """
+        .. deprecated::
+            This method is deprecated. Use ``client.spans.get_spans_dataframe()`` via
+            arize-phoenix-client instead.
+            See https://arize-phoenix.readthedocs.io/projects/client/en/latest/
+
         Queries the spans in the project based on the provided parameters.
 
         Parameters
@@ -192,11 +209,17 @@ class Session(TraceDataExtractor, ABC):
             project_name=project_name,
         )
 
+    @deprecated("Migrate to using client.spans.get_span_annotations via arize-phoenix-client")
     def get_evaluations(
         self,
         project_name: Optional[str] = None,
     ) -> list[Evaluations]:
         """
+        .. deprecated::
+            This method is deprecated. Use ``client.spans.get_span_annotations()`` via
+            arize-phoenix-client instead.
+            See https://arize-phoenix.readthedocs.io/projects/client/en/latest/
+
         Get the evaluations for a project.
 
         Parameters
@@ -255,7 +278,7 @@ class Session(TraceDataExtractor, ABC):
     @property
     def url(self) -> str:
         """Returns the url for the phoenix app"""
-        return _get_url(self.host, self.port, self.notebook_env)
+        return _get_url(self.host, self.port, self.notebook_env, self.root_path)
 
     @property
     def database_url(self) -> str:
@@ -288,6 +311,7 @@ class ProcessSession(Session):
             default_umap_parameters=default_umap_parameters,
             host=host,
             port=port,
+            root_path=root_path,
             notebook_env=notebook_env,
         )
         primary_inferences.to_disc()
@@ -354,6 +378,7 @@ class ThreadSession(Session):
             default_umap_parameters=default_umap_parameters,
             host=host,
             port=port,
+            root_path=root_path,
             notebook_env=notebook_env,
         )
         self.model = create_model_from_inferences(
@@ -369,7 +394,10 @@ class ThreadSession(Session):
         )
         # Initialize an app service that keeps the server running
         engine = create_engine_and_run_migrations(database_url)
-        instrumentation_cleanups = instrument_engine_if_enabled(engine)
+        shutdown_callbacks: list[Callable[[], None | Awaitable[None]]] = []
+        shutdown_callbacks.extend(instrument_engine_if_enabled(engine))
+        # Ensure engine is disposed on shutdown to properly close database connections
+        shutdown_callbacks.append(engine.dispose)
         factory = DbSessionFactory(db=_db(engine), dialect=engine.dialect.name)
         self.app = create_app(
             db=factory,
@@ -384,7 +412,7 @@ class ThreadSession(Session):
                 if (trace_dataset and (initial_evaluations := trace_dataset.evaluations))
                 else None
             ),
-            shutdown_callbacks=instrumentation_cleanups,
+            shutdown_callbacks=shutdown_callbacks,
         )
         self.server = ThreadServer(
             app=self.app,
@@ -436,6 +464,7 @@ def launch_app(
     default_umap_parameters: Optional[Mapping[str, Any]] = None,
     host: Optional[str] = None,
     port: Optional[int] = None,
+    root_path: Optional[str] = None,
     run_in_thread: bool = True,
     notebook_environment: Optional[Union[NotebookEnvironment, str]] = None,
     use_temp_dir: bool = True,
@@ -461,6 +490,9 @@ def launch_app(
         The port on which the server listens. When using traces this should not be
         used and should instead set the environment variable `PHOENIX_PORT`.
         Defaults to 6006.
+    root_path: str, optional
+        The root path to serve the application under (useful when behind a proxy).
+        Can also be set using environment variable `PHOENIX_HOST_ROOT_PATH`.
     run_in_thread: bool, optional, default=True
         Whether the server should run in a Thread or Process.
     default_umap_parameters: dict[str, Union[int, float]], optional, default=None
@@ -573,6 +605,7 @@ def launch_app(
             default_umap_parameters,
             host=host,
             port=port,
+            root_path=root_path,
             notebook_env=nb_env,
         )
         # TODO: catch exceptions from thread
@@ -586,6 +619,7 @@ def launch_app(
             default_umap_parameters,
             host=host,
             port=port,
+            root_path=root_path,
             notebook_env=nb_env,
         )
 
@@ -636,7 +670,7 @@ def close_app(delete_data: bool = False) -> None:
         delete_all(prompt_before_delete=False)
 
 
-def _get_url(host: str, port: int, notebook_env: NotebookEnvironment) -> str:
+def _get_url(host: str, port: int, notebook_env: NotebookEnvironment, root_path: str) -> str:
     """Determines the IFrame URL based on whether this is in a Colab or in a local notebook"""
     if notebook_env == NotebookEnvironment.COLAB:
         from google.colab.output import eval_js
@@ -648,10 +682,12 @@ def _get_url(host: str, port: int, notebook_env: NotebookEnvironment) -> str:
     if notebook_env == NotebookEnvironment.DATABRICKS:
         context = _get_databricks_context()
         return f"{_get_databricks_notebook_base_url(context)}/{port}/"
+    if not root_path.startswith("/"):
+        root_path = f"/{root_path}"
     if host == "0.0.0.0" or host == "127.0.0.1":
         # The app is running locally, so use localhost
-        return f"http://localhost:{port}/"
-    return f"http://{host}:{port}/"
+        return f"http://localhost:{port}{root_path}"
+    return f"http://{host}:{port}{root_path}"
 
 
 def _is_colab() -> bool:

phoenix/settings.py

@@ -21,6 +21,8 @@ class _Settings:
     disable_migrations: bool = field(default=False)
     # FullStory organization ID for web analytics tracking
     fullstory_org: Optional[str] = field(default=None)
+    # Scarf.sh pixel ID for open-source analytics and usage
+    scarf_sh_pixel_id: Optional[str] = field(default=None)
 
 
 # Singleton instance of the settings