arize-phoenix 4.8.1__py3-none-any.whl → 4.9.0__py3-none-any.whl

{arize_phoenix-4.8.1.dist-info → arize_phoenix-4.9.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: arize-phoenix
-Version: 4.8.1
+Version: 4.9.0
 Summary: AI Observability and Evaluation
 Project-URL: Documentation, https://docs.arize.com/phoenix/
 Project-URL: Issues, https://github.com/Arize-ai/phoenix/issues

{arize_phoenix-4.8.1.dist-info → arize_phoenix-4.9.0.dist-info}/RECORD

@@ -5,7 +5,7 @@ phoenix/exceptions.py,sha256=n2L2KKuecrdflB9MsCdAYCiSEvGJptIsfRkXMoJle7A,169
 phoenix/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 phoenix/services.py,sha256=aTxhcOA1pZHB6U-B3TEcp6fqDF5oT0xCUvEUNMZVTUQ,5175
 phoenix/settings.py,sha256=cO-qgis_S27nHirTobYI9hHPfZH18R--WMmxNdsVUwc,273
-phoenix/version.py,sha256=5LMFXHH6L0xgmxA0DlLrNZtG0vHgJ8uHcls9atNfDqI,22
+phoenix/version.py,sha256=E0Y9rD8RWyBe6e34I0525HrRS_vGhPvve493oPOdtXw,22
 phoenix/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 phoenix/core/embedding_dimension.py,sha256=zKGbcvwOXgLf-yrJBpQyKtd-LEOPRKHnUToyAU8Owis,87
 phoenix/core/model.py,sha256=km_a--PBHOuA337ClRw9xqhOHhrUT6Rl9pz_zV0JYkQ,4843
@@ -43,7 +43,7 @@ phoenix/experiments/evaluators/utils.py,sha256=SroMoxmPZIFCi2MbEOvXlBAFJbEZY2IWg
 phoenix/inferences/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 phoenix/inferences/errors.py,sha256=cGp9vxnw4SewFoWBV3ZGMkhE0Kh73lPIv3Ppz_H_RoA,8261
 phoenix/inferences/fixtures.py,sha256=FC2eRL4dpobKQHYOilFtDexUWFkMZ_w6jun_4WkbMk0,20792
-phoenix/inferences/inferences.py,sha256=YVZ56vZXgV0gVrDhFxcaPlawoDm5cFm2GQpaPkbZE-4,30718
+phoenix/inferences/inferences.py,sha256=aH2uHRJR4_W7CVy3EMEioaEBM8cTRYBUyVuDDVjwVXw,31106
 phoenix/inferences/schema.py,sha256=UYej9IJ6pFeNW3fq721kJy16ONso_xVDm78Q68G4hl4,6643
 phoenix/inferences/validation.py,sha256=fdmbsjUBwtacRiVFdh9aem-QrgPfq_OlEmPdascWluc,8297
 phoenix/metrics/README.md,sha256=5gekqTU-5gGdMwvcfNp2Wlu8p1ul9kGY_jq0XXQusoI,1964
@@ -125,7 +125,7 @@ phoenix/server/api/mutations/auth.py,sha256=vPRFoj7J6PV6QeODewG4K0PhoOebS5AfMRpb
 phoenix/server/api/mutations/dataset_mutations.py,sha256=CuKhxsYfvwVcdN_9EXhKxB6444BQfObzKzzyfAeg-n8,23199
 phoenix/server/api/mutations/experiment_mutations.py,sha256=vV2lbJ7ccXZqe-LY7nXx6QxWqhKQE4UNZAFcML-KQ8I,3011
 phoenix/server/api/mutations/export_events_mutations.py,sha256=t_wYBxaqvBJYRoHslh3Bmoxmwlzoy0u8SsBKWIKN5hE,4028
-phoenix/server/api/mutations/project_mutations.py,sha256=3SVDCZqxB0Iv60cOwBL8c-rY3QUUPs8PXbp-C_K1mWY,2267
+phoenix/server/api/mutations/project_mutations.py,sha256=d_xtYkYfZ5flpVgEkGknKB8rsEux-zZraczzqAs4e8A,2255
 phoenix/server/api/openapi/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 phoenix/server/api/openapi/main.py,sha256=WY0pj3B7siQyyYqKyhqnzWC7P8MtEtiukOBUjGwLXfw,153
 phoenix/server/api/openapi/schema.py,sha256=uuSYe1Ecu72aXRgTNjyMu-9ZPE13DAHJPKtedS-MsSs,451
@@ -203,12 +203,12 @@ phoenix/server/static/apple-touch-icon-76x76.png,sha256=CT_xT12I0u2i0WU8JzBZBuOQ
 phoenix/server/static/apple-touch-icon.png,sha256=fOfpjqGpWYbJ0eAurKsyoZP1EAs6ZVooBJ_SGk2ZkDs,3801
 phoenix/server/static/favicon.ico,sha256=bY0vvCKRftemZfPShwZtE93DiiQdaYaozkPGwNFr6H8,34494
 phoenix/server/static/index.css,sha256=KKGpx4iwF91VGRm0YN-4cn8oC-oIqC6HecoPf0x3ZM8,1885
-phoenix/server/static/index.js,sha256=sUkm_imwx5uXpCQxQEPmX-axDr094HE1wGdBznF8J_E,3524949
+phoenix/server/static/index.js,sha256=fo34I1yr65xkACAvw2LCNTDFMTpTQjKV3C1_oL1mWYg,3524937
 phoenix/server/static/modernizr.js,sha256=mvK-XtkNqjOral-QvzoqsyOMECXIMu5BQwSVN_wcU9c,2564
 phoenix/server/templates/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 phoenix/server/templates/index.html,sha256=S4z7qSoNSwnKFAH9r96AR-YJEyoKMd-VMWVlJ_IdzME,2039
 phoenix/session/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-phoenix/session/client.py,sha256=43MmopBHxPq2MprbSXixAzQyGr0VRhHEYZZ6WvITq1I,32343
+phoenix/session/client.py,sha256=8dWs_-boxhrqJ-MQMkhXYYL_1YBDccz83nwirJdtBp0,32400
 phoenix/session/data_extractor.py,sha256=dwhiDu-ISaXr8UI9I-CszZhB5BlUNmdDopjFZvMIXMw,2101
 phoenix/session/evaluation.py,sha256=aKeV8UVOyq3b7CYOwt3cWuLz0xzvMjX7vlEPILJ_fcs,5311
 phoenix/session/session.py,sha256=rjIuSSK2gAYIUPQTJc4E2ebew5o6I070FWRoFn4W3EI,26620
@@ -224,7 +224,7 @@ phoenix/trace/schemas.py,sha256=Mjc6fD9OyeMnEk5wPPSbveqnNUYWK3p3BxpOvSGanHU,5950
 phoenix/trace/span_evaluations.py,sha256=GaADtJLi2njra4aYaie0BIwkSgdxPB_SNseglI4ykZA,13104
 phoenix/trace/span_json_decoder.py,sha256=W6T1U0xndE2a-85O1QalJmStJK1zF1IoSU97h1RoWeY,3231
 phoenix/trace/span_json_encoder.py,sha256=tzSCIQJbeFBm33K68G8A5M12n_86tCDyuU0WAobxEz4,2010
-phoenix/trace/trace_dataset.py,sha256=9qDs8T3QQOTN9fHZzyeJlAvR-yW7tkq1OvV0xWILgzA,13917
+phoenix/trace/trace_dataset.py,sha256=Wq89jJ4hYQ1Qt-Uj11ZNzKQYQeKmGY6NqWStQiiTlMw,14351
 phoenix/trace/utils.py,sha256=7LurVGXn245cjj4MJsc7v6jq4DSJkpK6YGBfIaSywuw,1307
 phoenix/trace/dsl/README.md,sha256=ihmP9zGUC5V-TDbzKla76LuyDqPDQIBUH2BORwxNI68,2902
 phoenix/trace/dsl/__init__.py,sha256=WIQIjJg362XD3s50OsPJJ0xbDsGp41bSv7vDllLrPuA,144
@@ -248,8 +248,8 @@ phoenix/utilities/logging.py,sha256=lDXd6EGaamBNcQxL4vP1au9-i_SXe0OraUDiJOcszSw,
 phoenix/utilities/project.py,sha256=qWsvKnG1oKhOFUowXf9qiOL2ia7jaFe_ijFFHEt8GJo,431
 phoenix/utilities/re.py,sha256=PDve_OLjRTM8yQQJHC8-n3HdIONi7aNils3ZKRZ5uBM,2045
 phoenix/utilities/span_store.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-arize_phoenix-4.8.1.dist-info/METADATA,sha256=cr_RMue_eqzBxlqGELzqha7zvv0EF_J9qfc7grNpekg,11451
-arize_phoenix-4.8.1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-arize_phoenix-4.8.1.dist-info/licenses/IP_NOTICE,sha256=JBqyyCYYxGDfzQ0TtsQgjts41IJoa-hiwDrBjCb9gHM,469
-arize_phoenix-4.8.1.dist-info/licenses/LICENSE,sha256=HFkW9REuMOkvKRACuwLPT0hRydHb3zNg-fdFt94td18,3794
-arize_phoenix-4.8.1.dist-info/RECORD,,
+arize_phoenix-4.9.0.dist-info/METADATA,sha256=yF2f3TQt507o3KgtWsjLWsM4XtMtm0HSus54sjWZo_0,11451
+arize_phoenix-4.9.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+arize_phoenix-4.9.0.dist-info/licenses/IP_NOTICE,sha256=JBqyyCYYxGDfzQ0TtsQgjts41IJoa-hiwDrBjCb9gHM,469
+arize_phoenix-4.9.0.dist-info/licenses/LICENSE,sha256=HFkW9REuMOkvKRACuwLPT0hRydHb3zNg-fdFt94td18,3794
+arize_phoenix-4.9.0.dist-info/RECORD,,

phoenix/inferences/inferences.py

@@ -42,7 +42,13 @@ SchemaLike: TypeAlias = Any
 class Inferences:
     """
     A dataset to use for analysis using phoenix.
-    Used to construct a phoenix session via px.launch_app
+    Used to construct a phoenix session via px.launch_app.
+
+    Typical usage example::
+
+        primary_inferences = px.Inferences(
+            dataframe=production_dataframe, schema=schema, name="primary"
+        )
 
     Parameters
     ----------
@@ -62,9 +68,15 @@ class Inferences:
 
     Examples
     --------
-    >>> primary_inferences = px.Inferences(
-    >>>    dataframe=production_dataframe, schema=schema, name="primary"
-    >>> )
+    Define inferences ds from a pandas dataframe df and a schema object schema by running::
+
+        ds = px.Inferences(df, schema)
+
+    Alternatively, provide a name for the inferences that will appear in the application::
+
+        ds = px.Inferences(df, schema, name="training")
+
+    ds is then passed as the primary or reference argument to launch_app.
     """
 
     _data_file_name: str = "data.parquet"

phoenix/server/api/mutations/project_mutations.py

@@ -38,7 +38,7 @@ class ProjectMutationMixin:
             global_id=input.id, expected_type_name="Project"
         )
         delete_statement = delete(models.Trace).where(models.Trace.project_rowid == project_id)
-        if input.end_time is not None:
+        if input.end_time:
             delete_statement = delete_statement.where(models.Trace.start_time < input.end_time)
         async with info.context.db() as session:
             await session.execute(delete_statement)

phoenix/server/static/index.js

@@ -7844,7 +7844,7 @@ fragment DatasetHistoryTable_versions on Dataset {
           height: 500px;
         `,children:h(Vat,{dataset:n.dataset})})})}function Hat(t){let{datasetId:e}=t,[n,i]=(0,WH.useState)(null);return B($t,{children:[B(Vn,{children:[h(At,{variant:"default",icon:h(ke,{svg:h(Pe.ClockOutline,{})}),"aria-label":"Version History",onClick:()=>{i(h(Jat,{datasetId:e}))}}),h(fr,{children:"Dataset Version History"})]}),h(WH.Suspense,{fallback:null,children:h(Fn,{type:"modal",isDismissable:!0,onDismiss:()=>{i(null)},children:n})})]})}var bY=P(ie());var IGn=`pip install arize-phoenix>=${window.Config.platformVersion}`,pGn=`import os
 # Set the phoenix collector endpoint. Commonly http://localhost:6060 
-os.environ["PHOENIX_COLLECTOR_ENDPOINT"] = "<your-phoenix-url>"`,hGn=`from phoenix.datasets.types import Example
+os.environ["PHOENIX_COLLECTOR_ENDPOINT"] = "<your-phoenix-url>"`,hGn=`from phoenix.experiments import Example
 # Define your task
 # Typically should be an LLM call or a call to your application
 def my_task(example: Example) -> str:
@@ -7855,7 +7855,7 @@ def exact_match(input, output) -> float:
 
 # Store the evaluators for later use
 evaluators = [exact_match]`,CGn=`# Run an experiment
-from phoenix.datasets.experiments import run_experiment
+from phoenix.experiments import run_experiment
 
 experiment = run_experiment(dataset, my_task, evaluators=evaluators)`;function GH(){let[t,e]=(0,bY.useState)(null),n=(0,bY.useCallback)(()=>{e(h(Mn,{title:"Run Experiment",size:"XL",children:h(AGn,{})}))},[]);return B($t,{children:[h(At,{size:"compact",variant:"default",icon:h(ke,{svg:h(Pe.ExperimentOutline,{})}),onClick:n,children:"Run Experiment"}),h(Fn,{isDismissable:!0,type:"slideOver",onDismiss:()=>{e(null)},children:t})]})}function AGn(){let t=ud(i=>i.datasetName),e=ud(i=>i.latestVersion),n=(0,bY.useMemo)(()=>`import phoenix as px
 # Initialize a phoenix client

phoenix/session/client.py

@@ -68,12 +68,12 @@ class Client(TraceDataExtractor):
 
         Args:
             endpoint (str, optional): Phoenix server endpoint, e.g.
-            http://localhost:6006. If not provided, the endpoint will be
-            inferred from the environment variables.
+                http://localhost:6006. If not provided, the endpoint will be
+                inferred from the environment variables.
 
             headers (Mapping[str, str], optional): Headers to include in each
-            network request. If not provided, the headers will be inferred from
-            the environment variables (if present).
+                network request. If not provided, the headers will be inferred from
+                the environment variables (if present).
         """
         if kwargs.pop("use_active_session_if_available", None) is not None:
             print(
@@ -133,7 +133,8 @@ class Client(TraceDataExtractor):
                 using environment variables. If not provided, falls back to the default project.
 
         Returns:
-            Union[pd.DataFrame, List[pd.DataFrame]]: A pandas DataFrame or a list of pandas
+            Union[pd.DataFrame, List[pd.DataFrame]]:
+                A pandas DataFrame or a list of pandas.
                 DataFrames containing the queried span data, or None if no spans are found.
         """
         project_name = project_name or get_env_project_name()
@@ -191,7 +192,8 @@ class Client(TraceDataExtractor):
                 default project.
 
         Returns:
-            List[Evaluations]: A list of Evaluations objects containing evaluation data. Returns an
+            List[Evaluations]:
+                A list of Evaluations objects containing evaluation data. Returns an
                 empty list if no evaluations are found.
         """
         project_name = project_name or get_env_project_name()
@@ -341,10 +343,10 @@ class Client(TraceDataExtractor):
             id (Optional[str]): An ID for the dataset.
 
             name (Optional[str]): the name for the dataset. If provided, the ID
-            is ignored and the dataset is retrieved by name.
+                is ignored and the dataset is retrieved by name.
 
             version_id (Optional[str]): An ID for the version of the dataset, or
-            None.
+                None.
 
         Returns:
             A dataset object.

phoenix/trace/trace_dataset.py

@@ -101,6 +101,14 @@ class TraceDataset:
     """
     A TraceDataset is a wrapper around a dataframe which is a flattened representation
     of Spans. The collection of spans trace the LLM application's execution.
+
+    Typical usage example::
+
+        from phoenix.trace.utils import json_lines_to_df
+
+        with open("trace.jsonl", "r") as f:
+            trace_ds = TraceDataset(json_lines_to_df(f.readlines()))
+        px.launch_app(trace=trace_ds)
     """
 
     name: str
@@ -122,15 +130,15 @@ class TraceDataset:
         Constructs a TraceDataset from a dataframe of spans. Optionally takes in
         evaluations for the spans in the dataset.
 
-        Parameters
-        __________
-        dataframe: pandas.DataFrame
-            the pandas dataframe containing the tracing data. Each row
-            represents a span.
-        evaluations: Optional[Iterable[SpanEvaluations]]
-            an optional list of evaluations for the spans in the dataset. If
-            provided, the evaluations can be materialized into a unified
-            dataframe as annotations.
+        Args:
+            dataframe (pandas.DataFrame): The pandas dataframe containing the
+                tracing data. Each row of which is a flattened representation
+                of a span.
+            name (str): The name used to identify the dataset in the application.
+                If not provided, a random name will be generated.
+            evaluations (Optional[Iterable[SpanEvaluations]]): An optional list of
+                evaluations for the spans in the dataset. If provided, the evaluations
+                can be materialized into a unified dataframe as annotations.
         """
         # Validate the the dataframe has required fields
         if missing_columns := set(REQUIRED_COLUMNS) - set(dataframe.columns):
@@ -225,12 +233,12 @@ class TraceDataset:
 
         Args:
             directory (Optional[Union[str, Path]], optional): An optional path
-            to a directory where the data will be written. If not provided, the
-            data will be written to a default location.
+                to a directory where the data will be written. If not provided, the
+                data will be written to a default location.
 
         Returns:
             UUID: The id of the trace dataset, which can be used as key to load
-            the dataset from disk using `load`.
+                the dataset from disk using `load`.
         """
         directory = Path(directory or TRACE_DATASETS_DIR)
         for evals in self.evaluations:
@@ -273,9 +281,9 @@ class TraceDataset:
             id (Union[str, UUID]): The ID of the trace dataset to be loaded.
 
             directory (Optional[Union[str, Path]], optional): The path to the
-            directory containing the persisted trace dataset parquet file. If
-            not provided, the parquet file will be loaded from the same default
-            location used by `save`.
+                directory containing the persisted trace dataset parquet file. If
+                not provided, the parquet file will be loaded from the same default
+                location used by `save`.
 
         Returns:
             TraceDataset: The loaded trace dataset.

phoenix/version.py

@@ -1 +1 @@
-__version__ = "4.8.1"
+__version__ = "4.9.0"