@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.
- package/dist/esm/__generated__/api/v1.d.ts +377 -6
- package/dist/esm/__generated__/api/v1.d.ts.map +1 -1
- package/dist/esm/constants/serverRequirements.d.ts +2 -0
- package/dist/esm/constants/serverRequirements.d.ts.map +1 -1
- package/dist/esm/constants/serverRequirements.js +15 -0
- package/dist/esm/constants/serverRequirements.js.map +1 -1
- package/dist/esm/datasets/appendDatasetExamples.d.ts +9 -3
- package/dist/esm/datasets/appendDatasetExamples.d.ts.map +1 -1
- package/dist/esm/datasets/appendDatasetExamples.js +23 -3
- package/dist/esm/datasets/appendDatasetExamples.js.map +1 -1
- package/dist/esm/datasets/createDataset.d.ts +4 -1
- package/dist/esm/datasets/createDataset.d.ts.map +1 -1
- package/dist/esm/datasets/createDataset.js +38 -3
- package/dist/esm/datasets/createDataset.js.map +1 -1
- package/dist/esm/datasets/getDatasetExamples.d.ts.map +1 -1
- package/dist/esm/datasets/getDatasetExamples.js +3 -2
- package/dist/esm/datasets/getDatasetExamples.js.map +1 -1
- package/dist/esm/datasets/index.d.ts +0 -1
- package/dist/esm/datasets/index.d.ts.map +1 -1
- package/dist/esm/datasets/index.js +0 -1
- package/dist/esm/datasets/index.js.map +1 -1
- package/dist/esm/experiments/resumeEvaluation.d.ts.map +1 -1
- package/dist/esm/experiments/resumeEvaluation.js +2 -1
- package/dist/esm/experiments/resumeEvaluation.js.map +1 -1
- package/dist/esm/experiments/resumeExperiment.d.ts.map +1 -1
- package/dist/esm/experiments/resumeExperiment.js +3 -2
- package/dist/esm/experiments/resumeExperiment.js.map +1 -1
- package/dist/esm/experiments/runExperiment.js +1 -1
- package/dist/esm/experiments/runExperiment.js.map +1 -1
- package/dist/esm/spans/addSpanNote.d.ts +1 -1
- package/dist/esm/spans/addSpanNote.js +1 -1
- package/dist/esm/traces/addTraceNote.d.ts +43 -0
- package/dist/esm/traces/addTraceNote.d.ts.map +1 -0
- package/dist/esm/traces/addTraceNote.js +42 -0
- package/dist/esm/traces/addTraceNote.js.map +1 -0
- package/dist/esm/traces/index.d.ts +1 -0
- package/dist/esm/traces/index.d.ts.map +1 -1
- package/dist/esm/traces/index.js +1 -0
- package/dist/esm/traces/index.js.map +1 -1
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/esm/types/datasets.d.ts +10 -1
- package/dist/esm/types/datasets.d.ts.map +1 -1
- package/dist/esm/utils/formatPromptMessages.d.ts.map +1 -1
- package/dist/esm/utils/getPromptBySelector.d.ts.map +1 -1
- package/dist/src/__generated__/api/v1.d.ts +377 -6
- package/dist/src/__generated__/api/v1.d.ts.map +1 -1
- package/dist/src/constants/serverRequirements.d.ts +2 -0
- package/dist/src/constants/serverRequirements.d.ts.map +1 -1
- package/dist/src/constants/serverRequirements.js +16 -1
- package/dist/src/constants/serverRequirements.js.map +1 -1
- package/dist/src/datasets/appendDatasetExamples.d.ts +9 -3
- package/dist/src/datasets/appendDatasetExamples.d.ts.map +1 -1
- package/dist/src/datasets/appendDatasetExamples.js +24 -5
- package/dist/src/datasets/appendDatasetExamples.js.map +1 -1
- package/dist/src/datasets/createDataset.d.ts +4 -1
- package/dist/src/datasets/createDataset.d.ts.map +1 -1
- package/dist/src/datasets/createDataset.js +42 -5
- package/dist/src/datasets/createDataset.js.map +1 -1
- package/dist/src/datasets/getDatasetExamples.d.ts.map +1 -1
- package/dist/src/datasets/getDatasetExamples.js +15 -1
- package/dist/src/datasets/getDatasetExamples.js.map +1 -1
- package/dist/src/datasets/index.d.ts +0 -1
- package/dist/src/datasets/index.d.ts.map +1 -1
- package/dist/src/datasets/index.js +0 -1
- package/dist/src/datasets/index.js.map +1 -1
- package/dist/src/experiments/resumeEvaluation.d.ts.map +1 -1
- package/dist/src/experiments/resumeEvaluation.js +2 -1
- package/dist/src/experiments/resumeEvaluation.js.map +1 -1
- package/dist/src/experiments/resumeExperiment.d.ts.map +1 -1
- package/dist/src/experiments/resumeExperiment.js +3 -2
- package/dist/src/experiments/resumeExperiment.js.map +1 -1
- package/dist/src/experiments/runExperiment.js +1 -1
- package/dist/src/experiments/runExperiment.js.map +1 -1
- package/dist/src/spans/addSpanNote.d.ts +1 -1
- package/dist/src/spans/addSpanNote.js +1 -1
- package/dist/src/traces/addTraceNote.d.ts +43 -0
- package/dist/src/traces/addTraceNote.d.ts.map +1 -0
- package/dist/src/traces/addTraceNote.js +45 -0
- package/dist/src/traces/addTraceNote.js.map +1 -0
- package/dist/src/traces/index.d.ts +1 -0
- package/dist/src/traces/index.d.ts.map +1 -1
- package/dist/src/traces/index.js +1 -0
- package/dist/src/traces/index.js.map +1 -1
- package/dist/src/types/datasets.d.ts +10 -1
- package/dist/src/types/datasets.d.ts.map +1 -1
- package/dist/src/utils/formatPromptMessages.d.ts.map +1 -1
- package/dist/src/utils/getPromptBySelector.d.ts.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/docs/span-annotations.mdx +1 -1
- package/docs/spans.mdx +34 -1
- package/package.json +1 -1
- package/src/__generated__/api/v1.ts +377 -6
- package/src/constants/serverRequirements.ts +17 -0
- package/src/datasets/appendDatasetExamples.ts +26 -5
- package/src/datasets/createDataset.ts +66 -18
- package/src/datasets/getDatasetExamples.ts +7 -4
- package/src/datasets/index.ts +0 -1
- package/src/experiments/resumeEvaluation.ts +2 -1
- package/src/experiments/resumeExperiment.ts +3 -2
- package/src/experiments/runExperiment.ts +1 -1
- package/src/spans/addSpanNote.ts +1 -1
- package/src/traces/addTraceNote.ts +71 -0
- package/src/traces/index.ts +1 -0
- package/src/types/datasets.ts +10 -1
- package/dist/esm/datasets/createOrGetDataset.d.ts +0 -18
- package/dist/esm/datasets/createOrGetDataset.d.ts.map +0 -1
- package/dist/esm/datasets/createOrGetDataset.js +0 -29
- package/dist/esm/datasets/createOrGetDataset.js.map +0 -1
- package/dist/src/datasets/createOrGetDataset.d.ts +0 -18
- package/dist/src/datasets/createOrGetDataset.d.ts.map +0 -1
- package/dist/src/datasets/createOrGetDataset.js +0 -32
- package/dist/src/datasets/createOrGetDataset.js.map +0 -1
- 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
|
|
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
|
|
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",
|