@arizeai/phoenix-client 7.2.0 → 7.3.1

package/src/__generated__/api/v1.ts

@@ -423,6 +423,41 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/datasets/{dataset_identifier}/splits": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Create a dataset split */
+        post: operations["createDatasetSplit"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/datasets/{dataset_identifier}/splits/{split_id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /** Delete a dataset split */
+        delete: operations["deleteDatasetSplit"];
+        options?: never;
+        head?: never;
+        /** Update a dataset split */
+        patch: operations["updateDatasetSplit"];
+        trace?: never;
+    };
     "/v1/datasets/{id}/csv": {
         parameters: {
             query?: never;
@@ -600,6 +635,50 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/experiments/{experiment_id}/tags": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List the tags applied to an experiment
+         * @description List the tags currently pointing at this experiment. Tags are scoped to the experiment's dataset, so a tag appears here only while this experiment owns it.
+         */
+        get: operations["listExperimentTags"];
+        put?: never;
+        /**
+         * Assign a tag to an experiment
+         * @description Assign a tag to an experiment. Tags are scoped to the experiment's dataset and each tag name points at a single experiment, so assigning a tag that another experiment on the same dataset owns atomically moves the tag to this experiment. Re-assigning a tag the experiment already owns is idempotent and replaces the description. Assigning the reserved 'baseline' tag makes this experiment the dataset's baseline; ephemeral experiments cannot become the baseline.
+         */
+        post: operations["setExperimentTag"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/experiments/{experiment_id}/tags/{tag_identifier}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         * Remove a tag from an experiment
+         * @description Remove a tag, identified by its node ID or name, from the experiment that owns it. This operation is idempotent and never steals a tag from another experiment: if the experiment does not currently own the tag, the request is a no-op.
+         */
+        delete: operations["deleteExperimentTag"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/experiments/{experiment_id}/runs": {
         parameters: {
             query?: never;
@@ -2304,6 +2383,40 @@ export interface components {
         CreateDatasetLabelResponseBody: {
             data: components["schemas"]["DatasetLabel"];
         };
+        /** CreateDatasetSplitRequestBody */
+        CreateDatasetSplitRequestBody: {
+            /**
+             * Name
+             * @description A unique name for the split.
+             */
+            name: string;
+            /**
+             * Description
+             * @description An optional description of the split.
+             */
+            description?: string | null;
+            /**
+             * Color
+             * @description An optional hex color for the split (e.g. #33c5e8). Omit for a default.
+             */
+            color?: string | null;
+            /**
+             * Metadata
+             * @description Arbitrary JSON metadata for the split.
+             */
+            metadata?: {
+                [key: string]: unknown;
+            };
+            /**
+             * Example Ids
+             * @description Optional dataset example IDs (GlobalIDs) to seed the split with. Each example must belong to this dataset. Omit to create an empty split.
+             */
+            example_ids?: string[];
+        };
+        /** CreateDatasetSplitResponseBody */
+        CreateDatasetSplitResponseBody: {
+            data: components["schemas"]["DatasetSplit"];
+        };
         /**
          * CreateExperimentRequestBody
          * @description Details of the experiment to be created
@@ -2612,6 +2725,33 @@ export interface components {
             /** Color */
             color: string;
         };
+        /** DatasetSplit */
+        DatasetSplit: {
+            /** Id */
+            id: string;
+            /** Name */
+            name: string;
+            /** Description */
+            description: string | null;
+            /** Color */
+            color: string;
+            /** Metadata */
+            metadata: {
+                [key: string]: unknown;
+            };
+            /** Example Count */
+            example_count: number;
+            /**
+             * Created At
+             * Format: date-time
+             */
+            created_at: string;
+            /**
+             * Updated At
+             * Format: date-time
+             */
+            updated_at: string;
+        };
         /** DatasetVersion */
         DatasetVersion: {
             /** Version Id */
@@ -3069,6 +3209,24 @@ export interface components {
              */
             experiment_id: string;
         };
+        /** ExperimentTag */
+        ExperimentTag: {
+            /**
+             * Id
+             * @description The node ID of the tag
+             */
+            id: string;
+            /**
+             * Name
+             * @description The name of the tag
+             */
+            name: string;
+            /**
+             * Description
+             * @description The description of the tag
+             */
+            description: string | null;
+        };
         /**
          * FileUIPart
          * @description A file part of a message.
@@ -3430,6 +3588,11 @@ export interface components {
             /** Next Cursor */
             next_cursor: string | null;
         };
+        /** ListExperimentTagsResponseBody */
+        ListExperimentTagsResponseBody: {
+            /** Data */
+            data: components["schemas"]["ExperimentTag"][];
+        };
         /** ListExperimentsResponseBody */
         ListExperimentsResponseBody: {
             /** Data */
@@ -4989,6 +5152,20 @@ export interface components {
              */
             dataset_label_ids?: string[];
         };
+        /** SetExperimentTagRequestBody */
+        SetExperimentTagRequestBody: {
+            /** @description The name of the tag to assign, e.g. 'baseline'. If another experiment on the same dataset already owns this tag, the tag is moved to this experiment. */
+            name: components["schemas"]["Identifier"];
+            /**
+             * Description
+             * @description An optional description of the tag (replaces any existing description)
+             */
+            description?: string | null;
+        };
+        /** SetExperimentTagResponseBody */
+        SetExperimentTagResponseBody: {
+            data: components["schemas"]["ExperimentTag"];
+        };
         /** SetProjectAnnotationConfigsRequestBody */
         SetProjectAnnotationConfigsRequestBody: {
             /**
@@ -5924,6 +6101,45 @@ export interface components {
         UpdateDatasetLabelResponseBody: {
             data: components["schemas"]["DatasetLabel"];
         };
+        /** UpdateDatasetSplitRequestBody */
+        UpdateDatasetSplitRequestBody: {
+            /**
+             * Name
+             * @description A new unique name for the split.
+             */
+            name?: string | null;
+            /**
+             * Description
+             * @description A new description, or null to clear it.
+             */
+            description?: string | null;
+            /**
+             * Color
+             * @description A new hex color for the split.
+             */
+            color?: string | null;
+            /**
+             * Metadata
+             * @description New JSON metadata that replaces the existing metadata.
+             */
+            metadata?: {
+                [key: string]: unknown;
+            } | null;
+            /**
+             * Add Example Ids
+             * @description Dataset example IDs (GlobalIDs) to add to the split. Each example must belong to this dataset. Adding an example already in the split is a no-op.
+             */
+            add_example_ids?: string[];
+            /**
+             * Remove Example Ids
+             * @description Dataset example IDs (GlobalIDs) to remove from the split.
+             */
+            remove_example_ids?: string[];
+        };
+        /** UpdateDatasetSplitResponseBody */
+        UpdateDatasetSplitResponseBody: {
+            data: components["schemas"]["DatasetSplit"];
+        };
         /**
          * UpdateExperimentRequestBody
          * @description Fields to update on an experiment. Omit a field to leave it unchanged.
@@ -7793,6 +8009,184 @@ export interface operations {
             };
         };
     };
+    createDatasetSplit: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The dataset identifier: either dataset ID or dataset name. */
+                dataset_identifier: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateDatasetSplitRequestBody"];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CreateDatasetSplitResponseBody"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Dataset or example not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description A dataset split with the given name already exists */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Invalid request */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+    deleteDatasetSplit: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The dataset identifier: either dataset ID or dataset name. */
+                dataset_identifier: string;
+                /** @description The ID (GlobalID) of the dataset split. */
+                split_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Dataset or split not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Invalid dataset split ID */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+    updateDatasetSplit: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The dataset identifier: either dataset ID or dataset name. */
+                dataset_identifier: string;
+                /** @description The ID (GlobalID) of the dataset split. */
+                split_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UpdateDatasetSplitRequestBody"];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["UpdateDatasetSplitResponseBody"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Dataset, split, or example not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description A dataset split with the given name already exists */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Invalid request */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
     getDatasetCsv: {
         parameters: {
             query?: {
@@ -8363,6 +8757,160 @@ export interface operations {
             };
         };
     };
+    listExperimentTags: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The ID of the experiment */
+                experiment_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The tags currently applied to the experiment */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ListExperimentTagsResponseBody"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Experiment not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Invalid experiment ID */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+    setExperimentTag: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The ID of the experiment */
+                experiment_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["SetExperimentTagRequestBody"];
+            };
+        };
+        responses: {
+            /** @description The tag as it now applies to the experiment */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SetExperimentTagResponseBody"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Experiment not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Invalid experiment ID or request body, or the experiment is ephemeral and cannot be tagged as the baseline */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+    deleteExperimentTag: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The ID of the experiment */
+                experiment_id: string;
+                /** @description The node ID or name of the tag to remove */
+                tag_identifier: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description No content returned on successful tag removal */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Experiment not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Invalid experiment ID or tag identifier */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
     listExperimentRuns: {
         parameters: {
             query?: {

package/src/client.ts

@@ -9,6 +9,7 @@ import type {
   paths as oapiPathsV1,
 } from "./__generated__/api/v1.d.ts";
 import {
+  type BaseUrlSource,
   defaultGetEnvironmentOptions,
   makeDefaultClientOptions,
 } from "./config";
@@ -36,6 +37,14 @@ export type Types = {
   };
 };
 
+/**
+ * The client's resolved options, tagged with where the base URL came from so
+ * consumers can tell deliberate configuration from an ambient environment.
+ */
+export type PhoenixClientOptions = ClientOptions & {
+  baseUrlSource: BaseUrlSource;
+};
+
 /**
  * Merge all configuration options according to priority:
  * defaults < environment < explicit options
@@ -51,13 +60,20 @@ export const getMergedOptions = ({
 }: {
   options?: Partial<ClientOptions>;
   getEnvironmentOptions?: () => Partial<ClientOptions>;
-} = {}): ClientOptions => {
+} = {}): PhoenixClientOptions => {
   const defaultOptions = makeDefaultClientOptions();
   const environmentOptions = getEnvironmentOptions();
+  const baseUrlSource: BaseUrlSource =
+    options.baseUrl !== undefined
+      ? "explicit"
+      : environmentOptions.baseUrl !== undefined
+        ? "environment"
+        : "default";
   return {
     ...defaultOptions,
     ...environmentOptions,
     ...options,
+    baseUrlSource,
   };
 };