arize-phoenix 3.8.0__py3-none-any.whl → 3.10.0__py3-none-any.whl

phoenix/session/client.py

@@ -11,7 +11,12 @@ from pyarrow import ArrowInvalid
 from requests import Session
 
 import phoenix as px
-from phoenix.config import get_env_collector_endpoint, get_env_host, get_env_port
+from phoenix.config import (
+    get_env_collector_endpoint,
+    get_env_host,
+    get_env_port,
+    get_env_project_name,
+)
 from phoenix.session.data_extractor import TraceDataExtractor
 from phoenix.trace import Evaluations
 from phoenix.trace.dsl import SpanQuery
@@ -59,6 +64,7 @@ class Client(TraceDataExtractor):
         root_spans_only: Optional[bool] = None,
         project_name: Optional[str] = None,
     ) -> Optional[Union[pd.DataFrame, List[pd.DataFrame]]]:
+        project_name = project_name or get_env_project_name()
         if not queries:
             queries = (SpanQuery(),)
         if self._use_active_session_if_available and (session := px.active_session()):
@@ -102,6 +108,7 @@ class Client(TraceDataExtractor):
         self,
         project_name: Optional[str] = None,
     ) -> List[Evaluations]:
+        project_name = project_name or get_env_project_name()
         if self._use_active_session_if_available and (session := px.active_session()):
             return session.get_evaluations(project_name=project_name)
         response = self._session.get(

phoenix/session/session.py

@@ -1,6 +1,7 @@
 import json
 import logging
 import os
+import warnings
 from abc import ABC, abstractmethod
 from collections import UserList
 from datetime import datetime
@@ -24,12 +25,14 @@ import pandas as pd
 from phoenix.config import (
     ENV_NOTEBOOK_ENV,
     ENV_PHOENIX_COLLECTOR_ENDPOINT,
+    ENV_PHOENIX_HOST,
+    ENV_PHOENIX_PORT,
     get_env_host,
     get_env_port,
+    get_env_project_name,
     get_exported_files,
 )
 from phoenix.core.model_schema_adapter import create_model_from_datasets
-from phoenix.core.project import DEFAULT_PROJECT_NAME
 from phoenix.core.traces import Traces
 from phoenix.datasets.dataset import EMPTY_DATASET, Dataset
 from phoenix.pointcloud.umap_parameters import get_umap_parameters
@@ -331,8 +334,34 @@ class ThreadSession(Session):
         root_spans_only: Optional[bool] = None,
         project_name: Optional[str] = None,
     ) -> Optional[Union[pd.DataFrame, List[pd.DataFrame]]]:
+        """
+        Queries the spans in the project based on the provided parameters.
+
+        Parameters
+        ----------
+            queries : *SpanQuery
+                Variable-length argument list of SpanQuery objects representing
+                the queries to be executed.
+
+            start_time : datetime, optional
+                 datetime representing the start time of the query.
+
+            stop_time : datetime, optional
+                datetime representing the stop time of the query.
+
+            root_spans_only : boolean, optional
+                whether to include only root spans in the results.
+
+            project_name : string, optional
+                name of the project to query. Defaults to the project name set
+                in the environment variable `PHOENIX_PROJECT_NAME` or 'default' if not set.
+
+        Returns:
+            results : DataFrame
+                DataFrame or list of DataFrames containing the query results.
+        """
         if not (traces := self.traces) or not (
-            project := traces.get_project(project_name or DEFAULT_PROJECT_NAME)
+            project := traces.get_project(project_name or get_env_project_name())
         ):
             return None
         if not queries:
@@ -362,9 +391,24 @@ class ThreadSession(Session):
         self,
         project_name: Optional[str] = None,
     ) -> List[Evaluations]:
-        if not (traces := self.traces) or not (
-            project := traces.get_project(project_name or DEFAULT_PROJECT_NAME)
-        ):
+        """
+        Get the evaluations for a project.
+
+        Parameters
+        ----------
+            project_name :  str, optional
+                The name of the project. If not provided, the project name set
+                in the environment variable `PHOENIX_PROJECT_NAME` will be used.
+                Otherwise, 'default' will be used.
+
+        Returns
+        -------
+            evaluations : List[Evaluations]
+                A list of evaluations for the specified project.
+
+        """
+        project_name = project_name or get_env_project_name()
+        if not (traces := self.traces) or not (project := traces.get_project(project_name)):
             return []
         return project.export_evaluations()
 
@@ -454,6 +498,29 @@ def launch_app(
     else:
         nb_env = notebook_environment
 
+    if port is not None:
+        warning_message = (
+            "❗️ The launch_app `port` parameter is deprecated and "
+            "will be removed in a future release. "
+            f"Use the `{ENV_PHOENIX_PORT}` environment variable instead."
+        )
+        print(warning_message)
+        warnings.warn(
+            warning_message,
+            DeprecationWarning,
+        )
+    if host is not None:
+        warning_message = (
+            "❗️ The launch_app `host` parameter is deprecated and "
+            "will be removed in a future release. "
+            f"Use the `{ENV_PHOENIX_HOST}` environment variable instead."
+        )
+        print(warning_message)
+        warnings.warn(
+            warning_message,
+            DeprecationWarning,
+        )
+
     host = host or get_env_host()
     port = port or get_env_port()
 

phoenix/trace/langchain/instrumentor.py

@@ -4,9 +4,12 @@ from importlib.util import find_spec
 from typing import Any
 
 from openinference.instrumentation.langchain import LangChainInstrumentor as Instrumentor
+from openinference.semconv.resource import ResourceAttributes
 from opentelemetry.sdk import trace as trace_sdk
+from opentelemetry.sdk.resources import Resource
 from opentelemetry.sdk.trace.export import SimpleSpanProcessor
 
+from phoenix.config import get_env_project_name
 from phoenix.trace.exporter import _OpenInferenceExporter
 from phoenix.trace.tracer import _show_deprecation_warnings
 
@@ -26,6 +29,8 @@ class LangChainInstrumentor(Instrumentor):
         super().__init__()
 
     def instrument(self) -> None:
-        tracer_provider = trace_sdk.TracerProvider()
+        tracer_provider = trace_sdk.TracerProvider(
+            resource=Resource({ResourceAttributes.PROJECT_NAME: get_env_project_name()})
+        )
         tracer_provider.add_span_processor(SimpleSpanProcessor(_OpenInferenceExporter()))
         super().instrument(skip_dep_check=True, tracer_provider=tracer_provider)

phoenix/trace/llama_index/callback.py

@@ -1,12 +1,14 @@
 import logging
 from importlib.metadata import PackageNotFoundError, version
-from importlib.util import find_spec
-from typing import Any
+from typing import Any, Optional, Tuple
 
+from openinference.semconv.resource import ResourceAttributes
 from opentelemetry import trace as trace_api
 from opentelemetry.sdk import trace as trace_sdk
+from opentelemetry.sdk.resources import Resource
 from opentelemetry.sdk.trace.export import SimpleSpanProcessor
 
+from phoenix.config import get_env_project_name
 from phoenix.trace.errors import IncompatibleLibraryVersionError
 from phoenix.trace.exporter import _OpenInferenceExporter
 from phoenix.trace.tracer import _show_deprecation_warnings
@@ -18,39 +20,61 @@ INSTRUMENTATION_MODERN_VERSION = (1, 0, 0)
 
 
 def _check_instrumentation_compatibility() -> bool:
-    if find_spec("llama_index") is None:
-        raise PackageNotFoundError("Missing `llama-index`. Install with `pip install llama-index`.")
-    # split the version string into a tuple of integers
-    llama_index_version_str = version("llama-index")
-    llama_index_version = tuple(map(int, llama_index_version_str.split(".")[:3]))
+    llama_index_version_str = _get_version_if_installed("llama-index")
+    llama_index_installed = llama_index_version_str is not None
+    llama_index_core_version_str = _get_version_if_installed("llama-index-core")
+    llama_index_core_installed = modern_llama_index_installed = (
+        llama_index_core_version_str is not None
+    )
     instrumentation_version_str = version("openinference-instrumentation-llama-index")
-    instrumentation_version = tuple(map(int, instrumentation_version_str.split(".")[:3]))
-    # check if the llama_index version is compatible with the instrumentation version
-    if (
-        llama_index_version < LLAMA_INDEX_MODERN_VERSION
+    instrumentation_version = _parse_semantic_version(instrumentation_version_str)
+
+    if not llama_index_installed and not llama_index_core_installed:
+        raise PackageNotFoundError(
+            "Missing `llama_index`. "
+            "Install with `pip install llama-index` or "
+            "`pip install llama-index-core` for a minimal installation."
+        )
+    elif modern_llama_index_installed and instrumentation_version < INSTRUMENTATION_MODERN_VERSION:
+        raise IncompatibleLibraryVersionError(
+            f"llama-index-core v{llama_index_core_version_str} is not compatible with "
+            f"openinference-instrumentation-llama-index v{instrumentation_version_str}. "
+            "Please upgrade openinference-instrumentation-llama-index to at least 1.0.0 via "
+            "`pip install 'openinference-instrumentation-llama-index>=1.0.0'`."
+        )
+    elif (
+        llama_index_installed
+        and llama_index_version_str
+        and _parse_semantic_version(llama_index_version_str) < LLAMA_INDEX_MODERN_VERSION
         and instrumentation_version >= INSTRUMENTATION_MODERN_VERSION
     ):
         raise IncompatibleLibraryVersionError(
             f"llama-index v{llama_index_version_str} is not compatible with "
-            f"openinference-instrumentation-llama-index v{instrumentation_version_str}."
+            f"openinference-instrumentation-llama-index v{instrumentation_version_str}. "
             "Please either migrate llama-index to at least 0.10.0 or downgrade "
             "openinference-instrumentation-llama-index via "
             "`pip install 'openinference-instrumentation-llama-index<1.0.0'`."
         )
-    elif (
-        llama_index_version >= LLAMA_INDEX_MODERN_VERSION
-        and instrumentation_version < INSTRUMENTATION_MODERN_VERSION
-    ):
-        raise IncompatibleLibraryVersionError(
-            f"llama-index v{llama_index_version_str} is not compatible with "
-            f"openinference-instrumentation-llama-index v{instrumentation_version_str}."
-            "Please upgrade openinference-instrumentation-llama-index to at least 1.0.0"
-            "`pip install 'openinference-instrumentation-llama-index>=1.0.0'`."
-        )
-    # if the versions are compatible, return True
     return True
 
 
+def _get_version_if_installed(package_name: str) -> Optional[str]:
+    """
+    Gets the version of the package if it is installed, otherwise, returns None.
+    """
+    try:
+        return version(package_name)
+    except PackageNotFoundError:
+        return None
+
+
+def _parse_semantic_version(semver_string: str) -> Tuple[int, ...]:
+    """
+    Parse a semantic version string into a tuple of integers.
+    """
+    return tuple(map(int, semver_string.split(".")[:3]))
+
+
 if _check_instrumentation_compatibility():
     from openinference.instrumentation.llama_index._callback import (
         OpenInferenceTraceCallbackHandler as _OpenInferenceTraceCallbackHandler,
@@ -72,6 +96,8 @@ class OpenInferenceTraceCallbackHandler(_OpenInferenceTraceCallbackHandler):
 
     def __init__(self, *args: Any, **kwargs: Any) -> None:
         _show_deprecation_warnings(self, *args, **kwargs)
-        tracer_provider = trace_sdk.TracerProvider()
+        tracer_provider = trace_sdk.TracerProvider(
+            resource=Resource({ResourceAttributes.PROJECT_NAME: get_env_project_name()})
+        )
         tracer_provider.add_span_processor(SimpleSpanProcessor(_OpenInferenceExporter()))
         super().__init__(trace_api.get_tracer(__name__, __version__, tracer_provider))

phoenix/trace/openai/instrumentor.py

@@ -4,9 +4,12 @@ from importlib.util import find_spec
 from typing import Any
 
 from openinference.instrumentation.openai import OpenAIInstrumentor as Instrumentor
+from openinference.semconv.resource import ResourceAttributes
 from opentelemetry.sdk import trace as trace_sdk
+from opentelemetry.sdk.resources import Resource
 from opentelemetry.sdk.trace.export import SimpleSpanProcessor
 
+from phoenix.config import get_env_project_name
 from phoenix.trace.exporter import _OpenInferenceExporter
 from phoenix.trace.tracer import _show_deprecation_warnings
 
@@ -21,6 +24,8 @@ class OpenAIInstrumentor(Instrumentor):
         super().__init__()
 
     def instrument(self) -> None:
-        tracer_provider = trace_sdk.TracerProvider()
+        tracer_provider = trace_sdk.TracerProvider(
+            resource=Resource({ResourceAttributes.PROJECT_NAME: get_env_project_name()})
+        )
         tracer_provider.add_span_processor(SimpleSpanProcessor(_OpenInferenceExporter()))
         super().instrument(skip_dep_check=True, tracer_provider=tracer_provider)

phoenix/version.py

@@ -1 +1 @@
-__version__ = "3.8.0"
+__version__ = "3.10.0"

phoenix/server/api/types/DatasetInfo.py

@@ -1,24 +0,0 @@
-from datetime import datetime
-from typing import Optional
-
-import strawberry
-
-
-@strawberry.type
-class DatasetInfo:
-    start_time: datetime = strawberry.field(description="The start bookend of the data")
-    end_time: datetime = strawberry.field(description="The end bookend of the data")
-    record_count: int = strawberry.field(description="The record count of the data")
-
-
-@strawberry.type
-class TraceDatasetInfo(DatasetInfo):
-    token_count_total: int = strawberry.field(
-        description="Count of total (prompt + completion) tokens in the trace data"
-    )
-    latency_ms_p50: Optional[float] = strawberry.field(
-        description="Root span latency p50 quantile in milliseconds"
-    )
-    latency_ms_p99: Optional[float] = strawberry.field(
-        description="Root span latency p99 quantile in milliseconds"
-    )