@arizeai/phoenix-client 6.10.0 → 6.10.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arizeai/phoenix-client",
-  "version": "6.10.0",
+  "version": "6.10.1",
   "description": "A client for the Phoenix API",
   "keywords": [
     "arize",

package/src/__generated__/api/v1.ts

@@ -1383,22 +1383,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 +1609,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"]["AgentSpanContext"] | components["schemas"]["PlaygroundContext"] | components["schemas"]["CodeEvaluatorContext"] | components["schemas"]["LlmEvaluatorContext"] | components["schemas"]["DatasetContext"] | components["schemas"]["GraphQLContext"] | components["schemas"]["WebAccessContext"];
         /**
          * ChatRegenerateMessage
          * @description Regenerate message extended with Phoenix-specific fields.
@@ -1659,7 +1639,17 @@ export interface components {
             exportRemoteTraces?: 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"];
         } & {
@@ -1696,12 +1686,35 @@ export interface components {
             exportRemoteTraces?: 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 +1982,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 +2095,8 @@ export interface components {
             toolName: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default approval-requested
@@ -2070,6 +2105,8 @@ export interface components {
             state?: "approval-requested";
             /** Input */
             input: unknown;
+            /** Providerexecuted */
+            providerExecuted?: boolean | null;
             /** Callprovidermetadata */
             callProviderMetadata?: {
                 [key: string]: {
@@ -2094,6 +2131,8 @@ export interface components {
             toolName: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default approval-responded
@@ -2102,6 +2141,8 @@ export interface components {
             state?: "approval-responded";
             /** Input */
             input: unknown;
+            /** Providerexecuted */
+            providerExecuted?: boolean | null;
             /** Callprovidermetadata */
             callProviderMetadata?: {
                 [key: string]: {
@@ -2126,6 +2167,8 @@ export interface components {
             toolName: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default input-available
@@ -2134,6 +2177,8 @@ export interface components {
             state?: "input-available";
             /** Input */
             input: unknown;
+            /** Providerexecuted */
+            providerExecuted?: boolean | null;
             /** Callprovidermetadata */
             callProviderMetadata?: {
                 [key: string]: {
@@ -2158,6 +2203,8 @@ export interface components {
             toolName: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default input-streaming
@@ -2166,6 +2213,8 @@ export interface components {
             state?: "input-streaming";
             /** Input */
             input?: unknown | null;
+            /** Providerexecuted */
+            providerExecuted?: boolean | null;
             /** Callprovidermetadata */
             callProviderMetadata?: {
                 [key: string]: {
@@ -2190,6 +2239,8 @@ export interface components {
             toolName: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default output-available
@@ -2200,6 +2251,8 @@ export interface components {
             input: unknown;
             /** Output */
             output: unknown;
+            /** Providerexecuted */
+            providerExecuted?: boolean | null;
             /** Callprovidermetadata */
             callProviderMetadata?: {
                 [key: string]: {
@@ -2226,6 +2279,8 @@ export interface components {
             toolName: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default output-denied
@@ -2234,6 +2289,8 @@ export interface components {
             state?: "output-denied";
             /** Input */
             input: unknown;
+            /** Providerexecuted */
+            providerExecuted?: boolean | null;
             /** Callprovidermetadata */
             callProviderMetadata?: {
                 [key: string]: {
@@ -2258,6 +2315,8 @@ export interface components {
             toolName: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default output-error
@@ -2268,6 +2327,8 @@ export interface components {
             input: unknown;
             /** Errortext */
             errorText: string;
+            /** Providerexecuted */
+            providerExecuted?: boolean | null;
             /** Callprovidermetadata */
             callProviderMetadata?: {
                 [key: string]: {
@@ -2447,6 +2508,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 +2529,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 +2637,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 +2806,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 +3140,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 +3165,76 @@ export interface components {
              * @enum {string}
              */
             type: "playground";
-            /** Instanceids */
-            instanceIds: number[];
+            /**
+             * Recordexperiments
+             * @default true
+             */
+            recordExperiments?: boolean;
+            /**
+             * Repetitions
+             * @default 1
+             */
+            repetitions?: number;
+            /** 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;
+        };
+        /**
+         * 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: {
@@ -4452,6 +4636,8 @@ export interface components {
             type: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default approval-requested
@@ -4492,6 +4678,8 @@ export interface components {
             type: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default approval-responded
@@ -4544,6 +4732,8 @@ export interface components {
             type: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default input-available
@@ -4572,6 +4762,8 @@ export interface components {
             type: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default input-streaming
@@ -4600,6 +4792,8 @@ export interface components {
             type: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default output-available
@@ -4632,6 +4826,8 @@ export interface components {
             type: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default output-denied
@@ -4660,6 +4856,8 @@ export interface components {
             type: string;
             /** Toolcallid */
             toolCallId: string;
+            /** Title */
+            title?: string | null;
             /**
              * State
              * @default output-error
@@ -5027,6 +5225,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.
@@ -5055,6 +5266,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;
@@ -8880,13 +9104,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 */

package/src/experiments/helpers/getExampleGlobalId.ts

@@ -0,0 +1,12 @@
+import type { ExampleWithId } from "../../types/datasets";
+
+/**
+ * The example's node GlobalID, which experiment runs record as their
+ * `dataset_example_id`. Servers that predate the `nodeId` field deliver the
+ * GlobalID in the `id` field instead.
+ */
+export function getExampleGlobalId(
+  example: Pick<ExampleWithId, "id"> & Partial<Pick<ExampleWithId, "nodeId">>
+): string {
+  return example.nodeId ?? example.id;
+}

package/src/experiments/resumeEvaluation.ts

@@ -29,6 +29,7 @@ import { ensureString } from "../utils/ensureString";
 import { toObjectHeaders } from "../utils/toObjectHeaders";
 import { getExperimentInfo } from "./getExperimentInfo.js";
 import { getExperimentEvaluators } from "./helpers";
+import { getExampleGlobalId } from "./helpers/getExampleGlobalId";
 import { logEvalResumeSummary, PROGRESS_PREFIX } from "./logging";
 import { cleanupOwnedTracerProvider } from "./tracing";
 
@@ -729,7 +730,7 @@ async function runSingleEvaluation({
         ...objectAsAttributes({
           experiment_id: experimentId,
           experiment_run_id: experimentRun.id,
-          dataset_example_id: datasetExample.nodeId,
+          dataset_example_id: getExampleGlobalId(datasetExample),
         }),
       });
 

package/src/experiments/resumeExperiment.ts

@@ -28,6 +28,7 @@ import { isHttpErrorWithStatus } from "../utils/isHttpError";
 import { toObjectHeaders } from "../utils/toObjectHeaders";
 import { getDatasetExperimentsUrl, getExperimentUrl } from "../utils/urlUtils";
 import { getExperimentInfo } from "./getExperimentInfo.js";
+import { getExampleGlobalId } from "./helpers/getExampleGlobalId";
 import {
   logExperimentResumeSummary,
   logLinks,
@@ -619,7 +620,7 @@ async function recordTaskResult({
         },
       },
       body: {
-        dataset_example_id: example.nodeId,
+        dataset_example_id: getExampleGlobalId(example),
         repetition_number: repetitionNumber,
         output: output as Record<string, unknown>,
         start_time: startTime.toISOString(),
@@ -695,7 +696,7 @@ async function runSingleTask({
         [SemanticConventions.INPUT_MIME_TYPE]: MimeType.JSON,
         ...objectAsAttributes({
           experiment_id: experimentId,
-          dataset_example_id: example.nodeId,
+          dataset_example_id: getExampleGlobalId(example),
           repetition_number: repetitionNumber,
         }),
       });

package/src/experiments/runExperiment.ts

@@ -47,6 +47,7 @@ import {
 } from "../utils/urlUtils";
 import { getExperimentInfo } from "./getExperimentInfo";
 import { getExperimentEvaluators } from "./helpers";
+import { getExampleGlobalId } from "./helpers/getExampleGlobalId";
 import {
   logEvalSummary,
   logLinks,
@@ -485,7 +486,7 @@ function runTaskWithExamples({
         id: localId(), // initialized with local id, will be replaced with server-assigned id when dry run is false
         traceId,
         experimentId,
-        datasetExampleId: example.id,
+        datasetExampleId: getExampleGlobalId(example),
         startTime: new Date(),
         endTime: new Date(), // will get replaced with actual end time
         output: null,
@@ -509,7 +510,7 @@ function runTaskWithExamples({
             },
           },
           body: {
-            dataset_example_id: example.nodeId,
+            dataset_example_id: getExampleGlobalId(example),
             output: thisRun.output,
             repetition_number: repetitionNumber,
             start_time: thisRun.startTime.toISOString(),
@@ -681,9 +682,11 @@ export async function evaluateExperiment({
     type EvaluationId = string;
     const evaluationRuns: Record<EvaluationId, ExperimentEvaluationRun> = {};
 
+    // Index examples by node GlobalID, matching how runs record
+    // datasetExampleId.
     const examplesById: Record<string, Example> = {};
     for (const example of dataset.examples) {
-      examplesById[example.id] = example;
+      examplesById[getExampleGlobalId(example)] = example;
     }
 
     const onEvaluationComplete = (run: ExperimentEvaluationRun) => {