@arizeai/phoenix-client 6.7.0 → 6.8.1

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 (113) hide show
  1. package/dist/esm/__generated__/api/v1.d.ts +377 -6
  2. package/dist/esm/__generated__/api/v1.d.ts.map +1 -1
  3. package/dist/esm/constants/serverRequirements.d.ts +2 -0
  4. package/dist/esm/constants/serverRequirements.d.ts.map +1 -1
  5. package/dist/esm/constants/serverRequirements.js +15 -0
  6. package/dist/esm/constants/serverRequirements.js.map +1 -1
  7. package/dist/esm/datasets/appendDatasetExamples.d.ts +9 -3
  8. package/dist/esm/datasets/appendDatasetExamples.d.ts.map +1 -1
  9. package/dist/esm/datasets/appendDatasetExamples.js +23 -3
  10. package/dist/esm/datasets/appendDatasetExamples.js.map +1 -1
  11. package/dist/esm/datasets/createDataset.d.ts +4 -1
  12. package/dist/esm/datasets/createDataset.d.ts.map +1 -1
  13. package/dist/esm/datasets/createDataset.js +38 -3
  14. package/dist/esm/datasets/createDataset.js.map +1 -1
  15. package/dist/esm/datasets/getDatasetExamples.d.ts.map +1 -1
  16. package/dist/esm/datasets/getDatasetExamples.js +3 -2
  17. package/dist/esm/datasets/getDatasetExamples.js.map +1 -1
  18. package/dist/esm/datasets/index.d.ts +0 -1
  19. package/dist/esm/datasets/index.d.ts.map +1 -1
  20. package/dist/esm/datasets/index.js +0 -1
  21. package/dist/esm/datasets/index.js.map +1 -1
  22. package/dist/esm/experiments/resumeEvaluation.d.ts.map +1 -1
  23. package/dist/esm/experiments/resumeEvaluation.js +2 -1
  24. package/dist/esm/experiments/resumeEvaluation.js.map +1 -1
  25. package/dist/esm/experiments/resumeExperiment.d.ts.map +1 -1
  26. package/dist/esm/experiments/resumeExperiment.js +3 -2
  27. package/dist/esm/experiments/resumeExperiment.js.map +1 -1
  28. package/dist/esm/experiments/runExperiment.js +1 -1
  29. package/dist/esm/experiments/runExperiment.js.map +1 -1
  30. package/dist/esm/spans/addSpanNote.d.ts +1 -1
  31. package/dist/esm/spans/addSpanNote.js +1 -1
  32. package/dist/esm/traces/addTraceNote.d.ts +43 -0
  33. package/dist/esm/traces/addTraceNote.d.ts.map +1 -0
  34. package/dist/esm/traces/addTraceNote.js +42 -0
  35. package/dist/esm/traces/addTraceNote.js.map +1 -0
  36. package/dist/esm/traces/index.d.ts +1 -0
  37. package/dist/esm/traces/index.d.ts.map +1 -1
  38. package/dist/esm/traces/index.js +1 -0
  39. package/dist/esm/traces/index.js.map +1 -1
  40. package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
  41. package/dist/esm/types/datasets.d.ts +10 -1
  42. package/dist/esm/types/datasets.d.ts.map +1 -1
  43. package/dist/esm/utils/formatPromptMessages.d.ts.map +1 -1
  44. package/dist/esm/utils/getPromptBySelector.d.ts.map +1 -1
  45. package/dist/src/__generated__/api/v1.d.ts +377 -6
  46. package/dist/src/__generated__/api/v1.d.ts.map +1 -1
  47. package/dist/src/constants/serverRequirements.d.ts +2 -0
  48. package/dist/src/constants/serverRequirements.d.ts.map +1 -1
  49. package/dist/src/constants/serverRequirements.js +16 -1
  50. package/dist/src/constants/serverRequirements.js.map +1 -1
  51. package/dist/src/datasets/appendDatasetExamples.d.ts +9 -3
  52. package/dist/src/datasets/appendDatasetExamples.d.ts.map +1 -1
  53. package/dist/src/datasets/appendDatasetExamples.js +24 -5
  54. package/dist/src/datasets/appendDatasetExamples.js.map +1 -1
  55. package/dist/src/datasets/createDataset.d.ts +4 -1
  56. package/dist/src/datasets/createDataset.d.ts.map +1 -1
  57. package/dist/src/datasets/createDataset.js +42 -5
  58. package/dist/src/datasets/createDataset.js.map +1 -1
  59. package/dist/src/datasets/getDatasetExamples.d.ts.map +1 -1
  60. package/dist/src/datasets/getDatasetExamples.js +15 -1
  61. package/dist/src/datasets/getDatasetExamples.js.map +1 -1
  62. package/dist/src/datasets/index.d.ts +0 -1
  63. package/dist/src/datasets/index.d.ts.map +1 -1
  64. package/dist/src/datasets/index.js +0 -1
  65. package/dist/src/datasets/index.js.map +1 -1
  66. package/dist/src/experiments/resumeEvaluation.d.ts.map +1 -1
  67. package/dist/src/experiments/resumeEvaluation.js +2 -1
  68. package/dist/src/experiments/resumeEvaluation.js.map +1 -1
  69. package/dist/src/experiments/resumeExperiment.d.ts.map +1 -1
  70. package/dist/src/experiments/resumeExperiment.js +3 -2
  71. package/dist/src/experiments/resumeExperiment.js.map +1 -1
  72. package/dist/src/experiments/runExperiment.js +1 -1
  73. package/dist/src/experiments/runExperiment.js.map +1 -1
  74. package/dist/src/spans/addSpanNote.d.ts +1 -1
  75. package/dist/src/spans/addSpanNote.js +1 -1
  76. package/dist/src/traces/addTraceNote.d.ts +43 -0
  77. package/dist/src/traces/addTraceNote.d.ts.map +1 -0
  78. package/dist/src/traces/addTraceNote.js +45 -0
  79. package/dist/src/traces/addTraceNote.js.map +1 -0
  80. package/dist/src/traces/index.d.ts +1 -0
  81. package/dist/src/traces/index.d.ts.map +1 -1
  82. package/dist/src/traces/index.js +1 -0
  83. package/dist/src/traces/index.js.map +1 -1
  84. package/dist/src/types/datasets.d.ts +10 -1
  85. package/dist/src/types/datasets.d.ts.map +1 -1
  86. package/dist/src/utils/formatPromptMessages.d.ts.map +1 -1
  87. package/dist/src/utils/getPromptBySelector.d.ts.map +1 -1
  88. package/dist/tsconfig.tsbuildinfo +1 -1
  89. package/docs/span-annotations.mdx +1 -1
  90. package/docs/spans.mdx +34 -1
  91. package/package.json +1 -1
  92. package/src/__generated__/api/v1.ts +377 -6
  93. package/src/constants/serverRequirements.ts +17 -0
  94. package/src/datasets/appendDatasetExamples.ts +26 -5
  95. package/src/datasets/createDataset.ts +66 -18
  96. package/src/datasets/getDatasetExamples.ts +7 -4
  97. package/src/datasets/index.ts +0 -1
  98. package/src/experiments/resumeEvaluation.ts +2 -1
  99. package/src/experiments/resumeExperiment.ts +3 -2
  100. package/src/experiments/runExperiment.ts +1 -1
  101. package/src/spans/addSpanNote.ts +1 -1
  102. package/src/traces/addTraceNote.ts +71 -0
  103. package/src/traces/index.ts +1 -0
  104. package/src/types/datasets.ts +10 -1
  105. package/dist/esm/datasets/createOrGetDataset.d.ts +0 -18
  106. package/dist/esm/datasets/createOrGetDataset.d.ts.map +0 -1
  107. package/dist/esm/datasets/createOrGetDataset.js +0 -29
  108. package/dist/esm/datasets/createOrGetDataset.js.map +0 -1
  109. package/dist/src/datasets/createOrGetDataset.d.ts +0 -18
  110. package/dist/src/datasets/createOrGetDataset.d.ts.map +0 -1
  111. package/dist/src/datasets/createOrGetDataset.js +0 -32
  112. package/dist/src/datasets/createOrGetDataset.js.map +0 -1
  113. package/src/datasets/createOrGetDataset.ts +0 -40
@@ -226,7 +226,7 @@ do {
226
226
 
227
227
  ## Span Notes
228
228
 
229
- `addSpanNote` attaches a free-text comment to a span. Unlike structured annotations (which are keyed by `name` + `identifier`), notes are append-only — each call creates a new note with a unique timestamp-based identifier, so multiple notes naturally accumulate on the same span.
229
+ `addSpanNote` attaches a free-text comment to a span. Unlike structured annotations (which are keyed by `name` + `identifier`), notes are append-only — each call creates a new note with a unique UUIDv4 identifier, so multiple notes naturally accumulate on the same span.
230
230
 
231
231
  This makes notes a good mechanism for **open coding**: reviewers can leave qualitative observations on spans during exploratory analysis without needing to define annotation names or scoring rubrics up front. The accumulated notes can later inform what structured annotations to create.
232
232
 
package/docs/spans.mdx CHANGED
@@ -32,6 +32,29 @@ for (const span of result.spans) {
32
32
  }
33
33
  ```
34
34
 
35
+ ### Filtering by Attributes
36
+
37
+ Use the `attributes` parameter to filter spans by OpenInference attribute key-value pairs. Multiple entries are ANDed together. The JS type of the value determines how the stored attribute is matched: a `number` matches a stored integer or float, a `boolean` matches a stored boolean, and a `string` matches a stored string.
38
+
39
+ ```ts
40
+ // Spans from a specific model
41
+ const result = await getSpans({
42
+ project: { projectName: "support-bot" },
43
+ attributes: { "llm.model_name": "gpt-4o" },
44
+ });
45
+
46
+ // Spans for a session and a specific user (AND semantics)
47
+ const result = await getSpans({
48
+ project: { projectName: "support-bot" },
49
+ attributes: {
50
+ "session.id": "sess-abc123",
51
+ "user.id": "user-42",
52
+ },
53
+ });
54
+ ```
55
+
56
+ Non-finite number values (`Infinity`, `NaN`) throw a `RangeError`. Requires Phoenix server ≥ 14.9.0.
57
+
35
58
  ## Root Span Queries
36
59
 
37
60
  Use `parentId: null` to limit results to root spans only.
@@ -45,8 +68,12 @@ const rootSpans = await getSpans({
45
68
 
46
69
  ## Span Maintenance
47
70
 
71
+ ### Adding Notes
72
+
73
+ Use `addSpanNote` to attach a free-text note to a span. Multiple notes can be added to the same span — they are independent entries, each with its own timestamp.
74
+
48
75
  ```ts
49
- import { addSpanNote, deleteSpan } from "@arizeai/phoenix-client/spans";
76
+ import { addSpanNote } from "@arizeai/phoenix-client/spans";
50
77
 
51
78
  await addSpanNote({
52
79
  spanNote: {
@@ -54,6 +81,12 @@ await addSpanNote({
54
81
  note: "Escalated due to failed retrieval",
55
82
  },
56
83
  });
84
+ ```
85
+
86
+ ### Deleting Spans
87
+
88
+ ```ts
89
+ import { deleteSpan } from "@arizeai/phoenix-client/spans";
57
90
 
58
91
  await deleteSpan({
59
92
  spanIdentifier: "abc123def456",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@arizeai/phoenix-client",
3
- "version": "6.7.0",
3
+ "version": "6.8.1",
4
4
  "description": "A client for the Phoenix API",
5
5
  "keywords": [
6
6
  "arize",