@arizeai/phoenix-client 7.5.0 → 7.6.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 (60) hide show
  1. package/CHANGELOG.md +769 -0
  2. package/dist/esm/__generated__/api/v1.d.ts +748 -202
  3. package/dist/esm/__generated__/api/v1.d.ts.map +1 -1
  4. package/dist/esm/constants/serverRequirements.d.ts +1 -0
  5. package/dist/esm/constants/serverRequirements.d.ts.map +1 -1
  6. package/dist/esm/constants/serverRequirements.js +7 -0
  7. package/dist/esm/constants/serverRequirements.js.map +1 -1
  8. package/dist/esm/prompts/deletePrompt.d.ts +39 -0
  9. package/dist/esm/prompts/deletePrompt.d.ts.map +1 -0
  10. package/dist/esm/prompts/deletePrompt.js +52 -0
  11. package/dist/esm/prompts/deletePrompt.js.map +1 -0
  12. package/dist/esm/prompts/index.d.ts +1 -0
  13. package/dist/esm/prompts/index.d.ts.map +1 -1
  14. package/dist/esm/prompts/index.js +1 -0
  15. package/dist/esm/prompts/index.js.map +1 -1
  16. package/dist/esm/testing/reporter-format.d.ts.map +1 -1
  17. package/dist/esm/testing/reporter-format.js +13 -3
  18. package/dist/esm/testing/reporter-format.js.map +1 -1
  19. package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
  20. package/dist/esm/types/prompts.d.ts +9 -0
  21. package/dist/esm/types/prompts.d.ts.map +1 -1
  22. package/dist/esm/types/prompts.js.map +1 -1
  23. package/dist/esm/utils/resolvePromptIdentifier.d.ts +17 -0
  24. package/dist/esm/utils/resolvePromptIdentifier.d.ts.map +1 -0
  25. package/dist/esm/utils/resolvePromptIdentifier.js +36 -0
  26. package/dist/esm/utils/resolvePromptIdentifier.js.map +1 -0
  27. package/dist/src/__generated__/api/v1.d.ts +748 -202
  28. package/dist/src/__generated__/api/v1.d.ts.map +1 -1
  29. package/dist/src/constants/serverRequirements.d.ts +1 -0
  30. package/dist/src/constants/serverRequirements.d.ts.map +1 -1
  31. package/dist/src/constants/serverRequirements.js +8 -1
  32. package/dist/src/constants/serverRequirements.js.map +1 -1
  33. package/dist/src/prompts/deletePrompt.d.ts +39 -0
  34. package/dist/src/prompts/deletePrompt.d.ts.map +1 -0
  35. package/dist/src/prompts/deletePrompt.js +55 -0
  36. package/dist/src/prompts/deletePrompt.js.map +1 -0
  37. package/dist/src/prompts/index.d.ts +1 -0
  38. package/dist/src/prompts/index.d.ts.map +1 -1
  39. package/dist/src/prompts/index.js +1 -0
  40. package/dist/src/prompts/index.js.map +1 -1
  41. package/dist/src/testing/reporter-format.d.ts.map +1 -1
  42. package/dist/src/testing/reporter-format.js +13 -3
  43. package/dist/src/testing/reporter-format.js.map +1 -1
  44. package/dist/src/types/prompts.d.ts +9 -0
  45. package/dist/src/types/prompts.d.ts.map +1 -1
  46. package/dist/src/types/prompts.js.map +1 -1
  47. package/dist/src/utils/resolvePromptIdentifier.d.ts +17 -0
  48. package/dist/src/utils/resolvePromptIdentifier.d.ts.map +1 -0
  49. package/dist/src/utils/resolvePromptIdentifier.js +39 -0
  50. package/dist/src/utils/resolvePromptIdentifier.js.map +1 -0
  51. package/dist/tsconfig.tsbuildinfo +1 -1
  52. package/docs/prompts.mdx +19 -1
  53. package/package.json +11 -11
  54. package/src/__generated__/api/v1.ts +748 -202
  55. package/src/constants/serverRequirements.ts +8 -0
  56. package/src/prompts/deletePrompt.ts +70 -0
  57. package/src/prompts/index.ts +1 -0
  58. package/src/testing/reporter-format.ts +13 -3
  59. package/src/types/prompts.ts +10 -0
  60. package/src/utils/resolvePromptIdentifier.ts +41 -0
package/CHANGELOG.md ADDED
@@ -0,0 +1,769 @@
1
+ # @arizeai/phoenix-client
2
+
3
+ ## 7.6.0
4
+
5
+ ### Minor Changes
6
+
7
+ - d328c3e: Add a `deletePrompt` helper to the `prompts` subpath. It takes a `prompt` selector — `{ name }` or `{ promptId }` — matching the selector style `getPrompt` already uses, and calls `DELETE /v1/prompts/{prompt_identifier}` (Phoenix server >= 13.20.0). Version-level selectors (`{ versionId }`, `{ name, tag }`) are rejected rather than widened to the whole prompt. Deletion cascades to every version of the prompt along with its version tags and labels.
8
+
9
+ Also exports a `PromptIdentifier` type from `types/prompts` for the prompt-level selector union.
10
+
11
+ ## 7.5.0
12
+
13
+ ### Minor Changes
14
+
15
+ - 0ed987a: Re-enable the PXI agent-session server version guard. PXI now fails fast at startup with a clear upgrade message when the connected Phoenix server predates the agent-session chat contract (server < 20.0.0), instead of 404ing on the first send. phoenix-client adds capability requirements for the remaining agent-session routes (list, get, patch, compact, tool outputs), exports all agent-session requirements from the package root, and routes `getServerVersion` through the client's configured fetch.
16
+
17
+ ## 7.4.0
18
+
19
+ ### Minor Changes
20
+
21
+ - 90729f3: Add `updatePrompt` for `PATCH /v1/prompts/{prompt_identifier}` (description and metadata; requires Phoenix server >= 19.18.0).
22
+
23
+ ## 7.3.1
24
+
25
+ ### Patch Changes
26
+
27
+ - c892873: Add generated types for the experiment tag REST routes (`GET`/`POST /v1/experiments/{experiment_id}/tags` and `DELETE /v1/experiments/{experiment_id}/tags/{tag_identifier}`)
28
+
29
+ ## 7.3.0
30
+
31
+ ### Minor Changes
32
+
33
+ - d04f0fc: Introduce `PHOENIX_ENDPOINT` as the canonical base URL for API access, alongside `PHOENIX_COLLECTOR_ENDPOINT` for trace export.
34
+
35
+ Previously the TypeScript client read only `PHOENIX_HOST`, so pointing `PHOENIX_COLLECTOR_ENDPOINT` at a remote Phoenix and then reading spans back silently targeted `http://localhost:6006`. The client's base URL now resolves `PHOENIX_ENDPOINT` first, then the trace-export variables `PHOENIX_COLLECTOR_ENDPOINT` and `OTEL_EXPORTER_OTLP_ENDPOINT` (any `/v1/traces` path is stripped), then the legacy `PHOENIX_HOST` — matching the Python client rung for rung, so the same environment reaches the same server from either language.
36
+
37
+ `PHOENIX_BASE_URL` is honored below the trace-export variables as an undocumented compatibility fallback. The client docs advertised that name for years while no code read it, so values set from those docs did nothing; placing it below the other variables means those configurations start working without retargeting anyone who set both. It is also no longer enough on its own to displace a discovered `.env.phoenix`, so a stale value left in a shell cannot redirect a project that `px setup` configured.
38
+
39
+ Empty and whitespace-only values now count as unset everywhere in the resolution chains, so `export PHOENIX_ENDPOINT=` falls through to the next variable instead of stranding every consumer on localhost.
40
+
41
+ Experiment and test-suite tracing follow the same rules as `register()`: a client created with an explicit `baseUrl` exports its spans to that server, and a client whose base URL came from the environment lets the trace-export variables decide. An unparseable endpoint in a discovered `.env.phoenix` now falls back with a warning instead of aborting the run, and the cross-tier credential warning fires on this path too.
42
+
43
+ `@arizeai/phoenix-config` gains `ENV_PHOENIX_ENDPOINT`, `ENV_OTEL_EXPORTER_OTLP_ENDPOINT`, `ENV_OTEL_EXPORTER_OTLP_TRACES_ENDPOINT`, `getBaseUrlFromEnvironment[WithSource]()`, `getBaseUrlFromValues()` (same precedence over an injected env record), `getTraceExportEndpointFromEnvironment()`, and `PHOENIX_CONNECTION_ENV_KEYS` (for test env hygiene).
44
+
45
+ ### Patch Changes
46
+
47
+ - Updated dependencies [d04f0fc]
48
+ - Updated dependencies [5420522]
49
+ - @arizeai/phoenix-config@0.5.0
50
+ - @arizeai/phoenix-otel@2.2.0
51
+
52
+ ## 7.2.0
53
+
54
+ ### Minor Changes
55
+
56
+ - 59aa7cb: Add a `getProjects` helper to the new `@arizeai/phoenix-client/projects` entry point. It lists projects with automatic cursor pagination and accepts an optional `nameContains` filter, which maps to the `name_contains` query parameter on `GET /v1/projects` (case-insensitive substring match, requires Phoenix server >= 17.16.0).
57
+
58
+ ## 7.1.1
59
+
60
+ ### Patch Changes
61
+
62
+ - e35712a: Re-release to recover from a failed publish (versions were already on npm)
63
+
64
+ ## 7.1.0
65
+
66
+ ### Minor Changes
67
+
68
+ - df7057a: Add `spanIds` filter to `getSpans`, allowing spans to be fetched by span ID (requires Phoenix server >= 19.6.0)
69
+
70
+ ## 7.0.1
71
+
72
+ ### Patch Changes
73
+
74
+ - a6c3f88: Fix `resumeExperiment` and `resumeEvaluation` leaking detached workers on the first error. Both used `Promise.all([producer, ...workers])`, which rejects the instant one worker throws (e.g. under `stopOnFirstError`) while the remaining concurrent workers and the producer keep running — hitting the API and logging after the function has already returned or thrown. They now drain every task with `Promise.allSettled` and classify rejections by priority, so no background work outlives the call. This also fixes intermittent CI teardown errors (`Closing rpc while "onUserConsoleLog" was pending`) caused by that late console output.
75
+
76
+ ## 7.0.0
77
+
78
+ ### Major Changes
79
+
80
+ - 4867e34: Require AI SDK v7 for `@arizeai/phoenix-client`. The optional `ai` peer dependency now requires v7 (`^7.0.0`, previously `^6.0.90`). AI SDK v7 no longer emits OpenTelemetry spans through the global tracer provider on its own — to trace AI SDK calls made inside experiment tasks, pass the `@ai-sdk/otel` integration per call, constructed inside the task: `generateText({ ..., telemetry: { integrations: [new OpenTelemetry()] } })` (see `examples/run_experiment_with_ai_sdk.ts`). Phoenix evaluators from `@arizeai/phoenix-evals` are traced automatically and need no setup. Core client APIs retain Node.js 18 compatibility; AI SDK v7-backed features require the Node.js version supported by AI SDK v7. Type-checking the published declarations now requires TypeScript >= 5.3: the `.d.ts` files for the prompts entry use `with { "resolution-mode": "import" }` import attributes, which older TypeScript versions cannot parse (and `skipLibCheck` does not suppress).
81
+
82
+ ## 6.14.2
83
+
84
+ ### Patch Changes
85
+
86
+ - Updated dependencies [dc451a6]
87
+ - @arizeai/phoenix-otel@2.1.0
88
+
89
+ ## 6.14.1
90
+
91
+ ### Patch Changes
92
+
93
+ - Updated dependencies [30f0827]
94
+ - @arizeai/phoenix-otel@2.0.0
95
+
96
+ ## 6.14.0
97
+
98
+ ### Minor Changes
99
+
100
+ - d6b1cbb: Add a reusable refreshable-credential fetch wrapper to the Phoenix TypeScript
101
+ client, use it for OAuth-authenticated CLI API and PXI requests, and keep each
102
+ profile bound to the endpoint that issued its OAuth tokens.
103
+
104
+ ## 6.13.0
105
+
106
+ ### Minor Changes
107
+
108
+ - f94067b: Add px setup script for agent onboarding
109
+
110
+ ### Patch Changes
111
+
112
+ - Updated dependencies [f94067b]
113
+ - @arizeai/phoenix-config@0.4.0
114
+ - @arizeai/phoenix-otel@1.2.0
115
+
116
+ ## 6.12.2
117
+
118
+ ### Patch Changes
119
+
120
+ - Updated dependencies [c0ab6a9]
121
+ - @arizeai/phoenix-config@0.3.0
122
+ - @arizeai/phoenix-otel@1.1.1
123
+
124
+ ## 6.12.1
125
+
126
+ ### Patch Changes
127
+
128
+ - Updated dependencies [1e7d9fc]
129
+ - @arizeai/phoenix-config@0.2.0
130
+ - @arizeai/phoenix-otel@1.1.0
131
+
132
+ ## 6.12.0
133
+
134
+ ### Minor Changes
135
+
136
+ - 7947440: Add `logSpans` to `@arizeai/phoenix-client/spans`, mirroring the Python client's `log_spans` API. It submits spans directly to a project using Phoenix's simplified span structure (the same shape returned by `getSpans`), without requiring OpenTelemetry. Throws a new `SpanCreationError` with `invalidSpans`/`duplicateSpans` details if any span in the request is invalid or a duplicate.
137
+
138
+ ## 6.11.2
139
+
140
+ ### Patch Changes
141
+
142
+ - 7afa183: Fix `PHOENIX_TEST_TRACKING=false` not reliably disabling recording in vitest/jest eval suites. The flag is now read robustly (tolerating surrounding quotes and whitespace) and latches off for the whole process the first time it is seen disabled, so one suite can no longer re-enable recording for the others by mutating the environment mid-run. The run and annotation upload paths also honor the flag directly as a safeguard.
143
+
144
+ ## 6.11.1
145
+
146
+ ### Patch Changes
147
+
148
+ - a027ada: Rename the CI eval testing env var `PHOENIX_TEST_TRACING` to `PHOENIX_TEST_TRACKING` so it matches the internal "tracking" terminology (`isTrackingEnabled`, `SuiteState.trackingDisabled`). The behavior is unchanged: set `PHOENIX_TEST_TRACKING=false` to run a suite locally without syncing datasets, experiments, runs, or annotations to Phoenix.
149
+
150
+ **Beta breaking change:** if you adopted the beta testing API in 6.11.0 and set `PHOENIX_TEST_TRACING=false`, update it to `PHOENIX_TEST_TRACKING=false`. The old name is no longer read.
151
+
152
+ ## 6.11.0
153
+
154
+ ### Minor Changes
155
+
156
+ - 7efabf6: **Beta:** Add a vitest/jest-based CI eval testing API to `@arizeai/phoenix-client`. New `./vitest`, `./vitest/reporter`, `./jest`, and `./jest/reporter` entrypoints expose a Phoenix reporter (scoreboard + results table), acceptance-criteria support with an optimization `direction` ("maximize"/"minimize"), and tracing that records runs back to Phoenix. `jest` and `vitest` are added as optional peer dependencies.
157
+
158
+ This API is in beta and may change in a future release.
159
+
160
+ ## 6.10.1
161
+
162
+ ### Patch Changes
163
+
164
+ - 0347f22: Fix `evaluateExperiment` failing to match experiment runs to dataset examples when the dataset was uploaded with custom example ids. Runs now consistently identify examples by node GlobalID in `datasetExampleId` — previously runs created in-process recorded the custom example id while runs fetched from the server recorded the GlobalID — and the evaluation example lookup is keyed by the GlobalID to match. Run recording also falls back to the example `id` field on servers that predate node ids (where that field carries the GlobalID), instead of posting an empty `dataset_example_id`.
165
+
166
+ ## 6.10.0
167
+
168
+ ### Minor Changes
169
+
170
+ - 6dceb10: Restructure annotation bulk-delete commands into entity-first compound nouns:
171
+ `px span delete-annotations` becomes `px span-annotations delete`,
172
+ `px trace delete-annotations` becomes `px trace-annotations delete`, and
173
+ `px session delete-annotations` becomes `px session-annotations delete`. Flag
174
+ set, authorization gate (`--all` XOR `[--start-time, --end-time)`), payload
175
+ shape, and exit codes are unchanged.
176
+
177
+ Add an optional `identifier` body field to `addTraceNote`, `addSpanNote`, and
178
+ `addSessionNote` (and the generated REST types). When non-empty, the note is
179
+ upserted on `(entity_id, name='note', identifier)` so repeated calls with the
180
+ same identifier overwrite the existing note instead of appending. When the
181
+ helper is given an `identifier`, it now also calls
182
+ `ensureServerCapability` against the new identifier body-parameter
183
+ requirement so the caller fails fast against older Phoenix servers (which
184
+ would otherwise silently drop the field and append an auto-generated note).
185
+
186
+ ## 6.9.3
187
+
188
+ ### Patch Changes
189
+
190
+ - Updated dependencies [559acf8]
191
+ - @arizeai/phoenix-otel@1.0.2
192
+
193
+ ## 6.9.2
194
+
195
+ ### Patch Changes
196
+
197
+ - d0cc4c4: Update `openapi-fetch` from `^0.12.5` to `^0.17.0`.
198
+
199
+ ## 6.9.1
200
+
201
+ ### Patch Changes
202
+
203
+ - 5d14f23: Add LinkedIn link to the Community section of the README.
204
+ - Updated dependencies [5d14f23]
205
+ - @arizeai/phoenix-config@0.1.4
206
+ - @arizeai/phoenix-otel@1.0.1
207
+
208
+ ## 6.9.0
209
+
210
+ ### Minor Changes
211
+
212
+ - 2993b04: Add `addTraceAnnotation` and `logTraceAnnotations` to the `traces` subpath. Brings the TypeScript client to parity with the Python client by exposing the existing `/v1/trace_annotations` REST endpoint for structured (label/score/explanation) feedback on traces.
213
+
214
+ ### Patch Changes
215
+
216
+ - 2993b04: Clarify TSDoc and regenerated OpenAPI descriptions for `addSpanNote` and `addTraceNote`. Previous wording implied structured annotations were "unique by name", which is incorrect — annotations are keyed by `(name, target_id, identifier)`, so multiple annotations with the same name can coexist on the same span/trace/session by supplying distinct identifiers. Notes remain append-only via auto-generated UUIDv4 identifiers.
217
+ - 4e20267: Add session annotation and note commands to the Phoenix CLI, and add a session note helper to the TypeScript client. Session note creation requires Phoenix server 14.17.0 or newer.
218
+
219
+ ## 6.8.1
220
+
221
+ ### Patch Changes
222
+
223
+ - e381885: Gate `example_ids` on dataset upload (`createDataset`, `appendDatasetExamples`) by server version, so callers see a clear capability error when targeting a Phoenix server older than 15.0.0 instead of a confusing server-side failure.
224
+ - 187df7e: Regenerate REST API types for the session notes endpoint.
225
+
226
+ ## 6.8.0
227
+
228
+ ### Minor Changes
229
+
230
+ - a4dad8b: Add `addTraceNote()` helper for creating trace notes via `POST /v1/trace_notes`. The call performs a preflight server-version check and throws a descriptive error when the connected Phoenix server is too old. Requires Phoenix server >= 14.13.0.
231
+
232
+ ## 6.7.0
233
+
234
+ ### Minor Changes
235
+
236
+ - e19a038: Add `attributes` filter to `getSpans()` for type-aware attribute matching. Pass a `Record<string, string | number | boolean>` to filter spans by attribute key/value pairs with AND semantics — the JS value type selects how the stored attribute is matched (e.g., `{ "user.id": 12345 }` matches a stored integer, `{ "user.id": "12345" }` matches a stored string). Requires Phoenix server >= 14.9.0.
237
+
238
+ ## 6.6.2
239
+
240
+ ### Patch Changes
241
+
242
+ - 8444575: Move `@anthropic-ai/sdk`, `openai`, and `ai` from `optionalDependencies` to optional `peerDependencies`. Consumers no longer get these provider SDKs installed automatically — they are only installed if the consumer already depends on them.
243
+
244
+ ## 6.6.1
245
+
246
+ ### Patch Changes
247
+
248
+ - 1449f3d: Re-export openinference semantic conventions from phoenix-otel and update phoenix-client to import them from phoenix-otel instead of depending on @arizeai/openinference-semantic-conventions directly.
249
+ - Updated dependencies [1449f3d]
250
+ - @arizeai/phoenix-otel@1.0.0
251
+
252
+ ## 6.6.0
253
+
254
+ ### Minor Changes
255
+
256
+ - c70eca6: Add optional `traceId` to evaluator params so evaluators can fetch and analyze task traces for trajectory evaluation
257
+
258
+ ## 6.5.5
259
+
260
+ ### Patch Changes
261
+
262
+ - 1028be5: Bundle curated package docs and examples into npm packages under `docs/`.
263
+ - Updated dependencies [1028be5]
264
+ - @arizeai/phoenix-otel@0.4.3
265
+
266
+ ## 6.5.4
267
+
268
+ ### Patch Changes
269
+
270
+ - b4ded15: Update package READMEs with latest capabilities
271
+
272
+ - phoenix-client: Add Sessions section documenting `listSessions`, `getSession`, and `addSessionAnnotation`
273
+ - phoenix-evals: Add full pre-built evaluators table (conciseness, correctness, document relevance, refusal, tool evaluators), fix import paths for `bindEvaluator`
274
+ - phoenix-mcp: Expand Tool Coverage section with complete, accurate tool list
275
+ - phoenix-config: Full documentation replacing the one-line placeholder (installation, environment variables, usage examples)
276
+ - phoenix-cli: Add `px annotation-config` command documentation
277
+
278
+ - Updated dependencies [b4ded15]
279
+ - @arizeai/phoenix-config@0.1.3
280
+
281
+ ## 6.5.3
282
+
283
+ ### Patch Changes
284
+
285
+ - Updated dependencies [e4bdcf6]
286
+ - @arizeai/phoenix-config@0.1.2
287
+
288
+ ## 6.5.2
289
+
290
+ ### Patch Changes
291
+
292
+ - d204898: docs: document recently added commands and methods in package READMEs
293
+
294
+ ## 6.5.1
295
+
296
+ ### Patch Changes
297
+
298
+ - 91949d7: Add name, spanKind, and statusCode filter parameters to getSpans
299
+
300
+ ## 6.5.0
301
+
302
+ ### Minor Changes
303
+
304
+ - 9769f90: Add server version gating to phoenix-client. The client now reads the server version from response headers and validates it against minimum version requirements before calling newer API routes or using newer parameters. This prevents confusing errors when a client is newer than the server it connects to.
305
+
306
+ ## 6.4.0
307
+
308
+ ### Minor Changes
309
+
310
+ - 83b7f68: Add `getSessionTurns` function to retrieve ordered conversation turns (root span I/O) from a session
311
+
312
+ ## 6.3.0
313
+
314
+ ### Minor Changes
315
+
316
+ - d951320: Add `parentId` parameter to `getSpans` for filtering spans by parent span ID
317
+
318
+ ## 6.2.0
319
+
320
+ ### Minor Changes
321
+
322
+ - 6d896e3: Add `traceIds` parameter to `getSpans` and MCP `get-spans` tool for filtering spans by trace ID.
323
+
324
+ ## 6.1.0
325
+
326
+ ### Minor Changes
327
+
328
+ - 6296d0a: Replace `projectIdentifier: string` with a `ProjectIdentifier` discriminated union on `listSessions`. Callers can now pass `{ project: "name-or-id" }`, `{ projectId: "..." }`, or `{ projectName: "..." }` for explicit intent and better IDE autocompletion.
329
+ - 6296d0a: Add `getSession` and `listSessions` APIs for querying session data. `getSession` fetches a single session by ID or name, while `listSessions` returns paginated sessions for a project with cursor-based pagination.
330
+
331
+ ### Patch Changes
332
+
333
+ - b8ba989: Removed deprecated `ProjectSelector` type alias. Use `ProjectIdentifier` instead.
334
+
335
+ ## 6.0.0
336
+
337
+ ### Major Changes
338
+
339
+ - 03b10a8: feat: upgrade zod from v3 to v4
340
+
341
+ BREAKING CHANGE: Upgraded zod from v3 to v4. This changes inferred TypeScript types
342
+ for schemas using `z.looseObject()` (previously `.passthrough()`) which now include
343
+ `[x: string]: unknown` in their output types. Consumers using these types may need
344
+ to update their code. Additionally, `ZodError.errors` has been replaced with
345
+ `ZodError.issues`, `z.record()` now requires explicit key schemas, and
346
+ `zod-to-json-schema` has been replaced with native `z.toJSONSchema()`.
347
+
348
+ ### Patch Changes
349
+
350
+ - Updated dependencies [03b10a8]
351
+ - @arizeai/phoenix-otel@0.4.2
352
+
353
+ ## 5.9.0
354
+
355
+ ### Minor Changes
356
+
357
+ - b18325b: feat: upgrade AI SDK to v6
358
+
359
+ ### Patch Changes
360
+
361
+ - db24319: fix: polish experiment run output formatting and clarity
362
+ - Updated dependencies [db24319]
363
+ - @arizeai/phoenix-config@0.1.1
364
+
365
+ ## 5.8.2
366
+
367
+ ### Patch Changes
368
+
369
+ - 8be1940: Update `@arizeai/openinference-vercel` dependency to `^2.7.0`.
370
+ - Updated dependencies [7456462]
371
+ - @arizeai/phoenix-otel@0.4.1
372
+
373
+ ## 5.8.1
374
+
375
+ ### Patch Changes
376
+
377
+ - Updated dependencies [a8896db]
378
+ - @arizeai/phoenix-otel@0.4.0
379
+
380
+ ## 5.8.0
381
+
382
+ ### Minor Changes
383
+
384
+ - af4dc46: Add prompt introspection commands to Phoenix CLI
385
+ - `px prompts`: List all available prompts with names and descriptions
386
+ - `px prompt <identifier>`: Show a specific prompt with support for `--tag` and `--version` options
387
+ - `--format text`: Output prompt content with XML-style role tags for piping to AI assistants like Claude Code
388
+ - Pretty print now includes full tool definitions with parameters, types, and descriptions
389
+ - Added `listPrompts` function to phoenix-client
390
+
391
+ ## 5.7.0
392
+
393
+ ### Minor Changes
394
+
395
+ - 01eb1fb: feat: Add spanId support for linking dataset examples to traces
396
+
397
+ - Added `spanId` field to the `Example` interface for linking dataset examples back to their source spans
398
+ - Updated `createDataset` to accept examples with `spanId` and pass them to the API
399
+ - Updated `appendDatasetExamples` to accept examples with `spanId` and pass them to the API
400
+ - Added comprehensive unit tests for span ID functionality
401
+ - Added example script demonstrating how to create datasets from spans with trace associations
402
+
403
+ This feature enables traceability from datasets back to the original traces in Phoenix, making it easier to understand the provenance of dataset examples.
404
+
405
+ ## 5.6.1
406
+
407
+ ### Patch Changes
408
+
409
+ - ed59696: feat: Bump generated api schema
410
+
411
+ ## 5.6.0
412
+
413
+ ### Minor Changes
414
+
415
+ - 0f2950e: centralize phoenix config
416
+
417
+ ### Patch Changes
418
+
419
+ - Updated dependencies [0f2950e]
420
+ - @arizeai/phoenix-config@0.1.0
421
+
422
+ ## 5.5.5
423
+
424
+ ### Patch Changes
425
+
426
+ - 5132ce4: update openai to latest version
427
+
428
+ ## 5.5.4
429
+
430
+ ### Patch Changes
431
+
432
+ - 4208604: trigger changeset publish
433
+ - Updated dependencies [4208604]
434
+ - @arizeai/phoenix-otel@0.3.4
435
+
436
+ ## 5.5.3
437
+
438
+ ### Patch Changes
439
+
440
+ - c96475c: trigger changeset publish
441
+ - Updated dependencies [c96475c]
442
+ - @arizeai/phoenix-otel@0.3.3
443
+
444
+ ## 5.5.2
445
+
446
+ ### Patch Changes
447
+
448
+ - 857b617: add links to packages
449
+ - Updated dependencies [857b617]
450
+ - @arizeai/phoenix-otel@0.3.2
451
+
452
+ ## 5.5.1
453
+
454
+ ### Patch Changes
455
+
456
+ - Updated dependencies [ce5febf]
457
+ - @arizeai/phoenix-otel@0.3.1
458
+
459
+ ## 5.5.0
460
+
461
+ ### Minor Changes
462
+
463
+ - cb45336: support splits when creating dataset or adding examples
464
+
465
+ ## 5.4.1
466
+
467
+ ### Patch Changes
468
+
469
+ - b87d2a4: account for sub-paths in baseURLs properly
470
+
471
+ ## 5.4.0
472
+
473
+ ### Minor Changes
474
+
475
+ - 885be2a: make phoenix-client be able to take in phoenix evals directly
476
+
477
+ ## 5.3.0
478
+
479
+ ### Minor Changes
480
+
481
+ - 557865c: Add experiment resume and management features
482
+
483
+ **New APIs:**
484
+
485
+ - `createExperiment()` - Create an experiment without running it
486
+ - `resumeExperiment()` - Resume incomplete experiment runs (handles failed or missing runs)
487
+ - `resumeEvaluation()` - Add evaluations to completed experiments or retry failed evaluations
488
+ - `listExperiments()` - List experiments with filtering and pagination
489
+ - `deleteExperiment()` - Delete experiments
490
+
491
+ ### Patch Changes
492
+
493
+ - b000189: fix bug with channel error
494
+ - 0c92232: allow metadata when creating prompts
495
+
496
+ ## 5.2.1
497
+
498
+ ### Patch Changes
499
+
500
+ - Updated dependencies [419ea76]
501
+ - @arizeai/phoenix-otel@0.3.0
502
+
503
+ ## 5.2.0
504
+
505
+ ### Minor Changes
506
+
507
+ - f9d8b06: switch licensing to apache 2
508
+
509
+ ## 5.1.1
510
+
511
+ ### Patch Changes
512
+
513
+ - Updated dependencies [8bbff3a]
514
+ - @arizeai/phoenix-otel@0.2.1
515
+
516
+ ## 5.1.0
517
+
518
+ ### Minor Changes
519
+
520
+ - de6f111: refactor to use phoenix-otel across the client
521
+
522
+ ### Patch Changes
523
+
524
+ - Updated dependencies [de6f111]
525
+ - @arizeai/phoenix-otel@0.2.0
526
+
527
+ ## 5.0.0
528
+
529
+ ### Major Changes
530
+
531
+ - 950fda5: feat: Add support for dataset splits
532
+
533
+ This release introduces support for dataset splits, enabling you to segment and query specific portions of your dataset examples. The `DatasetSelector` interface has been enhanced to support filtering by splits, allowing for more granular dataset management and experimentation.
534
+
535
+ ## New Features
536
+
537
+ - **Dataset Splits Support**: Query dataset examples by split using the enhanced `DatasetSelector` interface
538
+ - **Split-based Experimentation**: Run experiments on specific dataset splits for targeted evaluation
539
+ - **Enhanced Dataset Types**: Updated type definitions to support split-based dataset operations
540
+
541
+ ## Breaking Changes
542
+
543
+ - **`runExperiment` API Changes**:
544
+ - The `datasetVersionId` parameter has been removed from `runExperiment`
545
+ - Version selection is now handled through the `DatasetSelector` interface
546
+ - Pass `versionId` and `splits` as properties of the `DatasetSelector` argument instead
547
+
548
+ ## Migration Guide
549
+
550
+ **Before:**
551
+
552
+ ```typescript
553
+ runExperiment({
554
+ dataset: { datasetId: "my-dataset" },
555
+ datasetVersionId: "version-123",
556
+ // ... other params
557
+ });
558
+ ```
559
+
560
+ **After:**
561
+
562
+ ```typescript
563
+ runExperiment({
564
+ dataset: {
565
+ datasetId: "my-dataset",
566
+ versionId: "version-123",
567
+ splits: ["train", "test"],
568
+ },
569
+ // ... other params
570
+ });
571
+ ```
572
+
573
+ ## 4.2.0
574
+
575
+ ### Minor Changes
576
+
577
+ - 85430fa: feat: Add configurable DiagLogLevel to runExperiment
578
+ - c7cc7d9: feat: Add createOrGetDataset helper function to phoenix-client
579
+
580
+ Additionally clean up build artifacts and type-checking amongst example scripts.
581
+
582
+ ## 4.1.0
583
+
584
+ ### Minor Changes
585
+
586
+ - 2981780: add session annotation functions
587
+
588
+ ## 4.0.3
589
+
590
+ ### Patch Changes
591
+
592
+ - e3a8ce2: pass through the tracer provider to experiments so that there is no need to configure it twice
593
+ - c85780b: Add support for generics across evals and experiments
594
+
595
+ ## 4.0.2
596
+
597
+ ### Patch Changes
598
+
599
+ - 1b71c66: make sure repetition numbers are greater than 0
600
+
601
+ ## 4.0.1
602
+
603
+ ### Patch Changes
604
+
605
+ - e72a9ad: don't swallow errors, allow for incomplete datasets (e.g. just inputs)
606
+
607
+ ## 4.0.0
608
+
609
+ ### Major Changes
610
+
611
+ - 7732f99: Breaking change for AI SDK users. Support for messages conversion for the AI SDK 5
612
+
613
+ ## 3.2.0
614
+
615
+ ### Minor Changes
616
+
617
+ - 4f43901: add support for logging document annotations
618
+
619
+ ## 3.1.0
620
+
621
+ ### Minor Changes
622
+
623
+ - ee0c829: switch to batch span processor by default and make it configurable
624
+
625
+ ## 3.0.0
626
+
627
+ ### Major Changes
628
+
629
+ - 3e80a50: delete span method
630
+
631
+ ### Minor Changes
632
+
633
+ - 8711bde: update major version of openai to ^5
634
+
635
+ ## 2.4.0
636
+
637
+ ### Minor Changes
638
+
639
+ - fe55fc5: get dataset with versionId
640
+
641
+ ## 2.3.5
642
+
643
+ ### Patch Changes
644
+
645
+ - 83748e6: add type exports and better documentation across packages
646
+
647
+ ## 2.3.4
648
+
649
+ ### Patch Changes
650
+
651
+ - 20db91d: Add tracing to evals, add tracing controls
652
+
653
+ ## 2.3.3
654
+
655
+ ### Patch Changes
656
+
657
+ - 2609fcd: bump target JS to es2017 for native async
658
+
659
+ ## 2.3.2
660
+
661
+ ### Patch Changes
662
+
663
+ - 6ef8e47: fix dataset pull by name
664
+
665
+ ## 2.3.1
666
+
667
+ ### Patch Changes
668
+
669
+ - b3e30db: simplify types for task output in experiments client api
670
+
671
+ ## 2.3.0
672
+
673
+ ### Minor Changes
674
+
675
+ - 3c97cc7: Add the ability to get a dataset by name
676
+
677
+ ## 2.2.0
678
+
679
+ ### Minor Changes
680
+
681
+ - 1906611: add getSpan method
682
+
683
+ ### Patch Changes
684
+
685
+ - 4c52db4: ollama provider added
686
+
687
+ ## 2.1.1
688
+
689
+ ### Patch Changes
690
+
691
+ - 5dd53be: add in xai to playground as provider
692
+
693
+ ## 2.1.0
694
+
695
+ ### Minor Changes
696
+
697
+ - b162720: add support for deepseek
698
+
699
+ ## 2.0.1
700
+
701
+ ### Patch Changes
702
+
703
+ - da7800a: feat(phoenix-client): Log the experiment/dataset link when calling runExperiment
704
+
705
+ ## 2.0.0
706
+
707
+ ### Major Changes
708
+
709
+ - 118e881: feat: add support for dataset creation and the ability to re-run experiments
710
+
711
+ ## 1.3.0
712
+
713
+ ### Minor Changes
714
+
715
+ - 536258e: feat(phoenix-client): Export traces from experiments to Phoenix
716
+
717
+ ## 1.2.0
718
+
719
+ ### Minor Changes
720
+
721
+ - f7fae3b: feat(phoenix-client): Record experiment results to Phoenix server
722
+ - 9273417: feat: Enqueue experiment runs
723
+ - 4dd23c8: support for annotation logging on spans
724
+
725
+ ## 1.1.0
726
+
727
+ ### Minor Changes
728
+
729
+ - fff5511: feat: Update openapi schema with new endpoints
730
+
731
+ ## 1.0.2
732
+
733
+ ### Patch Changes
734
+
735
+ - c99ee6f: Update type definitions to include max_completion_tokens openai parameter
736
+
737
+ ## 1.0.1
738
+
739
+ ### Patch Changes
740
+
741
+ - 2ffeb64: fix: Remove runtime dependency on `ai` package
742
+
743
+ ## 1.0.0
744
+
745
+ ### Major Changes
746
+
747
+ - 3f9e392: feat: Add support for Phoenix Prompts
748
+
749
+ Phoenix can now manage Prompts, and the `@arizeai/phoenix-client` package has been updated to support this.
750
+
751
+ In this initial release, we support the following:
752
+
753
+ - Fully typed Prompt REST endpoints
754
+ - Prompt Pulling
755
+ - Converting a Prompt to invocation parameters for the following LLM SDKs:
756
+ - OpenAI
757
+ - Anthropic
758
+ - Vercel AI SDK
759
+ - You can use any of the Vercel AI SDK Providers with your prompt
760
+
761
+ ### Patch Changes
762
+
763
+ - 95bfc7c: Add the ability to push prompts via the typescript client sdk
764
+
765
+ ## 0.0.1
766
+
767
+ ### Patch Changes
768
+
769
+ - 76a9cdf: pre-release of phoenix-client