@arizeai/phoenix-client 7.0.1 → 7.1.0

package/docs/overview.mdx

@@ -61,7 +61,7 @@ export PHOENIX_HOST=http://localhost:6006
 export PHOENIX_API_KEY=<your-api-key>
 ```
 
-If you're using Phoenix Cloud, `PHOENIX_HOST` may look like `https://app.phoenix.arize.com/s/my-space`.
+For a remote deployment, `PHOENIX_HOST` is that instance's base URL, e.g. `https://your-phoenix.example.com`.
 
 ```ts
 import { createClient } from "@arizeai/phoenix-client";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arizeai/phoenix-client",
-  "version": "7.0.1",
+  "version": "7.1.0",
   "description": "A client for the Phoenix API",
   "keywords": [
     "arize",
@@ -118,8 +118,8 @@
     "openapi-typescript": "^7.13.0",
     "tsx": "^4.23.1",
     "vitest": "^4.1.10",
-    "@arizeai/phoenix-evals": "2.1.0",
-    "@arizeai/phoenix-testing": "0.0.0"
+    "@arizeai/phoenix-testing": "0.0.0",
+    "@arizeai/phoenix-evals": "2.1.0"
   },
   "peerDependencies": {
     "@anthropic-ai/sdk": "^0.35.0",

package/src/__generated__/api/v1.ts

@@ -8636,6 +8636,8 @@ export interface operations {
                 end_time?: string | null;
                 /** @description Filter by one or more trace IDs */
                 trace_id?: string[] | null;
+                /** @description Filter by one or more span IDs */
+                span_id?: string[] | null;
                 /** @description Filter by parent span ID. Use "null" to get root spans only. */
                 parent_id?: string | null;
                 /** @description Filter by span name(s) */
@@ -8705,6 +8707,8 @@ export interface operations {
                 end_time?: string | null;
                 /** @description Filter by one or more trace IDs */
                 trace_id?: string[] | null;
+                /** @description Filter by one or more span IDs */
+                span_id?: string[] | null;
                 /** @description Filter by parent span ID. Use "null" to get root spans only. */
                 parent_id?: string | null;
                 /** @description Filter by span name(s) */

package/src/constants/serverRequirements.ts

@@ -75,6 +75,14 @@ export const GET_SPANS_TRACE_IDS: ParameterRequirement = {
   minServerVersion: [13, 9, 0],
 };
 
+export const GET_SPANS_SPAN_IDS: ParameterRequirement = {
+  kind: "parameter",
+  parameterName: "span_id",
+  parameterLocation: "query",
+  route: "GET /v1/projects/{id}/spans",
+  minServerVersion: [19, 6, 0],
+};
+
 export const GET_SPANS_FILTERS: ParameterRequirement = {
   kind: "parameter",
   parameterName: "span_kind",
@@ -145,6 +153,7 @@ export const ALL_REQUIREMENTS: readonly CapabilityRequirement[] = [
   ADD_TRACE_NOTE,
   ADD_SESSION_NOTE,
   GET_SPANS_TRACE_IDS,
+  GET_SPANS_SPAN_IDS,
   GET_SPANS_FILTERS,
   GET_SPANS_BY_ATTRIBUTE,
   LIST_PROJECT_TRACES,

package/src/spans/getSpans.ts

@@ -3,6 +3,7 @@ import { createClient } from "../client";
 import {
   GET_SPANS_BY_ATTRIBUTE,
   GET_SPANS_FILTERS,
+  GET_SPANS_SPAN_IDS,
   GET_SPANS_TRACE_IDS,
 } from "../constants/serverRequirements";
 import type { ClientFn } from "../types/core";
@@ -59,6 +60,8 @@ export interface GetSpansParams extends ClientFn {
   limit?: number;
   /** Filter spans by one or more trace IDs */
   traceIds?: string[] | null;
+  /** Filter spans by one or more span IDs */
+  spanIds?: string[] | null;
   /** Filter by parent span ID. Use `null` or the string `"null"` to get root spans only. */
   parentId?: string | null;
   /** Filter by span name(s) */
@@ -96,6 +99,7 @@ export type GetSpansResult = {
  * @returns A paginated response containing spans and optional next cursor
  *
  * @requires Phoenix server >= 13.9.0 when filtering by `traceIds`
+ * @requires Phoenix server >= 19.6.0 when filtering by `spanIds`
  * @requires Phoenix server >= 14.9.0 when filtering by `attributes`
  *
  * @example
@@ -125,6 +129,13 @@ export type GetSpansResult = {
  *   traceIds: ["trace-abc-123", "trace-def-456"],
  * });
  *
+ * // Get specific spans by span ID (requires Phoenix server >= 19.6.0)
+ * const result = await getSpans({
+ *   client,
+ *   project: { projectName: "my-project" },
+ *   spanIds: ["span-abc-123", "span-def-456"],
+ * });
+ *
  * // Paginate through results
  * let cursor: string | undefined;
  * do {
@@ -152,6 +163,7 @@ export async function getSpans({
   startTime,
   endTime,
   traceIds,
+  spanIds,
   parentId,
   name,
   spanKind,
@@ -168,6 +180,9 @@ export async function getSpans({
   if (traceIds) {
     await ensureServerCapability({ client, requirement: GET_SPANS_TRACE_IDS });
   }
+  if (spanIds) {
+    await ensureServerCapability({ client, requirement: GET_SPANS_SPAN_IDS });
+  }
   if (name != null || spanKind != null || statusCode != null) {
     await ensureServerCapability({ client, requirement: GET_SPANS_FILTERS });
   }
@@ -200,6 +215,10 @@ export async function getSpans({
     params.trace_id = traceIds;
   }
 
+  if (spanIds) {
+    params.span_id = spanIds;
+  }
+
   if (parentId !== undefined) {
     params.parent_id = parentId === null ? "null" : parentId;
   }