@arizeai/phoenix-cli 1.15.2 → 1.16.0

package/build/pxi/types.d.ts

@@ -1,89 +1,69 @@
+import type { componentsV1 } from "@arizeai/phoenix-client";
 import type { ChatTransport, UIMessage } from "ai";
 import type { PhoenixConfig } from "../config.js";
 /**
  * Shared types for the PXI terminal chat.
  *
- * These mirror the wire contract of the Phoenix server-agent chat endpoint so
- * the CLI and the server stay in lockstep: the CLI sends a {@link PxiChatRequest}
- * and renders the streamed {@link PxiMessage}s it gets back.
+ * Wire types are derived from the generated OpenAPI schema so the CLI and the
+ * server stay in lockstep at compile time. The exception is the chat message
+ * itself: the streaming layer is driven by the Vercel AI SDK, so
+ * {@link PxiMessage} is typed by the SDK's `UIMessage` rather than the
+ * schema's structural equivalent.
  */
+type SchemasV1 = componentsV1["schemas"];
 /**
  * Extra metadata the server attaches to each assistant message — the session it
  * belongs to, the Phoenix trace it produced (so the UI can link back to it), and
  * token usage. Fields are nullable because tracing and usage reporting are
  * optional and may be disabled server-side.
  */
-export type AssistantMessageMetadata = {
-    sessionId: string;
-    trace?: {
-        traceId: string;
-        rootSpanId: string;
-    } | null;
-    usage?: {
-        tokens: {
-            prompt: number;
-            completion: number;
-            total: number;
-        };
-        promptDetails?: {
-            cacheRead: number;
-            cacheWrite: number;
-        } | null;
-    } | null;
+export type PhoenixAssistantMessageMetadata = SchemasV1["PhoenixAssistantMessageMetadata"];
+/**
+ * `UIMessage.metadata` as a registry of namespaces: Phoenix's own fields under
+ * `phoenix`, pydantic-ai's message-level round-trip channel under `pydantic_ai`.
+ */
+export type PxiMessageMetadata = SchemasV1["MessageMetadata"];
+/** Transient data chunks streamed alongside assistant message content. */
+type PxiDataTypes = {
+    "session-summary": SchemasV1["SessionSummaryChunk"]["data"];
+    "transcript-persisted": SchemasV1["TranscriptPersistedChunk"]["data"];
 };
 /** A chat message (user or assistant) carrying PXI-specific metadata. */
-export type PxiMessage = UIMessage<AssistantMessageMetadata>;
-export type BuiltInProvider = "ANTHROPIC" | "AWS" | "AZURE_OPENAI" | "CEREBRAS" | "DEEPSEEK" | "FIREWORKS" | "GOOGLE" | "GROQ" | "MOONSHOT" | "OLLAMA" | "OPENAI" | "PERPLEXITY" | "TOGETHER" | "XAI";
+export type PxiMessage = UIMessage<PxiMessageMetadata, PxiDataTypes>;
+export type BuiltInProvider = SchemasV1["ModelProvider"];
 /**
  * Which model PXI should talk to. Either a built-in provider keyed by name
  * (e.g. `ANTHROPIC` + `claude-opus-4-6`) or a custom provider configured in
  * Phoenix and addressed by its server-side id.
  */
-export type ModelSelection = {
-    providerType: "builtin";
-    provider: BuiltInProvider;
-    modelName: string;
-} | {
-    providerType: "custom";
-    providerId: string;
-    modelName: string;
-};
+export type ModelSelection = SchemasV1["AgentModelSelection"];
 /**
  * A capability/environment hint sent alongside the conversation so the server
  * agent knows what it is allowed to do and the world it is operating in — the
  * caller's local clock and time zone, whether GraphQL mutations are permitted,
- * and whether web access and subagents are enabled for this run.
+ * and whether web access and subagents are enabled for this run. A subset of
+ * the server's full `ChatContext` union: the rest are browser-only surfaces.
  */
-export type PxiContext = {
-    type: "app";
-    currentDateTime: string;
-    timeZone: string;
-} | {
-    type: "graphql";
-    mutationsEnabled: boolean;
-} | {
-    type: "web_access";
-    enabled: boolean;
-} | {
-    type: "subagents";
-    enabled: boolean;
-};
+export type PxiContext = Extract<SchemasV1["ChatContext"], {
+    type: "app" | "graphql" | "web_access" | "subagents";
+}>;
 /**
  * How edit-style tool calls are gated: `"manual"` requires the user to approve
  * each one, `"bypass"` lets them run unattended (where the server supports it).
  */
-export type PxiEditPermission = "manual" | "bypass";
-/** The request body POSTed to the Phoenix server-agent chat endpoint. */
-export type PxiChatRequest = {
-    id: string;
-    messages: PxiMessage[];
-    trigger: "submit-message";
-    ingestTraces: boolean;
-    exportRemoteTraces: boolean;
-    attachUserId: boolean;
-    editPermission: PxiEditPermission;
-    contexts: PxiContext[];
-    model: ModelSelection;
+export type PxiEditPermission = NonNullable<SchemasV1["ChatRequestBody"]["editPermission"]>;
+/**
+ * The request body POSTed to the agent-session chat endpoint. The server owns
+ * the session transcript, so each turn carries only its trailing message.
+ *
+ * Derived from the generated `ChatRequestBody` schema, with every field the CLI
+ * sends made required (the schema marks server-defaulted fields optional) and
+ * `message` swapped for the SDK-typed {@link PxiMessage}. Fields the CLI never
+ * sends (`requestedSkills`, `turnTraceContext`, and `toolOutputs` — the CLI
+ * executes no client tools, so it has no tool outputs to submit) are omitted.
+ */
+export type PxiChatRequest = Required<Omit<SchemasV1["ChatRequestBody"], "message" | "requestedSkills" | "turnTraceContext" | "toolOutputs">> & {
+    message: PxiMessage;
 };
 /**
  * The fully-resolved configuration for a single PXI session, produced by
@@ -95,6 +75,12 @@ export type PxiRuntimeOptions = {
     sessionId: string;
     config: PhoenixConfig;
     modelSelection: ModelSelection;
+    /**
+     * Whether `--provider`/`--model`/`--custom-provider-id` were passed. Those
+     * flags express an intent to move a restored session onto that model, so
+     * restoring writes it rather than shadowing the persisted value locally.
+     */
+    hasExplicitModelSelection: boolean;
     skipModelPreflight: boolean;
     enableWebAccess: boolean;
     enableSubagents: boolean;
@@ -104,6 +90,76 @@ export type PxiRuntimeOptions = {
     exportRemoteTraces: boolean;
     attachUserId: boolean;
 };
+/** A persisted server-side chat session shown in the session picker. */
+export type PxiSessionSummary = {
+    id: string;
+    title: string;
+    updatedAt: string;
+    isTemporary: boolean;
+};
+/** A session and its canonical persisted transcript. */
+export type PxiSession = PxiSessionSummary & {
+    messages: PxiMessage[];
+    model: ModelSelection;
+    /**
+     * Whether another client currently holds the session's server-side lock.
+     * Absent means no lock is held.
+     */
+    isActive?: boolean;
+    /**
+     * The message ID of the most recently persisted transcript message, or
+     * null for an empty transcript.
+     */
+    lastMessageId?: string | null;
+};
+/**
+ * Cheap synchronization probe for a session: whether another client's turn
+ * holds the lock and where the persisted transcript's tail currently is.
+ * Polling fetches this instead of the full transcript and only downloads
+ * messages when the tail has moved.
+ */
+export type PxiSessionSyncState = {
+    isActive: boolean;
+    updatedAt: string;
+    lastMessageId: string | null;
+};
+/**
+ * The outcome of a compaction request. `compacted` is true when a new
+ * checkpoint was persisted, and `compactionMessage` is that checkpoint. A
+ * no-op — the conversation was already as compact as it can get — yields
+ * `compacted: false` with no message.
+ */
+export type PxiCompactionResult = {
+    compacted: boolean;
+    compactionMessage: PxiMessage | null;
+};
+/** Server-side session operations used by the chat UI. */
+export type PxiSessionClient = {
+    createSession: (options: {
+        temporary: boolean;
+        model: ModelSelection;
+    }) => Promise<PxiSession>;
+    listSessions: () => Promise<PxiSessionSummary[]>;
+    getSession: (options: {
+        sessionId: string;
+    }) => Promise<PxiSession>;
+    getSessionSyncState: (options: {
+        sessionId: string;
+    }) => Promise<PxiSessionSyncState>;
+    /**
+     * Change the model a persisted session runs on, returning the selection in
+     * effect. Turns assert the model they expect rather than setting it, so this
+     * is the only way to move an existing session to a different model.
+     */
+    patchSessionModel: (options: {
+        sessionId: string;
+        model: ModelSelection;
+    }) => Promise<ModelSelection>;
+    compactSession: (options: {
+        sessionId: string;
+        model: ModelSelection;
+    }) => Promise<PxiCompactionResult>;
+};
 /**
  * The interface the UI uses to talk to PXI. `sendMessage` streams an assistant
  * reply: `onAssistantMessage` fires on every incremental update so the UI can
@@ -116,8 +172,10 @@ export type PxiChatClient = {
         messages: PxiMessage[];
         abortSignal?: AbortSignal;
         onAssistantMessage: (message: PxiMessage) => void;
+        onSessionTitle?: (title: string) => void;
     }) => Promise<PxiMessage | null>;
 };
 /** The AI SDK chat transport specialized to {@link PxiMessage}. */
 export type PxiTransport = ChatTransport<PxiMessage>;
+export {};
 //# sourceMappingURL=types.d.ts.map

package/build/pxi/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/pxi/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;AAEnD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE/C;;;;;;GAMG;AAEH;;;;;GAKG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE;QACN,OAAO,EAAE,MAAM,CAAC;QAChB,UAAU,EAAE,MAAM,CAAC;KACpB,GAAG,IAAI,CAAC;IACT,KAAK,CAAC,EAAE;QACN,MAAM,EAAE;YACN,MAAM,EAAE,MAAM,CAAC;YACf,UAAU,EAAE,MAAM,CAAC;YACnB,KAAK,EAAE,MAAM,CAAC;SACf,CAAC;QACF,aAAa,CAAC,EAAE;YACd,SAAS,EAAE,MAAM,CAAC;YAClB,UAAU,EAAE,MAAM,CAAC;SACpB,GAAG,IAAI,CAAC;KACV,GAAG,IAAI,CAAC;CACV,CAAC;AAEF,yEAAyE;AACzE,MAAM,MAAM,UAAU,GAAG,SAAS,CAAC,wBAAwB,CAAC,CAAC;AAE7D,MAAM,MAAM,eAAe,GACvB,WAAW,GACX,KAAK,GACL,cAAc,GACd,UAAU,GACV,UAAU,GACV,WAAW,GACX,QAAQ,GACR,MAAM,GACN,UAAU,GACV,QAAQ,GACR,QAAQ,GACR,YAAY,GACZ,UAAU,GACV,KAAK,CAAC;AAEV;;;;GAIG;AACH,MAAM,MAAM,cAAc,GACtB;IACE,YAAY,EAAE,SAAS,CAAC;IACxB,QAAQ,EAAE,eAAe,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;CACnB,GACD;IACE,YAAY,EAAE,QAAQ,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEN;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAClB;IACE,IAAI,EAAE,KAAK,CAAC;IACZ,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;CAClB,GACD;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,gBAAgB,EAAE,OAAO,CAAC;CAC3B,GACD;IACE,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;CAClB,GACD;IACE,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEN;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEpD,yEAAyE;AACzE,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,UAAU,EAAE,CAAC;IACvB,OAAO,EAAE,gBAAgB,CAAC;IAC1B,YAAY,EAAE,OAAO,CAAC;IACtB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,YAAY,EAAE,OAAO,CAAC;IACtB,cAAc,EAAE,iBAAiB,CAAC;IAClC,QAAQ,EAAE,UAAU,EAAE,CAAC;IACvB,KAAK,EAAE,cAAc,CAAC;CACvB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,aAAa,CAAC;IACtB,cAAc,EAAE,cAAc,CAAC;IAC/B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,eAAe,EAAE,OAAO,CAAC;IACzB,eAAe,EAAE,OAAO,CAAC;IACzB,sBAAsB,EAAE,OAAO,CAAC;IAChC,cAAc,EAAE,iBAAiB,CAAC;IAClC,YAAY,EAAE,OAAO,CAAC;IACtB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,YAAY,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,WAAW,EAAE,CAAC,OAAO,EAAE;QACrB,QAAQ,EAAE,UAAU,EAAE,CAAC;QACvB,WAAW,CAAC,EAAE,WAAW,CAAC;QAC1B,kBAAkB,EAAE,CAAC,OAAO,EAAE,UAAU,KAAK,IAAI,CAAC;KACnD,KAAK,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;CAClC,CAAC;AAEF,mEAAmE;AACnE,MAAM,MAAM,YAAY,GAAG,aAAa,CAAC,UAAU,CAAC,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/pxi/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;AAEnD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE/C;;;;;;;;GAQG;AAEH,KAAK,SAAS,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;AAEzC;;;;;GAKG;AACH,MAAM,MAAM,+BAA+B,GACzC,SAAS,CAAC,iCAAiC,CAAC,CAAC;AAE/C;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,SAAS,CAAC,iBAAiB,CAAC,CAAC;AAE9D,0EAA0E;AAC1E,KAAK,YAAY,GAAG;IAClB,iBAAiB,EAAE,SAAS,CAAC,qBAAqB,CAAC,CAAC,MAAM,CAAC,CAAC;IAC5D,sBAAsB,EAAE,SAAS,CAAC,0BAA0B,CAAC,CAAC,MAAM,CAAC,CAAC;CACvE,CAAC;AAEF,yEAAyE;AACzE,MAAM,MAAM,UAAU,GAAG,SAAS,CAAC,kBAAkB,EAAE,YAAY,CAAC,CAAC;AAErE,MAAM,MAAM,eAAe,GAAG,SAAS,CAAC,eAAe,CAAC,CAAC;AAEzD;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,SAAS,CAAC,qBAAqB,CAAC,CAAC;AAE9D;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,CAC9B,SAAS,CAAC,aAAa,CAAC,EACxB;IAAE,IAAI,EAAE,KAAK,GAAG,SAAS,GAAG,YAAY,GAAG,WAAW,CAAA;CAAE,CACzD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,WAAW,CACzC,SAAS,CAAC,iBAAiB,CAAC,CAAC,gBAAgB,CAAC,CAC/C,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,cAAc,GAAG,QAAQ,CACnC,IAAI,CACF,SAAS,CAAC,iBAAiB,CAAC,EAC5B,SAAS,GAAG,iBAAiB,GAAG,kBAAkB,GAAG,aAAa,CACnE,CACF,GAAG;IACF,OAAO,EAAE,UAAU,CAAC;CACrB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,aAAa,CAAC;IACtB,cAAc,EAAE,cAAc,CAAC;IAC/B;;;;OAIG;IACH,yBAAyB,EAAE,OAAO,CAAC;IACnC,kBAAkB,EAAE,OAAO,CAAC;IAC5B,eAAe,EAAE,OAAO,CAAC;IACzB,eAAe,EAAE,OAAO,CAAC;IACzB,sBAAsB,EAAE,OAAO,CAAC;IAChC,cAAc,EAAE,iBAAiB,CAAC;IAClC,YAAY,EAAE,OAAO,CAAC;IACtB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,YAAY,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,wEAAwE;AACxE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,wDAAwD;AACxD,MAAM,MAAM,UAAU,GAAG,iBAAiB,GAAG;IAC3C,QAAQ,EAAE,UAAU,EAAE,CAAC;IACvB,KAAK,EAAE,cAAc,CAAC;IACtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,SAAS,EAAE,OAAO,CAAC;IACnB,iBAAiB,EAAE,UAAU,GAAG,IAAI,CAAC;CACtC,CAAC;AAEF,0DAA0D;AAC1D,MAAM,MAAM,gBAAgB,GAAG;IAC7B,aAAa,EAAE,CAAC,OAAO,EAAE;QACvB,SAAS,EAAE,OAAO,CAAC;QACnB,KAAK,EAAE,cAAc,CAAC;KACvB,KAAK,OAAO,CAAC,UAAU,CAAC,CAAC;IAC1B,YAAY,EAAE,MAAM,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IACjD,UAAU,EAAE,CAAC,OAAO,EAAE;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,UAAU,CAAC,CAAC;IACpE,mBAAmB,EAAE,CAAC,OAAO,EAAE;QAC7B,SAAS,EAAE,MAAM,CAAC;KACnB,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACnC;;;;OAIG;IACH,iBAAiB,EAAE,CAAC,OAAO,EAAE;QAC3B,SAAS,EAAE,MAAM,CAAC;QAClB,KAAK,EAAE,cAAc,CAAC;KACvB,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAC9B,cAAc,EAAE,CAAC,OAAO,EAAE;QACxB,SAAS,EAAE,MAAM,CAAC;QAClB,KAAK,EAAE,cAAc,CAAC;KACvB,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;CACpC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,WAAW,EAAE,CAAC,OAAO,EAAE;QACrB,QAAQ,EAAE,UAAU,EAAE,CAAC;QACvB,WAAW,CAAC,EAAE,WAAW,CAAC;QAC1B,kBAAkB,EAAE,CAAC,OAAO,EAAE,UAAU,KAAK,IAAI,CAAC;QAClD,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;KAC1C,KAAK,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;CAClC,CAAC;AAEF,mEAAmE;AACnE,MAAM,MAAM,YAAY,GAAG,aAAa,CAAC,UAAU,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arizeai/phoenix-cli",
-  "version": "1.15.2",
+  "version": "1.16.0",
   "description": "A command-line interface for Phoenix",
   "keywords": [
     "arize",
@@ -42,8 +42,8 @@
     "marked-terminal": "^7.3.0",
     "react": "19.2.7",
     "zod": "^4.4.3",
-    "@arizeai/phoenix-config": "0.5.0",
-    "@arizeai/phoenix-client": "7.4.0"
+    "@arizeai/phoenix-client": "7.5.0",
+    "@arizeai/phoenix-config": "0.5.0"
   },
   "devDependencies": {
     "@types/cross-spawn": "^6.0.6",