@arizeai/phoenix-client 6.5.0 → 6.5.1

package/package.json

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

package/src/constants/serverRequirements.ts

@@ -61,6 +61,14 @@ export const GET_SPANS_TRACE_IDS: ParameterRequirement = {
   minServerVersion: [13, 9, 0],
 };
 
+export const GET_SPANS_FILTERS: ParameterRequirement = {
+  kind: "parameter",
+  parameterName: "span_kind",
+  parameterLocation: "query",
+  route: "GET /v1/projects/{id}/spans",
+  minServerVersion: [13, 15, 0],
+};
+
 /**
  * Aggregate list of every known capability requirement.
  *
@@ -74,4 +82,5 @@ export const ALL_REQUIREMENTS: readonly CapabilityRequirement[] = [
   LIST_PROJECT_SESSIONS,
   ANNOTATE_SESSIONS,
   GET_SPANS_TRACE_IDS,
+  GET_SPANS_FILTERS,
 ] as const;

package/src/prompts/sdks/toAI.ts

@@ -1,7 +1,12 @@
 import type { ModelMessage, ToolChoice, ToolSet } from "ai";
 import invariant from "tiny-invariant";
 
-import { safelyConvertMessageToProvider } from "../../schemas/llm/converters";
+import {
+  safelyConvertMessageToProvider,
+  safelyConvertToolChoiceToProvider,
+  safelyConvertToolDefinitionToProvider,
+} from "../../schemas/llm/converters";
+import { findToolDefinitionName } from "../../schemas/llm/utils";
 import { formatPromptMessages } from "../../utils/formatPromptMessages";
 import type { Variables, toSDKParamsBase } from "./types";
 
@@ -62,19 +67,40 @@ export const toAI = <V extends Variables>({
       return vercelAIMessage;
     });
 
-    const tools = undefined;
-    if (prompt.tools?.tools && prompt.tools?.tools.length) {
-      // eslint-disable-next-line no-console
-      console.warn(
-        "Phoenix client does not automatically convert tools to AI SDK tools, please manually convert them."
-      );
+    let tools: ToolSet | undefined;
+    if (prompt.tools?.tools && prompt.tools.tools.length > 0) {
+      const toolsRecord: Record<string, unknown> = {};
+      for (const tool of prompt.tools.tools) {
+        const name = findToolDefinitionName(tool);
+        invariant(name, "Tool definition name is not valid");
+        const converted = safelyConvertToolDefinitionToProvider({
+          toolDefinition: tool,
+          targetProvider: "VERCEL_AI",
+        });
+        invariant(converted, "Tool definition is not valid");
+        toolsRecord[name] = converted;
+      }
+      tools =
+        Object.keys(toolsRecord).length > 0
+          ? (toolsRecord as ToolSet)
+          : undefined;
+    }
+
+    let toolChoice: PartialAIParams["toolChoice"];
+    if (tools && prompt.tools?.tool_choice) {
+      toolChoice =
+        safelyConvertToolChoiceToProvider({
+          toolChoice: prompt.tools.tool_choice,
+          targetProvider: "VERCEL_AI",
+        }) ?? undefined;
     }
 
     // combine base and computed params
     const completionParams: PartialAIParams = {
       ...baseCompletionParams,
       messages,
-      tools,
+      ...(tools !== undefined && { tools }),
+      ...(toolChoice !== undefined && { toolChoice }),
     };
 
     return completionParams;

package/src/spans/getSpans.ts

@@ -1,9 +1,13 @@
 import type { operations } from "../__generated__/api/v1";
 import { createClient } from "../client";
-import { GET_SPANS_TRACE_IDS } from "../constants/serverRequirements";
+import {
+  GET_SPANS_FILTERS,
+  GET_SPANS_TRACE_IDS,
+} from "../constants/serverRequirements";
 import type { ClientFn } from "../types/core";
 import type { ProjectIdentifier } from "../types/projects";
 import { resolveProjectIdentifier } from "../types/projects";
+import type { SpanKindFilter, SpanStatusCode } from "../types/spans";
 import { ensureServerCapability } from "../utils/serverVersionUtils";
 
 /**
@@ -24,6 +28,12 @@ export interface GetSpansParams extends ClientFn {
   traceIds?: 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) */
+  name?: string | string[] | null;
+  /** Filter by span kind(s) (LLM, CHAIN, TOOL, RETRIEVER, etc.) */
+  spanKind?: SpanKindFilter | SpanKindFilter[] | null;
+  /** Filter by status code(s) (OK, ERROR, UNSET) */
+  statusCode?: SpanStatusCode | SpanStatusCode[] | null;
 }
 
 export type GetSpansResponse = operations["getSpans"]["responses"]["200"];
@@ -103,11 +113,17 @@ export async function getSpans({
   endTime,
   traceIds,
   parentId,
+  name,
+  spanKind,
+  statusCode,
 }: GetSpansParams): Promise<GetSpansResult> {
   const client = _client ?? createClient();
   if (traceIds) {
     await ensureServerCapability({ client, requirement: GET_SPANS_TRACE_IDS });
   }
+  if (name != null || spanKind != null || statusCode != null) {
+    await ensureServerCapability({ client, requirement: GET_SPANS_FILTERS });
+  }
   const projectIdentifier = resolveProjectIdentifier(project);
 
   const params: NonNullable<operations["getSpans"]["parameters"]["query"]> = {
@@ -135,6 +151,18 @@ export async function getSpans({
     params.parent_id = parentId === null ? "null" : parentId;
   }
 
+  if (name) {
+    params.name = Array.isArray(name) ? name : [name];
+  }
+
+  if (spanKind) {
+    params.span_kind = Array.isArray(spanKind) ? spanKind : [spanKind];
+  }
+
+  if (statusCode) {
+    params.status_code = Array.isArray(statusCode) ? statusCode : [statusCode];
+  }
+
   const { data, error } = await client.GET(
     "/v1/projects/{project_identifier}/spans",
     {

package/src/spans/index.ts

@@ -4,5 +4,6 @@ export * from "./logSpanAnnotations";
 export * from "./addDocumentAnnotation";
 export * from "./logDocumentAnnotations";
 export * from "./getSpans";
+export type { SpanKindFilter, SpanStatusCode } from "../types/spans";
 export * from "./getSpanAnnotations";
 export * from "./deleteSpan";

package/src/types/spans.ts

@@ -0,0 +1,12 @@
+import type { OpenInferenceSpanKind } from "@arizeai/openinference-semantic-conventions";
+
+/**
+ * Status codes for spans.
+ */
+export type SpanStatusCode = "OK" | "ERROR" | "UNSET";
+
+/**
+ * Span kind filter value. Accepts well-known OpenInference span kinds
+ * as well as arbitrary strings for forward-compatibility.
+ */
+export type SpanKindFilter = OpenInferenceSpanKind | (string & {});