@arizeai/phoenix-client 7.8.0 → 7.10.0

package/docs/traces.mdx

@@ -29,7 +29,7 @@ The traces module provides trace retrieval, project transfer, and trace-level an
 
 ## Retrieve Traces
 
-Use `getTraces` when you want trace-centric pagination by project, optional inline spans, or filtering by session.
+Use `getTraces` when you want trace-centric pagination by project, optional inline spans, or filtering by session, error status, or latency.
 
 ```ts
 import { getTraces } from "@arizeai/phoenix-client/traces";
@@ -60,6 +60,18 @@ console.log(result.nextCursor);
 - `cursor`
 - `includeSpans`
 - `sessionId`
+- `error`
+- `minLatencyMs`
+- `maxLatencyMs`
+
+```ts
+// Slow traces that contain at least one errored span
+const slowFailures = await getTraces({
+  project: { projectName: "support-bot" },
+  error: true,
+  minLatencyMs: 1000,
+});
+```
 
 ### Notes
 
@@ -67,6 +79,7 @@ console.log(result.nextCursor);
 - Use the returned `nextCursor` to continue pagination
 - Set `includeSpans` when you need a trace-centric fetch that also contains span details
 - `project` accepts `{ project }`, `{ projectId }`, or `{ projectName }`
+- `error`, `minLatencyMs`, and `maxLatencyMs` require Phoenix server >= 20.8.0; `error: false` selects traces with no errored spans
 
 ## Move Traces To Another Project
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arizeai/phoenix-client",
-  "version": "7.8.0",
+  "version": "7.10.0",
   "description": "A client for the Phoenix API",
   "keywords": [
     "arize",
@@ -127,7 +127,7 @@
     "openai": "^6.49.0",
     "openapi-typescript": "^7.13.0",
     "tsx": "^4.23.12",
-    "vitest": "^4.1.11"
+    "vitest": "^5.0.0"
   },
   "peerDependencies": {
     "@anthropic-ai/sdk": "^0.35.0",

package/src/__generated__/api/v1.ts

@@ -1572,7 +1572,7 @@ export interface paths {
         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, zai) 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.
+         * @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, meta, minimax, moonshot, ollama, openai, perplexity, together, xai, zai) 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.
          */
@@ -2592,7 +2592,7 @@ export interface components {
         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, zai) or 'custom:{provider_id}:{model_name}' for a stored custom provider, e.g. 'openai:gpt-4o' or 'anthropic:claude-sonnet-4-5'.
+             * @description Model must be '{provider}:{model_name}' for a built-in provider (one of anthropic, aws, azure_openai, cerebras, deepseek, fireworks, google, groq, meta, minimax, moonshot, ollama, openai, perplexity, together, xai, zai) 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 */
@@ -4088,7 +4088,7 @@ export interface components {
          * ModelProvider
          * @enum {string}
          */
-        ModelProvider: "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" | "ZAI";
+        ModelProvider: "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "MINIMAX" | "PERPLEXITY" | "TOGETHER" | "ZAI" | "META";
         /** OAuth2User */
         OAuth2User: {
             /** Id */
@@ -4936,6 +4936,43 @@ export interface components {
             /** Content */
             content: string | (components["schemas"]["TextContentPart"] | components["schemas"]["ToolCallContentPart"] | components["schemas"]["ToolResultContentPart"])[];
         };
+        /** PromptMetaInvocationParameters */
+        PromptMetaInvocationParameters: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "meta";
+            meta: components["schemas"]["PromptMetaInvocationParametersContent"];
+        };
+        /** PromptMetaInvocationParametersContent */
+        PromptMetaInvocationParametersContent: {
+            /** Temperature */
+            temperature?: number;
+            /** Max Tokens */
+            max_tokens?: number;
+            /** Max Completion Tokens */
+            max_completion_tokens?: number;
+            /** Frequency Penalty */
+            frequency_penalty?: number;
+            /** Presence Penalty */
+            presence_penalty?: number;
+            /** Top P */
+            top_p?: number;
+            /** Seed */
+            seed?: number;
+            /** Stop */
+            stop?: string[];
+            /**
+             * Reasoning Effort
+             * @enum {string}
+             */
+            reasoning_effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
+            /** Extra Body */
+            extra_body?: {
+                [key: string]: unknown;
+            };
+        };
         /** PromptMoonshotInvocationParameters */
         PromptMoonshotInvocationParameters: {
             /**
@@ -5267,7 +5304,7 @@ export interface components {
             template_type: components["schemas"]["PromptTemplateType"];
             template_format: components["schemas"]["PromptTemplateFormat"];
             /** Invocation Parameters */
-            invocation_parameters: components["schemas"]["PromptOpenAIInvocationParameters"] | components["schemas"]["PromptAzureOpenAIInvocationParameters"] | components["schemas"]["PromptAnthropicInvocationParameters"] | components["schemas"]["PromptGoogleInvocationParameters"] | components["schemas"]["PromptDeepSeekInvocationParameters"] | components["schemas"]["PromptXAIInvocationParameters"] | components["schemas"]["PromptOllamaInvocationParameters"] | components["schemas"]["PromptAwsInvocationParameters"] | components["schemas"]["PromptCerebrasInvocationParameters"] | components["schemas"]["PromptFireworksInvocationParameters"] | components["schemas"]["PromptGroqInvocationParameters"] | components["schemas"]["PromptMoonshotInvocationParameters"] | components["schemas"]["PromptPerplexityInvocationParameters"] | components["schemas"]["PromptTogetherInvocationParameters"] | components["schemas"]["PromptZAIInvocationParameters"];
+            invocation_parameters: components["schemas"]["PromptOpenAIInvocationParameters"] | components["schemas"]["PromptAzureOpenAIInvocationParameters"] | components["schemas"]["PromptAnthropicInvocationParameters"] | components["schemas"]["PromptGoogleInvocationParameters"] | components["schemas"]["PromptDeepSeekInvocationParameters"] | components["schemas"]["PromptXAIInvocationParameters"] | components["schemas"]["PromptOllamaInvocationParameters"] | components["schemas"]["PromptAwsInvocationParameters"] | components["schemas"]["PromptCerebrasInvocationParameters"] | components["schemas"]["PromptFireworksInvocationParameters"] | components["schemas"]["PromptGroqInvocationParameters"] | components["schemas"]["PromptMoonshotInvocationParameters"] | components["schemas"]["PromptPerplexityInvocationParameters"] | components["schemas"]["PromptTogetherInvocationParameters"] | components["schemas"]["PromptZAIInvocationParameters"] | components["schemas"]["PromptMetaInvocationParameters"];
             tools?: components["schemas"]["PromptTools"] | null;
             /** Response Format */
             response_format?: components["schemas"]["PromptResponseFormatJSONSchema"] | null;
@@ -5286,7 +5323,7 @@ export interface components {
             template_type: components["schemas"]["PromptTemplateType"];
             template_format: components["schemas"]["PromptTemplateFormat"];
             /** Invocation Parameters */
-            invocation_parameters: components["schemas"]["PromptOpenAIInvocationParameters"] | components["schemas"]["PromptAzureOpenAIInvocationParameters"] | components["schemas"]["PromptAnthropicInvocationParameters"] | components["schemas"]["PromptGoogleInvocationParameters"] | components["schemas"]["PromptDeepSeekInvocationParameters"] | components["schemas"]["PromptXAIInvocationParameters"] | components["schemas"]["PromptOllamaInvocationParameters"] | components["schemas"]["PromptAwsInvocationParameters"] | components["schemas"]["PromptCerebrasInvocationParameters"] | components["schemas"]["PromptFireworksInvocationParameters"] | components["schemas"]["PromptGroqInvocationParameters"] | components["schemas"]["PromptMoonshotInvocationParameters"] | components["schemas"]["PromptPerplexityInvocationParameters"] | components["schemas"]["PromptTogetherInvocationParameters"] | components["schemas"]["PromptZAIInvocationParameters"];
+            invocation_parameters: components["schemas"]["PromptOpenAIInvocationParameters"] | components["schemas"]["PromptAzureOpenAIInvocationParameters"] | components["schemas"]["PromptAnthropicInvocationParameters"] | components["schemas"]["PromptGoogleInvocationParameters"] | components["schemas"]["PromptDeepSeekInvocationParameters"] | components["schemas"]["PromptXAIInvocationParameters"] | components["schemas"]["PromptOllamaInvocationParameters"] | components["schemas"]["PromptAwsInvocationParameters"] | components["schemas"]["PromptCerebrasInvocationParameters"] | components["schemas"]["PromptFireworksInvocationParameters"] | components["schemas"]["PromptGroqInvocationParameters"] | components["schemas"]["PromptMoonshotInvocationParameters"] | components["schemas"]["PromptPerplexityInvocationParameters"] | components["schemas"]["PromptTogetherInvocationParameters"] | components["schemas"]["PromptZAIInvocationParameters"] | components["schemas"]["PromptMetaInvocationParameters"];
             tools?: components["schemas"]["PromptTools"] | null;
             /** Response Format */
             response_format?: components["schemas"]["PromptResponseFormatJSONSchema"] | null;
@@ -10061,6 +10098,12 @@ export interface operations {
                 include_spans?: boolean;
                 /** @description List of session identifiers to filter traces by. Each value can be either a session_id string or a session GlobalID. Only traces belonging to the specified sessions will be returned. */
                 session_identifier?: string[] | null;
+                /** @description Filter by trace error status. If true, only return traces that contain at least one span with `status_code == ERROR`. If false, only return traces with no errored spans. If omitted, traces are not filtered by error status. Matches the error indicator shown in the UI. */
+                error?: boolean | null;
+                /** @description Inclusive lower bound on trace latency in milliseconds. */
+                min_latency_ms?: number | null;
+                /** @description Inclusive upper bound on trace latency in milliseconds. */
+                max_latency_ms?: number | null;
             };
             header?: never;
             path: {

package/src/constants/serverRequirements.ts

@@ -98,6 +98,16 @@ export const LIST_PROJECT_TRACES: RouteRequirement = {
   minServerVersion: [13, 15, 0],
 };
 
+export const GET_TRACES_FILTERS: ParameterRequirement = {
+  kind: "parameter",
+  parameterName: "error",
+  parameterLocation: "query",
+  route: "GET /v1/projects/{id}/traces",
+  minServerVersion: [20, 8, 0],
+  description:
+    "The 'error', 'min_latency_ms', and 'max_latency_ms' query parameters on GET /v1/projects/{id}/traces",
+};
+
 export const TRANSFER_TRACES: RouteRequirement = {
   kind: "route",
   method: "POST",
@@ -234,6 +244,7 @@ export const ALL_REQUIREMENTS: readonly CapabilityRequirement[] = [
   GET_SPANS_FILTERS,
   GET_SPANS_BY_ATTRIBUTE,
   LIST_PROJECT_TRACES,
+  GET_TRACES_FILTERS,
   TRANSFER_TRACES,
   DATASET_UPLOAD_EXAMPLE_IDS,
   ADD_TRACE_NOTE_IDENTIFIER,

package/src/prompts/constants.ts

@@ -16,6 +16,8 @@ export const PromptModelProviders: Record<PromptModelProvider, string> = {
   FIREWORKS: "Fireworks",
   GROQ: "Groq",
   MOONSHOT: "Moonshot",
+  MINIMAX: "MiniMax",
   PERPLEXITY: "Perplexity",
   ZAI: "Z.ai",
+  META: "Meta",
 };

package/src/prompts/sdks/toOpenAI.ts

@@ -57,6 +57,8 @@ function getInvocationParameters(
       return parameters.together;
     case "zai":
       return parameters.zai;
+    case "meta":
+      return parameters.meta;
     default:
       // eslint-disable-next-line no-console
       console.warn(

package/src/traces/getTraces.ts

@@ -1,6 +1,9 @@
 import type { operations } from "../__generated__/api/v1";
 import { createClient } from "../client";
-import { LIST_PROJECT_TRACES } from "../constants/serverRequirements";
+import {
+  GET_TRACES_FILTERS,
+  LIST_PROJECT_TRACES,
+} from "../constants/serverRequirements";
 import type { ClientFn } from "../types/core";
 import type { ProjectIdentifier } from "../types/projects";
 import { resolveProjectIdentifier } from "../types/projects";
@@ -28,6 +31,112 @@ export interface GetTracesParams extends ClientFn {
   includeSpans?: boolean;
   /** Filter traces by session identifier(s) (session_id strings or GlobalIDs) */
   sessionId?: string | string[] | null;
+  /**
+   * Filter by trace error status. `true` returns only traces containing at
+   * least one errored span, `false` only traces with no errored spans.
+   * Omit to leave traces unfiltered by error status.
+   *
+   * @requires Phoenix server >= 20.8.0
+   */
+  error?: boolean | null;
+  /**
+   * Inclusive lower bound on trace latency in milliseconds.
+   *
+   * @requires Phoenix server >= 20.8.0
+   */
+  minLatencyMs?: number | null;
+  /**
+   * Inclusive upper bound on trace latency in milliseconds.
+   *
+   * @requires Phoenix server >= 20.8.0
+   */
+  maxLatencyMs?: number | null;
+}
+
+/**
+ * Reject latency bounds the server would reject (negatives) or that can never
+ * match a trace (an inverted range), so callers get a clear error instead of a
+ * 422 or a silently empty page.
+ */
+function validateLatencyBounds({
+  minLatencyMs,
+  maxLatencyMs,
+}: Pick<GetTracesParams, "minLatencyMs" | "maxLatencyMs">): void {
+  if (minLatencyMs != null && minLatencyMs < 0) {
+    throw new Error(`minLatencyMs must be non-negative, got ${minLatencyMs}`);
+  }
+  if (maxLatencyMs != null && maxLatencyMs < 0) {
+    throw new Error(`maxLatencyMs must be non-negative, got ${maxLatencyMs}`);
+  }
+  if (
+    minLatencyMs != null &&
+    maxLatencyMs != null &&
+    minLatencyMs > maxLatencyMs
+  ) {
+    throw new Error(
+      `minLatencyMs (${minLatencyMs}) must not exceed maxLatencyMs (${maxLatencyMs})`
+    );
+  }
+}
+
+type ListProjectTracesQuery = NonNullable<
+  operations["listProjectTraces"]["parameters"]["query"]
+>;
+
+/**
+ * Translate the camelCase parameters into the endpoint's snake_case query,
+ * omitting anything the caller left unset so the server applies its defaults.
+ */
+function buildQuery({
+  cursor,
+  limit = 100,
+  startTime,
+  endTime,
+  sort,
+  order,
+  includeSpans,
+  sessionId,
+  error,
+  minLatencyMs,
+  maxLatencyMs,
+}: Omit<GetTracesParams, "client" | "project">): ListProjectTracesQuery {
+  const query: ListProjectTracesQuery = { limit };
+  if (cursor) {
+    query.cursor = cursor;
+  }
+  if (startTime) {
+    query.start_time =
+      startTime instanceof Date ? startTime.toISOString() : startTime;
+  }
+  if (endTime) {
+    query.end_time = endTime instanceof Date ? endTime.toISOString() : endTime;
+  }
+  if (sort) {
+    query.sort = sort;
+  }
+  if (order) {
+    query.order = order;
+  }
+  if (includeSpans) {
+    query.include_spans = true;
+  }
+  if (sessionId) {
+    query.session_identifier = Array.isArray(sessionId)
+      ? sessionId
+      : [sessionId];
+  }
+  // `error: false` is a meaningful filter (traces with no errored spans), so
+  // send the parameter whenever it was set rather than only when truthy.
+  if (error != null) {
+    query.error = error;
+  }
+  if (minLatencyMs != null) {
+    query.min_latency_ms = minLatencyMs;
+  }
+  if (maxLatencyMs != null) {
+    query.max_latency_ms = maxLatencyMs;
+  }
+  return query;
 }
 
 export type GetTracesResponse =
@@ -81,60 +190,30 @@ export type GetTracesResult = {
  *   });
  *   cursor = result.nextCursor || undefined;
  * } while (cursor);
+ *
+ * // Only slow traces that errored
+ * const slowFailures = await getTraces({
+ *   client,
+ *   project: { projectName: "my-project" },
+ *   error: true,
+ *   minLatencyMs: 1000,
+ * });
  * ```
  */
 export async function getTraces({
   client: _client,
   project,
-  cursor,
-  limit = 100,
-  startTime,
-  endTime,
-  sort,
-  order,
-  includeSpans,
-  sessionId,
+  ...params
 }: GetTracesParams): Promise<GetTracesResult> {
+  const { error: errorFilter, minLatencyMs, maxLatencyMs } = params;
   const client = _client ?? createClient();
+  validateLatencyBounds({ minLatencyMs, maxLatencyMs });
   await ensureServerCapability({ client, requirement: LIST_PROJECT_TRACES });
-  const projectIdentifier = resolveProjectIdentifier(project);
-
-  const params: NonNullable<
-    operations["listProjectTraces"]["parameters"]["query"]
-  > = {
-    limit,
-  };
-
-  if (cursor) {
-    params.cursor = cursor;
-  }
-
-  if (startTime) {
-    params.start_time =
-      startTime instanceof Date ? startTime.toISOString() : startTime;
-  }
-
-  if (endTime) {
-    params.end_time = endTime instanceof Date ? endTime.toISOString() : endTime;
-  }
-
-  if (sort) {
-    params.sort = sort;
-  }
-
-  if (order) {
-    params.order = order;
-  }
-
-  if (includeSpans) {
-    params.include_spans = true;
-  }
-
-  if (sessionId) {
-    params.session_identifier = Array.isArray(sessionId)
-      ? sessionId
-      : [sessionId];
+  if (errorFilter != null || minLatencyMs != null || maxLatencyMs != null) {
+    await ensureServerCapability({ client, requirement: GET_TRACES_FILTERS });
   }
+  const projectIdentifier = resolveProjectIdentifier(project);
+  const query = buildQuery(params);
 
   const { data, error } = await client.GET(
     "/v1/projects/{project_identifier}/traces",
@@ -143,7 +222,7 @@ export async function getTraces({
         path: {
           project_identifier: projectIdentifier,
         },
-        query: params,
+        query,
       },
     }
   );

package/src/types/prompts.ts

@@ -16,8 +16,10 @@ export type PromptModelProvider =
   | "FIREWORKS"
   | "GROQ"
   | "MOONSHOT"
+  | "MINIMAX"
   | "PERPLEXITY"
-  | "ZAI";
+  | "ZAI"
+  | "META";
 
 /**
  * Supported prompt provider SDKs