@arizeai/phoenix-client 7.1.1 → 7.3.0

package/docs/ci-evals-jest.mdx

@@ -23,7 +23,7 @@ module.exports = {
 - `testMatch` keeps eval suites separate from regular tests.
 - `reporters` keeps Jest's default reporter and adds the Phoenix
   summary block at the end of the run.
-- `setupFiles: ["dotenv/config"]` loads `PHOENIX_HOST`, `PHOENIX_API_KEY`,
+- `setupFiles: ["dotenv/config"]` loads `PHOENIX_ENDPOINT`, `PHOENIX_API_KEY`,
   and other env vars from `.env`.
 - `testTimeout` is bumped because LLM calls can be slow.
 

package/docs/ci-evals-vitest.mdx

@@ -28,7 +28,7 @@ export default defineConfig({
   `*.eval.ts` convention.
 - `reporters` keeps Vitest's default diagnostics and enables the Phoenix
   summary block.
-- `setupFiles: ["dotenv/config"]` loads `PHOENIX_HOST`, `PHOENIX_API_KEY`,
+- `setupFiles: ["dotenv/config"]` loads `PHOENIX_ENDPOINT`, `PHOENIX_API_KEY`,
   and any other env vars from `.env`.
 - `testTimeout` is bumped because LLM calls can be slow.
 

package/docs/ci-evals.mdx

@@ -94,7 +94,7 @@ standard Phoenix env vars.
 
 | Variable | Purpose |
 | --- | --- |
-| `PHOENIX_HOST` | Phoenix base URL |
+| `PHOENIX_ENDPOINT` | Phoenix base URL |
 | `PHOENIX_API_KEY` | Bearer token for Phoenix |
 | `PHOENIX_CLIENT_HEADERS` | Optional JSON headers forwarded to the Phoenix client and tracer |
 | `PHOENIX_TEST_TRACKING=false` | Disable sync to Phoenix for the current run (tracking is on by default) |

package/docs/overview.mdx

@@ -50,18 +50,18 @@ That gives the agent version-matched docs plus the exact implementation and gene
 
 ## Configuration
 
-`createClient()` resolves Phoenix client options in this order: library defaults, environment variables, then explicit options. In most applications, the normal setup is to set `PHOENIX_HOST` and `PHOENIX_API_KEY` in the environment and call `createClient()` with no overrides.
+`createClient()` resolves Phoenix client options in this order: library defaults, environment variables, then explicit options. In most applications, the normal setup is to set `PHOENIX_ENDPOINT` and `PHOENIX_API_KEY` in the environment and call `createClient()` with no overrides.
 
 ### Recommended Setup
 
 Use the environment-driven path unless you have a specific reason to override client options in code.
 
 ```bash
-export PHOENIX_HOST=http://localhost:6006
+export PHOENIX_ENDPOINT=http://localhost:6006
 export PHOENIX_API_KEY=<your-api-key>
 ```
 
-For a remote deployment, `PHOENIX_HOST` is that instance's base URL, e.g. `https://your-phoenix.example.com`.
+For a remote deployment, `PHOENIX_ENDPOINT` is that instance's base URL, e.g. `https://your-phoenix.example.com`.
 
 ```ts
 import { createClient } from "@arizeai/phoenix-client";
@@ -103,7 +103,7 @@ These are the Phoenix-specific options this package resolves before creating the
 
 | Option | Type | Description |
 |--------|------|-------------|
-| `baseUrl` | `string` | Base Phoenix URL. Defaults to `http://localhost:6006`, or `PHOENIX_HOST` when that environment variable is set. |
+| `baseUrl` | `string` | Base Phoenix URL. Defaults to `http://localhost:6006`, or `PHOENIX_ENDPOINT` when that environment variable is set. |
 | `headers` | `ClientOptions["headers"]` | Headers sent on every request. `PHOENIX_API_KEY` populates `Authorization` automatically. Explicit `headers` replace environment-derived headers. |
 
 ### Header Override Rule
@@ -124,7 +124,7 @@ const client = createClient({
 
 | Variable | Maps to | Description |
 |--------|---------|-------------|
-| `PHOENIX_HOST` | `options.baseUrl` | Base Phoenix URL, for example `http://localhost:6006`. |
+| `PHOENIX_ENDPOINT` | `options.baseUrl` | Base Phoenix URL, for example `http://localhost:6006`. |
 | `PHOENIX_API_KEY` | `options.headers.Authorization` | Bearer token for authenticated environments. |
 | `PHOENIX_CLIENT_HEADERS` | `options.headers` | Optional JSON-encoded object of additional headers to send on every request. Most setups do not need this. |
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arizeai/phoenix-client",
-  "version": "7.1.1",
+  "version": "7.3.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-config": "0.5.0",
+    "@arizeai/phoenix-otel": "2.2.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"
   },
   "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/client.ts

@@ -9,6 +9,7 @@ import type {
   paths as oapiPathsV1,
 } from "./__generated__/api/v1.d.ts";
 import {
+  type BaseUrlSource,
   defaultGetEnvironmentOptions,
   makeDefaultClientOptions,
 } from "./config";
@@ -36,6 +37,14 @@ export type Types = {
   };
 };
 
+/**
+ * The client's resolved options, tagged with where the base URL came from so
+ * consumers can tell deliberate configuration from an ambient environment.
+ */
+export type PhoenixClientOptions = ClientOptions & {
+  baseUrlSource: BaseUrlSource;
+};
+
 /**
  * Merge all configuration options according to priority:
  * defaults < environment < explicit options
@@ -51,13 +60,20 @@ export const getMergedOptions = ({
 }: {
   options?: Partial<ClientOptions>;
   getEnvironmentOptions?: () => Partial<ClientOptions>;
-} = {}): ClientOptions => {
+} = {}): PhoenixClientOptions => {
   const defaultOptions = makeDefaultClientOptions();
   const environmentOptions = getEnvironmentOptions();
+  const baseUrlSource: BaseUrlSource =
+    options.baseUrl !== undefined
+      ? "explicit"
+      : environmentOptions.baseUrl !== undefined
+        ? "environment"
+        : "default";
   return {
     ...defaultOptions,
     ...environmentOptions,
     ...options,
+    baseUrlSource,
   };
 };
 

package/src/config.ts

@@ -1,25 +1,24 @@
-import type { EnvironmentConfig } from "@arizeai/phoenix-config";
 import {
   DEFAULT_PHOENIX_BASE_URL,
-  getEnvironmentConfig,
+  getBaseUrlFromEnvironment,
+  getCredentialsFromEnvironment,
 } from "@arizeai/phoenix-config";
 import type { ClientOptions } from "openapi-fetch";
 
 /**
- * Convert a EnvironmentConfig object into a ClientOptions object.
+ * Convert resolved Phoenix credentials into a ClientOptions object.
  *
- * @param environment - The EnvironmentConfig object to convert.
+ * @param credentials - The API key and headers resolved from the environment.
  * @returns The converted ClientOptions object.
  */
-const phoenixEnvironmentToClientOptions = (
-  environment: EnvironmentConfig
+const phoenixCredentialsToClientOptions = (
+  credentials: ReturnType<typeof getCredentialsFromEnvironment>
 ): Partial<ClientOptions> => {
   const options: Partial<ClientOptions> = {
-    baseUrl: environment.PHOENIX_HOST,
     headers: {
-      ...(environment.PHOENIX_CLIENT_HEADERS ?? {}),
-      ...(environment.PHOENIX_API_KEY
-        ? { Authorization: `Bearer ${environment.PHOENIX_API_KEY}` }
+      ...(credentials.headers ?? {}),
+      ...(credentials.apiKey
+        ? { Authorization: `Bearer ${credentials.apiKey}` }
         : {}),
     },
   };
@@ -36,6 +35,17 @@ const phoenixEnvironmentToClientOptions = (
   );
 };
 
+/**
+ * Where a client's base URL came from: an explicit `baseUrl` option
+ * (`"explicit"`), a Phoenix environment variable (`"environment"`), or the
+ * built-in localhost default (`"default"`).
+ *
+ * Explicit configuration outranks the ambient environment, so this is what
+ * decides whether an environment variable may retarget the client's trace
+ * export.
+ */
+export type BaseUrlSource = "default" | "environment" | "explicit";
+
 /**
  * Get the environment options from the environment.
  *
@@ -46,7 +56,14 @@ export const defaultGetEnvironmentOptions = (): Partial<ClientOptions> => {
   if (typeof process !== "object" || typeof process.env !== "object") {
     return {};
   }
-  return phoenixEnvironmentToClientOptions(getEnvironmentConfig());
+  const options = phoenixCredentialsToClientOptions(
+    getCredentialsFromEnvironment()
+  );
+  // The base URL resolves as a tier group (PHOENIX_ENDPOINT first, inferring
+  // from the trace-export variables, then legacy PHOENIX_HOST) rather than
+  // variable by variable.
+  const baseUrl = getBaseUrlFromEnvironment();
+  return baseUrl !== undefined ? { ...options, baseUrl } : options;
 };
 
 /**

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,