@arizeai/phoenix-client 6.9.3 → 6.10.1

package/dist/esm/spans/getSpanAnnotations.d.ts

@@ -9,7 +9,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/dist/esm/spans/getSpanAnnotations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getSpanAnnotations.d.ts","sourceRoot":"","sources":["../../../src/spans/getSpanAnnotations.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAG3D;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,QAAQ;IACxD,+CAA+C;IAC/C,OAAO,EAAE,iBAAiB,CAAC;IAC3B,oDAAoD;IACpD,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,yMAAyM;IACzM,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAC;IAClC,iEAAiE;IACjE,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAC;IAClC,wBAAwB;IACxB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,0BAA0B,GACpC,UAAU,CAAC,8BAA8B,CAAC,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC;AAEjE,MAAM,MAAM,wBAAwB,GAAG;IACrC,WAAW,EAAE,0BAA0B,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC;IAC/E,UAAU,EAAE,0BAA0B,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC,aAAa,CAAC,CAAC;CACtF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,MAAM,EAAE,OAAO,EACf,OAAO,EACP,OAAO,EACP,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,EACN,KAAW,GACZ,EAAE,wBAAwB,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAwC9D"}
+{"version":3,"file":"getSpanAnnotations.d.ts","sourceRoot":"","sources":["../../../src/spans/getSpanAnnotations.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAG3D;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,QAAQ;IACxD,+CAA+C;IAC/C,OAAO,EAAE,iBAAiB,CAAC;IAC3B,oDAAoD;IACpD,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,0PAA0P;IAC1P,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAC;IAClC,iEAAiE;IACjE,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAC;IAClC,wBAAwB;IACxB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,0BAA0B,GACpC,UAAU,CAAC,8BAA8B,CAAC,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC;AAEjE,MAAM,MAAM,wBAAwB,GAAG;IACrC,WAAW,EAAE,0BAA0B,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC;IAC/E,UAAU,EAAE,0BAA0B,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC,aAAa,CAAC,CAAC;CACtF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,MAAM,EAAE,OAAO,EACf,OAAO,EACP,OAAO,EACP,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,EACN,KAAW,GACZ,EAAE,wBAAwB,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAwC9D"}

package/dist/esm/traces/addTraceNote.d.ts

@@ -11,6 +11,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;
 }
 /**
  * Parameters to add a trace note.
@@ -21,11 +28,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.

package/dist/esm/traces/addTraceNote.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"addTraceNote.d.ts","sourceRoot":"","sources":["../../../src/traces/addTraceNote.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAI9C;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,QAAQ;IAClD,SAAS,EAAE,SAAS,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAsB,YAAY,CAAC,EACjC,MAAM,EAAE,OAAO,EACf,SAAS,GACV,EAAE,kBAAkB,GAAG,OAAO,CAAC;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC,CAsB9C"}
+{"version":3,"file":"addTraceNote.d.ts","sourceRoot":"","sources":["../../../src/traces/addTraceNote.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAI9C;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,QAAQ;IAClD,SAAS,EAAE,SAAS,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,YAAY,CAAC,EACjC,MAAM,EAAE,OAAO,EACf,SAAS,GACV,EAAE,kBAAkB,GAAG,OAAO,CAAC;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC,CA6B9C"}

package/dist/esm/traces/addTraceNote.js

@@ -1,15 +1,14 @@
 import { createClient } from "../client.js";
-import { ADD_TRACE_NOTE } from "../constants/serverRequirements.js";
+import { ADD_TRACE_NOTE, ADD_TRACE_NOTE_IDENTIFIER, } from "../constants/serverRequirements.js";
 import { formatApiError } from "../utils/apiErrorUtils.js";
 import { ensureServerCapability } from "../utils/serverVersionUtils.js";
 /**
  * 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.
@@ -27,11 +26,18 @@ import { ensureServerCapability } from "../utils/serverVersionUtils.js";
 export async function addTraceNote({ client: _client, traceNote, }) {
     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,
             },
         },
     });

package/dist/esm/traces/addTraceNote.js.map

@@ -1 +1 @@
-{"version":3,"file":"addTraceNote.js","sourceRoot":"","sources":["../../../src/traces/addTraceNote.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAEjE,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAuBrE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,EACjC,MAAM,EAAE,OAAO,EACf,SAAS,GACU;IACnB,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,sBAAsB,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAEtE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,iBAAiB,EAAE;QAC3D,IAAI,EAAE;YACJ,IAAI,EAAE;gBACJ,QAAQ,EAAE,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE;gBAClC,IAAI,EAAE,SAAS,CAAC,IAAI;aACrB;SACF;KACF,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,6BAA6B,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACxE,CAAC;IAED,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC;IAED,OAAO,IAAI,CAAC,IAAI,CAAC;AACnB,CAAC"}
+{"version":3,"file":"addTraceNote.js","sourceRoot":"","sources":["../../../src/traces/addTraceNote.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EACL,cAAc,EACd,yBAAyB,GAC1B,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AA8BrE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,EACjC,MAAM,EAAE,OAAO,EACf,SAAS,GACU;IACnB,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,sBAAsB,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IACtE,IAAI,SAAS,CAAC,UAAU,EAAE,CAAC;QACzB,MAAM,sBAAsB,CAAC;YAC3B,MAAM;YACN,WAAW,EAAE,yBAAyB;SACvC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,iBAAiB,EAAE;QAC3D,IAAI,EAAE;YACJ,IAAI,EAAE;gBACJ,QAAQ,EAAE,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE;gBAClC,IAAI,EAAE,SAAS,CAAC,IAAI;gBACpB,UAAU,EAAE,SAAS,CAAC,UAAU;aACjC;SACF;KACF,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,6BAA6B,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACxE,CAAC;IAED,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC;IAED,OAAO,IAAI,CAAC,IAAI,CAAC;AACnB,CAAC"}