@arizeai/phoenix-client 5.2.0 → 5.3.0

package/src/experiments/deleteExperiment.ts

@@ -0,0 +1,67 @@
+import { createClient } from "../client";
+import { ClientFn } from "../types/core";
+import { ensureString } from "../utils/ensureString";
+
+/**
+ * Parameters to delete an experiment
+ */
+export interface DeleteExperimentParams extends ClientFn {
+  /**
+   * The ID of the experiment to delete
+   */
+  experimentId: string;
+}
+
+/**
+ * Delete an experiment by ID.
+ *
+ * **Important**: This operation permanently deletes the experiment and all its associated
+ * runs, evaluations, and annotations.
+ *
+ * Behavior:
+ * - Deletes the experiment and all its data
+ * - Returns successfully if experiment is found and deleted
+ * - Throws error if experiment is not found (404) or other errors occur
+ *
+ * @param params - The parameters to delete an experiment
+ * @returns Promise that resolves when the experiment is successfully deleted
+ * @throws Error if the experiment is not found or deletion fails
+ *
+ * @example
+ * ```ts
+ * import { deleteExperiment } from "@arizeai/phoenix-client/experiments";
+ *
+ * await deleteExperiment({
+ *   experimentId: "exp_123",
+ * });
+ * ```
+ */
+export async function deleteExperiment({
+  client: _client,
+  experimentId,
+}: DeleteExperimentParams): Promise<void> {
+  const client = _client ?? createClient();
+
+  const { error } = await client.DELETE("/v1/experiments/{experiment_id}", {
+    params: {
+      path: {
+        experiment_id: experimentId,
+      },
+    },
+  });
+
+  if (error) {
+    const isNotFound =
+      typeof error === "object" &&
+      error !== null &&
+      "status" in error &&
+      error.status === 404;
+    if (isNotFound) {
+      throw new Error(`Experiment not found: ${experimentId}`);
+    }
+
+    // Extract meaningful error information
+    const errorMessage = ensureString(error);
+    throw new Error(`Failed to delete experiment: ${errorMessage}`);
+  }
+}

package/src/experiments/getExperiment.ts

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

package/src/experiments/getExperimentInfo.ts

@@ -1,8 +1,9 @@
-import invariant from "tiny-invariant";
 import { createClient } from "../client";
 import { ClientFn } from "../types/core";
 import { type ExperimentInfo } from "../types/experiments";
 
+import invariant from "tiny-invariant";
+
 export type GetExperimentParams = ClientFn & {
   /**
    * The experiment ID
@@ -31,7 +32,14 @@ export async function getExperimentInfo({
     id: experimentData.id,
     datasetId: experimentData.dataset_id,
     datasetVersionId: experimentData.dataset_version_id,
-    projectName: experimentData.project_name || "", // This will never happen
-    metadata: experimentData.metadata,
+    repetitions: experimentData.repetitions,
+    metadata: experimentData.metadata || {},
+    projectName: experimentData.project_name || null,
+    createdAt: experimentData.created_at,
+    updatedAt: experimentData.updated_at,
+    exampleCount: experimentData.example_count,
+    successfulRunCount: experimentData.successful_run_count,
+    failedRunCount: experimentData.failed_run_count,
+    missingRunCount: experimentData.missing_run_count,
   };
 }

package/src/experiments/getExperimentRuns.ts

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

package/src/experiments/index.ts

@@ -2,3 +2,8 @@ export * from "./getExperimentInfo";
 export * from "./getExperiment";
 export * from "./getExperimentRuns";
 export * from "./runExperiment";
+export * from "./createExperiment";
+export * from "./listExperiments";
+export * from "./deleteExperiment";
+export * from "./resumeExperiment";
+export * from "./resumeEvaluation";

package/src/experiments/listExperiments.ts

@@ -0,0 +1,83 @@
+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";
+
+export type ListExperimentsParams = ClientFn & {
+  /**
+   * The dataset ID to list experiments for
+   */
+  datasetId: string;
+};
+
+const DEFAULT_PAGE_SIZE = 50;
+
+/**
+ * List all experiments for a dataset with automatic pagination handling.
+ *
+ * This function automatically handles pagination behind the scenes and returns
+ * a simple list of experiments.
+ *
+ * @example
+ * ```ts
+ * import { listExperiments } from "@arizeai/phoenix-client/experiments";
+ *
+ * const experiments = await listExperiments({
+ *   datasetId: "dataset_123",
+ * });
+ *
+ * for (const experiment of experiments) {
+ *   console.log(`Experiment: ${experiment.id}, Runs: ${experiment.successfulRunCount}`);
+ * }
+ * ```
+ */
+export async function listExperiments({
+  client: _client,
+  datasetId,
+}: ListExperimentsParams): Promise<ExperimentInfo[]> {
+  const client = _client || createClient();
+
+  const experiments: ExperimentInfo[] = [];
+  let cursor: string | null = null;
+
+  do {
+    const res: {
+      data?: components["schemas"]["ListExperimentsResponseBody"];
+    } = await client.GET("/v1/datasets/{dataset_id}/experiments", {
+      params: {
+        path: {
+          dataset_id: datasetId,
+        },
+        query: {
+          cursor,
+          limit: DEFAULT_PAGE_SIZE,
+        },
+      },
+    });
+
+    cursor = res.data?.next_cursor || null;
+    const data = res.data?.data;
+    invariant(data, "Failed to list experiments");
+
+    experiments.push(
+      ...data.map((exp) => ({
+        id: exp.id,
+        datasetId: exp.dataset_id,
+        datasetVersionId: exp.dataset_version_id,
+        repetitions: exp.repetitions,
+        metadata: exp.metadata || {},
+        projectName: exp.project_name || null,
+        createdAt: exp.created_at,
+        updatedAt: exp.updated_at,
+        exampleCount: exp.example_count,
+        successfulRunCount: exp.successful_run_count,
+        failedRunCount: exp.failed_run_count,
+        missingRunCount: exp.missing_run_count,
+      }))
+    );
+  } while (cursor != null);
+
+  return experiments;
+}