@arizeai/phoenix-client 1.3.0 → 2.0.1

package/src/types/datasets.ts

@@ -1,22 +1,48 @@
 import { Node } from "./core";
 
+/**
+ * A dataset can be identified by its datasetId
+ * TODO: add support for datasetName and datasetVersionId via discriminated union
+ */
+export type DatasetSelector = { datasetId: string };
+
+/**
+ * Overview information about a dataset
+ */
+export interface DatasetInfo extends Node {
+  name: string;
+  description?: string | null;
+  metadata?: Record<string, unknown>;
+}
+
+/**
+ * A dataset's examples
+ */
+export interface DatasetExamples {
+  examples: ExampleWithId[];
+  /**
+   * The version ID of the dataset examples
+   */
+  versionId: string;
+}
+
 /**
  * An example is a record to feed into an AI task
  */
-export interface Example extends Node {
-  id: string;
-  updatedAt: Date;
+export interface Example {
   input: Record<string, unknown>;
   output: Record<string, unknown> | null;
   metadata: Record<string, unknown>;
 }
 
 /**
- * A dataset is a collection of examples for an AI task
+ * An example that has been synced to the server
  */
-export interface Dataset extends Node {
-  id: string;
-  name: string;
-  versionId: string;
-  examples: Example[];
+export interface ExampleWithId extends Example, Node {
+  updatedAt: Date;
 }
+
+/**
+ * A dataset is a collection of examples for an AI task
+ */
+export interface Dataset extends DatasetInfo, DatasetExamples, Node {}

package/src/types/experiments.ts

@@ -5,17 +5,33 @@ import { Example } from "./datasets";
 /**
  * An experiment is a set of task runs on a dataset version
  */
-export interface Experiment extends Node {
+export interface ExperimentInfo extends Node {
   datasetId: string;
   datasetVersionId: string;
   /**
    * The project under which the experiment task traces are recorded
    */
   projectName: string;
+  /**
+   * Metadata about the experiment as an object of key values
+   * e.x. model name
+   */
+  metadata: Record<string, unknown>;
+}
+
+export type ExperimentRunID = string;
+
+/**
+ * A map of an experiment runId to the run
+ */
+export interface ExperimentRunsMap {
+  runs: Record<ExperimentRunID, ExperimentRun>;
 }
 
-export interface RanExperiment extends Experiment {
-  runs: Record<string, ExperimentRun>;
+/**
+ * An experiment that has been run and been recorded on the server
+ */
+export interface RanExperiment extends ExperimentInfo, ExperimentRunsMap {
   evaluationRuns?: 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`;
+}

package/dist/esm/utils/getDatasetBySelector.d.ts

@@ -1,25 +0,0 @@
-import { PhoenixClient } from "../client.js";
-import { Example } from "../types/datasets.js";
-import { Dataset } from "../types/datasets.js";
-/**
- * Parameters for the getDatasetLike function
- */
-export type GetDatasetLikeParams = {
-    /**
-     * The dataset to get. Can be in the form of a dataset id, an array of examples, or a dataset object.
-     */
-    dataset: Dataset | string | Example[];
-    client: PhoenixClient;
-};
-/**
- * Return a dataset object from the input.
- *
- * If the input is a string, assume it is a dataset id and fetch the dataset from the client.
- * If the input is an array of examples, create a new dataset from the examples then return it.
- * If the input is a dataset, return it as is.
- *
- * @param params - The parameters to get a dataset.
- * @returns The dataset.
- */
-export declare function getDatasetBySelector({ dataset, client, }: GetDatasetLikeParams): Promise<Dataset | null>;
-//# sourceMappingURL=getDatasetBySelector.d.ts.map

package/dist/esm/utils/getDatasetBySelector.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"getDatasetBySelector.d.ts","sourceRoot":"","sources":["../../../src/utils/getDatasetBySelector.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,OAAO,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,EAAE,CAAC;IACtC,MAAM,EAAE,aAAa,CAAC;CACvB,CAAC;AAEF;;;;;;;;;GASG;AACH,wBAAsB,oBAAoB,CAAC,EACzC,OAAO,EACP,MAAM,GACP,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAwBhD"}

package/dist/esm/utils/getDatasetBySelector.js

@@ -1,37 +0,0 @@
-import invariant from "tiny-invariant";
-/**
- * Return a dataset object from the input.
- *
- * If the input is a string, assume it is a dataset id and fetch the dataset from the client.
- * If the input is an array of examples, create a new dataset from the examples then return it.
- * If the input is a dataset, return it as is.
- *
- * @param params - The parameters to get a dataset.
- * @returns The dataset.
- */
-export async function getDatasetBySelector({ dataset, client, }) {
-    if (typeof dataset === "string") {
-        const datasetResponse = await client
-            .GET(`/v1/datasets/{id}`, { params: { path: { id: dataset } } })
-            .then((d) => d.data?.data);
-        invariant(datasetResponse, `Dataset ${dataset} not found`);
-        const examples = await client
-            .GET(`/v1/datasets/{id}/examples`, { params: { path: { id: dataset } } })
-            .then((e) => e.data?.data);
-        invariant(examples, `Examples for dataset ${dataset} not found`);
-        const datasetWithExamples = {
-            ...datasetResponse,
-            examples: examples.examples.map((example) => ({
-                ...example,
-                updatedAt: new Date(example.updated_at),
-            })),
-            versionId: examples.version_id,
-        };
-        return datasetWithExamples;
-    }
-    if (Array.isArray(dataset)) {
-        throw new Error("TODO: implement dataset creation from examples");
-    }
-    return dataset;
-}
-//# sourceMappingURL=getDatasetBySelector.js.map

package/dist/esm/utils/getDatasetBySelector.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getDatasetBySelector.js","sourceRoot":"","sources":["../../../src/utils/getDatasetBySelector.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,gBAAgB,CAAC;AAiBvC;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,EACzC,OAAO,EACP,MAAM,GACe;IACrB,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAChC,MAAM,eAAe,GAAG,MAAM,MAAM;aACjC,GAAG,CAAC,mBAAmB,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;aAC/D,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC7B,SAAS,CAAC,eAAe,EAAE,WAAW,OAAO,YAAY,CAAC,CAAC;QAC3D,MAAM,QAAQ,GAAG,MAAM,MAAM;aAC1B,GAAG,CAAC,4BAA4B,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;aACxE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC7B,SAAS,CAAC,QAAQ,EAAE,wBAAwB,OAAO,YAAY,CAAC,CAAC;QACjE,MAAM,mBAAmB,GAAY;YACnC,GAAG,eAAe;YAClB,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;gBAC5C,GAAG,OAAO;gBACV,SAAS,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;aACxC,CAAC,CAAC;YACH,SAAS,EAAE,QAAQ,CAAC,UAAU;SAC/B,CAAC;QACF,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;IACpE,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/src/utils/getDatasetBySelector.d.ts

@@ -1,25 +0,0 @@
-import { PhoenixClient } from "../client";
-import { Example } from "../types/datasets";
-import { Dataset } from "../types/datasets";
-/**
- * Parameters for the getDatasetLike function
- */
-export type GetDatasetLikeParams = {
-    /**
-     * The dataset to get. Can be in the form of a dataset id, an array of examples, or a dataset object.
-     */
-    dataset: Dataset | string | Example[];
-    client: PhoenixClient;
-};
-/**
- * Return a dataset object from the input.
- *
- * If the input is a string, assume it is a dataset id and fetch the dataset from the client.
- * If the input is an array of examples, create a new dataset from the examples then return it.
- * If the input is a dataset, return it as is.
- *
- * @param params - The parameters to get a dataset.
- * @returns The dataset.
- */
-export declare function getDatasetBySelector({ dataset, client, }: GetDatasetLikeParams): Promise<Dataset | null>;
-//# sourceMappingURL=getDatasetBySelector.d.ts.map

package/dist/src/utils/getDatasetBySelector.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"getDatasetBySelector.d.ts","sourceRoot":"","sources":["../../../src/utils/getDatasetBySelector.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,OAAO,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,EAAE,CAAC;IACtC,MAAM,EAAE,aAAa,CAAC;CACvB,CAAC;AAEF;;;;;;;;;GASG;AACH,wBAAsB,oBAAoB,CAAC,EACzC,OAAO,EACP,MAAM,GACP,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAwBhD"}

package/dist/src/utils/getDatasetBySelector.js

@@ -1,47 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDatasetBySelector = getDatasetBySelector;
-const tiny_invariant_1 = __importDefault(require("tiny-invariant"));
-/**
- * Return a dataset object from the input.
- *
- * If the input is a string, assume it is a dataset id and fetch the dataset from the client.
- * If the input is an array of examples, create a new dataset from the examples then return it.
- * If the input is a dataset, return it as is.
- *
- * @param params - The parameters to get a dataset.
- * @returns The dataset.
- */
-function getDatasetBySelector(_a) {
-    return __awaiter(this, arguments, void 0, function* ({ dataset, client, }) {
-        if (typeof dataset === "string") {
-            const datasetResponse = yield client
-                .GET(`/v1/datasets/{id}`, { params: { path: { id: dataset } } })
-                .then((d) => { var _a; return (_a = d.data) === null || _a === void 0 ? void 0 : _a.data; });
-            (0, tiny_invariant_1.default)(datasetResponse, `Dataset ${dataset} not found`);
-            const examples = yield client
-                .GET(`/v1/datasets/{id}/examples`, { params: { path: { id: dataset } } })
-                .then((e) => { var _a; return (_a = e.data) === null || _a === void 0 ? void 0 : _a.data; });
-            (0, tiny_invariant_1.default)(examples, `Examples for dataset ${dataset} not found`);
-            const datasetWithExamples = Object.assign(Object.assign({}, datasetResponse), { examples: examples.examples.map((example) => (Object.assign(Object.assign({}, example), { updatedAt: new Date(example.updated_at) }))), versionId: examples.version_id });
-            return datasetWithExamples;
-        }
-        if (Array.isArray(dataset)) {
-            throw new Error("TODO: implement dataset creation from examples");
-        }
-        return dataset;
-    });
-}
-//# sourceMappingURL=getDatasetBySelector.js.map

package/dist/src/utils/getDatasetBySelector.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getDatasetBySelector.js","sourceRoot":"","sources":["../../../src/utils/getDatasetBySelector.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AA2BA,oDA2BC;AAtDD,oEAAuC;AAiBvC;;;;;;;;;GASG;AACH,SAAsB,oBAAoB;yDAAC,EACzC,OAAO,EACP,MAAM,GACe;QACrB,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAChC,MAAM,eAAe,GAAG,MAAM,MAAM;iBACjC,GAAG,CAAC,mBAAmB,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;iBAC/D,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,WAAC,OAAA,MAAA,CAAC,CAAC,IAAI,0CAAE,IAAI,CAAA,EAAA,CAAC,CAAC;YAC7B,IAAA,wBAAS,EAAC,eAAe,EAAE,WAAW,OAAO,YAAY,CAAC,CAAC;YAC3D,MAAM,QAAQ,GAAG,MAAM,MAAM;iBAC1B,GAAG,CAAC,4BAA4B,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;iBACxE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,WAAC,OAAA,MAAA,CAAC,CAAC,IAAI,0CAAE,IAAI,CAAA,EAAA,CAAC,CAAC;YAC7B,IAAA,wBAAS,EAAC,QAAQ,EAAE,wBAAwB,OAAO,YAAY,CAAC,CAAC;YACjE,MAAM,mBAAmB,mCACpB,eAAe,KAClB,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,iCACxC,OAAO,KACV,SAAS,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IACvC,CAAC,EACH,SAAS,EAAE,QAAQ,CAAC,UAAU,GAC/B,CAAC;YACF,OAAO,mBAAmB,CAAC;QAC7B,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;QACpE,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;CAAA"}

package/src/utils/getDatasetBySelector.ts

@@ -1,55 +0,0 @@
-import invariant from "tiny-invariant";
-import { PhoenixClient } from "../client";
-import { Example } from "../types/datasets";
-
-import { Dataset } from "../types/datasets";
-
-/**
- * Parameters for the getDatasetLike function
- */
-export type GetDatasetLikeParams = {
-  /**
-   * The dataset to get. Can be in the form of a dataset id, an array of examples, or a dataset object.
-   */
-  dataset: Dataset | string | Example[];
-  client: PhoenixClient;
-};
-
-/**
- * Return a dataset object from the input.
- *
- * If the input is a string, assume it is a dataset id and fetch the dataset from the client.
- * If the input is an array of examples, create a new dataset from the examples then return it.
- * If the input is a dataset, return it as is.
- *
- * @param params - The parameters to get a dataset.
- * @returns The dataset.
- */
-export async function getDatasetBySelector({
-  dataset,
-  client,
-}: GetDatasetLikeParams): Promise<Dataset | null> {
-  if (typeof dataset === "string") {
-    const datasetResponse = await client
-      .GET(`/v1/datasets/{id}`, { params: { path: { id: dataset } } })
-      .then((d) => d.data?.data);
-    invariant(datasetResponse, `Dataset ${dataset} not found`);
-    const examples = await client
-      .GET(`/v1/datasets/{id}/examples`, { params: { path: { id: dataset } } })
-      .then((e) => e.data?.data);
-    invariant(examples, `Examples for dataset ${dataset} not found`);
-    const datasetWithExamples: Dataset = {
-      ...datasetResponse,
-      examples: examples.examples.map((example) => ({
-        ...example,
-        updatedAt: new Date(example.updated_at),
-      })),
-      versionId: examples.version_id,
-    };
-    return datasetWithExamples;
-  }
-  if (Array.isArray(dataset)) {
-    throw new Error("TODO: implement dataset creation from examples");
-  }
-  return dataset;
-}