@arizeai/phoenix-client 3.0.0 → 3.2.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 (91) hide show
  1. package/README.md +22 -1
  2. package/dist/esm/__generated__/api/v1.d.ts +188 -50
  3. package/dist/esm/__generated__/api/v1.d.ts.map +1 -1
  4. package/dist/esm/experiments/instrumention.d.ts +6 -1
  5. package/dist/esm/experiments/instrumention.d.ts.map +1 -1
  6. package/dist/esm/experiments/instrumention.js +15 -15
  7. package/dist/esm/experiments/instrumention.js.map +1 -1
  8. package/dist/esm/experiments/runExperiment.d.ts +12 -2
  9. package/dist/esm/experiments/runExperiment.d.ts.map +1 -1
  10. package/dist/esm/experiments/runExperiment.js +5 -2
  11. package/dist/esm/experiments/runExperiment.js.map +1 -1
  12. package/dist/esm/schemas/llm/converters.js +4 -4
  13. package/dist/esm/schemas/llm/converters.js.map +1 -1
  14. package/dist/esm/spans/addDocumentAnnotation.d.ts +45 -0
  15. package/dist/esm/spans/addDocumentAnnotation.d.ts.map +1 -0
  16. package/dist/esm/spans/addDocumentAnnotation.js +45 -0
  17. package/dist/esm/spans/addDocumentAnnotation.js.map +1 -0
  18. package/dist/esm/spans/addSpanAnnotation.d.ts +8 -2
  19. package/dist/esm/spans/addSpanAnnotation.d.ts.map +1 -1
  20. package/dist/esm/spans/addSpanAnnotation.js +5 -5
  21. package/dist/esm/spans/addSpanAnnotation.js.map +1 -1
  22. package/dist/esm/spans/index.d.ts +2 -0
  23. package/dist/esm/spans/index.d.ts.map +1 -1
  24. package/dist/esm/spans/index.js +2 -0
  25. package/dist/esm/spans/index.js.map +1 -1
  26. package/dist/esm/spans/logDocumentAnnotations.d.ts +58 -0
  27. package/dist/esm/spans/logDocumentAnnotations.d.ts.map +1 -0
  28. package/dist/esm/spans/logDocumentAnnotations.js +55 -0
  29. package/dist/esm/spans/logDocumentAnnotations.js.map +1 -0
  30. package/dist/esm/spans/logSpanAnnotations.d.ts +7 -1
  31. package/dist/esm/spans/logSpanAnnotations.d.ts.map +1 -1
  32. package/dist/esm/spans/logSpanAnnotations.js +5 -5
  33. package/dist/esm/spans/logSpanAnnotations.js.map +1 -1
  34. package/dist/esm/spans/types.d.ts +48 -0
  35. package/dist/esm/spans/types.d.ts.map +1 -1
  36. package/dist/esm/spans/types.js +41 -8
  37. package/dist/esm/spans/types.js.map +1 -1
  38. package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
  39. package/dist/esm/utils/formatPromptMessages.d.ts.map +1 -1
  40. package/dist/esm/utils/getPromptBySelector.d.ts.map +1 -1
  41. package/dist/src/__generated__/api/v1.d.ts +188 -50
  42. package/dist/src/__generated__/api/v1.d.ts.map +1 -1
  43. package/dist/src/experiments/instrumention.d.ts +6 -1
  44. package/dist/src/experiments/instrumention.d.ts.map +1 -1
  45. package/dist/src/experiments/instrumention.js +13 -13
  46. package/dist/src/experiments/instrumention.js.map +1 -1
  47. package/dist/src/experiments/runExperiment.d.ts +12 -2
  48. package/dist/src/experiments/runExperiment.d.ts.map +1 -1
  49. package/dist/src/experiments/runExperiment.js +5 -2
  50. package/dist/src/experiments/runExperiment.js.map +1 -1
  51. package/dist/src/schemas/llm/converters.js +4 -4
  52. package/dist/src/schemas/llm/converters.js.map +1 -1
  53. package/dist/src/spans/addDocumentAnnotation.d.ts +45 -0
  54. package/dist/src/spans/addDocumentAnnotation.d.ts.map +1 -0
  55. package/dist/src/spans/addDocumentAnnotation.js +49 -0
  56. package/dist/src/spans/addDocumentAnnotation.js.map +1 -0
  57. package/dist/src/spans/addSpanAnnotation.d.ts +8 -2
  58. package/dist/src/spans/addSpanAnnotation.d.ts.map +1 -1
  59. package/dist/src/spans/addSpanAnnotation.js +6 -6
  60. package/dist/src/spans/addSpanAnnotation.js.map +1 -1
  61. package/dist/src/spans/index.d.ts +2 -0
  62. package/dist/src/spans/index.d.ts.map +1 -1
  63. package/dist/src/spans/index.js +2 -0
  64. package/dist/src/spans/index.js.map +1 -1
  65. package/dist/src/spans/logDocumentAnnotations.d.ts +58 -0
  66. package/dist/src/spans/logDocumentAnnotations.d.ts.map +1 -0
  67. package/dist/src/spans/logDocumentAnnotations.js +58 -0
  68. package/dist/src/spans/logDocumentAnnotations.js.map +1 -0
  69. package/dist/src/spans/logSpanAnnotations.d.ts +7 -1
  70. package/dist/src/spans/logSpanAnnotations.d.ts.map +1 -1
  71. package/dist/src/spans/logSpanAnnotations.js +5 -6
  72. package/dist/src/spans/logSpanAnnotations.js.map +1 -1
  73. package/dist/src/spans/types.d.ts +48 -0
  74. package/dist/src/spans/types.d.ts.map +1 -1
  75. package/dist/src/spans/types.js +45 -10
  76. package/dist/src/spans/types.js.map +1 -1
  77. package/dist/src/utils/formatPromptMessages.d.ts.map +1 -1
  78. package/dist/src/utils/getPromptBySelector.d.ts.map +1 -1
  79. package/dist/tsconfig.tsbuildinfo +1 -1
  80. package/package.json +1 -1
  81. package/src/__generated__/api/v1.d.ts +1240 -1238
  82. package/src/__generated__/api/v1.ts +188 -50
  83. package/src/experiments/instrumention.ts +27 -14
  84. package/src/experiments/runExperiment.ts +15 -0
  85. package/src/schemas/llm/converters.ts +4 -4
  86. package/src/spans/addDocumentAnnotation.ts +66 -0
  87. package/src/spans/addSpanAnnotation.ts +12 -6
  88. package/src/spans/index.ts +2 -0
  89. package/src/spans/logDocumentAnnotations.ts +79 -0
  90. package/src/spans/logSpanAnnotations.ts +11 -5
  91. package/src/spans/types.ts +112 -8
@@ -1,18 +1,51 @@
1
+ /**
2
+ * Build and validate annotation result fields
3
+ */
4
+ function buildAnnotationResult(annotation, annotationType) {
5
+ const result = {};
6
+ // Build result with trimming for string fields
7
+ if (annotation.label !== undefined) {
8
+ result.label = annotation.label.trim() || null;
9
+ }
10
+ if (annotation.score !== undefined) {
11
+ result.score = annotation.score;
12
+ }
13
+ if (annotation.explanation !== undefined) {
14
+ result.explanation = annotation.explanation.trim() || null;
15
+ }
16
+ // Validate that at least one result field is provided
17
+ const hasValidResult = result.label || result.score !== undefined || result.explanation;
18
+ if (!hasValidResult) {
19
+ throw new Error(`At least one of label, score, or explanation must be provided for ${annotationType} annotation`);
20
+ }
21
+ return result;
22
+ }
1
23
  /**
2
24
  * Convert a SpanAnnotation to the API format
3
25
  */
4
26
  export function toSpanAnnotationData(annotation) {
27
+ const result = buildAnnotationResult(annotation, "span");
28
+ return {
29
+ span_id: annotation.spanId.trim(),
30
+ name: annotation.name.trim(),
31
+ annotator_kind: annotation.annotatorKind ?? "HUMAN",
32
+ result,
33
+ metadata: annotation.metadata ?? null,
34
+ identifier: annotation.identifier?.trim() ?? "",
35
+ };
36
+ }
37
+ /**
38
+ * Convert a DocumentAnnotation to the API format
39
+ */
40
+ export function toDocumentAnnotationData(annotation) {
41
+ const result = buildAnnotationResult(annotation, "document");
5
42
  return {
6
- span_id: annotation.spanId,
7
- name: annotation.name,
43
+ span_id: annotation.spanId.trim(),
44
+ document_position: annotation.documentPosition,
45
+ name: annotation.name.trim(),
8
46
  annotator_kind: annotation.annotatorKind ?? "HUMAN",
9
- result: {
10
- label: annotation.label ?? null,
11
- score: annotation.score ?? null,
12
- explanation: null,
13
- },
47
+ result,
14
48
  metadata: annotation.metadata ?? null,
15
- identifier: annotation.identifier ?? "",
16
49
  };
17
50
  }
18
51
  //# sourceMappingURL=types.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/spans/types.ts"],"names":[],"mappings":"AAyCA;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAClC,UAA0B;IAE1B,OAAO;QACL,OAAO,EAAE,UAAU,CAAC,MAAM;QAC1B,IAAI,EAAE,UAAU,CAAC,IAAI;QACrB,cAAc,EAAE,UAAU,CAAC,aAAa,IAAI,OAAO;QACnD,MAAM,EAAE;YACN,KAAK,EAAE,UAAU,CAAC,KAAK,IAAI,IAAI;YAC/B,KAAK,EAAE,UAAU,CAAC,KAAK,IAAI,IAAI;YAC/B,WAAW,EAAE,IAAI;SAClB;QACD,QAAQ,EAAE,UAAU,CAAC,QAAQ,IAAI,IAAI;QACrC,UAAU,EAAE,UAAU,CAAC,UAAU,IAAI,EAAE;KACxC,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/spans/types.ts"],"names":[],"mappings":"AA8FA;;GAEG;AACH,SAAS,qBAAqB,CAC5B,UAGC,EACD,cAAmC;IAEnC,MAAM,MAAM,GAAqB,EAAE,CAAC;IAEpC,+CAA+C;IAC/C,IAAI,UAAU,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QACnC,MAAM,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,IAAI,CAAC;IACjD,CAAC;IACD,IAAI,UAAU,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QACnC,MAAM,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;IAClC,CAAC;IACD,IAAI,UAAU,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QACzC,MAAM,CAAC,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,IAAI,CAAC;IAC7D,CAAC;IAED,sDAAsD;IACtD,MAAM,cAAc,GAClB,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,WAAW,CAAC;IACnE,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CACb,qEAAqE,cAAc,aAAa,CACjG,CAAC;IACJ,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAClC,UAA0B;IAE1B,MAAM,MAAM,GAAG,qBAAqB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAEzD,OAAO;QACL,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,IAAI,EAAE;QACjC,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE;QAC5B,cAAc,EAAE,UAAU,CAAC,aAAa,IAAI,OAAO;QACnD,MAAM;QACN,QAAQ,EAAE,UAAU,CAAC,QAAQ,IAAI,IAAI;QACrC,UAAU,EAAE,UAAU,CAAC,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE;KAChD,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CACtC,UAA8B;IAE9B,MAAM,MAAM,GAAG,qBAAqB,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAE7D,OAAO;QACL,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,IAAI,EAAE;QACjC,iBAAiB,EAAE,UAAU,CAAC,gBAAgB;QAC9C,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE;QAC5B,cAAc,EAAE,UAAU,CAAC,aAAa,IAAI,OAAO;QACnD,MAAM;QACN,QAAQ,EAAE,UAAU,CAAC,QAAQ,IAAI,IAAI;KACtC,CAAC;AACJ,CAAC"}