@arizeai/phoenix-client 7.1.0 → 7.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arizeai/phoenix-client",
-  "version": "7.1.0",
+  "version": "7.2.0",
   "description": "A client for the Phoenix API",
   "keywords": [
     "arize",
@@ -53,6 +53,10 @@
       "import": "./dist/esm/sessions/index.js",
       "require": "./dist/src/sessions/index.js"
     },
+    "./projects": {
+      "import": "./dist/esm/projects/index.js",
+      "require": "./dist/src/projects/index.js"
+    },
     "./traces": {
       "import": "./dist/esm/traces/index.js",
       "require": "./dist/src/traces/index.js"
@@ -95,31 +99,31 @@
     }
   },
   "dependencies": {
-    "@arizeai/openinference-semantic-conventions": "^2.5.0",
+    "@arizeai/openinference-semantic-conventions": "^2.6.0",
     "async": "^3.2.6",
     "openapi-fetch": "^0.17.0",
     "tiny-invariant": "^1.3.3",
     "zod": "^4.4.3",
-    "@arizeai/phoenix-config": "0.4.0",
-    "@arizeai/phoenix-otel": "2.1.0"
+    "@arizeai/phoenix-otel": "2.1.0",
+    "@arizeai/phoenix-config": "0.4.0"
   },
   "devDependencies": {
-    "@ai-sdk/openai": "^4.0.0",
-    "@ai-sdk/otel": "^1.0.0",
+    "@ai-sdk/openai": "^4.0.27",
+    "@ai-sdk/otel": "^1.0.47",
     "@anthropic-ai/sdk": "^0.111.0",
     "@opentelemetry/api": "^1.9.1",
-    "@opentelemetry/sdk-trace-node": "^2.9.0",
+    "@opentelemetry/sdk-trace-node": "^2.10.0",
     "@types/async": "^3.2.25",
-    "@types/node": "^26.1.1",
-    "ai": "^7.0.0",
+    "@types/node": "^26.1.2",
+    "ai": "^7.0.47",
     "dotenv": "^17.4.2",
     "jest": "^30.4.2",
-    "openai": "^6.48.0",
+    "openai": "^6.49.0",
     "openapi-typescript": "^7.13.0",
     "tsx": "^4.23.1",
     "vitest": "^4.1.10",
-    "@arizeai/phoenix-testing": "0.0.0",
-    "@arizeai/phoenix-evals": "2.1.0"
+    "@arizeai/phoenix-evals": "2.2.0",
+    "@arizeai/phoenix-testing": "0.0.0"
   },
   "peerDependencies": {
     "@anthropic-ai/sdk": "^0.35.0",

package/src/__generated__/api/v1.ts

@@ -1027,7 +1027,11 @@ export interface paths {
         delete: operations["deletePrompt"];
         options?: never;
         head?: never;
-        patch?: never;
+        /**
+         * Update prompt metadata
+         * @description Update a prompt's description and metadata by identifier.
+         */
+        patch: operations["patchPrompt"];
         trace?: never;
     };
     "/v1/projects": {
@@ -1390,6 +1394,28 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/chat/completions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * OpenAI-compatible chat completions
+         * @description Creates a chat completion using the OpenAI wire format, proxying to the selected provider with credentials resolved on the server (secret store first, environment second) — callers never handle provider API keys. Model must be '{provider}:{model_name}' for a built-in provider (one of anthropic, aws, azure_openai, cerebras, deepseek, fireworks, google, groq, moonshot, ollama, openai, perplexity, together, xai) or 'custom:{provider_id}:{model_name}' for a stored custom provider, e.g. 'openai:gpt-4o' or 'anthropic:claude-sonnet-4-5'. Set `stream: true` for server-sent events of `chat.completion.chunk` payloads terminated by `data: [DONE]`. Tool calling is not supported.
+         *
+         *     **Phoenix is not an AI gateway.** The same server also takes on trace ingestion traffic, so routing production LLM calls through it competes with ingestion. Use this endpoint only to quickly try out different models in non-production environments.
+         */
+        post: operations["createChatCompletion"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/auth/login": {
         parameters: {
             query?: never;
@@ -1933,6 +1959,98 @@ export interface components {
             /** Score */
             score?: number | null;
         };
+        /** ChatCompletion */
+        ChatCompletion: {
+            /** Id */
+            id: string;
+            /**
+             * Object
+             * @default chat.completion
+             * @constant
+             */
+            object?: "chat.completion";
+            /** Created */
+            created: number;
+            /** Model */
+            model: string;
+            /** Choices */
+            choices: components["schemas"]["ChatCompletionChoice"][];
+            usage: components["schemas"]["ChatCompletionUsage"];
+        };
+        /** ChatCompletionChoice */
+        ChatCompletionChoice: {
+            /**
+             * Index
+             * @default 0
+             */
+            index?: number;
+            message: components["schemas"]["ChatCompletionMessage"];
+            /** Finish Reason */
+            finish_reason: string;
+        };
+        /** ChatCompletionErrorDetail */
+        ChatCompletionErrorDetail: {
+            /** Message */
+            message: string;
+            /** Type */
+            type: string;
+            /** Param */
+            param?: string | null;
+            /** Code */
+            code?: string | null;
+        };
+        /** ChatCompletionErrorResponse */
+        ChatCompletionErrorResponse: {
+            error: components["schemas"]["ChatCompletionErrorDetail"];
+        };
+        /** ChatCompletionMessage */
+        ChatCompletionMessage: {
+            /**
+             * Role
+             * @default assistant
+             * @constant
+             */
+            role?: "assistant";
+            /** Content */
+            content: string;
+        };
+        /** ChatCompletionRequestMessage */
+        ChatCompletionRequestMessage: {
+            /**
+             * Role
+             * @enum {string}
+             */
+            role: "system" | "developer" | "user" | "assistant";
+            /** Content */
+            content: string | components["schemas"]["ChatCompletionTextPart"][];
+        };
+        /** ChatCompletionStreamOptions */
+        ChatCompletionStreamOptions: {
+            /**
+             * Include Usage
+             * @default false
+             */
+            include_usage?: boolean;
+        };
+        /** ChatCompletionTextPart */
+        ChatCompletionTextPart: {
+            /**
+             * Type
+             * @constant
+             */
+            type: "text";
+            /** Text */
+            text: string;
+        };
+        /** ChatCompletionUsage */
+        ChatCompletionUsage: {
+            /** Prompt Tokens */
+            prompt_tokens: number;
+            /** Completion Tokens */
+            completion_tokens: number;
+            /** Total Tokens */
+            total_tokens: number;
+        };
         /**
          * ChatContext
          * @description Discriminated union of every UI-state context the agent understands.
@@ -2107,6 +2225,63 @@ export interface components {
         CreateApiKeyResponseBody: {
             data: components["schemas"]["CreatedApiKey"];
         };
+        /**
+         * CreateChatCompletionRequestBody
+         * @example {
+         *       "messages": [
+         *         {
+         *           "content": "You are a helpful assistant.",
+         *           "role": "system"
+         *         },
+         *         {
+         *           "content": "Say hello.",
+         *           "role": "user"
+         *         }
+         *       ],
+         *       "model": "openai:gpt-4o"
+         *     }
+         */
+        CreateChatCompletionRequestBody: {
+            /**
+             * Model
+             * @description Model must be '{provider}:{model_name}' for a built-in provider (one of anthropic, aws, azure_openai, cerebras, deepseek, fireworks, google, groq, moonshot, ollama, openai, perplexity, together, xai) or 'custom:{provider_id}:{model_name}' for a stored custom provider, e.g. 'openai:gpt-4o' or 'anthropic:claude-sonnet-4-5'.
+             */
+            model: string;
+            /** Messages */
+            messages: components["schemas"]["ChatCompletionRequestMessage"][];
+            /**
+             * Stream
+             * @default false
+             */
+            stream?: boolean;
+            /** Temperature */
+            temperature?: number | null;
+            /** Top P */
+            top_p?: number | null;
+            /** Max Tokens */
+            max_tokens?: number | null;
+            /** Max Completion Tokens */
+            max_completion_tokens?: number | null;
+            /** Stop */
+            stop?: string | string[] | null;
+            /** Frequency Penalty */
+            frequency_penalty?: number | null;
+            /** Presence Penalty */
+            presence_penalty?: number | null;
+            /** Seed */
+            seed?: number | null;
+            /** N */
+            n?: number | null;
+            stream_options?: components["schemas"]["ChatCompletionStreamOptions"] | null;
+            /** Tools */
+            tools?: unknown[] | null;
+            /** Tool Choice */
+            tool_choice?: unknown | null;
+            /** Response Format */
+            response_format?: {
+                [key: string]: unknown;
+            } | null;
+        };
         /** CreateDatasetLabelRequestBody */
         CreateDatasetLabelRequestBody: {
             /**
@@ -3596,6 +3771,28 @@ export interface components {
              */
             message?: string | null;
         };
+        /**
+         * PatchPromptRequestBody
+         * @description Fields to update on a prompt. Omit a field to leave it unchanged.
+         */
+        PatchPromptRequestBody: {
+            /**
+             * Description
+             * @description New description for the prompt (null clears the description)
+             */
+            description?: string | null;
+            /**
+             * Metadata
+             * @description New metadata object for the prompt (replaces the existing metadata as a whole)
+             */
+            metadata?: {
+                [key: string]: unknown;
+            };
+        };
+        /** PatchPromptResponseBody */
+        PatchPromptResponseBody: {
+            data: components["schemas"]["Prompt"];
+        };
         /**
          * PhoenixUIMessage
          * @description `UIMessage` with `metadata` narrowed to the Phoenix wire shapes.
@@ -3756,12 +3953,9 @@ export interface components {
          *
          *     ``span_filter`` carries the project-scoped span filter expression when the
          *     span filter field is mounted — empty string when the field is mounted with
-         *     no condition applied, ``None`` when the field is not present at all.
-         *
-         *     ``root_spans_only`` carries the current state of the spans-table root vs.
-         *     all toggle when that toggle is mounted — ``True`` when the table is
-         *     restricted to root spans, ``False`` when it shows every span, ``None``
-         *     when the toggle is not present (e.g. on the traces tab).
+         *     no condition applied, ``None`` when the field is not present at all. It
+         *     describes the view in full, root-span scoping included (which is expressed
+         *     within the filter DSL as ``parent_id is None``).
          */
         ProjectContext: {
             /**
@@ -3773,8 +3967,6 @@ export interface components {
             projectNodeId: string;
             /** Spanfilter */
             spanFilter?: string | null;
-            /** Rootspansonly */
-            rootSpansOnly?: boolean | null;
         };
         /** Prompt */
         Prompt: {
@@ -9480,6 +9672,60 @@ export interface operations {
             };
         };
     };
+    patchPrompt: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The identifier of the prompt, i.e. name or ID. */
+                prompt_identifier: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["PatchPromptRequestBody"];
+            };
+        };
+        responses: {
+            /** @description The updated prompt */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PatchPromptResponseBody"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Unprocessable Entity */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
     getProjects: {
         parameters: {
             query?: {
@@ -10679,6 +10925,66 @@ export interface operations {
             };
         };
     };
+    createChatCompletion: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateChatCompletionRequestBody"];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ChatCompletion"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ChatCompletionErrorResponse"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ChatCompletionErrorResponse"];
+                };
+            };
+            /** @description Unprocessable Entity */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ChatCompletionErrorResponse"];
+                };
+            };
+        };
+    };
     _login_auth_login_post: {
         parameters: {
             query?: never;

package/src/experiments/getExperiment.ts

@@ -25,13 +25,10 @@ export async function getExperiment({
     getExperimentRuns({ client, experimentId }),
   ]);
   const experimentRunsMap: ExperimentRunsMap = {
-    runs: experimentRuns.runs.reduce(
-      (acc, run) => {
-        acc[run.id] = run;
-        return acc;
-      },
-      {} as ExperimentRunsMap["runs"]
-    ),
+    runs: experimentRuns.runs.reduce<ExperimentRunsMap["runs"]>((acc, run) => {
+      acc[run.id] = run;
+      return acc;
+    }, {}),
   };
   return {
     ...experiment,

package/src/projects/getProjects.ts

@@ -0,0 +1,69 @@
+import invariant from "tiny-invariant";
+
+import type { components } from "../__generated__/api/v1";
+import { createClient } from "../client";
+import type { ClientFn } from "../types/core";
+import type { Project } from "../types/projects";
+
+export interface GetProjectsParams extends ClientFn {
+  /**
+   * Return only projects whose name contains this substring
+   * (case-insensitive). The match is performed server-side.
+   *
+   * @requires Phoenix server >= 17.16.0
+   */
+  nameContains?: string;
+}
+
+type ProjectsResponse = components["schemas"]["GetProjectsResponseBody"];
+
+const DEFAULT_PAGE_SIZE = 100;
+
+/**
+ * List projects with automatic pagination handling.
+ *
+ * @example
+ * ```ts
+ * import { getProjects } from "@arizeai/phoenix-client/projects";
+ *
+ * // Every project
+ * const projects = await getProjects();
+ *
+ * // Only projects whose name contains "agent" (requires Phoenix server >= 17.16.0)
+ * const agentProjects = await getProjects({ nameContains: "agent" });
+ *
+ * for (const project of agentProjects) {
+ *   console.log(`Project: ${project.name} (${project.id})`);
+ * }
+ * ```
+ */
+export async function getProjects(
+  params: GetProjectsParams = {}
+): Promise<Project[]> {
+  const client = params.client || createClient();
+  const { nameContains } = params;
+
+  const projects: Project[] = [];
+  let cursor: string | null | undefined = null;
+
+  do {
+    const response: { data?: ProjectsResponse; error?: unknown } =
+      await client.GET("/v1/projects", {
+        params: {
+          query: {
+            cursor,
+            limit: DEFAULT_PAGE_SIZE,
+            name_contains: nameContains,
+          },
+        },
+      });
+
+    if (response.error) throw response.error;
+    invariant(response.data?.data, "Failed to list projects");
+
+    cursor = response.data.next_cursor ?? null;
+    projects.push(...response.data.data);
+  } while (cursor != null);
+
+  return projects;
+}

package/src/projects/index.ts

@@ -0,0 +1 @@
+export * from "./getProjects";

package/src/prompts/createPrompt.ts

@@ -301,6 +301,6 @@ export function promptVersion(params: PromptVersionInput): PromptVersionData {
         },
       };
     default:
-      assertUnreachable(model_provider);
+      return assertUnreachable(model_provider);
   }
 }

package/src/prompts/sdks/toSDK.ts

@@ -42,7 +42,7 @@ const getTargetSDK = <SDK extends SupportedSDK>(sdk: SDK) => {
     case "ai":
       return PROVIDER_TO_SDK.ai;
     default:
-      assertUnreachable(sdk);
+      return assertUnreachable(sdk);
   }
 };
 

package/src/schemas/llm/converters.ts

@@ -294,7 +294,7 @@ export const fromOpenAIToolCall = <
         toolCall
       ) as ReturnType;
     default:
-      assertUnreachable(targetProvider);
+      return assertUnreachable(targetProvider);
   }
 };
 
@@ -328,7 +328,7 @@ export const toOpenAIToolChoice = (
         validatedToolChoice
       );
     default:
-      assertUnreachable(provider);
+      return assertUnreachable(provider);
   }
 };
 
@@ -373,7 +373,7 @@ export const fromOpenAIToolChoice = <
         toolChoice
       ) as ReturnType;
     default:
-      assertUnreachable(targetProvider);
+      return assertUnreachable(targetProvider);
   }
 };
 
@@ -406,7 +406,7 @@ export const toOpenAIToolDefinition = (
     case null:
       return null;
     default:
-      assertUnreachable(provider);
+      return assertUnreachable(provider);
   }
 };
 
@@ -447,7 +447,7 @@ export const fromOpenAIToolDefinition = <
         toolDefinition
       ) as ReturnType;
     default:
-      assertUnreachable(targetProvider);
+      return assertUnreachable(targetProvider);
   }
 };
 

package/src/schemas/llm/openai/converters.ts

@@ -324,7 +324,7 @@ export const openAIMessageToVercelAI = openAIMessageSchema.transform(
           content: [],
         };
       default:
-        assertUnreachable(role);
+        return assertUnreachable(role);
     }
   }
 );
@@ -354,7 +354,7 @@ export const openAIToolChoiceToAnthropic = openAIToolChoiceSchema.transform(
       case "required":
         return { type: "any" };
       default:
-        assertUnreachable(openAI);
+        return assertUnreachable(openAI);
     }
   }
 );
@@ -372,7 +372,7 @@ export const openAIToolChoiceToVercelAI = openAIToolChoiceSchema.transform(
       case "required":
         return "required";
       default:
-        assertUnreachable(openAI);
+        return assertUnreachable(openAI);
     }
   }
 );

package/src/schemas/llm/phoenixPrompt/converters.ts

@@ -172,6 +172,8 @@ export const phoenixToolChoiceToOpenAI = phoenixToolChoiceSchema.transform(
         return "required";
       case "specific_function":
         return { type: "function", function: { name: phoenix.function_name } };
+      default:
+        return assertUnreachable(phoenix);
     }
   }
 );

package/src/types/projects.ts

@@ -1,3 +1,10 @@
+import type { components } from "../__generated__/api/v1";
+
+/**
+ * A project as returned by the Phoenix REST API.
+ */
+export type Project = components["schemas"]["Project"];
+
 /**
  * Identifies a project. Accepts any of:
  * - `project` — a project ID or name (the server accepts either)

package/src/utils/serverVersionUtils.ts

@@ -20,6 +20,7 @@
 
 import type { PhoenixClient } from "../client";
 import type { CapabilityRequirement } from "../types/serverRequirements";
+import { assertUnreachable } from "./assertUnreachable";
 import { formatVersion, satisfiesMinVersion } from "./semverUtils";
 
 // ---------------------------------------------------------------------------
@@ -37,6 +38,8 @@ export function capabilityLabel(req: CapabilityRequirement): string {
       return `The ${req.method} ${req.path} route`;
     case "parameter":
       return `The '${req.parameterName}' ${req.parameterLocation} parameter on ${req.route}`;
+    default:
+      return assertUnreachable(req);
   }
 }