@arizeai/phoenix-client 5.2.0 → 5.3.0

package/dist/esm/__generated__/api/v1.d.ts

@@ -254,7 +254,10 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** List experiments by dataset */
+        /**
+         * List experiments by dataset
+         * @description Retrieve a paginated list of experiments for the specified dataset.
+         */
         get: operations["listExperiments"];
         put?: never;
         /** Create experiment on a dataset */
@@ -276,6 +279,39 @@ export interface paths {
         get: operations["getExperiment"];
         put?: never;
         post?: never;
+        /** Delete experiment by ID */
+        delete: operations["deleteExperiment"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/experiments/{experiment_id}/incomplete-runs": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get incomplete runs for an experiment
+         * @description Get runs that need to be completed for this experiment.
+         *
+         *     Returns all incomplete runs, including both missing runs (not yet attempted)
+         *     and failed runs (attempted but have errors).
+         *
+         *     Args:
+         *         experiment_id: The ID of the experiment
+         *         cursor: Cursor for pagination
+         *         limit: Maximum number of results to return
+         *
+         *     Returns:
+         *         Paginated list of incomplete runs grouped by dataset example,
+         *         with repetition numbers that need to be run
+         */
+        get: operations["getIncompleteExperimentRuns"];
+        put?: never;
+        post?: never;
         delete?: never;
         options?: never;
         head?: never;
@@ -337,6 +373,39 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/experiments/{experiment_id}/incomplete-evaluations": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get incomplete evaluations for an experiment
+         * @description Get experiment runs that have incomplete evaluations.
+         *
+         *     Returns runs with:
+         *     - Missing evaluations (evaluator has not been run)
+         *     - Failed evaluations (evaluator ran but has errors)
+         *
+         *     Args:
+         *         experiment_id: The ID of the experiment
+         *         evaluation_name: List of evaluation names to check (required, at least one)
+         *         cursor: Cursor for pagination
+         *         limit: Maximum number of results to return
+         *
+         *     Returns:
+         *         Paginated list of runs with incomplete evaluations
+         */
+        get: operations["getIncompleteExperimentEvaluations"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/experiment_evaluations": {
         parameters: {
             query?: never;
@@ -1198,6 +1267,26 @@ export interface components {
              * @description The last update timestamp of the experiment
              */
             updated_at: string;
+            /**
+             * Example Count
+             * @description Number of examples in the experiment
+             */
+            example_count: number;
+            /**
+             * Successful Run Count
+             * @description Number of successful runs in the experiment
+             */
+            successful_run_count: number;
+            /**
+             * Failed Run Count
+             * @description Number of failed runs in the experiment
+             */
+            failed_run_count: number;
+            /**
+             * Missing Run Count
+             * @description Number of missing (not yet executed) runs in the experiment
+             */
+            missing_run_count: number;
         };
         /** ExperimentEvaluationResult */
         ExperimentEvaluationResult: {
@@ -1217,8 +1306,8 @@ export interface components {
              */
             explanation?: string | null;
         };
-        /** ExperimentRunResponse */
-        ExperimentRunResponse: {
+        /** ExperimentRun */
+        ExperimentRun: {
             /**
              * Dataset Example Id
              * @description The ID of the dataset example used in the experiment run
@@ -1313,6 +1402,20 @@ export interface components {
         GetExperimentResponseBody: {
             data: components["schemas"]["Experiment"];
         };
+        /** GetIncompleteEvaluationsResponseBody */
+        GetIncompleteEvaluationsResponseBody: {
+            /** Data */
+            data: components["schemas"]["IncompleteExperimentEvaluation"][];
+            /** Next Cursor */
+            next_cursor: string | null;
+        };
+        /** GetIncompleteExperimentRunsResponseBody */
+        GetIncompleteExperimentRunsResponseBody: {
+            /** Data */
+            data: components["schemas"]["IncompleteExperimentRun"][];
+            /** Next Cursor */
+            next_cursor: string | null;
+        };
         /** GetProjectResponseBody */
         GetProjectResponseBody: {
             data: components["schemas"]["Project"];
@@ -1363,6 +1466,34 @@ export interface components {
         };
         /** Identifier */
         Identifier: string;
+        /**
+         * IncompleteExperimentEvaluation
+         * @description Information about an experiment run with incomplete evaluations
+         */
+        IncompleteExperimentEvaluation: {
+            /** @description The experiment run */
+            experiment_run: components["schemas"]["ExperimentRun"];
+            /** @description The dataset example */
+            dataset_example: components["schemas"]["DatasetExample"];
+            /**
+             * Evaluation Names
+             * @description List of evaluation names that are incomplete (either missing or failed)
+             */
+            evaluation_names: string[];
+        };
+        /**
+         * IncompleteExperimentRun
+         * @description Information about incomplete runs for a dataset example
+         */
+        IncompleteExperimentRun: {
+            /** @description The dataset example */
+            dataset_example: components["schemas"]["DatasetExample"];
+            /**
+             * Repetition Numbers
+             * @description List of repetition numbers that need to be run
+             */
+            repetition_numbers: number[];
+        };
         /** InsertedSessionAnnotation */
         InsertedSessionAnnotation: {
             /**
@@ -1427,7 +1558,7 @@ export interface components {
         /** ListExperimentRunsResponseBody */
         ListExperimentRunsResponseBody: {
             /** Data */
-            data: components["schemas"]["ExperimentRunResponse"][];
+            data: components["schemas"]["ExperimentRun"][];
             /** Next Cursor */
             next_cursor: string | null;
         };
@@ -1435,6 +1566,8 @@ export interface components {
         ListExperimentsResponseBody: {
             /** Data */
             data: components["schemas"]["Experiment"][];
+            /** Next Cursor */
+            next_cursor: string | null;
         };
         /** LocalUser */
         LocalUser: {
@@ -1773,6 +1906,10 @@ export interface components {
             description?: string | null;
             /** Source Prompt Id */
             source_prompt_id?: string | null;
+            /** Metadata */
+            metadata?: {
+                [key: string]: unknown;
+            } | null;
             /** Id */
             id: string;
         };
@@ -1882,6 +2019,10 @@ export interface components {
             description?: string | null;
             /** Source Prompt Id */
             source_prompt_id?: string | null;
+            /** Metadata */
+            metadata?: {
+                [key: string]: unknown;
+            } | null;
         };
         /** PromptDeepSeekInvocationParameters */
         PromptDeepSeekInvocationParameters: {
@@ -3627,7 +3768,12 @@ export interface operations {
     };
     listExperiments: {
         parameters: {
-            query?: never;
+            query?: {
+                /** @description Cursor for pagination (base64-encoded experiment ID) */
+                cursor?: string | null;
+                /** @description The max number of experiments to return at a time. */
+                limit?: number;
+            };
             header?: never;
             path: {
                 dataset_id: string;
@@ -3636,7 +3782,7 @@ export interface operations {
         };
         requestBody?: never;
         responses: {
-            /** @description Experiments retrieved successfully */
+            /** @description Paginated list of experiments for the dataset */
             200: {
                 headers: {
                     [name: string]: unknown;
@@ -3654,13 +3800,13 @@ export interface operations {
                     "text/plain": string;
                 };
             };
-            /** @description Validation Error */
+            /** @description Unprocessable Entity */
             422: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["HTTPValidationError"];
+                    "text/plain": string;
                 };
             };
         };
@@ -3767,6 +3913,107 @@ export interface operations {
             };
         };
     };
+    deleteExperiment: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                experiment_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Experiment deleted successfully */
+            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 Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    getIncompleteExperimentRuns: {
+        parameters: {
+            query?: {
+                /** @description Cursor for pagination */
+                cursor?: string | null;
+                /** @description Maximum number of examples with incomplete runs to return */
+                limit?: number;
+            };
+            header?: never;
+            path: {
+                experiment_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Incomplete runs retrieved successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["GetIncompleteExperimentRunsResponseBody"];
+                };
+            };
+            /** @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 cursor format */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
     getExperimentJSON: {
         parameters: {
             query?: never;
@@ -3953,7 +4200,7 @@ export interface operations {
                     "text/plain": string;
                 };
             };
-            /** @description This experiment run has already been submitted */
+            /** @description Experiment run already exists with a successful result and cannot be updated */
             409: {
                 headers: {
                     [name: string]: unknown;
@@ -3973,6 +4220,71 @@ export interface operations {
             };
         };
     };
+    getIncompleteExperimentEvaluations: {
+        parameters: {
+            query?: {
+                /** @description Evaluation names to check */
+                evaluation_name?: string[];
+                /** @description Cursor for pagination */
+                cursor?: string | null;
+                /** @description Maximum number of runs with incomplete evaluations to return */
+                limit?: number;
+            };
+            header?: never;
+            path: {
+                experiment_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Incomplete evaluations retrieved successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["GetIncompleteEvaluationsResponseBody"];
+                };
+            };
+            /** @description No evaluator names provided */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @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 cursor format */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
     upsertExperimentEvaluation: {
         parameters: {
             query?: never;