@arizeai/phoenix-client 6.10.0 → 6.11.0

package/src/__generated__/api/v1.ts

@@ -388,7 +388,11 @@ export interface paths {
         delete: operations["deleteExperiment"];
         options?: never;
         head?: never;
-        patch?: never;
+        /**
+         * Update an experiment by ID
+         * @description Partially update an experiment's name, description, and/or metadata. Only the fields included in the request body are changed; omitted fields are left as-is. Patching an ephemeral experiment refreshes its last-update timestamp, which extends the window before it is swept away.
+         */
+        patch: operations["updateExperiment"];
         trace?: never;
     };
     "/v1/experiments/{experiment_id}/incomplete-runs": {
@@ -1383,22 +1387,6 @@ export interface paths {
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
-        /**
-         * AgentCapabilities
-         * @description Runtime capability state sent by the browser for a chat turn.
-         */
-        AgentCapabilities: {
-            /**
-             * Bash.Retaininactivesessions
-             * @default false
-             */
-            "bash.retainInactiveSessions"?: boolean;
-            /**
-             * Graphql.Mutations
-             * @default false
-             */
-            "graphql.mutations"?: boolean;
-        };
         /**
          * AgentSpanContext
          * @description Span the user has selected.
@@ -1625,12 +1613,8 @@ export interface components {
         /**
          * ChatContext
          * @description Discriminated union of every UI-state context the agent understands.
-         *
-         *     Wrapped in ``RootModel`` so the generated OpenAPI schema exposes a single
-         *     named ``ChatContext`` component instead of inlining the ``oneOf`` at every
-         *     reference site. The actual member is accessible via ``.root``.
          */
-        ChatContext: components["schemas"]["AppContext"] | components["schemas"]["ProjectContext"] | components["schemas"]["TraceContext"] | components["schemas"]["AgentSpanContext"] | components["schemas"]["PlaygroundContext"];
+        ChatContext: components["schemas"]["AppContext"] | components["schemas"]["ProjectContext"] | components["schemas"]["TraceContext"] | components["schemas"]["SessionContext"] | components["schemas"]["PromptContext"] | components["schemas"]["PromptVersionContext"] | components["schemas"]["AgentSpanContext"] | components["schemas"]["PlaygroundContext"] | components["schemas"]["CodeEvaluatorContext"] | components["schemas"]["LlmEvaluatorContext"] | components["schemas"]["DatasetContext"] | components["schemas"]["GraphQLContext"] | components["schemas"]["WebAccessContext"] | components["schemas"]["SubagentsContext"];
         /**
          * ChatRegenerateMessage
          * @description Regenerate message extended with Phoenix-specific fields.
@@ -1657,9 +1641,25 @@ export interface components {
              * @default false
              */
             exportRemoteTraces?: boolean;
+            /**
+             * Attachuserid
+             * @description When true and the request is authenticated as a PhoenixUser, attaches the user's email as the OpenInference ``user.id`` span attribute on all traced work for this request.
+             * @default false
+             */
+            attachUserId?: boolean;
             /** Contexts */
             contexts?: components["schemas"]["ChatContext"][];
-            capabilities?: components["schemas"]["AgentCapabilities"];
+            /**
+             * Editpermission
+             * @default manual
+             * @enum {string}
+             */
+            editPermission?: "manual" | "bypass";
+            /**
+             * Requestedskills
+             * @description Skills the user explicitly requested via the prompt's slash-command affordance. The server force-loads each available skill by injecting a synthetic load_skill tool call/result at the tail of the message history. Unknown or context-unavailable names are ignored.
+             */
+            requestedSkills?: string[];
             /** Model */
             model: components["schemas"]["CustomProviderModelSelection"] | components["schemas"]["BuiltInProviderModelSelection"];
         } & {
@@ -1694,14 +1694,43 @@ export interface components {
              * @default false
              */
             exportRemoteTraces?: boolean;
+            /**
+             * Attachuserid
+             * @description When true and the request is authenticated as a PhoenixUser, attaches the user's email as the OpenInference ``user.id`` span attribute on all traced work for this request.
+             * @default false
+             */
+            attachUserId?: boolean;
             /** Contexts */
             contexts?: components["schemas"]["ChatContext"][];
-            capabilities?: components["schemas"]["AgentCapabilities"];
+            /**
+             * Editpermission
+             * @default manual
+             * @enum {string}
+             */
+            editPermission?: "manual" | "bypass";
+            /**
+             * Requestedskills
+             * @description Skills the user explicitly requested via the prompt's slash-command affordance. The server force-loads each available skill by injecting a synthetic load_skill tool call/result at the tail of the message history. Unknown or context-unavailable names are ignored.
+             */
+            requestedSkills?: string[];
             /** Model */
             model: components["schemas"]["CustomProviderModelSelection"] | components["schemas"]["BuiltInProviderModelSelection"];
         } & {
             [key: string]: unknown;
         };
+        /**
+         * CodeEvaluatorContext
+         * @description Code-evaluator create/edit form mounted in the current browser route.
+         */
+        CodeEvaluatorContext: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "code_evaluator";
+            /** Evaluatornodeid */
+            evaluatorNodeId?: string | null;
+        };
         /** ContinuousAnnotationConfig */
         ContinuousAnnotationConfig: {
             /** Name */
@@ -1969,6 +1998,26 @@ export interface components {
             /** Example Count */
             example_count: number;
         };
+        /**
+         * DatasetContext
+         * @description Dataset the user is currently viewing or has bound to a workflow.
+         *
+         *     Carries the dataset's relay node id and, when known, the active version
+         *     node id. These IDs scope the create-form handoff link and the sampling of
+         *     active dataset examples used as prompt context; the dataset schema itself
+         *     is open.
+         */
+        DatasetContext: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "dataset";
+            /** Datasetnodeid */
+            datasetNodeId: string;
+            /** Datasetversionnodeid */
+            datasetVersionNodeId?: string | null;
+        };
         /** DatasetExample */
         DatasetExample: {
             /** Id */
@@ -2062,6 +2111,8 @@ export interface components {
             toolName: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default approval-requested
@@ -2070,6 +2121,8 @@ export interface components {
             state?: "approval-requested";
             /** Input */
             input: unknown;
+            /** Providerexecuted */
+            providerExecuted?: boolean | null;
             /** Callprovidermetadata */
             callProviderMetadata?: {
                 [key: string]: {
@@ -2094,6 +2147,8 @@ export interface components {
             toolName: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default approval-responded
@@ -2102,6 +2157,8 @@ export interface components {
             state?: "approval-responded";
             /** Input */
             input: unknown;
+            /** Providerexecuted */
+            providerExecuted?: boolean | null;
             /** Callprovidermetadata */
             callProviderMetadata?: {
                 [key: string]: {
@@ -2126,6 +2183,8 @@ export interface components {
             toolName: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default input-available
@@ -2134,6 +2193,8 @@ export interface components {
             state?: "input-available";
             /** Input */
             input: unknown;
+            /** Providerexecuted */
+            providerExecuted?: boolean | null;
             /** Callprovidermetadata */
             callProviderMetadata?: {
                 [key: string]: {
@@ -2158,6 +2219,8 @@ export interface components {
             toolName: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default input-streaming
@@ -2166,6 +2229,8 @@ export interface components {
             state?: "input-streaming";
             /** Input */
             input?: unknown | null;
+            /** Providerexecuted */
+            providerExecuted?: boolean | null;
             /** Callprovidermetadata */
             callProviderMetadata?: {
                 [key: string]: {
@@ -2190,6 +2255,8 @@ export interface components {
             toolName: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default output-available
@@ -2200,6 +2267,8 @@ export interface components {
             input: unknown;
             /** Output */
             output: unknown;
+            /** Providerexecuted */
+            providerExecuted?: boolean | null;
             /** Callprovidermetadata */
             callProviderMetadata?: {
                 [key: string]: {
@@ -2226,6 +2295,8 @@ export interface components {
             toolName: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default output-denied
@@ -2234,6 +2305,8 @@ export interface components {
             state?: "output-denied";
             /** Input */
             input: unknown;
+            /** Providerexecuted */
+            providerExecuted?: boolean | null;
             /** Callprovidermetadata */
             callProviderMetadata?: {
                 [key: string]: {
@@ -2258,6 +2331,8 @@ export interface components {
             toolName: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default output-error
@@ -2268,6 +2343,8 @@ export interface components {
             input: unknown;
             /** Errortext */
             errorText: string;
+            /** Providerexecuted */
+            providerExecuted?: boolean | null;
             /** Callprovidermetadata */
             callProviderMetadata?: {
                 [key: string]: {
@@ -2294,6 +2371,16 @@ export interface components {
              * @description The ID of the dataset version associated with the experiment
              */
             dataset_version_id: string;
+            /**
+             * Name
+             * @description The name of the experiment
+             */
+            name: string;
+            /**
+             * Description
+             * @description The description of the experiment
+             */
+            description: string | null;
             /**
              * Repetitions
              * @description Number of times the experiment is repeated
@@ -2447,6 +2534,13 @@ export interface components {
             type: "FREEFORM";
             /** Description */
             description?: string | null;
+            optimization_direction?: components["schemas"]["OptimizationDirection"] | null;
+            /** Threshold */
+            threshold?: number | null;
+            /** Lower Bound */
+            lower_bound?: number | null;
+            /** Upper Bound */
+            upper_bound?: number | null;
             /** Id */
             id: string;
         };
@@ -2461,6 +2555,13 @@ export interface components {
             type: "FREEFORM";
             /** Description */
             description?: string | null;
+            optimization_direction?: components["schemas"]["OptimizationDirection"] | null;
+            /** Threshold */
+            threshold?: number | null;
+            /** Lower Bound */
+            lower_bound?: number | null;
+            /** Upper Bound */
+            upper_bound?: number | null;
         };
         /** GetAnnotationConfigResponseBody */
         GetAnnotationConfigResponseBody: {
@@ -2562,6 +2663,19 @@ export interface components {
             /** Data */
             data: components["schemas"]["LocalUser"] | components["schemas"]["OAuth2User"] | components["schemas"]["LDAPUser"] | components["schemas"]["AnonymousUser"];
         };
+        /**
+         * GraphQLContext
+         * @description GraphQL runtime state.
+         */
+        GraphQLContext: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "graphql";
+            /** Mutationsenabled */
+            mutationsEnabled: boolean;
+        };
         /** HTTPValidationError */
         HTTPValidationError: {
             /** Detail */
@@ -2718,6 +2832,19 @@ export interface components {
             /** Next Cursor */
             next_cursor: string | null;
         };
+        /**
+         * LlmEvaluatorContext
+         * @description LLM-evaluator create/edit form mounted in the current browser route.
+         */
+        LlmEvaluatorContext: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "llm_evaluator";
+            /** Evaluatornodeid */
+            evaluatorNodeId?: string | null;
+        };
         /** LocalUser */
         LocalUser: {
             /** Id */
@@ -3039,6 +3166,21 @@ export interface components {
              */
             message?: string | null;
         };
+        /**
+         * PlaygroundBuiltinModelContext
+         * @description Built-in playground model selection.
+         */
+        PlaygroundBuiltinModelContext: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "builtin";
+            /** Provider */
+            provider: string;
+            /** Modelname */
+            modelName: string;
+        };
         /**
          * PlaygroundContext
          * @description Playground prompt editor state mounted in the current browser route.
@@ -3049,8 +3191,108 @@ export interface components {
              * @enum {string}
              */
             type: "playground";
-            /** Instanceids */
-            instanceIds: number[];
+            /**
+             * Recordexperiments
+             * @default true
+             */
+            recordExperiments?: boolean;
+            /**
+             * Repetitions
+             * @default 1
+             */
+            repetitions?: number;
+            nextExperimentScaffold?: components["schemas"]["PlaygroundExperimentScaffoldContext"] | null;
+            /** Instances */
+            instances?: components["schemas"]["PlaygroundInstanceContext"][];
+            /** Evaluators */
+            evaluators?: components["schemas"]["PlaygroundEvaluatorContext"][];
+        };
+        /**
+         * PlaygroundCustomProviderModelContext
+         * @description Custom-provider playground model selection.
+         */
+        PlaygroundCustomProviderModelContext: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "custom";
+            /** Customproviderid */
+            customProviderId: string;
+            /** Customprovidername */
+            customProviderName: string;
+            /** Provider */
+            provider: string;
+            /** Modelname */
+            modelName: string;
+        };
+        /**
+         * PlaygroundEvaluatorContext
+         * @description One dataset evaluator on the mounted playground's roster. ``name`` is
+         *     user-controlled; sanitize at every model-visible boundary.
+         */
+        PlaygroundEvaluatorContext: {
+            /** Datasetevaluatorid */
+            datasetEvaluatorId: string;
+            /** Name */
+            name: string;
+            /**
+             * Kind
+             * @enum {string}
+             */
+            kind: "LLM" | "CODE" | "BUILTIN";
+            /** Isbuiltin */
+            isBuiltin: boolean;
+            /** Isapplied */
+            isApplied: boolean;
+        };
+        /**
+         * PlaygroundExperimentScaffoldContext
+         * @description Experiment name/description/metadata the user has staged for the playground's
+         *     *next* dataset-backed run, before that run has started.
+         *
+         *     The playground UI lets the user pre-set how the next recorded run's experiment
+         *     will be named, described, and tagged (via the ``set_playground_experiment_recording``
+         *     tool or the recording form). That staged state is surfaced here so the agent can
+         *     see what is already set and avoid re-staging it.
+         *
+         *     Field semantics:
+         *     - ``name`` / ``description``: the staged values, surfaced to the model verbatim,
+         *       or ``None`` when the user has not staged them.
+         *     - ``has_metadata``: a presence flag, not the value. Only *whether* metadata has
+         *       been staged is model-relevant (so the agent knows not to re-attach it); the
+         *       metadata object itself is deliberately kept out of the prompt.
+         *
+         *     A field left unstaged (``None`` / ``False``) falls back to the server default when
+         *     the run starts. The scaffold is consumed once that next run begins.
+         */
+        PlaygroundExperimentScaffoldContext: {
+            /** Name */
+            name?: string | null;
+            /** Description */
+            description?: string | null;
+            /**
+             * Hasmetadata
+             * @default false
+             */
+            hasMetadata?: boolean;
+        };
+        /**
+         * PlaygroundInstanceContext
+         * @description One mounted playground instance and its current model selection.
+         *
+         *     ``experiment_id`` carries the relay node id of the experiment produced by
+         *     this instance's last dataset-backed run, or ``None`` when the instance has
+         *     not produced one. Ephemeral experiments are included: they remain queryable
+         *     until the server sweeps them ~24h after their last update.
+         */
+        PlaygroundInstanceContext: {
+            /** Instanceid */
+            instanceId: number;
+            /** Model */
+            model?: (components["schemas"]["PlaygroundBuiltinModelContext"] | components["schemas"]["PlaygroundCustomProviderModelContext"]) | null;
+            /** Experimentid */
+            experimentId?: string | null;
         };
         /** Project */
         Project: {
@@ -3276,6 +3518,19 @@ export interface components {
             /** Messages */
             messages: components["schemas"]["PromptMessage"][];
         };
+        /**
+         * PromptContext
+         * @description Prompt the user is currently viewing.
+         */
+        PromptContext: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "prompt";
+            /** Promptnodeid */
+            promptNodeId: string;
+        };
         /** PromptData */
         PromptData: {
             name: components["schemas"]["Identifier"];
@@ -3776,6 +4031,21 @@ export interface components {
             /** Id */
             id: string;
         };
+        /**
+         * PromptVersionContext
+         * @description Prompt version the user is currently viewing.
+         */
+        PromptVersionContext: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "prompt_version";
+            /** Promptnodeid */
+            promptNodeId: string;
+            /** Promptversionnodeid */
+            promptVersionNodeId: string;
+        };
         /** PromptVersionData */
         PromptVersionData: {
             /** Description */
@@ -3977,6 +4247,21 @@ export interface components {
             /** Next Cursor */
             next_cursor: string | null;
         };
+        /**
+         * SessionContext
+         * @description Session the user is currently viewing.
+         */
+        SessionContext: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "session";
+            /** Projectnodeid */
+            projectNodeId: string;
+            /** Sessionnodeid */
+            sessionNodeId: string;
+        };
         /** SessionData */
         SessionData: {
             /** Id */
@@ -4403,6 +4688,19 @@ export interface components {
              */
             type?: "step-start";
         };
+        /**
+         * SubagentsContext
+         * @description User's per-turn request to expose the subagent-spawning tool.
+         */
+        SubagentsContext: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "subagents";
+            /** Enabled */
+            enabled: boolean;
+        };
         /** TextContentPart */
         TextContentPart: {
             /**
@@ -4452,6 +4750,8 @@ export interface components {
             type: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default approval-requested
@@ -4492,6 +4792,8 @@ export interface components {
             type: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default approval-responded
@@ -4544,6 +4846,8 @@ export interface components {
             type: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default input-available
@@ -4572,6 +4876,8 @@ export interface components {
             type: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default input-streaming
@@ -4600,6 +4906,8 @@ export interface components {
             type: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default output-available
@@ -4632,6 +4940,8 @@ export interface components {
             type: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default output-denied
@@ -4660,6 +4970,8 @@ export interface components {
             type: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default output-error
@@ -4908,6 +5220,33 @@ export interface components {
             /** Data */
             data: components["schemas"]["CategoricalAnnotationConfig"] | components["schemas"]["ContinuousAnnotationConfig"] | components["schemas"]["FreeformAnnotationConfig"];
         };
+        /**
+         * UpdateExperimentRequestBody
+         * @description Fields to update on an experiment. Omit a field to leave it unchanged.
+         */
+        UpdateExperimentRequestBody: {
+            /**
+             * Name
+             * @description New name for the experiment (null is rejected; name is required)
+             */
+            name?: string | null;
+            /**
+             * Description
+             * @description New description for the experiment (null clears the description)
+             */
+            description?: string | null;
+            /**
+             * Metadata
+             * @description New metadata object for the experiment (replaces the existing metadata as a whole; null is rejected)
+             */
+            metadata?: {
+                [key: string]: unknown;
+            } | null;
+        };
+        /** UpdateExperimentResponseBody */
+        UpdateExperimentResponseBody: {
+            data: components["schemas"]["Experiment"];
+        };
         /** UpdateProjectRequestBody */
         UpdateProjectRequestBody: {
             /** Description */
@@ -5027,6 +5366,19 @@ export interface components {
             /** Context */
             ctx?: Record<string, unknown>;
         };
+        /**
+         * WebAccessContext
+         * @description User's per-turn request to expose web search / fetch tools.
+         */
+        WebAccessContext: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "web_access";
+            /** Enabled */
+            enabled: boolean;
+        };
         /**
          * _SummarizeRequest
          * @description Body for POST /agents/{agent_id}/sessions/{session_id}/summary.
@@ -5045,6 +5397,12 @@ export interface components {
              * @default false
              */
             exportRemoteTraces?: boolean;
+            /**
+             * Attachuserid
+             * @description When true and the request is authenticated as a PhoenixUser, attaches the user's email as the OpenInference ``user.id`` span attribute on all traced work for this request.
+             * @default false
+             */
+            attachUserId?: boolean;
             /** Messages */
             messages: components["schemas"]["UIMessage"][];
             /** Model */
@@ -5055,6 +5413,19 @@ export interface components {
             /** Summary */
             summary: string;
         };
+        /**
+         * ToolCallProviderMetadata
+         * @description Payload Phoenix stamps under the ``phoenix`` namespace of Vercel AI
+         *     ``providerMetadata`` on tool-call chunks (``tool-input-start`` and
+         *     ``tool-input-available``).
+         */
+        ToolCallProviderMetadata: {
+            /**
+             * Tool Execution Environment
+             * @enum {string}
+             */
+            tool_execution_environment: "client" | "server";
+        };
     };
     responses: never;
     parameters: never;
@@ -6354,6 +6725,59 @@ export interface operations {
             };
         };
     };
+    updateExperiment: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                experiment_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UpdateExperimentRequestBody"];
+            };
+        };
+        responses: {
+            /** @description Experiment updated successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["UpdateExperimentResponseBody"];
+                };
+            };
+            /** @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 */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
     getIncompleteExperimentRuns: {
         parameters: {
             query?: {
@@ -8880,13 +9304,13 @@ export interface operations {
             };
         };
         responses: {
-            /** @description Vercel-AI-style SSE stream. The turn ends with a `message-metadata` chunk whose `messageMetadata` payload matches `AssistantMessageMetadata`. Declared here so the model is included in the generated OpenAPI components. */
+            /** @description Successful Response */
             200: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["AssistantMessageMetadata"];
+                    "application/json": unknown;
                 };
             };
             /** @description Validation Error */