@arizeai/phoenix-client 2.0.0 → 2.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arizeai/phoenix-client",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "A client for the Phoenix API",
   "main": "dist/src/index.js",
   "module": "dist/esm/index.js",

package/src/experiments/runExperiment.ts

@@ -32,6 +32,11 @@ import {
 import { ensureString } from "../utils/ensureString";
 import type { NodeTracerProvider } from "@opentelemetry/sdk-trace-node";
 import { objectAsAttributes } from "../utils/objectAsAttributes";
+import {
+  getDatasetUrl,
+  getDatasetExperimentsUrl,
+  getExperimentUrl,
+} from "../utils/urlUtils";
 
 /**
  * Parameters for running an experiment.
@@ -197,6 +202,26 @@ export async function runExperiment({
     );
   }
 
+  if (!isDryRun && client.config.baseUrl) {
+    const datasetUrl = getDatasetUrl({
+      baseUrl: client.config.baseUrl,
+      datasetId: dataset.id,
+    });
+    const datasetExperimentsUrl = getDatasetExperimentsUrl({
+      baseUrl: client.config.baseUrl,
+      datasetId: dataset.id,
+    });
+    const experimentUrl = getExperimentUrl({
+      baseUrl: client.config.baseUrl,
+      datasetId: dataset.id,
+      experimentId: experiment.id,
+    });
+
+    logger.info(`📊 View dataset: ${datasetUrl}`);
+    logger.info(`📺 View dataset experiments: ${datasetExperimentsUrl}`);
+    logger.info(`🔗 View this experiment: ${experimentUrl}`);
+  }
+
   logger.info(
     `🧪 Starting experiment "${experimentName || `<unnamed>`}" on dataset "${dataset.id}" with task "${task.name}" and ${evaluators?.length ?? 0} ${pluralize(
       "evaluator",
@@ -243,6 +268,15 @@ export async function runExperiment({
 
   logger.info(`✅ Experiment ${experiment.id} completed`);
 
+  if (!isDryRun && client.config.baseUrl) {
+    const experimentUrl = getExperimentUrl({
+      baseUrl: client.config.baseUrl,
+      datasetId: dataset.id,
+      experimentId: experiment.id,
+    });
+    logger.info(`🔍 View results: ${experimentUrl}`);
+  }
+
   return ranExperiment;
 }
 
@@ -444,6 +478,15 @@ export async function evaluateExperiment({
       evaluators?.length ?? 0
     )}`
   );
+
+  if (!isDryRun && client.config.baseUrl) {
+    const experimentUrl = getExperimentUrl({
+      baseUrl: client.config.baseUrl,
+      datasetId: experiment.datasetId,
+      experimentId: experiment.id,
+    });
+    logger.info(`🔗 View experiment evaluation: ${experimentUrl}`);
+  }
   type EvaluationId = string;
   const evaluationRuns: Record<EvaluationId, ExperimentEvaluationRun> = {};
 

package/src/utils/urlUtils.ts

@@ -0,0 +1,63 @@
+/**
+ * Utility functions for constructing URLs to Phoenix resources
+ */
+
+/**
+ * Get the base URL for Phoenix web UI
+ * @param baseUrl The base URL of the Phoenix API
+ * @returns The base URL for the Phoenix web UI
+ */
+function getWebBaseUrl(baseUrl: string): string {
+  return new URL(baseUrl).toString();
+}
+
+/**
+ * Get the URL to view a specific experiment in the Phoenix web UI
+ * @param baseUrl The base URL of the Phoenix API
+ * @param datasetId The ID of the dataset
+ * @param experimentId The ID of the experiment
+ * @returns The URL to view the experiment
+ */
+export function getExperimentUrl({
+  baseUrl,
+  datasetId,
+  experimentId,
+}: {
+  baseUrl: string;
+  datasetId: string;
+  experimentId: string;
+}): string {
+  return `${getWebBaseUrl(baseUrl)}datasets/${datasetId}/compare?experimentId=${experimentId}`;
+}
+
+/**
+ * Get the URL to view experiments for a dataset in the Phoenix web UI
+ * @param baseUrl The base URL of the Phoenix API
+ * @param datasetId The ID of the dataset
+ * @returns The URL to view dataset experiments
+ */
+export function getDatasetExperimentsUrl({
+  baseUrl,
+  datasetId,
+}: {
+  baseUrl: string;
+  datasetId: string;
+}): string {
+  return `${getWebBaseUrl(baseUrl)}datasets/${datasetId}/experiments`;
+}
+
+/**
+ * Get the URL to view a dataset in the Phoenix web UI
+ * @param baseUrl The base URL of the Phoenix API
+ * @param datasetId The ID of the dataset
+ * @returns The URL to view the dataset
+ */
+export function getDatasetUrl({
+  baseUrl,
+  datasetId,
+}: {
+  baseUrl: string;
+  datasetId: string;
+}): string {
+  return `${getWebBaseUrl(baseUrl)}datasets/${datasetId}/examples`;
+}