@arizeai/phoenix-client 1.3.0 → 2.0.0

package/README.md

@@ -173,6 +173,123 @@ const prompt = await phoenix.GET("/v1/prompts/{prompt_identifier}/latest", {
 
 A comprehensive overview of the available endpoints and their parameters is available in the OpenAPI viewer within Phoenix, or in the [Phoenix OpenAPI spec](https://github.com/Arize-ai/phoenix/blob/main/schemas/openapi.json).
 
+## Datasets
+
+The `@arizeai/phoenix-client` package allows you to create and manage datasets, which are collections of examples used for experiments and evaluation.
+
+### Creating a Dataset
+
+You can create a dataset by providing a name, description, and an array of examples (each with `input`, `output`, and optional `metadata`).
+
+```ts
+import { createDataset } from "@arizeai/phoenix-client/datasets";
+
+const { datasetId } = await createDataset({
+  name: "questions",
+  description: "a simple dataset of questions",
+  examples: [
+    {
+      input: { question: "What is the capital of France" },
+      output: { answer: "Paris" },
+      metadata: {},
+    },
+    {
+      input: { question: "What is the capital of the USA" },
+      output: { answer: "Washington D.C." },
+      metadata: {},
+    },
+  ],
+});
+// You can now use datasetId to run experiments or add more examples
+```
+
+## Experiments
+
+The `@arizeai/phoenix-client` package provides an experiments API for running and evaluating tasks on datasets. This is useful for benchmarking models, evaluating outputs, and tracking experiment results in Phoenix.
+
+### Running an Experiment
+
+To run an experiment, you typically:
+
+1. Create a dataset (or use an existing one)
+2. Define a task function to run on each example
+3. Define one or more evaluators to score or label the outputs
+4. Run the experiment and inspect the results
+
+Below is a complete example:
+
+```ts
+import { createDataset } from "@arizeai/phoenix-client/datasets";
+import {
+  asEvaluator,
+  runExperiment,
+} from "@arizeai/phoenix-client/experiments";
+
+// 1. Create a dataset
+const { datasetId } = await createDataset({
+  name: "names-dataset",
+  description: "a simple dataset of names",
+  examples: [
+    {
+      input: { name: "John" },
+      output: { text: "Hello, John!" },
+      metadata: {},
+    },
+    {
+      input: { name: "Jane" },
+      output: { text: "Hello, Jane!" },
+      metadata: {},
+    },
+  ],
+});
+
+// 2. Define a task to run on each example
+const task = async (example) => `hello ${example.input.name}`;
+
+// 3. Define evaluators
+const evaluators = [
+  asEvaluator({
+    name: "matches",
+    kind: "CODE",
+    evaluate: async ({ output, expected }) => {
+      const matches = output === expected?.text;
+      return {
+        label: matches ? "matches" : "does not match",
+        score: matches ? 1 : 0,
+        explanation: matches
+          ? "output matches expected"
+          : "output does not match expected",
+        metadata: {},
+      };
+    },
+  }),
+  asEvaluator({
+    name: "contains-hello",
+    kind: "CODE",
+    evaluate: async ({ output }) => {
+      const matches = typeof output === "string" && output.includes("hello");
+      return {
+        label: matches ? "contains hello" : "does not contain hello",
+        score: matches ? 1 : 0,
+        explanation: matches
+          ? "output contains hello"
+          : "output does not contain hello",
+        metadata: {},
+      };
+    },
+  }),
+];
+
+// 4. Run the experiment
+const experiment = await runExperiment({
+  dataset: { datasetId },
+  task,
+  evaluators,
+});
+```
+
+> **Hint:** Tasks and evaluators are instrumented using [OpenTelemetry](https://opentelemetry.io/). You can view detailed traces of experiment runs and evaluations directly in the Phoenix UI for debugging and performance analysis.
+
 ## Examples
 
 To run examples, install dependencies using `pnpm` and run:
@@ -193,4 +310,5 @@ Compatibility Table:
 
 | Phoenix Client Version | Phoenix Server Version |
 | ---------------------- | ---------------------- |
+| ^2.0.0                 | ^9.0.0                 |
 | ^1.0.0                 | ^8.0.0                 |

package/dist/esm/datasets/appendDatasetExamples.d.ts

@@ -0,0 +1,21 @@
+import { ClientFn } from "../types/core.js";
+import { Example, DatasetSelector } from "../types/datasets.js";
+export type AppendDatasetExamplesParams = ClientFn & {
+    /**
+     * The dataset to append examples to
+     */
+    dataset: DatasetSelector;
+    /**
+     * The examples to append to the dataset
+     */
+    examples: Example[];
+};
+export type AppendDatasetExamplesResponse = {
+    datasetId: string;
+};
+/**
+ * Append examples to an existing dataset
+ * @experimental this interface may change in the future
+ */
+export declare function appendDatasetExamples({ client: _client, dataset, examples, }: AppendDatasetExamplesParams): Promise<AppendDatasetExamplesResponse>;
+//# sourceMappingURL=appendDatasetExamples.d.ts.map

package/dist/esm/datasets/appendDatasetExamples.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"appendDatasetExamples.d.ts","sourceRoot":"","sources":["../../../src/datasets/appendDatasetExamples.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAG7D,MAAM,MAAM,2BAA2B,GAAG,QAAQ,GAAG;IACnD;;OAEG;IACH,OAAO,EAAE,eAAe,CAAC;IACzB;;OAEG;IACH,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,SAAS,EAAE,MAAM,CAAC;CAGnB,CAAC;AAEF;;;GAGG;AACH,wBAAsB,qBAAqB,CAAC,EAC1C,MAAM,EAAE,OAAO,EACf,OAAO,EACP,QAAQ,GACT,EAAE,2BAA2B,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAwBtE"}

package/dist/esm/datasets/appendDatasetExamples.js

@@ -0,0 +1,32 @@
+import { createClient } from "../client.js";
+import invariant from "tiny-invariant";
+/**
+ * Append examples to an existing dataset
+ * @experimental this interface may change in the future
+ */
+export async function appendDatasetExamples({ client: _client, dataset, examples, }) {
+    const client = _client || createClient();
+    const inputs = examples.map((example) => example.input);
+    const outputs = examples.map((example) => example.output ?? {}); // Treat null as an empty object
+    const metadata = examples.map((example) => example.metadata);
+    const appendResponse = await client.POST("/v1/datasets/upload", {
+        params: {
+            query: {
+                sync: true,
+            },
+        },
+        body: {
+            name: dataset.datasetId,
+            action: "append",
+            inputs,
+            outputs,
+            metadata,
+        },
+    });
+    invariant(appendResponse.data?.data, "Failed to append dataset examples");
+    const datasetId = appendResponse.data.data.dataset_id;
+    return {
+        datasetId,
+    };
+}
+//# sourceMappingURL=appendDatasetExamples.js.map

package/dist/esm/datasets/appendDatasetExamples.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"appendDatasetExamples.js","sourceRoot":"","sources":["../../../src/datasets/appendDatasetExamples.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAGzC,OAAO,SAAS,MAAM,gBAAgB,CAAC;AAmBvC;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,EAC1C,MAAM,EAAE,OAAO,EACf,OAAO,EACP,QAAQ,GACoB;IAC5B,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACxD,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC,gCAAgC;IACjG,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC7D,MAAM,cAAc,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,qBAAqB,EAAE;QAC9D,MAAM,EAAE;YACN,KAAK,EAAE;gBACL,IAAI,EAAE,IAAI;aACX;SACF;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,OAAO,CAAC,SAAS;YACvB,MAAM,EAAE,QAAQ;YAChB,MAAM;YACN,OAAO;YACP,QAAQ;SACT;KACF,CAAC,CAAC;IACH,SAAS,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,mCAAmC,CAAC,CAAC;IAC1E,MAAM,SAAS,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC;IACtD,OAAO;QACL,SAAS;KACV,CAAC;AACJ,CAAC"}

package/dist/esm/datasets/createDataset.d.ts

@@ -0,0 +1,25 @@
+import { ClientFn } from "../types/core.js";
+import { Example } from "../types/datasets.js";
+export type CreateDatasetParams = ClientFn & {
+    /**
+     * The name of the dataset
+     */
+    name: string;
+    /**
+     * The description of the dataset
+     */
+    description: string;
+    /**
+     * The examples to create in the dataset
+     */
+    examples: Example[];
+};
+export type CreateDatasetResponse = {
+    datasetId: string;
+};
+/**
+ * Create a new dataset
+ * @experimental this interface may change in the future
+ */
+export declare function createDataset({ client: _client, name, description, examples, }: CreateDatasetParams): Promise<CreateDatasetResponse>;
+//# sourceMappingURL=createDataset.d.ts.map

package/dist/esm/datasets/createDataset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createDataset.d.ts","sourceRoot":"","sources":["../../../src/datasets/createDataset.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAG5C,MAAM,MAAM,mBAAmB,GAAG,QAAQ,GAAG;IAC3C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,wBAAsB,aAAa,CAAC,EAClC,MAAM,EAAE,OAAO,EACf,IAAI,EACJ,WAAW,EACX,QAAQ,GACT,EAAE,mBAAmB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CA0BtD"}

package/dist/esm/datasets/createDataset.js

@@ -0,0 +1,34 @@
+import { createClient } from "../client.js";
+import invariant from "tiny-invariant";
+/**
+ * Create a new dataset
+ * @experimental this interface may change in the future
+ */
+export async function createDataset({ client: _client, name, description, examples, }) {
+    const client = _client || createClient();
+    const inputs = examples.map((example) => example.input);
+    const outputs = examples.map((example) => example.output ?? {}); // Treat null as an empty object
+    const metadata = examples.map((example) => example.metadata);
+    const createDatasetResponse = await client.POST("/v1/datasets/upload", {
+        params: {
+            query: {
+                // TODO: parameterize this
+                sync: true,
+            },
+        },
+        body: {
+            name,
+            description,
+            action: "create",
+            inputs,
+            outputs,
+            metadata,
+        },
+    });
+    invariant(createDatasetResponse.data?.data, "Failed to create dataset");
+    const datasetId = createDatasetResponse.data.data.dataset_id;
+    return {
+        datasetId,
+    };
+}
+//# sourceMappingURL=createDataset.js.map

package/dist/esm/datasets/createDataset.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createDataset.js","sourceRoot":"","sources":["../../../src/datasets/createDataset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAGzC,OAAO,SAAS,MAAM,gBAAgB,CAAC;AAqBvC;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,EAClC,MAAM,EAAE,OAAO,EACf,IAAI,EACJ,WAAW,EACX,QAAQ,GACY;IACpB,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACxD,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC,gCAAgC;IACjG,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC7D,MAAM,qBAAqB,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,qBAAqB,EAAE;QACrE,MAAM,EAAE;YACN,KAAK,EAAE;gBACL,0BAA0B;gBAC1B,IAAI,EAAE,IAAI;aACX;SACF;QACD,IAAI,EAAE;YACJ,IAAI;YACJ,WAAW;YACX,MAAM,EAAE,QAAQ;YAChB,MAAM;YACN,OAAO;YACP,QAAQ;SACT;KACF,CAAC,CAAC;IACH,SAAS,CAAC,qBAAqB,CAAC,IAAI,EAAE,IAAI,EAAE,0BAA0B,CAAC,CAAC;IACxE,MAAM,SAAS,GAAG,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC;IAC7D,OAAO;QACL,SAAS;KACV,CAAC;AACJ,CAAC"}

package/dist/esm/datasets/getDataset.d.ts

@@ -0,0 +1,10 @@
+import { ClientFn } from "../types/core.js";
+import { DatasetSelector, Dataset } from "../types/datasets.js";
+export type GetDatasetParams = ClientFn & {
+    dataset: DatasetSelector;
+};
+/**
+ * Get dataset info and the examples from the latest version of the dataset
+ */
+export declare function getDataset({ client: _client, dataset, }: GetDatasetParams): Promise<Dataset>;
+//# sourceMappingURL=getDataset.d.ts.map

package/dist/esm/datasets/getDataset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDataset.d.ts","sourceRoot":"","sources":["../../../src/datasets/getDataset.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAI7D,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG;IACxC,OAAO,EAAE,eAAe,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,wBAAsB,UAAU,CAAC,EAC/B,MAAM,EAAE,OAAO,EACf,OAAO,GACR,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,CAUrC"}

package/dist/esm/datasets/getDataset.js

@@ -0,0 +1,18 @@
+import { createClient } from "../client.js";
+import { getDatasetExamples } from "./getDatasetExamples.js";
+import { getDatasetInfo } from "./getDatasetInfo.js";
+/**
+ * Get dataset info and the examples from the latest version of the dataset
+ */
+export async function getDataset({ client: _client, dataset, }) {
+    const client = _client || createClient();
+    const [datasetInfo, datasetExamples] = await Promise.all([
+        getDatasetInfo({ client, dataset }),
+        getDatasetExamples({ client, dataset }),
+    ]);
+    return {
+        ...datasetInfo,
+        ...datasetExamples,
+    };
+}
+//# sourceMappingURL=getDataset.js.map

package/dist/esm/datasets/getDataset.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDataset.js","sourceRoot":"","sources":["../../../src/datasets/getDataset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAGzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAMlD;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,EAC/B,MAAM,EAAE,OAAO,EACf,OAAO,GACU;IACjB,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,CAAC,WAAW,EAAE,eAAe,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QACvD,cAAc,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;QACnC,kBAAkB,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;KACxC,CAAC,CAAC;IACH,OAAO;QACL,GAAG,WAAW;QACd,GAAG,eAAe;KACnB,CAAC;AACJ,CAAC"}

package/dist/esm/datasets/getDatasetExamples.d.ts

@@ -0,0 +1,10 @@
+import { ClientFn } from "../types/core.js";
+import { DatasetSelector, DatasetExamples } from "../types/datasets.js";
+export type GetDatasetExamplesParams = ClientFn & {
+    dataset: DatasetSelector;
+};
+/**
+ * Get the latest examples from a dataset
+ */
+export declare function getDatasetExamples({ client: _client, dataset, }: GetDatasetExamplesParams): Promise<DatasetExamples>;
+//# sourceMappingURL=getDatasetExamples.d.ts.map

package/dist/esm/datasets/getDatasetExamples.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDatasetExamples.d.ts","sourceRoot":"","sources":["../../../src/datasets/getDatasetExamples.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAErE,MAAM,MAAM,wBAAwB,GAAG,QAAQ,GAAG;IAChD,OAAO,EAAE,eAAe,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,MAAM,EAAE,OAAO,EACf,OAAO,GACR,EAAE,wBAAwB,GAAG,OAAO,CAAC,eAAe,CAAC,CAkBrD"}

package/dist/esm/datasets/getDatasetExamples.js

@@ -0,0 +1,25 @@
+import invariant from "tiny-invariant";
+import { createClient } from "../client.js";
+/**
+ * Get the latest examples from a dataset
+ */
+export async function getDatasetExamples({ client: _client, dataset, }) {
+    const client = _client || createClient();
+    const response = await client.GET("/v1/datasets/{id}/examples", {
+        params: {
+            path: {
+                id: dataset.datasetId,
+            },
+        },
+    });
+    invariant(response.data?.data, "Failed to get dataset examples");
+    const examplesData = response.data.data;
+    return {
+        versionId: examplesData.version_id,
+        examples: examplesData.examples.map((example) => ({
+            ...example,
+            updatedAt: new Date(example.updated_at),
+        })),
+    };
+}
+//# sourceMappingURL=getDatasetExamples.js.map

package/dist/esm/datasets/getDatasetExamples.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDatasetExamples.js","sourceRoot":"","sources":["../../../src/datasets/getDatasetExamples.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAQzC;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,EACvC,MAAM,EAAE,OAAO,EACf,OAAO,GACkB;IACzB,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,4BAA4B,EAAE;QAC9D,MAAM,EAAE;YACN,IAAI,EAAE;gBACJ,EAAE,EAAE,OAAO,CAAC,SAAS;aACtB;SACF;KACF,CAAC,CAAC;IACH,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,gCAAgC,CAAC,CAAC;IACjE,MAAM,YAAY,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;IACxC,OAAO;QACL,SAAS,EAAE,YAAY,CAAC,UAAU;QAClC,QAAQ,EAAE,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YAChD,GAAG,OAAO;YACV,SAAS,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;SACxC,CAAC,CAAC;KACJ,CAAC;AACJ,CAAC"}

package/dist/esm/datasets/getDatasetInfo.d.ts

@@ -0,0 +1,11 @@
+import { ClientFn } from "../types/core.js";
+import { DatasetSelector, DatasetInfo } from "../types/datasets.js";
+export type GetDatasetInfoParams = ClientFn & {
+    dataset: DatasetSelector;
+};
+/**
+ * Get an overview of the information in a dataset
+ * Note: this does not include the examples contained in the dataset
+ */
+export declare function getDatasetInfo({ client: _client, dataset, }: GetDatasetInfoParams): Promise<DatasetInfo>;
+//# sourceMappingURL=getDatasetInfo.d.ts.map

package/dist/esm/datasets/getDatasetInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDatasetInfo.d.ts","sourceRoot":"","sources":["../../../src/datasets/getDatasetInfo.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEjE,MAAM,MAAM,oBAAoB,GAAG,QAAQ,GAAG;IAC5C,OAAO,EAAE,eAAe,CAAC;CAC1B,CAAC;AAEF;;;GAGG;AACH,wBAAsB,cAAc,CAAC,EACnC,MAAM,EAAE,OAAO,EACf,OAAO,GACR,EAAE,oBAAoB,GAAG,OAAO,CAAC,WAAW,CAAC,CAiB7C"}

package/dist/esm/datasets/getDatasetInfo.js

@@ -0,0 +1,25 @@
+import invariant from "tiny-invariant";
+import { createClient } from "../client.js";
+/**
+ * Get an overview of the information in a dataset
+ * Note: this does not include the examples contained in the dataset
+ */
+export async function getDatasetInfo({ client: _client, dataset, }) {
+    const client = _client || createClient();
+    const datasetResponse = await client.GET("/v1/datasets/{id}", {
+        params: {
+            path: {
+                id: dataset.datasetId,
+            },
+        },
+    });
+    invariant(datasetResponse.data?.data, "Failed to get dataset info");
+    const datasetInfo = datasetResponse.data.data;
+    return {
+        id: datasetInfo.id,
+        name: datasetInfo.name,
+        description: datasetInfo.description || undefined,
+        metadata: datasetInfo.metadata,
+    };
+}
+//# sourceMappingURL=getDatasetInfo.js.map

package/dist/esm/datasets/getDatasetInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDatasetInfo.js","sourceRoot":"","sources":["../../../src/datasets/getDatasetInfo.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAQzC;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,EACnC,MAAM,EAAE,OAAO,EACf,OAAO,GACc;IACrB,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,eAAe,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,mBAAmB,EAAE;QAC5D,MAAM,EAAE;YACN,IAAI,EAAE;gBACJ,EAAE,EAAE,OAAO,CAAC,SAAS;aACtB;SACF;KACF,CAAC,CAAC;IACH,SAAS,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE,4BAA4B,CAAC,CAAC;IACpE,MAAM,WAAW,GAAG,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC;IAC9C,OAAO;QACL,EAAE,EAAE,WAAW,CAAC,EAAE;QAClB,IAAI,EAAE,WAAW,CAAC,IAAI;QACtB,WAAW,EAAE,WAAW,CAAC,WAAW,IAAI,SAAS;QACjD,QAAQ,EAAE,WAAW,CAAC,QAAQ;KAC/B,CAAC;AACJ,CAAC"}

package/dist/esm/datasets/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./createDataset.js";
+export * from "./getDataset.js";
+export * from "./getDatasetExamples.js";
+export * from "./appendDatasetExamples.js";
+export * from "./getDatasetExamples.js";
+export * from "./getDatasetInfo.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/datasets/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/datasets/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC"}

package/dist/esm/datasets/index.js

@@ -0,0 +1,7 @@
+export * from "./createDataset.js";
+export * from "./getDataset.js";
+export * from "./getDatasetExamples.js";
+export * from "./appendDatasetExamples.js";
+export * from "./getDatasetExamples.js";
+export * from "./getDatasetInfo.js";
+//# sourceMappingURL=index.js.map

package/dist/esm/datasets/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/datasets/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC"}

package/dist/esm/datasets/listDatasets.d.ts

@@ -0,0 +1,23 @@
+import { DatasetInfo } from "../types/datasets.js";
+import { ClientFn } from "../types/core.js";
+export type ListDatasetsParams = ClientFn;
+type FullDatasetInfo = DatasetInfo & {
+    startDate: Date;
+    endDate: Date;
+};
+/**
+ * List the information about all datasets available to the client.
+ *
+ * @example
+ * ```ts
+ * import { listDatasets } from "@arizeai/phoenix-client/datasets";
+ *
+ * const datasets = await listDatasets({});
+ * console.log(datasets);
+ * ```
+ *
+ * @throws {Error} If the datasets cannot be listed or the response is invalid.
+ */
+export declare function listDatasets({ client: _client, }: ListDatasetsParams): Promise<FullDatasetInfo[]>;
+export {};
+//# sourceMappingURL=listDatasets.d.ts.map

package/dist/esm/datasets/listDatasets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"listDatasets.d.ts","sourceRoot":"","sources":["../../../src/datasets/listDatasets.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAGzC,MAAM,MAAM,kBAAkB,GAAG,QAAQ,CAAC;AAE1C,KAAK,eAAe,GAAG,WAAW,GAAG;IACnC,SAAS,EAAE,IAAI,CAAC;IAChB,OAAO,EAAE,IAAI,CAAC;CACf,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,wBAAsB,YAAY,CAAC,EACjC,MAAM,EAAE,OAAO,GAChB,EAAE,kBAAkB,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC,CASjD"}

package/dist/esm/datasets/listDatasets.js

@@ -0,0 +1,26 @@
+import { createClient } from "../client.js";
+import invariant from "tiny-invariant";
+/**
+ * List the information about all datasets available to the client.
+ *
+ * @example
+ * ```ts
+ * import { listDatasets } from "@arizeai/phoenix-client/datasets";
+ *
+ * const datasets = await listDatasets({});
+ * console.log(datasets);
+ * ```
+ *
+ * @throws {Error} If the datasets cannot be listed or the response is invalid.
+ */
+export async function listDatasets({ client: _client, }) {
+    const client = _client || createClient();
+    const response = await client.GET("/v1/datasets");
+    invariant(response.data?.data, "Failed to list datasets");
+    return response.data.data.map((dataset) => ({
+        ...dataset,
+        startDate: new Date(dataset.created_at),
+        endDate: new Date(dataset.updated_at),
+    }));
+}
+//# sourceMappingURL=listDatasets.js.map

package/dist/esm/datasets/listDatasets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"listDatasets.js","sourceRoot":"","sources":["../../../src/datasets/listDatasets.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAGzC,OAAO,SAAS,MAAM,gBAAgB,CAAC;AASvC;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,EACjC,MAAM,EAAE,OAAO,GACI;IACnB,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAClD,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,yBAAyB,CAAC,CAAC;IAC1D,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAC1C,GAAG,OAAO;QACV,SAAS,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;QACvC,OAAO,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;KACtC,CAAC,CAAC,CAAC;AACN,CAAC"}

package/dist/esm/experiments/getExperiment.d.ts

@@ -0,0 +1,14 @@
+import { ClientFn } from "../types/core.js";
+import { RanExperiment } from "../types/experiments.js";
+export type GetExperimentResultParams = ClientFn & {
+    /**
+     * The experiment ID.
+     */
+    experimentId: string;
+};
+/**
+ * A function that gets the result of a experiment.
+ * Fetches the experiment data as well as the runs.
+ */
+export declare function getExperiment({ client: _client, experimentId, }: GetExperimentResultParams): Promise<RanExperiment>;
+//# sourceMappingURL=getExperiment.d.ts.map

package/dist/esm/experiments/getExperiment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getExperiment.d.ts","sourceRoot":"","sources":["../../../src/experiments/getExperiment.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAqB,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAIxE,MAAM,MAAM,yBAAyB,GAAG,QAAQ,GAAG;IACjD;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,wBAAsB,aAAa,CAAC,EAClC,MAAM,EAAE,OAAO,EACf,YAAY,GACb,EAAE,yBAAyB,GAAG,OAAO,CAAC,aAAa,CAAC,CAmBpD"}

package/dist/esm/experiments/getExperiment.js

@@ -0,0 +1,25 @@
+import { createClient } from "../client.js";
+import { getExperimentInfo } from "./getExperimentInfo.js";
+import { getExperimentRuns } from "./getExperimentRuns.js";
+/**
+ * A function that gets the result of a experiment.
+ * Fetches the experiment data as well as the runs.
+ */
+export async function getExperiment({ client: _client, experimentId, }) {
+    const client = _client || createClient();
+    const [experiment, experimentRuns] = await Promise.all([
+        getExperimentInfo({ client, experimentId }),
+        getExperimentRuns({ client, experimentId }),
+    ]);
+    const experimentRunsMap = {
+        runs: experimentRuns.runs.reduce((acc, run) => {
+            acc[run.id] = run;
+            return acc;
+        }, {}),
+    };
+    return {
+        ...experiment,
+        ...experimentRunsMap,
+    };
+}
+//# sourceMappingURL=getExperiment.js.map

package/dist/esm/experiments/getExperiment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getExperiment.js","sourceRoot":"","sources":["../../../src/experiments/getExperiment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAGzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AASxD;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,EAClC,MAAM,EAAE,OAAO,EACf,YAAY,GACc;IAC1B,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,CAAC,UAAU,EAAE,cAAc,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QACrD,iBAAiB,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC;QAC3C,iBAAiB,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC;KAC5C,CAAC,CAAC;IACH,MAAM,iBAAiB,GAAsB;QAC3C,IAAI,EAAE,cAAc,CAAC,IAAI,CAAC,MAAM,CAC9B,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACX,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC;YAClB,OAAO,GAAG,CAAC;QACb,CAAC,EACD,EAA+B,CAChC;KACF,CAAC;IACF,OAAO;QACL,GAAG,UAAU;QACb,GAAG,iBAAiB;KACrB,CAAC;AACJ,CAAC"}

package/dist/esm/experiments/getExperimentInfo.d.ts

@@ -0,0 +1,13 @@
+import { ClientFn } from "../types/core.js";
+import { type ExperimentInfo } from "../types/experiments.js";
+export type GetExperimentParams = ClientFn & {
+    /**
+     * The experiment ID
+     */
+    experimentId: string;
+};
+/**
+ * Returns an object containing the high-level info about an experiment
+ */
+export declare function getExperimentInfo({ client: _client, experimentId: experiment_id, }: GetExperimentParams): Promise<ExperimentInfo>;
+//# sourceMappingURL=getExperimentInfo.d.ts.map

package/dist/esm/experiments/getExperimentInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getExperimentInfo.d.ts","sourceRoot":"","sources":["../../../src/experiments/getExperimentInfo.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAE3D,MAAM,MAAM,mBAAmB,GAAG,QAAQ,GAAG;IAC3C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,MAAM,EAAE,OAAO,EACf,YAAY,EAAE,aAAa,GAC5B,EAAE,mBAAmB,GAAG,OAAO,CAAC,cAAc,CAAC,CAoB/C"}

package/dist/esm/experiments/getExperimentInfo.js

@@ -0,0 +1,24 @@
+import invariant from "tiny-invariant";
+import { createClient } from "../client.js";
+/**
+ * Returns an object containing the high-level info about an experiment
+ */
+export async function getExperimentInfo({ client: _client, experimentId: experiment_id, }) {
+    const client = _client || createClient();
+    const { data: { data: experimentData } = {} } = await client.GET("/v1/experiments/{experiment_id}", {
+        params: {
+            path: {
+                experiment_id,
+            },
+        },
+    });
+    invariant(experimentData, "Failed to get experiment");
+    return {
+        id: experimentData.id,
+        datasetId: experimentData.dataset_id,
+        datasetVersionId: experimentData.dataset_version_id,
+        projectName: experimentData.project_name || "", // This will never happen
+        metadata: experimentData.metadata,
+    };
+}
+//# sourceMappingURL=getExperimentInfo.js.map

package/dist/esm/experiments/getExperimentInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getExperimentInfo.js","sourceRoot":"","sources":["../../../src/experiments/getExperimentInfo.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAWzC;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,EACtC,MAAM,EAAE,OAAO,EACf,YAAY,EAAE,aAAa,GACP;IACpB,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,EAAE,EAAE,GAAG,MAAM,MAAM,CAAC,GAAG,CAC9D,iCAAiC,EACjC;QACE,MAAM,EAAE;YACN,IAAI,EAAE;gBACJ,aAAa;aACd;SACF;KACF,CACF,CAAC;IACF,SAAS,CAAC,cAAc,EAAE,0BAA0B,CAAC,CAAC;IACtD,OAAO;QACL,EAAE,EAAE,cAAc,CAAC,EAAE;QACrB,SAAS,EAAE,cAAc,CAAC,UAAU;QACpC,gBAAgB,EAAE,cAAc,CAAC,kBAAkB;QACnD,WAAW,EAAE,cAAc,CAAC,YAAY,IAAI,EAAE,EAAE,yBAAyB;QACzE,QAAQ,EAAE,cAAc,CAAC,QAAQ;KAClC,CAAC;AACJ,CAAC"}

package/dist/esm/experiments/getExperimentRuns.d.ts

@@ -0,0 +1,15 @@
+import { ClientFn } from "../types/core.js";
+import { ExperimentRun } from "../types/experiments.js";
+export type GetExperimentRunsParams = ClientFn & {
+    /**
+     * The experiment ID.
+     */
+    experimentId: string;
+};
+/**
+ * A function that gets the runs (e.g. the results) of a experiment
+ */
+export declare function getExperimentRuns({ client: _client, experimentId, }: GetExperimentRunsParams): Promise<{
+    runs: ExperimentRun[];
+}>;
+//# sourceMappingURL=getExperimentRuns.d.ts.map

package/dist/esm/experiments/getExperimentRuns.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getExperimentRuns.d.ts","sourceRoot":"","sources":["../../../src/experiments/getExperimentRuns.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD,MAAM,MAAM,uBAAuB,GAAG,QAAQ,GAAG;IAC/C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,MAAM,EAAE,OAAO,EACf,YAAY,GACb,EAAE,uBAAuB,GAAG,OAAO,CAAC;IAAE,IAAI,EAAE,aAAa,EAAE,CAAA;CAAE,CAAC,CA0B9D"}

package/dist/esm/experiments/getExperimentRuns.js

@@ -0,0 +1,33 @@
+import { createClient } from "../client.js";
+import invariant from "tiny-invariant";
+/**
+ * A function that gets the runs (e.g. the results) of a experiment
+ */
+export async function getExperimentRuns({ client: _client, experimentId, }) {
+    const client = _client || createClient();
+    const getRunsPromise = client.GET("/v1/experiments/{experiment_id}/runs", {
+        params: {
+            path: {
+                experiment_id: experimentId,
+            },
+        },
+    });
+    const [experimentRunResponse] = await Promise.all([getRunsPromise]);
+    const { data: { data: experimentRunsData } = {} } = experimentRunResponse;
+    invariant(experimentRunsData, "Failed to retrieve experiment runs");
+    return {
+        runs: experimentRunsData.map((run) => {
+            return {
+                id: run.id,
+                traceId: run.trace_id || null,
+                experimentId: run.experiment_id,
+                datasetExampleId: run.dataset_example_id,
+                startTime: new Date(run.start_time),
+                endTime: new Date(run.end_time),
+                output: run.output,
+                error: run.error || null,
+            };
+        }),
+    };
+}
+//# sourceMappingURL=getExperimentRuns.js.map

package/dist/esm/experiments/getExperimentRuns.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getExperimentRuns.js","sourceRoot":"","sources":["../../../src/experiments/getExperimentRuns.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,SAAS,MAAM,gBAAgB,CAAC;AAWvC;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,EACtC,MAAM,EAAE,OAAO,EACf,YAAY,GACY;IACxB,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC,sCAAsC,EAAE;QACxE,MAAM,EAAE;YACN,IAAI,EAAE;gBACJ,aAAa,EAAE,YAAY;aAC5B;SACF;KACF,CAAC,CAAC;IACH,MAAM,CAAC,qBAAqB,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC;IACpE,MAAM,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,kBAAkB,EAAE,GAAG,EAAE,EAAE,GAAG,qBAAqB,CAAC;IAC1E,SAAS,CAAC,kBAAkB,EAAE,oCAAoC,CAAC,CAAC;IACpE,OAAO;QACL,IAAI,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;YACnC,OAAO;gBACL,EAAE,EAAE,GAAG,CAAC,EAAE;gBACV,OAAO,EAAE,GAAG,CAAC,QAAQ,IAAI,IAAI;gBAC7B,YAAY,EAAE,GAAG,CAAC,aAAa;gBAC/B,gBAAgB,EAAE,GAAG,CAAC,kBAAkB;gBACxC,SAAS,EAAE,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC;gBACnC,OAAO,EAAE,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC;gBAC/B,MAAM,EAAE,GAAG,CAAC,MAAiC;gBAC7C,KAAK,EAAE,GAAG,CAAC,KAAK,IAAI,IAAI;aACzB,CAAC;QACJ,CAAC,CAAC;KACH,CAAC;AACJ,CAAC"}