@arizeai/phoenix-client 5.5.0 → 5.5.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arizeai/phoenix-client",
-  "version": "5.5.0",
+  "version": "5.5.4",
   "description": "A client for the Phoenix API",
   "main": "dist/src/index.js",
   "module": "dist/esm/index.js",
@@ -56,6 +56,14 @@
   ],
   "author": "oss@arize.com",
   "license": "Apache-2.0",
+  "homepage": "https://github.com/Arize-ai/phoenix/tree/main/js/packages/phoenix-client",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Arize-ai/phoenix.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Arize-ai/phoenix/issues"
+  },
   "devDependencies": {
     "@ai-sdk/openai": "^2.0.27",
     "@anthropic-ai/sdk": "^0.35.0",
@@ -67,7 +75,7 @@
     "tsx": "^4.19.3",
     "typescript": "^5.8.2",
     "vitest": "^4.0.10",
-    "@arizeai/phoenix-evals": "0.6.0"
+    "@arizeai/phoenix-evals": "0.6.5"
   },
   "dependencies": {
     "@arizeai/openinference-semantic-conventions": "^1.1.0",
@@ -77,7 +85,7 @@
     "tiny-invariant": "^1.3.3",
     "zod": "^3.24.3",
     "zod-to-json-schema": "^3.24.3",
-    "@arizeai/phoenix-otel": "0.3.0"
+    "@arizeai/phoenix-otel": "0.3.4"
   },
   "engines": {
     "node": ">=18"

package/src/__generated__/api/v1.ts

@@ -526,6 +526,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/span_notes": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Create a span note
+         * @description Add a note annotation to a span. Notes are special annotations that allow multiple entries per span (unlike regular annotations which are unique by name and identifier). Each note gets a unique timestamp-based identifier.
+         */
+        post: operations["createSpanNote"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/spans/{span_identifier}": {
         parameters: {
             query?: never;
@@ -1096,6 +1116,14 @@ export interface components {
         CreatePromptResponseBody: {
             data: components["schemas"]["PromptVersion"];
         };
+        /** CreateSpanNoteRequestBody */
+        CreateSpanNoteRequestBody: {
+            data: components["schemas"]["SpanNoteData"];
+        };
+        /** CreateSpanNoteResponseBody */
+        CreateSpanNoteResponseBody: {
+            data: components["schemas"]["InsertedSpanAnnotation"];
+        };
         /** CreateSpansRequestBody */
         CreateSpansRequestBody: {
             /** Data */
@@ -1117,7 +1145,7 @@ export interface components {
         /** CreateUserRequestBody */
         CreateUserRequestBody: {
             /** User */
-            user: components["schemas"]["LocalUserData"] | components["schemas"]["OAuth2UserData"];
+            user: components["schemas"]["LocalUserData"] | components["schemas"]["OAuth2UserData"] | components["schemas"]["LDAPUserData"];
             /**
              * Send Welcome Email
              * @default true
@@ -1127,7 +1155,7 @@ export interface components {
         /** CreateUserResponseBody */
         CreateUserResponseBody: {
             /** Data */
-            data: components["schemas"]["LocalUser"] | components["schemas"]["OAuth2User"];
+            data: components["schemas"]["LocalUser"] | components["schemas"]["OAuth2User"] | components["schemas"]["LDAPUser"];
         };
         /** Dataset */
         Dataset: {
@@ -1456,7 +1484,7 @@ export interface components {
         /** GetUsersResponseBody */
         GetUsersResponseBody: {
             /** Data */
-            data: (components["schemas"]["LocalUser"] | components["schemas"]["OAuth2User"])[];
+            data: (components["schemas"]["LocalUser"] | components["schemas"]["OAuth2User"] | components["schemas"]["LDAPUser"])[];
             /** Next Cursor */
             next_cursor: string | null;
         };
@@ -1527,6 +1555,52 @@ export interface components {
              */
             id: string;
         };
+        /** LDAPUser */
+        LDAPUser: {
+            /** Id */
+            id: string;
+            /**
+             * Created At
+             * Format: date-time
+             */
+            created_at: string;
+            /**
+             * Updated At
+             * Format: date-time
+             */
+            updated_at: string;
+            /** Email */
+            email: string;
+            /** Username */
+            username: string;
+            /**
+             * Role
+             * @enum {string}
+             */
+            role: "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER";
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            auth_method: "LDAP";
+        };
+        /** LDAPUserData */
+        LDAPUserData: {
+            /** Email */
+            email: string;
+            /** Username */
+            username: string;
+            /**
+             * Role
+             * @enum {string}
+             */
+            role: "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER";
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            auth_method: "LDAP";
+        };
         /** ListDatasetExamplesData */
         ListDatasetExamplesData: {
             /** Dataset Id */
@@ -2669,6 +2743,19 @@ export interface components {
                 [key: string]: unknown;
             };
         };
+        /** SpanNoteData */
+        SpanNoteData: {
+            /**
+             * Span Id
+             * @description OpenTelemetry Span ID (hex format w/o 0x prefix)
+             */
+            span_id: string;
+            /**
+             * Note
+             * @description The note text to add to the span
+             */
+            note: string;
+        };
         /** SpansResponseBody */
         SpansResponseBody: {
             /** Data */
@@ -4678,6 +4765,57 @@ export interface operations {
             };
         };
     };
+    createSpanNote: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateSpanNoteRequestBody"];
+            };
+        };
+        responses: {
+            /** @description Span note created successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CreateSpanNoteResponseBody"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Span 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"];
+                };
+            };
+        };
+    };
     deleteSpan: {
         parameters: {
             query?: never;

package/src/spans/addSpanNote.ts

@@ -0,0 +1,69 @@
+import { createClient } from "../client";
+import { ClientFn } from "../types/core";
+
+/**
+ * Parameters for a single span note
+ */
+export interface SpanNote {
+  /**
+   * The OpenTelemetry Span ID (hex format without 0x prefix)
+   */
+  spanId: string;
+  /**
+   * The note text to add to the span
+   */
+  note: string;
+}
+
+/**
+ * Parameters to add a span note
+ */
+export interface AddSpanNoteParams extends ClientFn {
+  spanNote: SpanNote;
+}
+
+/**
+ * Add a note to a span.
+ *
+ * Notes are a special type of annotation that allow multiple entries per span
+ * (unlike regular annotations which are unique by name and identifier).
+ * Each note gets a unique timestamp-based identifier.
+ *
+ * @param params - The parameters to add a span note
+ * @returns The ID of the created note annotation
+ *
+ * @example
+ * ```ts
+ * const result = await addSpanNote({
+ *   spanNote: {
+ *     spanId: "123abc",
+ *     note: "This span looks suspicious, needs review"
+ *   }
+ * });
+ * ```
+ */
+export async function addSpanNote({
+  client: _client,
+  spanNote,
+}: AddSpanNoteParams): Promise<{ id: string }> {
+  const client = _client ?? createClient();
+
+  const { data, error } = await client.POST("/v1/span_notes", {
+    body: {
+      data: {
+        span_id: spanNote.spanId.trim(),
+        note: spanNote.note,
+      },
+    },
+  });
+
+  if (error) {
+    throw new Error(`Failed to add span note: ${error}`);
+  }
+
+  if (!data?.data) {
+    throw new Error("Failed to add span note: no data returned");
+  }
+
+  return data.data;
+}

package/src/spans/index.ts

@@ -1,4 +1,5 @@
 export * from "./addSpanAnnotation";
+export * from "./addSpanNote";
 export * from "./logSpanAnnotations";
 export * from "./addDocumentAnnotation";
 export * from "./logDocumentAnnotations";