@arizeai/phoenix-client 5.4.0 → 5.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arizeai/phoenix-client",
-  "version": "5.4.0",
+  "version": "5.5.0",
   "description": "A client for the Phoenix API",
   "main": "dist/src/index.js",
   "module": "dist/esm/index.js",
@@ -67,7 +67,7 @@
     "tsx": "^4.19.3",
     "typescript": "^5.8.2",
     "vitest": "^4.0.10",
-    "@arizeai/phoenix-evals": "0.4.0"
+    "@arizeai/phoenix-evals": "0.6.0"
   },
   "dependencies": {
     "@arizeai/openinference-semantic-conventions": "^1.1.0",

package/src/__generated__/api/v1.ts

@@ -3527,6 +3527,8 @@ export interface operations {
                     inputs: Record<string, unknown>[];
                     outputs?: Record<string, unknown>[];
                     metadata?: Record<string, unknown>[];
+                    /** @description Split per example: string, string array, or null */
+                    splits?: (string | string[] | null)[];
                 };
                 "multipart/form-data": {
                     /** @enum {string} */
@@ -3536,6 +3538,8 @@ export interface operations {
                     "input_keys[]": string[];
                     "output_keys[]": string[];
                     "metadata_keys[]"?: string[];
+                    /** @description Column names for auto-assigning examples to splits */
+                    "split_keys[]"?: string[];
                     /** Format: binary */
                     file: string;
                 };

package/src/datasets/appendDatasetExamples.ts

@@ -36,6 +36,9 @@ 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 ?? {});
+  const splits = examples.map((example) =>
+    example.splits !== undefined ? example.splits : null
+  );
   let datasetName: string;
   if ("datasetName" in dataset) {
     datasetName = dataset.datasetName;
@@ -58,6 +61,7 @@ export async function appendDatasetExamples({
       inputs,
       outputs,
       metadata,
+      splits,
     },
   });
   invariant(appendResponse.data?.data, "Failed to append dataset examples");

package/src/datasets/createDataset.ts

@@ -37,6 +37,9 @@ export async function createDataset({
   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 splits = examples.map((example) =>
+    example?.splits !== undefined ? example.splits : null
+  );
   const createDatasetResponse = await client.POST("/v1/datasets/upload", {
     params: {
       query: {
@@ -51,6 +54,7 @@ export async function createDataset({
       inputs,
       outputs,
       metadata,
+      splits,
     },
   });
   invariant(createDatasetResponse.data?.data, "Failed to create dataset");

package/src/types/datasets.ts

@@ -45,6 +45,13 @@ export interface Example {
   input: Record<string, unknown>;
   output?: Record<string, unknown> | null;
   metadata?: Record<string, unknown> | null;
+  /**
+   * Split assignment for this example. Can be:
+   * - A single string for one split: "train"
+   * - An array of strings for multiple splits: ["train", "easy"]
+   * - null for no split assignment
+   */
+  splits?: string | string[] | null;
 }
 
 /**

package/src/utils/urlUtils.ts

@@ -8,7 +8,13 @@
  * @returns The base URL for the Phoenix web UI
  */
 function getWebBaseUrl(baseUrl: string): string {
-  return new URL(baseUrl).toString();
+  const url = new URL(baseUrl);
+  // Ensure the pathname ends with a trailing slash for proper path concatenation
+  // Without this, the URL constructor treats the last segment as a file and replaces it
+  if (!url.pathname.endsWith("/")) {
+    url.pathname += "/";
+  }
+  return url.toString();
 }
 
 /**
@@ -28,7 +34,9 @@ export function getExperimentUrl({
   datasetId: string;
   experimentId: string;
 }): string {
-  return `${getWebBaseUrl(baseUrl)}datasets/${datasetId}/compare?experimentId=${experimentId}`;
+  const url = new URL(`datasets/${datasetId}/compare`, getWebBaseUrl(baseUrl));
+  url.searchParams.set("experimentId", experimentId);
+  return url.toString();
 }
 
 /**
@@ -45,7 +53,11 @@ export function getDatasetExperimentsUrl({
   baseUrl: string;
   datasetId: string;
 }): string {
-  return `${getWebBaseUrl(baseUrl)}datasets/${datasetId}/experiments`;
+  const url = new URL(
+    `datasets/${datasetId}/experiments`,
+    getWebBaseUrl(baseUrl)
+  );
+  return url.toString();
 }
 
 /**
@@ -62,5 +74,6 @@ export function getDatasetUrl({
   baseUrl: string;
   datasetId: string;
 }): string {
-  return `${getWebBaseUrl(baseUrl)}datasets/${datasetId}/examples`;
+  const url = new URL(`datasets/${datasetId}/examples`, getWebBaseUrl(baseUrl));
+  return url.toString();
 }