@arizeai/phoenix-client 5.8.2 → 5.9.0

package/package.json

@@ -1,7 +1,32 @@
 {
   "name": "@arizeai/phoenix-client",
-  "version": "5.8.2",
+  "version": "5.9.0",
   "description": "A client for the Phoenix API",
+  "keywords": [
+    "arize",
+    "datasets",
+    "evaluation",
+    "experiments",
+    "llm",
+    "phoenix",
+    "prompts",
+    "tracing"
+  ],
+  "homepage": "https://github.com/Arize-ai/phoenix/tree/main/js/packages/phoenix-client",
+  "bugs": {
+    "url": "https://github.com/Arize-ai/phoenix/issues"
+  },
+  "license": "Apache-2.0",
+  "author": "oss@arize.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Arize-ai/phoenix.git"
+  },
+  "files": [
+    "dist",
+    "src",
+    "package.json"
+  ],
   "main": "dist/src/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/src/index.d.ts",
@@ -39,44 +64,6 @@
       "require": "./dist/src/types/*.d.ts"
     }
   },
-  "files": [
-    "dist",
-    "src",
-    "package.json"
-  ],
-  "keywords": [
-    "phoenix",
-    "arize",
-    "llm",
-    "tracing",
-    "evaluation",
-    "prompts",
-    "datasets",
-    "experiments"
-  ],
-  "author": "oss@arize.com",
-  "license": "Apache-2.0",
-  "homepage": "https://github.com/Arize-ai/phoenix/tree/main/js/packages/phoenix-client",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Arize-ai/phoenix.git"
-  },
-  "bugs": {
-    "url": "https://github.com/Arize-ai/phoenix/issues"
-  },
-  "devDependencies": {
-    "@ai-sdk/openai": "^2.0.27",
-    "@anthropic-ai/sdk": "^0.35.0",
-    "@types/async": "^3.2.24",
-    "@types/node": "^20.17.22",
-    "ai": "^5.0.38",
-    "openai": "^6.10.0",
-    "openapi-typescript": "^7.6.1",
-    "tsx": "^4.19.3",
-    "typescript": "^5.8.2",
-    "vitest": "^4.0.10",
-    "@arizeai/phoenix-evals": "0.9.0"
-  },
   "dependencies": {
     "@arizeai/openinference-semantic-conventions": "^1.1.0",
     "@arizeai/openinference-vercel": "^2.7.0",
@@ -85,25 +72,37 @@
     "tiny-invariant": "^1.3.3",
     "zod": "^3.24.3",
     "zod-to-json-schema": "^3.24.3",
-    "@arizeai/phoenix-otel": "0.4.1",
-    "@arizeai/phoenix-config": "0.1.0"
+    "@arizeai/phoenix-config": "0.1.1",
+    "@arizeai/phoenix-otel": "0.4.1"
   },
-  "engines": {
-    "node": ">=18"
+  "devDependencies": {
+    "@ai-sdk/openai": "^3.0.29",
+    "@anthropic-ai/sdk": "^0.35.0",
+    "@types/async": "^3.2.24",
+    "@types/node": "^20.17.22",
+    "ai": "^6.0.90",
+    "openai": "^6.10.0",
+    "openapi-typescript": "^7.6.1",
+    "tsx": "^4.19.3",
+    "vitest": "^4.0.10",
+    "@arizeai/phoenix-evals": "0.10.0"
   },
   "optionalDependencies": {
     "@anthropic-ai/sdk": "^0.35.0",
-    "ai": "^5.0.76",
+    "ai": "^6.0.90",
     "openai": "^6.10.0"
   },
+  "engines": {
+    "node": ">=18"
+  },
   "scripts": {
+    "build": "tsc --build tsconfig.json tsconfig.esm.json && tsc-alias -p tsconfig.esm.json",
     "clean": "rimraf dist",
-    "prebuild": "pnpm run clean && pnpm run generate",
     "generate": "openapi-typescript --empty-objects-unknown=true --default-non-nullable=false ../../../schemas/openapi.json -o ./src/__generated__/api/v1.ts",
-    "build": "tsc --build tsconfig.json tsconfig.esm.json && tsc-alias -p tsconfig.esm.json",
     "postbuild": "echo '{\"type\": \"module\"}' > ./dist/esm/package.json",
-    "type:check": "tsc --noEmit",
+    "prebuild": "pnpm run clean && pnpm run generate",
     "test": "vitest run",
-    "test:watch": "vitest watch"
+    "test:watch": "vitest watch",
+    "typecheck": "tsc --noEmit"
   }
 }

package/src/__generated__/api/v1.ts

@@ -4015,7 +4015,10 @@ export interface operations {
     };
     deleteExperiment: {
         parameters: {
-            query?: never;
+            query?: {
+                /** @description If true, also delete the project associated with the experiment that contains traces and spans for the experiment tasks. */
+                delete_project?: boolean;
+            };
             header?: never;
             path: {
                 experiment_id: string;

package/src/client.ts

@@ -1,3 +1,8 @@
+import createOpenApiClient, {
+  type ClientOptions,
+  type Middleware,
+} from "openapi-fetch";
+
 import type {
   components as oapiComponentsV1,
   operations as oapiOperationsV1,
@@ -8,11 +13,6 @@ import {
   makeDefaultClientOptions,
 } from "./config";
 
-import createOpenApiClient, {
-  type ClientOptions,
-  type Middleware,
-} from "openapi-fetch";
-
 export type pathsV1 = oapiPathsV1;
 export type componentsV1 = oapiComponentsV1;
 export type operationsV1 = oapiOperationsV1;

package/src/config.ts

@@ -1,9 +1,8 @@
+import type { EnvironmentConfig } from "@arizeai/phoenix-config";
 import {
   DEFAULT_PHOENIX_BASE_URL,
-  EnvironmentConfig,
   getEnvironmentConfig,
 } from "@arizeai/phoenix-config";
-
 import type { ClientOptions } from "openapi-fetch";
 
 /**

package/src/datasets/appendDatasetExamples.ts

@@ -1,11 +1,10 @@
-import { createClient } from "../client";
-import { ClientFn } from "../types/core";
-import { DatasetSelector, Example } from "../types/datasets";
+import invariant from "tiny-invariant";
 
+import { createClient } from "../client";
+import type { ClientFn } from "../types/core";
+import type { DatasetSelector, Example } from "../types/datasets";
 import { getDatasetInfo } from "./getDatasetInfo";
 
-import invariant from "tiny-invariant";
-
 export type AppendDatasetExamplesParams = ClientFn & {
   /**
    * The dataset to append examples to

package/src/datasets/createDataset.ts

@@ -1,9 +1,9 @@
-import { createClient } from "../client";
-import { ClientFn } from "../types/core";
-import { Example } from "../types/datasets";
-
 import invariant from "tiny-invariant";
 
+import { createClient } from "../client";
+import type { ClientFn } from "../types/core";
+import type { Example } from "../types/datasets";
+
 export type CreateDatasetParams = ClientFn & {
   /**
    * The name of the dataset

package/src/datasets/createOrGetDataset.ts

@@ -1,6 +1,6 @@
 import { createClient } from "../client";
-
-import { createDataset, CreateDatasetParams } from "./createDataset";
+import type { CreateDatasetParams } from "./createDataset";
+import { createDataset } from "./createDataset";
 import { getDatasetInfoByName } from "./getDatasetInfoByName";
 
 export type CreateOrGetDatasetParams = CreateDatasetParams;

package/src/datasets/getDataset.ts

@@ -1,7 +1,6 @@
 import { createClient } from "../client";
-import { ClientFn } from "../types/core";
-import { Dataset, DatasetSelector } from "../types/datasets";
-
+import type { ClientFn } from "../types/core";
+import type { Dataset, DatasetSelector } from "../types/datasets";
 import { getDatasetExamples } from "./getDatasetExamples";
 import { getDatasetInfo } from "./getDatasetInfo";
 

package/src/datasets/getDatasetExamples.ts

@@ -1,11 +1,10 @@
-import { createClient } from "../client";
-import { ClientFn } from "../types/core";
-import { DatasetExamples, DatasetSelector } from "../types/datasets";
+import invariant from "tiny-invariant";
 
+import { createClient } from "../client";
+import type { ClientFn } from "../types/core";
+import type { DatasetExamples, DatasetSelector } from "../types/datasets";
 import { getDatasetInfoByName } from "./getDatasetInfoByName";
 
-import invariant from "tiny-invariant";
-
 export type GetDatasetExamplesParams = ClientFn & {
   /** Dataset selector (ID, name, or version ID) */
   dataset: DatasetSelector;

package/src/datasets/getDatasetInfo.ts

@@ -1,11 +1,10 @@
-import { createClient } from "../client";
-import { ClientFn } from "../types/core";
-import { DatasetInfo, DatasetSelector } from "../types/datasets";
+import invariant from "tiny-invariant";
 
+import { createClient } from "../client";
+import type { ClientFn } from "../types/core";
+import type { DatasetInfo, DatasetSelector } from "../types/datasets";
 import { getDatasetInfoByName } from "./getDatasetInfoByName";
 
-import invariant from "tiny-invariant";
-
 export type GetDatasetInfoParams = ClientFn & {
   dataset: DatasetSelector;
 };

package/src/datasets/getDatasetInfoByName.ts

@@ -1,6 +1,6 @@
 import { createClient } from "../client";
-import { ClientFn } from "../types/core";
-import { DatasetInfo } from "../types/datasets";
+import type { ClientFn } from "../types/core";
+import type { DatasetInfo } from "../types/datasets";
 
 export type GetDatasetParams = ClientFn & {
   datasetName: string;

package/src/datasets/listDatasets.ts

@@ -1,9 +1,9 @@
-import { createClient } from "../client";
-import { ClientFn } from "../types/core";
-import { DatasetInfo } from "../types/datasets";
-
 import invariant from "tiny-invariant";
 
+import { createClient } from "../client";
+import type { ClientFn } from "../types/core";
+import type { DatasetInfo } from "../types/datasets";
+
 export type ListDatasetsParams = ClientFn;
 
 export type FullDatasetInfo = DatasetInfo & {

package/src/experiments/createExperiment.ts

@@ -1,9 +1,9 @@
-import { createClient } from "../client";
-import { ClientFn } from "../types/core";
-import { ExperimentInfo } from "../types/experiments";
-
 import invariant from "tiny-invariant";
 
+import { createClient } from "../client";
+import type { ClientFn } from "../types/core";
+import type { ExperimentInfo } from "../types/experiments";
+
 export type CreateExperimentParams = ClientFn & {
   /**
    * The dataset ID to create the experiment for

package/src/experiments/deleteExperiment.ts

@@ -1,5 +1,5 @@
 import { createClient } from "../client";
-import { ClientFn } from "../types/core";
+import type { ClientFn } from "../types/core";
 import { ensureString } from "../utils/ensureString";
 
 /**
@@ -10,6 +10,11 @@ export interface DeleteExperimentParams extends ClientFn {
    * The ID of the experiment to delete
    */
   experimentId: string;
+  /**
+   * If true, also delete the project associated with the experiment.
+   * Defaults to false.
+   */
+  deleteProject?: boolean;
 }
 
 /**
@@ -33,12 +38,14 @@ export interface DeleteExperimentParams extends ClientFn {
  *
  * await deleteExperiment({
  *   experimentId: "exp_123",
+ *   deleteProject: true,
  * });
  * ```
  */
 export async function deleteExperiment({
   client: _client,
   experimentId,
+  deleteProject,
 }: DeleteExperimentParams): Promise<void> {
   const client = _client ?? createClient();
 
@@ -47,6 +54,9 @@ export async function deleteExperiment({
       path: {
         experiment_id: experimentId,
       },
+      ...(deleteProject !== undefined && {
+        query: { delete_project: deleteProject },
+      }),
     },
   });
 

package/src/experiments/getExperiment.ts

@@ -1,7 +1,6 @@
 import { createClient } from "../client";
-import { ClientFn } from "../types/core";
-import { ExperimentRunsMap, RanExperiment } from "../types/experiments";
-
+import type { ClientFn } from "../types/core";
+import type { ExperimentRunsMap, RanExperiment } from "../types/experiments";
 import { getExperimentInfo } from "./getExperimentInfo";
 import { getExperimentRuns } from "./getExperimentRuns";
 

package/src/experiments/getExperimentInfo.ts

@@ -1,9 +1,9 @@
-import { createClient } from "../client";
-import { ClientFn } from "../types/core";
-import { type ExperimentInfo } from "../types/experiments";
-
 import invariant from "tiny-invariant";
 
+import { createClient } from "../client";
+import type { ClientFn } from "../types/core";
+import type { ExperimentInfo } from "../types/experiments";
+
 export type GetExperimentParams = ClientFn & {
   /**
    * The experiment ID

package/src/experiments/getExperimentRuns.ts

@@ -1,10 +1,10 @@
-import { components } from "../__generated__/api/v1";
-import { createClient } from "../client";
-import { ClientFn } from "../types/core";
-import { ExperimentRun } from "../types/experiments";
-
 import invariant from "tiny-invariant";
 
+import type { components } from "../__generated__/api/v1";
+import { createClient } from "../client";
+import type { ClientFn } from "../types/core";
+import type { ExperimentRun } from "../types/experiments";
+
 export type GetExperimentRunsParams = ClientFn & {
   /**
    * The experiment ID.

package/src/experiments/helpers/asExperimentEvaluator.ts

@@ -1,5 +1,5 @@
-import { AnnotatorKind } from "../../types/annotations";
-import { Evaluator } from "../../types/experiments";
+import type { AnnotatorKind } from "../../types/annotations";
+import type { Evaluator } from "../../types/experiments";
 
 /**
  * Wrap an evaluator function in an object with a name property.

package/src/experiments/helpers/fromPhoenixLLMEvaluator.ts

@@ -1,7 +1,6 @@
 import type { LLMEvaluator } from "@arizeai/phoenix-evals";
 
-import { Evaluator } from "../../types/experiments";
-
+import type { Evaluator } from "../../types/experiments";
 import { asExperimentEvaluator } from "./asExperimentEvaluator";
 
 /**

package/src/experiments/helpers/getExperimentEvaluators.ts

@@ -1,7 +1,6 @@
 import type { LLMEvaluator } from "@arizeai/phoenix-evals";
 
-import { Evaluator } from "../../types/experiments";
-
+import type { Evaluator } from "../../types/experiments";
 import { fromPhoenixLLMEvaluator } from "./fromPhoenixLLMEvaluator";
 
 /**

package/src/experiments/listExperiments.ts

@@ -1,10 +1,10 @@
-import { components } from "../__generated__/api/v1";
-import { createClient } from "../client";
-import { ClientFn } from "../types/core";
-import { ExperimentInfo } from "../types/experiments";
-
 import invariant from "tiny-invariant";
 
+import type { components } from "../__generated__/api/v1";
+import { createClient } from "../client";
+import type { ClientFn } from "../types/core";
+import type { ExperimentInfo } from "../types/experiments";
+
 export type ListExperimentsParams = ClientFn & {
   /**
    * The dataset ID to list experiments for

package/src/experiments/logging.ts

@@ -0,0 +1,169 @@
+import type { Logger } from "../logger";
+import type { ExperimentEvaluationRun } from "../types/experiments";
+
+/**
+ * Progress line prefixes used in experiment run output.
+ * e.g. "[start] Tasks (3 examples × 1 repetition)"
+ */
+export const PROGRESS_PREFIX = {
+  start: "[start] ",
+  progress: "[progress] ",
+  completed: "[completed] ",
+} as const;
+
+/**
+ * Log a task summary table.
+ * Outputs a header + a single-row table keyed as "summary".
+ */
+export function logTaskSummary(
+  logger: Logger,
+  {
+    nExamples,
+    repetitions,
+    nRuns,
+    nErrors,
+  }: {
+    nExamples: number;
+    repetitions: number;
+    nRuns: number;
+    nErrors: number;
+  }
+): void {
+  logger.info("");
+  logger.info("Task Summary");
+  const row: Record<string, unknown> = { examples: nExamples };
+  if (repetitions > 1) row.repetitions = repetitions;
+  row.runs = nRuns;
+  if (nErrors > 0) row.errors = nErrors;
+  logger.table({ summary: row });
+}
+
+/**
+ * Log an evaluation summary table, keyed by evaluator name.
+ * Aggregates scores and labels per evaluator.
+ */
+export function logEvalSummary(
+  logger: Logger,
+  evalRuns: ExperimentEvaluationRun[]
+): void {
+  logger.info("");
+  logger.info("Evaluation Summary");
+
+  const byEvaluator = new Map<string, ExperimentEvaluationRun[]>();
+  for (const ev of evalRuns) {
+    const list = byEvaluator.get(ev.name) ?? [];
+    list.push(ev);
+    byEvaluator.set(ev.name, list);
+  }
+
+  const tableObj: Record<string, Record<string, unknown>> = {};
+  for (const [name, evs] of byEvaluator.entries()) {
+    const scores = evs.flatMap((ev) =>
+      ev.result?.score != null ? [ev.result.score] : []
+    );
+    const labels = evs.flatMap((ev) =>
+      ev.result?.label != null ? [ev.result.label] : []
+    );
+    const errors = evs.filter((ev) => ev.error != null);
+
+    const row: Record<string, unknown> = { runs: evs.length };
+    if (errors.length > 0) row.errors = errors.length;
+    if (scores.length > 0) {
+      row.scores = scores.length;
+      row["avg score"] = Number(
+        (scores.reduce((a, b) => a + b, 0) / scores.length).toFixed(3)
+      );
+    }
+    if (labels.length > 0) {
+      row.labels = labels.length;
+      const counts: Record<string, number> = {};
+      for (const label of labels) counts[label] = (counts[label] ?? 0) + 1;
+      const topLabels = Object.entries(counts)
+        .sort((a, b) => b[1] - a[1])
+        .slice(0, 2);
+      if (topLabels[0])
+        row["label 1"] = `${topLabels[0][0]} (${topLabels[0][1]})`;
+      if (topLabels[1])
+        row["label 2"] = `${topLabels[1][0]} (${topLabels[1][1]})`;
+    }
+    tableObj[name] = row;
+  }
+
+  logger.table(tableObj);
+}
+
+/**
+ * Log a padded "Links" block.
+ * Labels are padded to align URLs. No-ops when links is empty.
+ */
+export function logLinks(
+  logger: Logger,
+  links: Array<{ label: string; url: string }>
+): void {
+  if (links.length === 0) return;
+  const maxLen = Math.max(...links.map((link) => link.label.length));
+  logger.info("");
+  logger.info("Links");
+  for (const { label, url } of links) {
+    logger.info(`  ${label.padEnd(maxLen)}  ${url}`);
+  }
+  logger.info("");
+}
+
+/**
+ * Log experiment resume summary table.
+ * Outputs a header + a single-row table keyed as "summary".
+ */
+export function logExperimentResumeSummary(
+  logger: Logger,
+  {
+    experimentId,
+    processed,
+    completed,
+    failed,
+  }: {
+    experimentId: string;
+    processed: number;
+    completed: number;
+    failed: number;
+  }
+): void {
+  logger.info("Experiment Resume Summary");
+  logger.table({
+    summary: {
+      "experiment id": experimentId,
+      processed,
+      completed,
+      failed,
+    },
+  });
+}
+
+/**
+ * Log evaluation resume summary table.
+ * Outputs a header + a single-row table keyed as "summary".
+ */
+export function logEvalResumeSummary(
+  logger: Logger,
+  {
+    experimentId,
+    processed,
+    completed,
+    failed,
+  }: {
+    experimentId: string;
+    processed: number;
+    completed: number;
+    failed: number;
+  }
+): void {
+  logger.info("Evaluation Resume Summary");
+  logger.table({
+    summary: {
+      "experiment id": experimentId,
+      processed,
+      completed,
+      failed,
+    },
+  });
+}