@arizeai/phoenix-client 6.9.3 → 6.10.1

package/src/constants/serverRequirements.ts

@@ -106,6 +106,30 @@ export const DATASET_UPLOAD_EXAMPLE_IDS: ParameterRequirement = {
   minServerVersion: [15, 0, 0],
 };
 
+export const ADD_TRACE_NOTE_IDENTIFIER: ParameterRequirement = {
+  kind: "parameter",
+  parameterName: "identifier",
+  parameterLocation: "body",
+  route: "POST /v1/trace_notes",
+  minServerVersion: [15, 5, 0],
+};
+
+export const ADD_SPAN_NOTE_IDENTIFIER: ParameterRequirement = {
+  kind: "parameter",
+  parameterName: "identifier",
+  parameterLocation: "body",
+  route: "POST /v1/span_notes",
+  minServerVersion: [15, 5, 0],
+};
+
+export const ADD_SESSION_NOTE_IDENTIFIER: ParameterRequirement = {
+  kind: "parameter",
+  parameterName: "identifier",
+  parameterLocation: "body",
+  route: "POST /v1/session_notes",
+  minServerVersion: [15, 5, 0],
+};
+
 /**
  * Aggregate list of every known capability requirement.
  *
@@ -125,4 +149,7 @@ export const ALL_REQUIREMENTS: readonly CapabilityRequirement[] = [
   GET_SPANS_BY_ATTRIBUTE,
   LIST_PROJECT_TRACES,
   DATASET_UPLOAD_EXAMPLE_IDS,
+  ADD_TRACE_NOTE_IDENTIFIER,
+  ADD_SPAN_NOTE_IDENTIFIER,
+  ADD_SESSION_NOTE_IDENTIFIER,
 ] as const;

package/src/experiments/helpers/getExampleGlobalId.ts

@@ -0,0 +1,12 @@
+import type { ExampleWithId } from "../../types/datasets";
+
+/**
+ * The example's node GlobalID, which experiment runs record as their
+ * `dataset_example_id`. Servers that predate the `nodeId` field deliver the
+ * GlobalID in the `id` field instead.
+ */
+export function getExampleGlobalId(
+  example: Pick<ExampleWithId, "id"> & Partial<Pick<ExampleWithId, "nodeId">>
+): string {
+  return example.nodeId ?? example.id;
+}

package/src/experiments/resumeEvaluation.ts

@@ -29,6 +29,7 @@ import { ensureString } from "../utils/ensureString";
 import { toObjectHeaders } from "../utils/toObjectHeaders";
 import { getExperimentInfo } from "./getExperimentInfo.js";
 import { getExperimentEvaluators } from "./helpers";
+import { getExampleGlobalId } from "./helpers/getExampleGlobalId";
 import { logEvalResumeSummary, PROGRESS_PREFIX } from "./logging";
 import { cleanupOwnedTracerProvider } from "./tracing";
 
@@ -729,7 +730,7 @@ async function runSingleEvaluation({
         ...objectAsAttributes({
           experiment_id: experimentId,
           experiment_run_id: experimentRun.id,
-          dataset_example_id: datasetExample.nodeId,
+          dataset_example_id: getExampleGlobalId(datasetExample),
         }),
       });
 

package/src/experiments/resumeExperiment.ts

@@ -28,6 +28,7 @@ import { isHttpErrorWithStatus } from "../utils/isHttpError";
 import { toObjectHeaders } from "../utils/toObjectHeaders";
 import { getDatasetExperimentsUrl, getExperimentUrl } from "../utils/urlUtils";
 import { getExperimentInfo } from "./getExperimentInfo.js";
+import { getExampleGlobalId } from "./helpers/getExampleGlobalId";
 import {
   logExperimentResumeSummary,
   logLinks,
@@ -619,7 +620,7 @@ async function recordTaskResult({
         },
       },
       body: {
-        dataset_example_id: example.nodeId,
+        dataset_example_id: getExampleGlobalId(example),
         repetition_number: repetitionNumber,
         output: output as Record<string, unknown>,
         start_time: startTime.toISOString(),
@@ -695,7 +696,7 @@ async function runSingleTask({
         [SemanticConventions.INPUT_MIME_TYPE]: MimeType.JSON,
         ...objectAsAttributes({
           experiment_id: experimentId,
-          dataset_example_id: example.nodeId,
+          dataset_example_id: getExampleGlobalId(example),
           repetition_number: repetitionNumber,
         }),
       });

package/src/experiments/runExperiment.ts

@@ -47,6 +47,7 @@ import {
 } from "../utils/urlUtils";
 import { getExperimentInfo } from "./getExperimentInfo";
 import { getExperimentEvaluators } from "./helpers";
+import { getExampleGlobalId } from "./helpers/getExampleGlobalId";
 import {
   logEvalSummary,
   logLinks,
@@ -485,7 +486,7 @@ function runTaskWithExamples({
         id: localId(), // initialized with local id, will be replaced with server-assigned id when dry run is false
         traceId,
         experimentId,
-        datasetExampleId: example.id,
+        datasetExampleId: getExampleGlobalId(example),
         startTime: new Date(),
         endTime: new Date(), // will get replaced with actual end time
         output: null,
@@ -509,7 +510,7 @@ function runTaskWithExamples({
             },
           },
           body: {
-            dataset_example_id: example.nodeId,
+            dataset_example_id: getExampleGlobalId(example),
             output: thisRun.output,
             repetition_number: repetitionNumber,
             start_time: thisRun.startTime.toISOString(),
@@ -681,9 +682,11 @@ export async function evaluateExperiment({
     type EvaluationId = string;
     const evaluationRuns: Record<EvaluationId, ExperimentEvaluationRun> = {};
 
+    // Index examples by node GlobalID, matching how runs record
+    // datasetExampleId.
     const examplesById: Record<string, Example> = {};
     for (const example of dataset.examples) {
-      examplesById[example.id] = example;
+      examplesById[getExampleGlobalId(example)] = example;
     }
 
     const onEvaluationComplete = (run: ExperimentEvaluationRun) => {

package/src/sessions/addSessionNote.ts

@@ -1,5 +1,8 @@
 import { createClient } from "../client";
-import { ADD_SESSION_NOTE } from "../constants/serverRequirements";
+import {
+  ADD_SESSION_NOTE,
+  ADD_SESSION_NOTE_IDENTIFIER,
+} from "../constants/serverRequirements";
 import type { ClientFn } from "../types/core";
 import { formatApiError } from "../utils/apiErrorUtils";
 import { ensureServerCapability } from "../utils/serverVersionUtils";
@@ -16,6 +19,13 @@ export interface SessionNote {
    * The note text to add to the session.
    */
   note: string;
+  /**
+   * Optional caller-supplied identifier. When non-empty, the note is upserted
+   * on `(sessionId, name='note', identifier)` — repeated calls with the same
+   * identifier overwrite the existing note. When omitted, the server stamps a
+   * unique `px-session-note:<uuid>` identifier so each call appends a new note.
+   */
+  identifier?: string;
 }
 
 /**
@@ -28,8 +38,10 @@ export interface AddSessionNoteParams extends ClientFn {
 /**
  * Add a note to a session.
  *
- * Notes are a special type of annotation that allow multiple entries per session.
- * Each note gets a unique UUIDv4 identifier.
+ * When `sessionNote.identifier` is omitted, each call appends a new note with
+ * an auto-generated identifier. When `identifier` is non-empty, repeated calls
+ * with the same `(sessionId, name='note', identifier)` overwrite the existing
+ * note.
  *
  * @param params - The parameters to add a session note.
  * @returns The ID of the created note annotation.
@@ -52,12 +64,19 @@ export async function addSessionNote({
 }: AddSessionNoteParams): Promise<{ id: string }> {
   const client = _client ?? createClient();
   await ensureServerCapability({ client, requirement: ADD_SESSION_NOTE });
+  if (sessionNote.identifier) {
+    await ensureServerCapability({
+      client,
+      requirement: ADD_SESSION_NOTE_IDENTIFIER,
+    });
+  }
 
   const { data, error } = await client.POST("/v1/session_notes", {
     body: {
       data: {
         session_id: sessionNote.sessionId.trim(),
         note: sessionNote.note,
+        identifier: sessionNote.identifier,
       },
     },
   });

package/src/spans/addSpanNote.ts

@@ -1,6 +1,8 @@
 import { createClient } from "../client";
+import { ADD_SPAN_NOTE_IDENTIFIER } from "../constants/serverRequirements";
 import type { ClientFn } from "../types/core";
 import { formatApiError } from "../utils/apiErrorUtils";
+import { ensureServerCapability } from "../utils/serverVersionUtils";
 
 /**
  * Parameters for a single span note
@@ -14,6 +16,13 @@ export interface SpanNote {
    * The note text to add to the span
    */
   note: string;
+  /**
+   * Optional caller-supplied identifier. When non-empty, the note is upserted
+   * on `(spanId, name='note', identifier)` — repeated calls with the same
+   * identifier overwrite the existing note. When omitted, the server stamps a
+   * unique `px-span-note:<uuid>` identifier so each call appends a new note.
+   */
+  identifier?: string;
 }
 
 /**
@@ -26,11 +35,10 @@ export interface AddSpanNoteParams extends ClientFn {
 /**
  * Add a note to a span.
  *
- * Notes are append-only: each call creates a new note with an auto-generated
- * UUIDv4 identifier, so multiple notes accumulate on the same span. Structured
- * annotations, by contrast, are keyed by `(name, spanId, identifier)` — to keep
- * multiple structured annotations with the same name on a span, supply distinct
- * identifiers; otherwise re-writing the same name overwrites the existing one.
+ * When `spanNote.identifier` is omitted, each call appends a new note with an
+ * auto-generated identifier. When `identifier` is non-empty, repeated calls
+ * with the same `(spanId, name='note', identifier)` overwrite the existing
+ * note.
  *
  * @param params - The parameters to add a span note
  * @returns The ID of the created note annotation
@@ -50,12 +58,19 @@ export async function addSpanNote({
   spanNote,
 }: AddSpanNoteParams): Promise<{ id: string }> {
   const client = _client ?? createClient();
+  if (spanNote.identifier) {
+    await ensureServerCapability({
+      client,
+      requirement: ADD_SPAN_NOTE_IDENTIFIER,
+    });
+  }
 
   const { data, error } = await client.POST("/v1/span_notes", {
     body: {
       data: {
         span_id: spanNote.spanId.trim(),
         note: spanNote.note,
+        identifier: spanNote.identifier,
       },
     },
   });

package/src/spans/getSpanAnnotations.ts

@@ -12,7 +12,7 @@ export interface GetSpanAnnotationsParams extends ClientFn {
   project: ProjectIdentifier;
   /** One or more span IDs to fetch annotations for */
   spanIds: string[];
-  /** Optional list of annotation names to include. If provided, only annotations with these names will be returned. 'note' annotations are excluded by default unless explicitly included in this list. */
+  /** Optional list of annotation names to include. If provided, only annotations with these names will be returned (allowlist). When omitted, the response includes every matching row regardless of name (no annotation names are excluded by default). */
   includeAnnotationNames?: string[];
   /** Optional list of annotation names to exclude from results. */
   excludeAnnotationNames?: string[];

package/src/traces/addTraceNote.ts

@@ -1,5 +1,8 @@
 import { createClient } from "../client";
-import { ADD_TRACE_NOTE } from "../constants/serverRequirements";
+import {
+  ADD_TRACE_NOTE,
+  ADD_TRACE_NOTE_IDENTIFIER,
+} from "../constants/serverRequirements";
 import type { ClientFn } from "../types/core";
 import { formatApiError } from "../utils/apiErrorUtils";
 import { ensureServerCapability } from "../utils/serverVersionUtils";
@@ -16,6 +19,13 @@ export interface TraceNote {
    * The note text to add to the trace.
    */
   note: string;
+  /**
+   * Optional caller-supplied identifier. When non-empty, the note is upserted
+   * on `(traceId, name='note', identifier)` — repeated calls with the same
+   * identifier overwrite the existing note. When omitted, the server stamps a
+   * unique `px-trace-note:<uuid>` identifier so each call appends a new note.
+   */
+  identifier?: string;
 }
 
 /**
@@ -28,11 +38,10 @@ export interface AddTraceNoteParams extends ClientFn {
 /**
  * Add a note to a trace.
  *
- * Notes are append-only: each call creates a new note with an auto-generated
- * UUIDv4 identifier, so multiple notes accumulate on the same trace. Structured
- * annotations, by contrast, are keyed by `(name, traceId, identifier)` — to keep
- * multiple structured annotations with the same name on a trace, supply distinct
- * identifiers; otherwise re-writing the same name overwrites the existing one.
+ * When `traceNote.identifier` is omitted, each call appends a new note with an
+ * auto-generated identifier. When `identifier` is non-empty, repeated calls
+ * with the same `(traceId, name='note', identifier)` overwrite the existing
+ * note.
  *
  * @param params - The parameters to add a trace note.
  * @returns The ID of the created note annotation.
@@ -53,12 +62,19 @@ export async function addTraceNote({
 }: AddTraceNoteParams): Promise<{ id: string }> {
   const client = _client ?? createClient();
   await ensureServerCapability({ client, requirement: ADD_TRACE_NOTE });
+  if (traceNote.identifier) {
+    await ensureServerCapability({
+      client,
+      requirement: ADD_TRACE_NOTE_IDENTIFIER,
+    });
+  }
 
   const { data, error } = await client.POST("/v1/trace_notes", {
     body: {
       data: {
         trace_id: traceNote.traceId.trim(),
         note: traceNote.note,
+        identifier: traceNote.identifier,
       },
     },
   });