@arizeai/phoenix-client 6.7.0 → 6.8.1

package/src/__generated__/api/v1.ts

@@ -214,6 +214,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/datasets/{id}/jsonl": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Download dataset examples as JSONL file */
+        get: operations["getDatasetJSONL"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/datasets/{id}/jsonl/openai_ft": {
         parameters: {
             query?: never;
@@ -458,6 +475,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/trace_notes": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Create a trace note
+         * @description Add a note annotation to a trace. Notes are special annotations that allow multiple entries per trace (unlike regular annotations which are unique by name and identifier). Each note gets a unique UUIDv4 identifier.
+         */
+        post: operations["createTraceNote"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/traces/{trace_identifier}": {
         parameters: {
             query?: never;
@@ -554,7 +591,7 @@ export interface paths {
         put?: never;
         /**
          * Create a span note
-         * @description Add a note annotation to a span. Notes are special annotations that allow multiple entries per span (unlike regular annotations which are unique by name and identifier). Each note gets a unique timestamp-based identifier.
+         * @description Add a note annotation to a span. Notes are special annotations that allow multiple entries per span (unlike regular annotations which are unique by name and identifier). Each note gets a unique UUIDv4 identifier.
          */
         post: operations["createSpanNote"];
         delete?: never;
@@ -894,6 +931,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/session_notes": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Create a session note
+         * @description Add a note annotation to a session. Notes are special annotations that allow multiple entries per session (unlike regular annotations which are unique by name and identifier). Each note gets a unique UUIDv4 identifier.
+         */
+        post: operations["createSessionNote"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/document_annotations": {
         parameters: {
             query?: never;
@@ -1265,6 +1322,14 @@ export interface components {
         CreatePromptResponseBody: {
             data: components["schemas"]["PromptVersion"];
         };
+        /** CreateSessionNoteRequestBody */
+        CreateSessionNoteRequestBody: {
+            data: components["schemas"]["SessionNoteData"];
+        };
+        /** CreateSessionNoteResponseBody */
+        CreateSessionNoteResponseBody: {
+            data: components["schemas"]["InsertedSessionAnnotation"];
+        };
         /** CreateSpanNoteRequestBody */
         CreateSpanNoteRequestBody: {
             data: components["schemas"]["SpanNoteData"];
@@ -1291,6 +1356,14 @@ export interface components {
              */
             total_queued: number;
         };
+        /** CreateTraceNoteRequestBody */
+        CreateTraceNoteRequestBody: {
+            data: components["schemas"]["TraceNoteData"];
+        };
+        /** CreateTraceNoteResponseBody */
+        CreateTraceNoteResponseBody: {
+            data: components["schemas"]["InsertedTraceAnnotation"];
+        };
         /** CreateUserRequestBody */
         CreateUserRequestBody: {
             /** User */
@@ -1335,6 +1408,8 @@ export interface components {
         DatasetExample: {
             /** Id */
             id: string;
+            /** Node Id */
+            node_id: string;
             /** Input */
             input: {
                 [key: string]: unknown;
@@ -2187,8 +2262,34 @@ export interface components {
             top_p?: number;
             /** Stop Sequences */
             stop_sequences?: string[];
+            output_config?: components["schemas"]["PromptAnthropicOutputConfig"];
             /** Thinking */
-            thinking?: components["schemas"]["PromptAnthropicThinkingConfigDisabled"] | components["schemas"]["PromptAnthropicThinkingConfigEnabled"];
+            thinking?: components["schemas"]["PromptAnthropicThinkingConfigDisabled"] | components["schemas"]["PromptAnthropicThinkingConfigEnabled"] | components["schemas"]["PromptAnthropicThinkingConfigAdaptive"];
+            /** Extra Body */
+            extra_body?: {
+                [key: string]: unknown;
+            };
+        };
+        /** PromptAnthropicOutputConfig */
+        PromptAnthropicOutputConfig: {
+            /**
+             * Effort
+             * @enum {string}
+             */
+            effort?: "low" | "medium" | "high" | "xhigh" | "max";
+        };
+        /** PromptAnthropicThinkingConfigAdaptive */
+        PromptAnthropicThinkingConfigAdaptive: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "adaptive";
+            /**
+             * Display
+             * @enum {string}
+             */
+            display?: "summarized" | "omitted";
         };
         /** PromptAnthropicThinkingConfigDisabled */
         PromptAnthropicThinkingConfigDisabled: {
@@ -2207,6 +2308,11 @@ export interface components {
             type: "enabled";
             /** Budget Tokens */
             budget_tokens: number;
+            /**
+             * Display
+             * @enum {string}
+             */
+            display?: "summarized" | "omitted";
         };
         /** PromptAwsInvocationParameters */
         PromptAwsInvocationParameters: {
@@ -2225,6 +2331,8 @@ export interface components {
             temperature?: number;
             /** Top P */
             top_p?: number;
+            /** Stop Sequences */
+            stop_sequences?: string[];
         };
         /** PromptAzureOpenAIInvocationParameters */
         PromptAzureOpenAIInvocationParameters: {
@@ -2251,11 +2359,17 @@ export interface components {
             top_p?: number;
             /** Seed */
             seed?: number;
+            /** Stop */
+            stop?: string[];
             /**
              * Reasoning Effort
              * @enum {string}
              */
             reasoning_effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
+            /** Extra Body */
+            extra_body?: {
+                [key: string]: unknown;
+            };
         };
         /** PromptCerebrasInvocationParameters */
         PromptCerebrasInvocationParameters: {
@@ -2282,11 +2396,17 @@ export interface components {
             top_p?: number;
             /** Seed */
             seed?: number;
+            /** Stop */
+            stop?: string[];
             /**
              * Reasoning Effort
              * @enum {string}
              */
             reasoning_effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
+            /** Extra Body */
+            extra_body?: {
+                [key: string]: unknown;
+            };
         };
         /** PromptChatTemplate */
         PromptChatTemplate: {
@@ -2335,11 +2455,17 @@ export interface components {
             top_p?: number;
             /** Seed */
             seed?: number;
+            /** Stop */
+            stop?: string[];
             /**
              * Reasoning Effort
              * @enum {string}
              */
             reasoning_effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
+            /** Extra Body */
+            extra_body?: {
+                [key: string]: unknown;
+            };
         };
         /** PromptFireworksInvocationParameters */
         PromptFireworksInvocationParameters: {
@@ -2366,11 +2492,17 @@ export interface components {
             top_p?: number;
             /** Seed */
             seed?: number;
+            /** Stop */
+            stop?: string[];
             /**
              * Reasoning Effort
              * @enum {string}
              */
             reasoning_effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
+            /** Extra Body */
+            extra_body?: {
+                [key: string]: unknown;
+            };
         };
         /** PromptGoogleInvocationParameters */
         PromptGoogleInvocationParameters: {
@@ -2397,6 +2529,19 @@ export interface components {
             top_p?: number;
             /** Top K */
             top_k?: number;
+            thinking_config?: components["schemas"]["PromptGoogleThinkingConfig"];
+        };
+        /** PromptGoogleThinkingConfig */
+        PromptGoogleThinkingConfig: {
+            /** Thinking Budget */
+            thinking_budget?: number;
+            /**
+             * Thinking Level
+             * @enum {string}
+             */
+            thinking_level?: "minimal" | "low" | "medium" | "high";
+            /** Include Thoughts */
+            include_thoughts?: boolean;
         };
         /** PromptGroqInvocationParameters */
         PromptGroqInvocationParameters: {
@@ -2423,11 +2568,17 @@ export interface components {
             top_p?: number;
             /** Seed */
             seed?: number;
+            /** Stop */
+            stop?: string[];
             /**
              * Reasoning Effort
              * @enum {string}
              */
             reasoning_effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
+            /** Extra Body */
+            extra_body?: {
+                [key: string]: unknown;
+            };
         };
         /** PromptMessage */
         PromptMessage: {
@@ -2464,11 +2615,17 @@ export interface components {
             top_p?: number;
             /** Seed */
             seed?: number;
+            /** Stop */
+            stop?: string[];
             /**
              * Reasoning Effort
              * @enum {string}
              */
             reasoning_effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
+            /** Extra Body */
+            extra_body?: {
+                [key: string]: unknown;
+            };
         };
         /** PromptOllamaInvocationParameters */
         PromptOllamaInvocationParameters: {
@@ -2495,11 +2652,17 @@ export interface components {
             top_p?: number;
             /** Seed */
             seed?: number;
+            /** Stop */
+            stop?: string[];
             /**
              * Reasoning Effort
              * @enum {string}
              */
             reasoning_effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
+            /** Extra Body */
+            extra_body?: {
+                [key: string]: unknown;
+            };
         };
         /** PromptOpenAIInvocationParameters */
         PromptOpenAIInvocationParameters: {
@@ -2526,11 +2689,17 @@ export interface components {
             top_p?: number;
             /** Seed */
             seed?: number;
+            /** Stop */
+            stop?: string[];
             /**
              * Reasoning Effort
              * @enum {string}
              */
             reasoning_effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
+            /** Extra Body */
+            extra_body?: {
+                [key: string]: unknown;
+            };
         };
         /** PromptPerplexityInvocationParameters */
         PromptPerplexityInvocationParameters: {
@@ -2557,11 +2726,17 @@ export interface components {
             top_p?: number;
             /** Seed */
             seed?: number;
+            /** Stop */
+            stop?: string[];
             /**
              * Reasoning Effort
              * @enum {string}
              */
             reasoning_effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
+            /** Extra Body */
+            extra_body?: {
+                [key: string]: unknown;
+            };
         };
         /** PromptResponseFormatJSONSchema */
         PromptResponseFormatJSONSchema: {
@@ -2630,11 +2805,17 @@ export interface components {
             top_p?: number;
             /** Seed */
             seed?: number;
+            /** Stop */
+            stop?: string[];
             /**
              * Reasoning Effort
              * @enum {string}
              */
             reasoning_effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
+            /** Extra Body */
+            extra_body?: {
+                [key: string]: unknown;
+            };
         };
         /** PromptToolChoiceNone */
         PromptToolChoiceNone: {
@@ -2781,11 +2962,17 @@ export interface components {
             top_p?: number;
             /** Seed */
             seed?: number;
+            /** Stop */
+            stop?: string[];
             /**
              * Reasoning Effort
              * @enum {string}
              */
             reasoning_effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
+            /** Extra Body */
+            extra_body?: {
+                [key: string]: unknown;
+            };
         };
         /** ResponseBody[UpsertOrDeleteSecretsResult] */
         ResponseBody_UpsertOrDeleteSecretsResult_: {
@@ -2919,6 +3106,19 @@ export interface components {
             /** Traces */
             traces: components["schemas"]["SessionTraceData"][];
         };
+        /** SessionNoteData */
+        SessionNoteData: {
+            /**
+             * Session Id
+             * @description Session ID
+             */
+            session_id: string;
+            /**
+             * Note
+             * @description The note text to add to the session
+             */
+            note: string;
+        };
         /** SessionTraceData */
         SessionTraceData: {
             /** Id */
@@ -3382,6 +3582,19 @@ export interface components {
             /** Spans */
             spans?: components["schemas"]["TraceSpanData"][] | null;
         };
+        /** TraceNoteData */
+        TraceNoteData: {
+            /**
+             * Trace Id
+             * @description OpenTelemetry Trace ID (hex format w/o 0x prefix)
+             */
+            trace_id: string;
+            /**
+             * Note
+             * @description The note text to add to the trace
+             */
+            note: string;
+        };
         /** TraceSpanData */
         TraceSpanData: {
             /** Id */
@@ -3427,6 +3640,12 @@ export interface components {
             dataset_id: string;
             /** Version Id */
             version_id: string;
+            /** Num Created Examples */
+            num_created_examples: number;
+            /** Num Updated Examples */
+            num_updated_examples: number;
+            /** Num Deleted Examples */
+            num_deleted_examples: number;
         };
         /** UploadDatasetResponseBody */
         UploadDatasetResponseBody: {
@@ -4132,7 +4351,7 @@ export interface operations {
             content: {
                 "application/json": {
                     /** @enum {string} */
-                    action?: "create" | "append";
+                    action?: "create" | "append" | "update";
                     name: string;
                     description?: string;
                     inputs: Record<string, unknown>[];
@@ -4142,21 +4361,27 @@ export interface operations {
                     splits?: (string | string[] | null)[];
                     /** @description Span IDs to link examples back to spans */
                     span_ids?: (string | null)[];
+                    /** @description Optional example ID per example. If provided, it is used as the example's stable public ID. */
+                    example_ids?: (string | null)[];
                 };
                 "multipart/form-data": {
                     /** @enum {string} */
-                    action?: "create" | "append";
+                    action?: "create" | "append" | "update";
                     name: string;
                     description?: string;
                     "input_keys[]": string[];
                     "output_keys[]": string[];
                     "metadata_keys[]"?: string[];
-                    /** @description Column names for auto-assigning examples to splits */
+                    /** @description Deprecated: use split_key instead. Column names for auto-assigning examples to splits */
                     "split_keys[]"?: string[];
+                    /** @description Single column name containing split names (plain string or JSON list) per row */
+                    split_key?: string;
                     /** @description Column names whose object values should be flattened into their selected bucket */
                     "flatten_keys[]"?: string[];
                     /** @description Column name for span IDs to link examples back to spans */
                     span_id_key?: string;
+                    /** @description Column name containing stable IDs for examples. When provided, examples with matching IDs are updated in place when their content changes. */
+                    example_id_key?: string;
                     /** Format: binary */
                     file: string;
                 };
@@ -4181,7 +4406,7 @@ export interface operations {
                     "text/plain": string;
                 };
             };
-            /** @description Dataset of the same name already exists */
+            /** @description Dataset with the given name already exists (action=create). */
             409: {
                 headers: {
                     [name: string]: unknown;
@@ -4300,6 +4525,50 @@ export interface operations {
             };
         };
     };
+    getDatasetJSONL: {
+        parameters: {
+            query?: {
+                /** @description The ID of the dataset version (if omitted, returns data from the latest version) */
+                version_id?: string | null;
+            };
+            header?: never;
+            path: {
+                /** @description The ID of the dataset */
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Invalid dataset or version ID */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
     getDatasetJSONLOpenAIFineTuning: {
         parameters: {
             query?: {
@@ -5082,6 +5351,57 @@ export interface operations {
             };
         };
     };
+    createTraceNote: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateTraceNoteRequestBody"];
+            };
+        };
+        responses: {
+            /** @description Trace note created successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CreateTraceNoteResponseBody"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Trace 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"];
+                };
+            };
+        };
+    };
     deleteTrace: {
         parameters: {
             query?: never;
@@ -6473,6 +6793,57 @@ export interface operations {
             };
         };
     };
+    createSessionNote: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateSessionNoteRequestBody"];
+            };
+        };
+        responses: {
+            /** @description Session note created successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CreateSessionNoteResponseBody"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Session 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"];
+                };
+            };
+        };
+    };
     annotateSpanDocuments: {
         parameters: {
             query?: {

package/src/constants/serverRequirements.ts

@@ -53,6 +53,13 @@ export const ANNOTATE_SESSIONS: RouteRequirement = {
   minServerVersion: [12, 0, 0],
 };
 
+export const ADD_TRACE_NOTE: RouteRequirement = {
+  kind: "route",
+  method: "POST",
+  path: "/v1/trace_notes",
+  minServerVersion: [14, 13, 0],
+};
+
 export const GET_SPANS_TRACE_IDS: ParameterRequirement = {
   kind: "parameter",
   parameterName: "trace_id",
@@ -84,6 +91,14 @@ export const GET_SPANS_BY_ATTRIBUTE: ParameterRequirement = {
   minServerVersion: [14, 9, 0],
 };
 
+export const DATASET_UPLOAD_EXAMPLE_IDS: ParameterRequirement = {
+  kind: "parameter",
+  parameterName: "example_ids",
+  parameterLocation: "body",
+  route: "POST /v1/datasets/upload",
+  minServerVersion: [15, 0, 0],
+};
+
 /**
  * Aggregate list of every known capability requirement.
  *
@@ -96,8 +111,10 @@ export const ALL_REQUIREMENTS: readonly CapabilityRequirement[] = [
   DELETE_SESSIONS,
   LIST_PROJECT_SESSIONS,
   ANNOTATE_SESSIONS,
+  ADD_TRACE_NOTE,
   GET_SPANS_TRACE_IDS,
   GET_SPANS_FILTERS,
   GET_SPANS_BY_ATTRIBUTE,
   LIST_PROJECT_TRACES,
+  DATASET_UPLOAD_EXAMPLE_IDS,
 ] as const;