@arizeai/phoenix-client 2.3.5 → 2.4.0

package/package.json

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

package/src/datasets/getDataset.ts

@@ -6,19 +6,23 @@ import { getDatasetInfo } from "./getDatasetInfo";
 
 export type GetDatasetParams = ClientFn & {
   dataset: DatasetSelector;
+  versionId?: string;
 };
 
 /**
- * Get dataset info and the examples from the latest version of the dataset
+ * Get dataset info and examples from the dataset
+ * @param dataset - Dataset selector (ID or name)
+ * @param versionId - Optional specific version ID (if omitted, returns data from the latest version)
  */
 export async function getDataset({
   client: _client,
   dataset,
+  versionId,
 }: GetDatasetParams): Promise<Dataset> {
   const client = _client || createClient();
   const [datasetInfo, datasetExamples] = await Promise.all([
     getDatasetInfo({ client, dataset }),
-    getDatasetExamples({ client, dataset }),
+    getDatasetExamples({ client, dataset, versionId }),
   ]);
   return {
     ...datasetInfo,

package/src/datasets/getDatasetExamples.ts

@@ -6,17 +6,23 @@ import { getDatasetInfoByName } from "./getDatasetInfoByName";
 
 export type GetDatasetExamplesParams = ClientFn & {
   dataset: DatasetSelector;
+  versionId?: string;
 };
 
 /**
- * Get the latest examples from a dataset
+ * Get examples from a dataset
+ * @param dataset - Dataset selector (ID, name, or version ID)
+ * @param versionId - Optional specific version ID (ignored if dataset selector is datasetVersionId)
  */
 export async function getDatasetExamples({
   client: _client,
   dataset,
+  versionId,
 }: GetDatasetExamplesParams): Promise<DatasetExamples> {
   const client = _client || createClient();
+
   let datasetId: string;
+
   if ("datasetName" in dataset) {
     const datasetInfo = await getDatasetInfoByName({
       client,
@@ -26,13 +32,20 @@ export async function getDatasetExamples({
   } else {
     datasetId = dataset.datasetId;
   }
+
   const response = await client.GET("/v1/datasets/{id}/examples", {
     params: {
       path: {
         id: datasetId,
       },
+      query: versionId
+        ? {
+            version_id: versionId,
+          }
+        : undefined,
     },
   });
+
   invariant(response.data?.data, "Failed to get dataset examples");
   const examplesData = response.data.data;
   return {

package/src/datasets/getDatasetInfo.ts

@@ -11,12 +11,14 @@ export type GetDatasetInfoParams = ClientFn & {
 /**
  * Get an overview of the information in a dataset
  * Note: this does not include the examples contained in the dataset
+ * Dataset info is not version-specific, only examples are versioned
  */
 export async function getDatasetInfo({
   client: _client,
   dataset,
 }: GetDatasetInfoParams): Promise<DatasetInfo> {
   const client = _client || createClient();
+
   if ("datasetName" in dataset) {
     return await getDatasetInfoByName({
       client,

package/src/datasets/index.ts

@@ -2,5 +2,4 @@ export * from "./createDataset";
 export * from "./getDataset";
 export * from "./getDatasetExamples";
 export * from "./appendDatasetExamples";
-export * from "./getDatasetExamples";
 export * from "./getDatasetInfo";

package/src/types/datasets.ts

@@ -1,11 +1,18 @@
 import { Node } from "./core";
 
 /**
- * A dataset can be identified by its datasetId
- * TODO: add support for datasetVersionId via discriminated union
+ * A dataset can be identified by its datasetId, datasetName, or datasetVersionId
  */
 export type DatasetSelector = { datasetId: string } | { datasetName: string };
 
+/**
+ * Parameters for selecting a specific version of a dataset
+ */
+export interface DatasetVersionSelector {
+  dataset: DatasetSelector;
+  versionId?: string;
+}
+
 /**
  * Overview information about a dataset
  */
@@ -15,6 +22,15 @@ export interface DatasetInfo extends Node {
   metadata?: Record<string, unknown>;
 }
 
+/**
+ * Information about a dataset version
+ */
+export interface DatasetVersionInfo extends Node {
+  description?: string | null;
+  metadata?: Record<string, unknown>;
+  createdAt: Date;
+}
+
 /**
  * A dataset's examples
  */
@@ -46,3 +62,10 @@ export interface ExampleWithId extends Example, Node {
  * A dataset is a collection of examples for an AI task
  */
 export interface Dataset extends DatasetInfo, DatasetExamples, Node {}
+
+/**
+ * A dataset with its version information
+ */
+export interface DatasetWithVersion extends Dataset {
+  versionInfo: DatasetVersionInfo;
+}