@arizeai/phoenix-client 6.9.3 → 6.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. package/dist/esm/__generated__/api/v1.d.ts +72 -20
  2. package/dist/esm/__generated__/api/v1.d.ts.map +1 -1
  3. package/dist/esm/constants/serverRequirements.d.ts +3 -0
  4. package/dist/esm/constants/serverRequirements.d.ts.map +1 -1
  5. package/dist/esm/constants/serverRequirements.js +24 -0
  6. package/dist/esm/constants/serverRequirements.js.map +1 -1
  7. package/dist/esm/sessions/addSessionNote.d.ts +11 -2
  8. package/dist/esm/sessions/addSessionNote.d.ts.map +1 -1
  9. package/dist/esm/sessions/addSessionNote.js +12 -3
  10. package/dist/esm/sessions/addSessionNote.js.map +1 -1
  11. package/dist/esm/spans/addSpanNote.d.ts +11 -5
  12. package/dist/esm/spans/addSpanNote.d.ts.map +1 -1
  13. package/dist/esm/spans/addSpanNote.js +13 -5
  14. package/dist/esm/spans/addSpanNote.js.map +1 -1
  15. package/dist/esm/spans/getSpanAnnotations.d.ts +1 -1
  16. package/dist/esm/spans/getSpanAnnotations.d.ts.map +1 -1
  17. package/dist/esm/traces/addTraceNote.d.ts +11 -5
  18. package/dist/esm/traces/addTraceNote.d.ts.map +1 -1
  19. package/dist/esm/traces/addTraceNote.js +12 -6
  20. package/dist/esm/traces/addTraceNote.js.map +1 -1
  21. package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
  22. package/dist/esm/utils/formatPromptMessages.d.ts.map +1 -1
  23. package/dist/esm/utils/getPromptBySelector.d.ts.map +1 -1
  24. package/dist/src/__generated__/api/v1.d.ts +72 -20
  25. package/dist/src/__generated__/api/v1.d.ts.map +1 -1
  26. package/dist/src/constants/serverRequirements.d.ts +3 -0
  27. package/dist/src/constants/serverRequirements.d.ts.map +1 -1
  28. package/dist/src/constants/serverRequirements.js +25 -1
  29. package/dist/src/constants/serverRequirements.js.map +1 -1
  30. package/dist/src/sessions/addSessionNote.d.ts +11 -2
  31. package/dist/src/sessions/addSessionNote.d.ts.map +1 -1
  32. package/dist/src/sessions/addSessionNote.js +11 -2
  33. package/dist/src/sessions/addSessionNote.js.map +1 -1
  34. package/dist/src/spans/addSpanNote.d.ts +11 -5
  35. package/dist/src/spans/addSpanNote.d.ts.map +1 -1
  36. package/dist/src/spans/addSpanNote.js +13 -5
  37. package/dist/src/spans/addSpanNote.js.map +1 -1
  38. package/dist/src/spans/getSpanAnnotations.d.ts +1 -1
  39. package/dist/src/spans/getSpanAnnotations.d.ts.map +1 -1
  40. package/dist/src/traces/addTraceNote.d.ts +11 -5
  41. package/dist/src/traces/addTraceNote.d.ts.map +1 -1
  42. package/dist/src/traces/addTraceNote.js +11 -5
  43. package/dist/src/traces/addTraceNote.js.map +1 -1
  44. package/dist/src/utils/formatPromptMessages.d.ts.map +1 -1
  45. package/dist/src/utils/getPromptBySelector.d.ts.map +1 -1
  46. package/dist/tsconfig.tsbuildinfo +1 -1
  47. package/package.json +1 -1
  48. package/src/__generated__/api/v1.ts +72 -20
  49. package/src/constants/serverRequirements.ts +27 -0
  50. package/src/sessions/addSessionNote.ts +22 -3
  51. package/src/spans/addSpanNote.ts +20 -5
  52. package/src/spans/getSpanAnnotations.ts +1 -1
  53. package/src/traces/addTraceNote.ts +22 -6
@@ -24,6 +24,9 @@ export declare const GET_SPANS_FILTERS: ParameterRequirement;
24
24
  export declare const LIST_PROJECT_TRACES: RouteRequirement;
25
25
  export declare const GET_SPANS_BY_ATTRIBUTE: ParameterRequirement;
26
26
  export declare const DATASET_UPLOAD_EXAMPLE_IDS: ParameterRequirement;
27
+ export declare const ADD_TRACE_NOTE_IDENTIFIER: ParameterRequirement;
28
+ export declare const ADD_SPAN_NOTE_IDENTIFIER: ParameterRequirement;
29
+ export declare const ADD_SESSION_NOTE_IDENTIFIER: ParameterRequirement;
27
30
  /**
28
31
  * Aggregate list of every known capability requirement.
29
32
  *
@@ -1 +1 @@
1
- {"version":3,"file":"serverRequirements.d.ts","sourceRoot":"","sources":["../../../src/constants/serverRequirements.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EACV,qBAAqB,EACrB,oBAAoB,EACpB,gBAAgB,EACjB,MAAM,6BAA6B,CAAC;AAErC,eAAO,MAAM,WAAW,EAAE,gBAKzB,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,gBAK5B,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,gBAK7B,CAAC;AAEF,eAAO,MAAM,qBAAqB,EAAE,gBAKnC,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,gBAK/B,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,gBAK5B,CAAC;AAEF,eAAO,MAAM,gBAAgB,EAAE,gBAK9B,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,oBAMjC,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,oBAM/B,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,gBAKjC,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,oBAMpC,CAAC;AAEF,eAAO,MAAM,0BAA0B,EAAE,oBAMxC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,EAAE,SAAS,qBAAqB,EAanD,CAAC"}
1
+ {"version":3,"file":"serverRequirements.d.ts","sourceRoot":"","sources":["../../../src/constants/serverRequirements.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EACV,qBAAqB,EACrB,oBAAoB,EACpB,gBAAgB,EACjB,MAAM,6BAA6B,CAAC;AAErC,eAAO,MAAM,WAAW,EAAE,gBAKzB,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,gBAK5B,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,gBAK7B,CAAC;AAEF,eAAO,MAAM,qBAAqB,EAAE,gBAKnC,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,gBAK/B,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,gBAK5B,CAAC;AAEF,eAAO,MAAM,gBAAgB,EAAE,gBAK9B,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,oBAMjC,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,oBAM/B,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,gBAKjC,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,oBAMpC,CAAC;AAEF,eAAO,MAAM,0BAA0B,EAAE,oBAMxC,CAAC;AAEF,eAAO,MAAM,yBAAyB,EAAE,oBAMvC,CAAC;AAEF,eAAO,MAAM,wBAAwB,EAAE,oBAMtC,CAAC;AAEF,eAAO,MAAM,2BAA2B,EAAE,oBAMzC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,EAAE,SAAS,qBAAqB,EAgBnD,CAAC"}
@@ -87,6 +87,27 @@ export const DATASET_UPLOAD_EXAMPLE_IDS = {
87
87
  route: "POST /v1/datasets/upload",
88
88
  minServerVersion: [15, 0, 0],
89
89
  };
90
+ export const ADD_TRACE_NOTE_IDENTIFIER = {
91
+ kind: "parameter",
92
+ parameterName: "identifier",
93
+ parameterLocation: "body",
94
+ route: "POST /v1/trace_notes",
95
+ minServerVersion: [15, 5, 0],
96
+ };
97
+ export const ADD_SPAN_NOTE_IDENTIFIER = {
98
+ kind: "parameter",
99
+ parameterName: "identifier",
100
+ parameterLocation: "body",
101
+ route: "POST /v1/span_notes",
102
+ minServerVersion: [15, 5, 0],
103
+ };
104
+ export const ADD_SESSION_NOTE_IDENTIFIER = {
105
+ kind: "parameter",
106
+ parameterName: "identifier",
107
+ parameterLocation: "body",
108
+ route: "POST /v1/session_notes",
109
+ minServerVersion: [15, 5, 0],
110
+ };
90
111
  /**
91
112
  * Aggregate list of every known capability requirement.
92
113
  *
@@ -106,5 +127,8 @@ export const ALL_REQUIREMENTS = [
106
127
  GET_SPANS_BY_ATTRIBUTE,
107
128
  LIST_PROJECT_TRACES,
108
129
  DATASET_UPLOAD_EXAMPLE_IDS,
130
+ ADD_TRACE_NOTE_IDENTIFIER,
131
+ ADD_SPAN_NOTE_IDENTIFIER,
132
+ ADD_SESSION_NOTE_IDENTIFIER,
109
133
  ];
110
134
  //# sourceMappingURL=serverRequirements.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"serverRequirements.js","sourceRoot":"","sources":["../../../src/constants/serverRequirements.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAQH,MAAM,CAAC,MAAM,WAAW,GAAqB;IAC3C,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,2BAA2B;IACjC,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAqB;IAC9C,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,2BAA2B;IACjC,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC9B,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAqB;IAC/C,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,qBAAqB;IAC3B,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC9B,CAAC;AAEF,MAAM,CAAC,MAAM,qBAAqB,GAAqB;IACrD,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,oCAAoC;IAC1C,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAqB;IACjD,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,yBAAyB;IAC/B,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAqB;IAC9C,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,iBAAiB;IACvB,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC9B,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAqB;IAChD,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,mBAAmB;IACzB,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC9B,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAyB;IACvD,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,UAAU;IACzB,iBAAiB,EAAE,OAAO;IAC1B,KAAK,EAAE,6BAA6B;IACpC,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAyB;IACrD,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,WAAW;IAC1B,iBAAiB,EAAE,OAAO;IAC1B,KAAK,EAAE,6BAA6B;IACpC,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC9B,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAqB;IACnD,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,0CAA0C;IAChD,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC9B,CAAC;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAyB;IAC1D,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,WAAW;IAC1B,iBAAiB,EAAE,OAAO;IAC1B,KAAK,EAAE,6BAA6B;IACpC,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEF,MAAM,CAAC,MAAM,0BAA0B,GAAyB;IAC9D,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,aAAa;IAC5B,iBAAiB,EAAE,MAAM;IACzB,KAAK,EAAE,0BAA0B;IACjC,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAqC;IAChE,WAAW;IACX,cAAc;IACd,eAAe;IACf,qBAAqB;IACrB,iBAAiB;IACjB,cAAc;IACd,gBAAgB;IAChB,mBAAmB;IACnB,iBAAiB;IACjB,sBAAsB;IACtB,mBAAmB;IACnB,0BAA0B;CAClB,CAAC"}
1
+ {"version":3,"file":"serverRequirements.js","sourceRoot":"","sources":["../../../src/constants/serverRequirements.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAQH,MAAM,CAAC,MAAM,WAAW,GAAqB;IAC3C,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,2BAA2B;IACjC,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAqB;IAC9C,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,2BAA2B;IACjC,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC9B,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAqB;IAC/C,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,qBAAqB;IAC3B,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC9B,CAAC;AAEF,MAAM,CAAC,MAAM,qBAAqB,GAAqB;IACrD,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,oCAAoC;IAC1C,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAqB;IACjD,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,yBAAyB;IAC/B,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAqB;IAC9C,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,iBAAiB;IACvB,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC9B,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAqB;IAChD,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,mBAAmB;IACzB,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC9B,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAyB;IACvD,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,UAAU;IACzB,iBAAiB,EAAE,OAAO;IAC1B,KAAK,EAAE,6BAA6B;IACpC,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAyB;IACrD,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,WAAW;IAC1B,iBAAiB,EAAE,OAAO;IAC1B,KAAK,EAAE,6BAA6B;IACpC,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC9B,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAqB;IACnD,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,0CAA0C;IAChD,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC9B,CAAC;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAyB;IAC1D,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,WAAW;IAC1B,iBAAiB,EAAE,OAAO;IAC1B,KAAK,EAAE,6BAA6B;IACpC,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEF,MAAM,CAAC,MAAM,0BAA0B,GAAyB;IAC9D,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,aAAa;IAC5B,iBAAiB,EAAE,MAAM;IACzB,KAAK,EAAE,0BAA0B;IACjC,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEF,MAAM,CAAC,MAAM,yBAAyB,GAAyB;IAC7D,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,YAAY;IAC3B,iBAAiB,EAAE,MAAM;IACzB,KAAK,EAAE,sBAAsB;IAC7B,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEF,MAAM,CAAC,MAAM,wBAAwB,GAAyB;IAC5D,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,YAAY;IAC3B,iBAAiB,EAAE,MAAM;IACzB,KAAK,EAAE,qBAAqB;IAC5B,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEF,MAAM,CAAC,MAAM,2BAA2B,GAAyB;IAC/D,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,YAAY;IAC3B,iBAAiB,EAAE,MAAM;IACzB,KAAK,EAAE,wBAAwB;IAC/B,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAqC;IAChE,WAAW;IACX,cAAc;IACd,eAAe;IACf,qBAAqB;IACrB,iBAAiB;IACjB,cAAc;IACd,gBAAgB;IAChB,mBAAmB;IACnB,iBAAiB;IACjB,sBAAsB;IACtB,mBAAmB;IACnB,0BAA0B;IAC1B,yBAAyB;IACzB,wBAAwB;IACxB,2BAA2B;CACnB,CAAC"}
@@ -11,6 +11,13 @@ export interface SessionNote {
11
11
  * The note text to add to the session.
12
12
  */
13
13
  note: string;
14
+ /**
15
+ * Optional caller-supplied identifier. When non-empty, the note is upserted
16
+ * on `(sessionId, name='note', identifier)` — repeated calls with the same
17
+ * identifier overwrite the existing note. When omitted, the server stamps a
18
+ * unique `px-session-note:<uuid>` identifier so each call appends a new note.
19
+ */
20
+ identifier?: string;
14
21
  }
15
22
  /**
16
23
  * Parameters to add a session note.
@@ -21,8 +28,10 @@ export interface AddSessionNoteParams extends ClientFn {
21
28
  /**
22
29
  * Add a note to a session.
23
30
  *
24
- * Notes are a special type of annotation that allow multiple entries per session.
25
- * Each note gets a unique UUIDv4 identifier.
31
+ * When `sessionNote.identifier` is omitted, each call appends a new note with
32
+ * an auto-generated identifier. When `identifier` is non-empty, repeated calls
33
+ * with the same `(sessionId, name='note', identifier)` overwrite the existing
34
+ * note.
26
35
  *
27
36
  * @param params - The parameters to add a session note.
28
37
  * @returns The ID of the created note annotation.
@@ -1 +1 @@
1
- {"version":3,"file":"addSessionNote.d.ts","sourceRoot":"","sources":["../../../src/sessions/addSessionNote.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAI9C;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,QAAQ;IACpD,WAAW,EAAE,WAAW,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,cAAc,CAAC,EACnC,MAAM,EAAE,OAAO,EACf,WAAW,GACZ,EAAE,oBAAoB,GAAG,OAAO,CAAC;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC,CAsBhD"}
1
+ {"version":3,"file":"addSessionNote.d.ts","sourceRoot":"","sources":["../../../src/sessions/addSessionNote.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAI9C;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,QAAQ;IACpD,WAAW,EAAE,WAAW,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,cAAc,CAAC,EACnC,MAAM,EAAE,OAAO,EACf,WAAW,GACZ,EAAE,oBAAoB,GAAG,OAAO,CAAC;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC,CA6BhD"}
@@ -1,12 +1,14 @@
1
1
  import { createClient } from "../client.js";
2
- import { ADD_SESSION_NOTE } from "../constants/serverRequirements.js";
2
+ import { ADD_SESSION_NOTE, ADD_SESSION_NOTE_IDENTIFIER, } from "../constants/serverRequirements.js";
3
3
  import { formatApiError } from "../utils/apiErrorUtils.js";
4
4
  import { ensureServerCapability } from "../utils/serverVersionUtils.js";
5
5
  /**
6
6
  * Add a note to a session.
7
7
  *
8
- * Notes are a special type of annotation that allow multiple entries per session.
9
- * Each note gets a unique UUIDv4 identifier.
8
+ * When `sessionNote.identifier` is omitted, each call appends a new note with
9
+ * an auto-generated identifier. When `identifier` is non-empty, repeated calls
10
+ * with the same `(sessionId, name='note', identifier)` overwrite the existing
11
+ * note.
10
12
  *
11
13
  * @param params - The parameters to add a session note.
12
14
  * @returns The ID of the created note annotation.
@@ -26,11 +28,18 @@ import { ensureServerCapability } from "../utils/serverVersionUtils.js";
26
28
  export async function addSessionNote({ client: _client, sessionNote, }) {
27
29
  const client = _client ?? createClient();
28
30
  await ensureServerCapability({ client, requirement: ADD_SESSION_NOTE });
31
+ if (sessionNote.identifier) {
32
+ await ensureServerCapability({
33
+ client,
34
+ requirement: ADD_SESSION_NOTE_IDENTIFIER,
35
+ });
36
+ }
29
37
  const { data, error } = await client.POST("/v1/session_notes", {
30
38
  body: {
31
39
  data: {
32
40
  session_id: sessionNote.sessionId.trim(),
33
41
  note: sessionNote.note,
42
+ identifier: sessionNote.identifier,
34
43
  },
35
44
  },
36
45
  });
@@ -1 +1 @@
1
- {"version":3,"file":"addSessionNote.js","sourceRoot":"","sources":["../../../src/sessions/addSessionNote.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAEnE,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAuBrE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,EACnC,MAAM,EAAE,OAAO,EACf,WAAW,GACU;IACrB,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,sBAAsB,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAAC,CAAC;IAExE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE;QAC7D,IAAI,EAAE;YACJ,IAAI,EAAE;gBACJ,UAAU,EAAE,WAAW,CAAC,SAAS,CAAC,IAAI,EAAE;gBACxC,IAAI,EAAE,WAAW,CAAC,IAAI;aACvB;SACF;KACF,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,+BAA+B,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,IAAI,CAAC,IAAI,CAAC;AACnB,CAAC"}
1
+ {"version":3,"file":"addSessionNote.js","sourceRoot":"","sources":["../../../src/sessions/addSessionNote.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EACL,gBAAgB,EAChB,2BAA2B,GAC5B,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AA8BrE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,EACnC,MAAM,EAAE,OAAO,EACf,WAAW,GACU;IACrB,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,sBAAsB,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAAC,CAAC;IACxE,IAAI,WAAW,CAAC,UAAU,EAAE,CAAC;QAC3B,MAAM,sBAAsB,CAAC;YAC3B,MAAM;YACN,WAAW,EAAE,2BAA2B;SACzC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE;QAC7D,IAAI,EAAE;YACJ,IAAI,EAAE;gBACJ,UAAU,EAAE,WAAW,CAAC,SAAS,CAAC,IAAI,EAAE;gBACxC,IAAI,EAAE,WAAW,CAAC,IAAI;gBACtB,UAAU,EAAE,WAAW,CAAC,UAAU;aACnC;SACF;KACF,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,+BAA+B,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,IAAI,CAAC,IAAI,CAAC;AACnB,CAAC"}
@@ -11,6 +11,13 @@ export interface SpanNote {
11
11
  * The note text to add to the span
12
12
  */
13
13
  note: string;
14
+ /**
15
+ * Optional caller-supplied identifier. When non-empty, the note is upserted
16
+ * on `(spanId, name='note', identifier)` — repeated calls with the same
17
+ * identifier overwrite the existing note. When omitted, the server stamps a
18
+ * unique `px-span-note:<uuid>` identifier so each call appends a new note.
19
+ */
20
+ identifier?: string;
14
21
  }
15
22
  /**
16
23
  * Parameters to add a span note
@@ -21,11 +28,10 @@ export interface AddSpanNoteParams extends ClientFn {
21
28
  /**
22
29
  * Add a note to a span.
23
30
  *
24
- * Notes are append-only: each call creates a new note with an auto-generated
25
- * UUIDv4 identifier, so multiple notes accumulate on the same span. Structured
26
- * annotations, by contrast, are keyed by `(name, spanId, identifier)` — to keep
27
- * multiple structured annotations with the same name on a span, supply distinct
28
- * identifiers; otherwise re-writing the same name overwrites the existing one.
31
+ * When `spanNote.identifier` is omitted, each call appends a new note with an
32
+ * auto-generated identifier. When `identifier` is non-empty, repeated calls
33
+ * with the same `(spanId, name='note', identifier)` overwrite the existing
34
+ * note.
29
35
  *
30
36
  * @param params - The parameters to add a span note
31
37
  * @returns The ID of the created note annotation
@@ -1 +1 @@
1
- {"version":3,"file":"addSpanNote.d.ts","sourceRoot":"","sources":["../../../src/spans/addSpanNote.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAG9C;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,QAAQ;IACjD,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAsB,WAAW,CAAC,EAChC,MAAM,EAAE,OAAO,EACf,QAAQ,GACT,EAAE,iBAAiB,GAAG,OAAO,CAAC;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC,CAqB7C"}
1
+ {"version":3,"file":"addSpanNote.d.ts","sourceRoot":"","sources":["../../../src/spans/addSpanNote.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAI9C;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,QAAQ;IACjD,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,WAAW,CAAC,EAChC,MAAM,EAAE,OAAO,EACf,QAAQ,GACT,EAAE,iBAAiB,GAAG,OAAO,CAAC;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC,CA4B7C"}
@@ -1,13 +1,14 @@
1
1
  import { createClient } from "../client.js";
2
+ import { ADD_SPAN_NOTE_IDENTIFIER } from "../constants/serverRequirements.js";
2
3
  import { formatApiError } from "../utils/apiErrorUtils.js";
4
+ import { ensureServerCapability } from "../utils/serverVersionUtils.js";
3
5
  /**
4
6
  * Add a note to a span.
5
7
  *
6
- * Notes are append-only: each call creates a new note with an auto-generated
7
- * UUIDv4 identifier, so multiple notes accumulate on the same span. Structured
8
- * annotations, by contrast, are keyed by `(name, spanId, identifier)` — to keep
9
- * multiple structured annotations with the same name on a span, supply distinct
10
- * identifiers; otherwise re-writing the same name overwrites the existing one.
8
+ * When `spanNote.identifier` is omitted, each call appends a new note with an
9
+ * auto-generated identifier. When `identifier` is non-empty, repeated calls
10
+ * with the same `(spanId, name='note', identifier)` overwrite the existing
11
+ * note.
11
12
  *
12
13
  * @param params - The parameters to add a span note
13
14
  * @returns The ID of the created note annotation
@@ -24,11 +25,18 @@ import { formatApiError } from "../utils/apiErrorUtils.js";
24
25
  */
25
26
  export async function addSpanNote({ client: _client, spanNote, }) {
26
27
  const client = _client ?? createClient();
28
+ if (spanNote.identifier) {
29
+ await ensureServerCapability({
30
+ client,
31
+ requirement: ADD_SPAN_NOTE_IDENTIFIER,
32
+ });
33
+ }
27
34
  const { data, error } = await client.POST("/v1/span_notes", {
28
35
  body: {
29
36
  data: {
30
37
  span_id: spanNote.spanId.trim(),
31
38
  note: spanNote.note,
39
+ identifier: spanNote.identifier,
32
40
  },
33
41
  },
34
42
  });
@@ -1 +1 @@
1
- {"version":3,"file":"addSpanNote.js","sourceRoot":"","sources":["../../../src/spans/addSpanNote.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAuBxD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,EAChC,MAAM,EAAE,OAAO,EACf,QAAQ,GACU;IAClB,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IAEzC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE;QAC1D,IAAI,EAAE;YACJ,IAAI,EAAE;gBACJ,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE;gBAC/B,IAAI,EAAE,QAAQ,CAAC,IAAI;aACpB;SACF;KACF,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,4BAA4B,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACvE,CAAC;IAED,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;IAC/D,CAAC;IAED,OAAO,IAAI,CAAC,IAAI,CAAC;AACnB,CAAC"}
1
+ {"version":3,"file":"addSpanNote.js","sourceRoot":"","sources":["../../../src/spans/addSpanNote.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAC;AAE3E,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AA8BrE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,EAChC,MAAM,EAAE,OAAO,EACf,QAAQ,GACU;IAClB,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC;QACxB,MAAM,sBAAsB,CAAC;YAC3B,MAAM;YACN,WAAW,EAAE,wBAAwB;SACtC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE;QAC1D,IAAI,EAAE;YACJ,IAAI,EAAE;gBACJ,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE;gBAC/B,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,UAAU,EAAE,QAAQ,CAAC,UAAU;aAChC;SACF;KACF,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,4BAA4B,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACvE,CAAC;IAED,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;IAC/D,CAAC;IAED,OAAO,IAAI,CAAC,IAAI,CAAC;AACnB,CAAC"}
@@ -9,7 +9,7 @@ export interface GetSpanAnnotationsParams extends ClientFn {
9
9
  project: ProjectIdentifier;
10
10
  /** One or more span IDs to fetch annotations for */
11
11
  spanIds: string[];
12
- /** 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. */
12
+ /** 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). */
13
13
  includeAnnotationNames?: string[];
14
14
  /** Optional list of annotation names to exclude from results. */
15
15
  excludeAnnotationNames?: string[];
@@ -1 +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"}
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,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"}
@@ -11,6 +11,13 @@ export interface TraceNote {
11
11
  * The note text to add to the trace.
12
12
  */
13
13
  note: string;
14
+ /**
15
+ * Optional caller-supplied identifier. When non-empty, the note is upserted
16
+ * on `(traceId, name='note', identifier)` — repeated calls with the same
17
+ * identifier overwrite the existing note. When omitted, the server stamps a
18
+ * unique `px-trace-note:<uuid>` identifier so each call appends a new note.
19
+ */
20
+ identifier?: string;
14
21
  }
15
22
  /**
16
23
  * Parameters to add a trace note.
@@ -21,11 +28,10 @@ export interface AddTraceNoteParams extends ClientFn {
21
28
  /**
22
29
  * Add a note to a trace.
23
30
  *
24
- * Notes are append-only: each call creates a new note with an auto-generated
25
- * UUIDv4 identifier, so multiple notes accumulate on the same trace. Structured
26
- * annotations, by contrast, are keyed by `(name, traceId, identifier)` — to keep
27
- * multiple structured annotations with the same name on a trace, supply distinct
28
- * identifiers; otherwise re-writing the same name overwrites the existing one.
31
+ * When `traceNote.identifier` is omitted, each call appends a new note with an
32
+ * auto-generated identifier. When `identifier` is non-empty, repeated calls
33
+ * with the same `(traceId, name='note', identifier)` overwrite the existing
34
+ * note.
29
35
  *
30
36
  * @param params - The parameters to add a trace note.
31
37
  * @returns The ID of the created note annotation.
@@ -1 +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"}
1
+ {"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"}
@@ -1,15 +1,14 @@
1
1
  import { createClient } from "../client.js";
2
- import { ADD_TRACE_NOTE } from "../constants/serverRequirements.js";
2
+ import { ADD_TRACE_NOTE, ADD_TRACE_NOTE_IDENTIFIER, } from "../constants/serverRequirements.js";
3
3
  import { formatApiError } from "../utils/apiErrorUtils.js";
4
4
  import { ensureServerCapability } from "../utils/serverVersionUtils.js";
5
5
  /**
6
6
  * Add a note to a trace.
7
7
  *
8
- * Notes are append-only: each call creates a new note with an auto-generated
9
- * UUIDv4 identifier, so multiple notes accumulate on the same trace. Structured
10
- * annotations, by contrast, are keyed by `(name, traceId, identifier)` — to keep
11
- * multiple structured annotations with the same name on a trace, supply distinct
12
- * identifiers; otherwise re-writing the same name overwrites the existing one.
8
+ * When `traceNote.identifier` is omitted, each call appends a new note with an
9
+ * auto-generated identifier. When `identifier` is non-empty, repeated calls
10
+ * with the same `(traceId, name='note', identifier)` overwrite the existing
11
+ * note.
13
12
  *
14
13
  * @param params - The parameters to add a trace note.
15
14
  * @returns The ID of the created note annotation.
@@ -27,11 +26,18 @@ import { ensureServerCapability } from "../utils/serverVersionUtils.js";
27
26
  export async function addTraceNote({ client: _client, traceNote, }) {
28
27
  const client = _client ?? createClient();
29
28
  await ensureServerCapability({ client, requirement: ADD_TRACE_NOTE });
29
+ if (traceNote.identifier) {
30
+ await ensureServerCapability({
31
+ client,
32
+ requirement: ADD_TRACE_NOTE_IDENTIFIER,
33
+ });
34
+ }
30
35
  const { data, error } = await client.POST("/v1/trace_notes", {
31
36
  body: {
32
37
  data: {
33
38
  trace_id: traceNote.traceId.trim(),
34
39
  note: traceNote.note,
40
+ identifier: traceNote.identifier,
35
41
  },
36
42
  },
37
43
  });
@@ -1 +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"}
1
+ {"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"}