@arizeai/phoenix-client 6.1.0 → 6.3.0

package/package.json

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

package/src/__generated__/api/v1.ts

@@ -787,6 +787,34 @@ export interface paths {
         get: operations["getSession"];
         put?: never;
         post?: never;
+        /**
+         * Delete a session by identifier
+         * @description Delete a session by its identifier. The identifier can be either:
+         *     1. A global ID (base64-encoded)
+         *     2. A user-provided session_id string
+         *
+         *     This will permanently remove the session and all associated traces, spans, and annotations via cascade delete.
+         */
+        delete: operations["deleteSession"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/sessions/delete": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Bulk delete sessions
+         * @description Delete multiple sessions by their identifiers (GlobalIDs or session_id strings). All identifiers in a single request must be the same type. Non-existent IDs are silently skipped. All associated traces, spans, and annotations are cascade deleted.
+         */
+        post: operations["deleteSessions"];
         delete?: never;
         options?: never;
         head?: never;
@@ -1284,6 +1312,14 @@ export interface components {
             /** Data */
             data: components["schemas"]["CategoricalAnnotationConfig"] | components["schemas"]["ContinuousAnnotationConfig"] | components["schemas"]["FreeformAnnotationConfig"];
         };
+        /** DeleteSessionsRequestBody */
+        DeleteSessionsRequestBody: {
+            /**
+             * Session Identifiers
+             * @description List of session identifiers to delete. All identifiers must be the same type: either all GlobalIDs or all user-provided session_id strings.
+             */
+            session_identifiers: string[];
+        };
         /** Experiment */
         Experiment: {
             /**
@@ -1745,7 +1781,7 @@ export interface components {
          * ModelProvider
          * @enum {string}
          */
-        ModelProvider: "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS";
+        ModelProvider: "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER";
         /** OAuth2User */
         OAuth2User: {
             /** Id */
@@ -2122,6 +2158,37 @@ export interface components {
              */
             reasoning_effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
         };
+        /** PromptCerebrasInvocationParameters */
+        PromptCerebrasInvocationParameters: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "cerebras";
+            cerebras: components["schemas"]["PromptCerebrasInvocationParametersContent"];
+        };
+        /** PromptCerebrasInvocationParametersContent */
+        PromptCerebrasInvocationParametersContent: {
+            /** 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;
+            /**
+             * Reasoning Effort
+             * @enum {string}
+             */
+            reasoning_effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
+        };
         /** PromptChatTemplate */
         PromptChatTemplate: {
             /**
@@ -2175,6 +2242,37 @@ export interface components {
              */
             reasoning_effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
         };
+        /** PromptFireworksInvocationParameters */
+        PromptFireworksInvocationParameters: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "fireworks";
+            fireworks: components["schemas"]["PromptFireworksInvocationParametersContent"];
+        };
+        /** PromptFireworksInvocationParametersContent */
+        PromptFireworksInvocationParametersContent: {
+            /** 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;
+            /**
+             * Reasoning Effort
+             * @enum {string}
+             */
+            reasoning_effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
+        };
         /** PromptGoogleInvocationParameters */
         PromptGoogleInvocationParameters: {
             /**
@@ -2201,6 +2299,37 @@ export interface components {
             /** Top K */
             top_k?: number;
         };
+        /** PromptGroqInvocationParameters */
+        PromptGroqInvocationParameters: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "groq";
+            groq: components["schemas"]["PromptGroqInvocationParametersContent"];
+        };
+        /** PromptGroqInvocationParametersContent */
+        PromptGroqInvocationParametersContent: {
+            /** 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;
+            /**
+             * Reasoning Effort
+             * @enum {string}
+             */
+            reasoning_effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
+        };
         /** PromptMessage */
         PromptMessage: {
             /**
@@ -2211,6 +2340,37 @@ export interface components {
             /** Content */
             content: string | (components["schemas"]["TextContentPart"] | components["schemas"]["ToolCallContentPart"] | components["schemas"]["ToolResultContentPart"])[];
         };
+        /** PromptMoonshotInvocationParameters */
+        PromptMoonshotInvocationParameters: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "moonshot";
+            moonshot: components["schemas"]["PromptMoonshotInvocationParametersContent"];
+        };
+        /** PromptMoonshotInvocationParametersContent */
+        PromptMoonshotInvocationParametersContent: {
+            /** 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;
+            /**
+             * Reasoning Effort
+             * @enum {string}
+             */
+            reasoning_effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
+        };
         /** PromptOllamaInvocationParameters */
         PromptOllamaInvocationParameters: {
             /**
@@ -2273,6 +2433,37 @@ export interface components {
              */
             reasoning_effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
         };
+        /** PromptPerplexityInvocationParameters */
+        PromptPerplexityInvocationParameters: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "perplexity";
+            perplexity: components["schemas"]["PromptPerplexityInvocationParametersContent"];
+        };
+        /** PromptPerplexityInvocationParametersContent */
+        PromptPerplexityInvocationParametersContent: {
+            /** 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;
+            /**
+             * Reasoning Effort
+             * @enum {string}
+             */
+            reasoning_effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
+        };
         /** PromptResponseFormatJSONSchema */
         PromptResponseFormatJSONSchema: {
             /**
@@ -2315,6 +2506,37 @@ export interface components {
          * @enum {string}
          */
         PromptTemplateType: "STR" | "CHAT";
+        /** PromptTogetherInvocationParameters */
+        PromptTogetherInvocationParameters: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "together";
+            together: components["schemas"]["PromptTogetherInvocationParametersContent"];
+        };
+        /** PromptTogetherInvocationParametersContent */
+        PromptTogetherInvocationParametersContent: {
+            /** 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;
+            /**
+             * Reasoning Effort
+             * @enum {string}
+             */
+            reasoning_effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
+        };
         /** PromptToolChoiceNone */
         PromptToolChoiceNone: {
             /**
@@ -2397,7 +2619,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"];
+            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"];
             tools?: components["schemas"]["PromptTools"] | null;
             /** Response Format */
             response_format?: components["schemas"]["PromptResponseFormatJSONSchema"] | null;
@@ -2416,7 +2638,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"];
+            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"];
             tools?: components["schemas"]["PromptTools"] | null;
             /** Response Format */
             response_format?: components["schemas"]["PromptResponseFormatJSONSchema"] | null;
@@ -4635,6 +4857,10 @@ export interface operations {
                 start_time?: string | null;
                 /** @description Exclusive upper bound time */
                 end_time?: string | null;
+                /** @description Filter by one or more trace IDs */
+                trace_id?: string[] | null;
+                /** @description Filter by parent span ID. Use "null" to get root spans only. */
+                parent_id?: string | null;
             };
             header?: never;
             path: {
@@ -4694,6 +4920,10 @@ export interface operations {
                 start_time?: string | null;
                 /** @description Exclusive upper bound time */
                 end_time?: string | null;
+                /** @description Filter by one or more trace IDs */
+                trace_id?: string[] | null;
+                /** @description Filter by parent span ID. Use "null" to get root spans only. */
+                parent_id?: string | null;
             };
             header?: never;
             path: {
@@ -5751,6 +5981,94 @@ export interface operations {
             };
         };
     };
+    deleteSession: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The session identifier: either a GlobalID or user-provided session_id string. */
+                session_identifier: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    deleteSessions: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["DeleteSessionsRequestBody"];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Unprocessable Entity */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
     listProjectSessions: {
         parameters: {
             query?: {

package/src/prompts/constants.ts

@@ -12,4 +12,9 @@ export const PromptModelProviders: Record<PromptModelProvider, string> = {
   XAI: "xAI",
   OLLAMA: "Ollama",
   AWS: "AWS Bedrock",
+  CEREBRAS: "Cerebras",
+  FIREWORKS: "Fireworks",
+  GROQ: "Groq",
+  MOONSHOT: "Moonshot",
+  PERPLEXITY: "Perplexity",
 };

package/src/sessions/deleteSession.ts

@@ -0,0 +1,73 @@
+import { createClient } from "../client";
+import type { ClientFn } from "../types/core";
+
+/**
+ * Parameters to delete a session
+ */
+export interface DeleteSessionParams extends ClientFn {
+  /**
+   * The session ID. Can be either:
+   * - A user-provided session ID string
+   * - A Phoenix Global ID (base64-encoded)
+   */
+  sessionId: string;
+}
+
+/**
+ * Delete a single session by ID.
+ *
+ * This will permanently remove the session and all associated traces, spans,
+ * and annotations via cascade delete.
+ *
+ * @experimental this function is experimental and may change in the future
+ *
+ * @param params - The parameters to delete a session
+ * @returns Promise that resolves when the session is successfully deleted
+ * @throws Error if the session is not found or deletion fails
+ *
+ * @example
+ * ```ts
+ * // Delete by user-provided session ID
+ * await deleteSession({
+ *   client,
+ *   sessionId: "my-session-id"
+ * });
+ *
+ * // Delete by Phoenix Global ID
+ * await deleteSession({
+ *   client,
+ *   sessionId: "UHJvamVjdFNlc3Npb246MTIz"
+ * });
+ * ```
+ */
+export async function deleteSession({
+  client: _client,
+  sessionId,
+}: DeleteSessionParams): Promise<void> {
+  const client = _client ?? createClient();
+
+  const { error } = await client.DELETE("/v1/sessions/{session_identifier}", {
+    params: {
+      path: {
+        session_identifier: sessionId,
+      },
+    },
+  });
+
+  if (error) {
+    const isNotFound =
+      typeof error === "object" &&
+      error !== null &&
+      "status" in error &&
+      error.status === 404;
+    if (isNotFound) {
+      throw new Error(`Session not found: ${sessionId}`);
+    }
+
+    const errorMessage =
+      typeof error === "object" && error !== null
+        ? JSON.stringify(error, null, 2)
+        : String(error);
+    throw new Error(`Failed to delete session: ${errorMessage}`);
+  }
+}

package/src/sessions/deleteSessions.ts

@@ -0,0 +1,65 @@
+import { createClient } from "../client";
+import type { ClientFn } from "../types/core";
+
+/**
+ * Parameters to bulk delete sessions
+ */
+export interface DeleteSessionsParams extends ClientFn {
+  /**
+   * List of session identifiers to delete. Each can be either:
+   * - A user-provided session ID string
+   * - A Phoenix Global ID (base64-encoded)
+   *
+   * All identifiers must be the same type (no mixing).
+   */
+  sessionIds: string[];
+}
+
+/**
+ * Delete multiple sessions by their identifiers.
+ *
+ * All identifiers must be the same type: either all GlobalIDs or all
+ * user-provided session_id strings. Non-existent IDs are silently skipped.
+ * All associated traces, spans, and annotations are cascade deleted.
+ *
+ * @experimental this function is experimental and may change in the future
+ *
+ * @param params - The parameters to bulk delete sessions
+ * @returns Promise that resolves when the sessions are successfully deleted
+ * @throws Error if identifiers are mixed types or deletion fails
+ *
+ * @example
+ * ```ts
+ * // Delete by user-provided session IDs
+ * await deleteSessions({
+ *   client,
+ *   sessionIds: ["session-1", "session-2", "session-3"]
+ * });
+ *
+ * // Delete by Phoenix Global IDs
+ * await deleteSessions({
+ *   client,
+ *   sessionIds: ["UHJvamVjdFNlc3Npb246MQ==", "UHJvamVjdFNlc3Npb246Mg=="]
+ * });
+ * ```
+ */
+export async function deleteSessions({
+  client: _client,
+  sessionIds,
+}: DeleteSessionsParams): Promise<void> {
+  const client = _client ?? createClient();
+
+  const { error } = await client.POST("/v1/sessions/delete", {
+    body: {
+      session_identifiers: sessionIds,
+    },
+  });
+
+  if (error) {
+    const errorMessage =
+      typeof error === "object" && error !== null
+        ? JSON.stringify(error, null, 2)
+        : String(error);
+    throw new Error(`Failed to delete sessions: ${errorMessage}`);
+  }
+}

package/src/sessions/index.ts

@@ -1,4 +1,6 @@
 export * from "./addSessionAnnotation";
+export * from "./deleteSession";
+export * from "./deleteSessions";
 export * from "./getSession";
 export * from "./listSessions";
 export * from "./logSessionAnnotations";

package/src/spans/getSpans.ts

@@ -18,6 +18,10 @@ export interface GetSpansParams extends ClientFn {
   cursor?: string | null;
   /** Maximum number of spans to return */
   limit?: number;
+  /** Filter spans by one or more trace IDs */
+  traceIds?: string[] | null;
+  /** Filter by parent span ID. Use `null` or the string `"null"` to get root spans only. */
+  parentId?: string | null;
 }
 
 export type GetSpansResponse = operations["getSpans"]["responses"]["200"];
@@ -59,6 +63,13 @@ export type GetSpansResult = {
  *   limit: 100
  * });
 
+ *
+ * // Get all spans for specific traces (requires Phoenix server >= 13.9.0)
+ * const result = await getSpans({
+ *   client,
+ *   project: { projectName: "my-project" },
+ *   traceIds: ["trace-abc-123", "trace-def-456"],
+ * });
  *
  * // Paginate through results
  * let cursor: string | undefined;
@@ -86,6 +97,8 @@ export async function getSpans({
   limit = 100,
   startTime,
   endTime,
+  traceIds,
+  parentId,
 }: GetSpansParams): Promise<GetSpansResult> {
   const client = _client ?? createClient();
   const projectIdentifier = resolveProjectIdentifier(project);
@@ -107,6 +120,14 @@ export async function getSpans({
     params.end_time = endTime instanceof Date ? endTime.toISOString() : endTime;
   }
 
+  if (traceIds) {
+    params.trace_id = traceIds;
+  }
+
+  if (parentId !== undefined) {
+    params.parent_id = parentId === null ? "null" : parentId;
+  }
+
   const { data, error } = await client.GET(
     "/v1/projects/{project_identifier}/spans",
     {

package/src/types/prompts.ts

@@ -11,7 +11,12 @@ export type PromptModelProvider =
   | "DEEPSEEK"
   | "XAI"
   | "OLLAMA"
-  | "AWS";
+  | "AWS"
+  | "CEREBRAS"
+  | "FIREWORKS"
+  | "GROQ"
+  | "MOONSHOT"
+  | "PERPLEXITY";
 
 /**
  * Supported prompt provider SDKs