@arizeai/phoenix-client 2.2.0 → 2.3.0

package/package.json

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

package/src/datasets/appendDatasetExamples.ts

@@ -2,6 +2,7 @@ import { createClient } from "../client";
 import { ClientFn } from "../types/core";
 import { Example, DatasetSelector } from "../types/datasets";
 import invariant from "tiny-invariant";
+import { getDatasetInfo } from "./getDatasetInfo";
 
 export type AppendDatasetExamplesParams = ClientFn & {
   /**
@@ -33,6 +34,16 @@ export async function appendDatasetExamples({
   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);
+  let datasetName: string;
+  if ("datasetName" in dataset) {
+    datasetName = dataset.datasetName;
+  } else {
+    const datasetInfo = await getDatasetInfo({
+      client,
+      dataset,
+    });
+    datasetName = datasetInfo.name;
+  }
   const appendResponse = await client.POST("/v1/datasets/upload", {
     params: {
       query: {
@@ -40,7 +51,7 @@ export async function appendDatasetExamples({
       },
     },
     body: {
-      name: dataset.datasetId,
+      name: datasetName,
       action: "append",
       inputs,
       outputs,

package/src/datasets/getDatasetExamples.ts

@@ -2,6 +2,7 @@ import invariant from "tiny-invariant";
 import { createClient } from "../client";
 import { ClientFn } from "../types/core";
 import { DatasetSelector, DatasetExamples } from "../types/datasets";
+import { getDatasetInfoByName } from "./getDatasetInfoByName";
 
 export type GetDatasetExamplesParams = ClientFn & {
   dataset: DatasetSelector;
@@ -15,10 +16,20 @@ export async function getDatasetExamples({
   dataset,
 }: GetDatasetExamplesParams): Promise<DatasetExamples> {
   const client = _client || createClient();
+  let datasetId: string;
+  if ("datasetName" in dataset) {
+    const datasetInfo = await getDatasetInfoByName({
+      client,
+      datasetName: dataset.datasetName,
+    });
+    datasetId = datasetInfo.id;
+  } else {
+    datasetId = dataset.datasetId;
+  }
   const response = await client.GET("/v1/datasets/{id}/examples", {
     params: {
       path: {
-        id: dataset.datasetId,
+        id: datasetId,
       },
     },
   });

package/src/datasets/getDatasetInfo.ts

@@ -2,6 +2,7 @@ import invariant from "tiny-invariant";
 import { createClient } from "../client";
 import { ClientFn } from "../types/core";
 import { DatasetSelector, DatasetInfo } from "../types/datasets";
+import { getDatasetInfoByName } from "./getDatasetInfoByName";
 
 export type GetDatasetInfoParams = ClientFn & {
   dataset: DatasetSelector;
@@ -16,6 +17,13 @@ export async function getDatasetInfo({
   dataset,
 }: GetDatasetInfoParams): Promise<DatasetInfo> {
   const client = _client || createClient();
+  if ("datasetName" in dataset) {
+    return await getDatasetInfoByName({
+      client,
+      datasetName: dataset.datasetName,
+    });
+  }
+
   const datasetResponse = await client.GET("/v1/datasets/{id}", {
     params: {
       path: {

package/src/datasets/getDatasetInfoByName.ts

@@ -0,0 +1,35 @@
+import { createClient } from "../client";
+import { ClientFn } from "../types/core";
+import { DatasetInfo } from "../types/datasets";
+
+export type GetDatasetParams = ClientFn & {
+  datasetName: string;
+};
+
+/**
+ * Get the information of a dataset via the name
+ */
+export async function getDatasetInfoByName({
+  client: _client,
+  datasetName,
+}: GetDatasetParams): Promise<DatasetInfo> {
+  const client = _client || createClient();
+  const response = await client.GET("/v1/datasets", {
+    query: {
+      name: datasetName,
+    },
+  });
+  if (response.data?.data?.length) {
+    const datasetInfo = response.data.data[0];
+    if (!datasetInfo) {
+      throw new Error(`Dataset with name ${datasetName} not found`);
+    }
+    return {
+      id: datasetInfo.id,
+      name: datasetInfo.name,
+      description: datasetInfo.description || undefined,
+      metadata: datasetInfo.metadata,
+    };
+  }
+  throw new Error(`Dataset with name ${datasetName} not found`);
+}

package/src/types/datasets.ts

@@ -2,9 +2,9 @@ import { Node } from "./core";
 
 /**
  * A dataset can be identified by its datasetId
- * TODO: add support for datasetName and datasetVersionId via discriminated union
+ * TODO: add support for datasetVersionId via discriminated union
  */
-export type DatasetSelector = { datasetId: string };
+export type DatasetSelector = { datasetId: string } | { datasetName: string };
 
 /**
  * Overview information about a dataset