@arizeai/phoenix-client 7.13.0 → 7.15.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 (106) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/dist/esm/__generated__/api/v1.d.ts +17 -4
  3. package/dist/esm/__generated__/api/v1.d.ts.map +1 -1
  4. package/dist/esm/constants/serverRequirements.d.ts +5 -0
  5. package/dist/esm/constants/serverRequirements.d.ts.map +1 -1
  6. package/dist/esm/constants/serverRequirements.js +35 -0
  7. package/dist/esm/constants/serverRequirements.js.map +1 -1
  8. package/dist/esm/datasets/createDatasetSplit.d.ts +39 -0
  9. package/dist/esm/datasets/createDatasetSplit.d.ts.map +1 -0
  10. package/dist/esm/datasets/createDatasetSplit.js +42 -0
  11. package/dist/esm/datasets/createDatasetSplit.js.map +1 -0
  12. package/dist/esm/datasets/deleteDatasetSplit.d.ts +24 -0
  13. package/dist/esm/datasets/deleteDatasetSplit.d.ts.map +1 -0
  14. package/dist/esm/datasets/deleteDatasetSplit.js +31 -0
  15. package/dist/esm/datasets/deleteDatasetSplit.js.map +1 -0
  16. package/dist/esm/datasets/index.d.ts +4 -0
  17. package/dist/esm/datasets/index.d.ts.map +1 -1
  18. package/dist/esm/datasets/index.js +3 -0
  19. package/dist/esm/datasets/index.js.map +1 -1
  20. package/dist/esm/datasets/resolveDatasetIdentifier.d.ts +4 -0
  21. package/dist/esm/datasets/resolveDatasetIdentifier.d.ts.map +1 -0
  22. package/dist/esm/datasets/resolveDatasetIdentifier.js +5 -0
  23. package/dist/esm/datasets/resolveDatasetIdentifier.js.map +1 -0
  24. package/dist/esm/datasets/updateDatasetSplit.d.ts +48 -0
  25. package/dist/esm/datasets/updateDatasetSplit.d.ts.map +1 -0
  26. package/dist/esm/datasets/updateDatasetSplit.js +55 -0
  27. package/dist/esm/datasets/updateDatasetSplit.js.map +1 -0
  28. package/dist/esm/prompts/deletePromptVersionTag.d.ts +36 -0
  29. package/dist/esm/prompts/deletePromptVersionTag.d.ts.map +1 -0
  30. package/dist/esm/prompts/deletePromptVersionTag.js +44 -0
  31. package/dist/esm/prompts/deletePromptVersionTag.js.map +1 -0
  32. package/dist/esm/prompts/index.d.ts +2 -0
  33. package/dist/esm/prompts/index.d.ts.map +1 -1
  34. package/dist/esm/prompts/index.js +2 -0
  35. package/dist/esm/prompts/index.js.map +1 -1
  36. package/dist/esm/prompts/upsertPromptVersionTag.d.ts +40 -0
  37. package/dist/esm/prompts/upsertPromptVersionTag.d.ts.map +1 -0
  38. package/dist/esm/prompts/upsertPromptVersionTag.js +49 -0
  39. package/dist/esm/prompts/upsertPromptVersionTag.js.map +1 -0
  40. package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
  41. package/dist/esm/types/datasets.d.ts +10 -5
  42. package/dist/esm/types/datasets.d.ts.map +1 -1
  43. package/dist/esm/utils/resolvePromptVersionId.d.ts +11 -0
  44. package/dist/esm/utils/resolvePromptVersionId.d.ts.map +1 -0
  45. package/dist/esm/utils/resolvePromptVersionId.js +15 -0
  46. package/dist/esm/utils/resolvePromptVersionId.js.map +1 -0
  47. package/dist/src/__generated__/api/v1.d.ts +17 -4
  48. package/dist/src/__generated__/api/v1.d.ts.map +1 -1
  49. package/dist/src/constants/serverRequirements.d.ts +5 -0
  50. package/dist/src/constants/serverRequirements.d.ts.map +1 -1
  51. package/dist/src/constants/serverRequirements.js +36 -1
  52. package/dist/src/constants/serverRequirements.js.map +1 -1
  53. package/dist/src/datasets/createDatasetSplit.d.ts +39 -0
  54. package/dist/src/datasets/createDatasetSplit.d.ts.map +1 -0
  55. package/dist/src/datasets/createDatasetSplit.js +42 -0
  56. package/dist/src/datasets/createDatasetSplit.js.map +1 -0
  57. package/dist/src/datasets/deleteDatasetSplit.d.ts +24 -0
  58. package/dist/src/datasets/deleteDatasetSplit.d.ts.map +1 -0
  59. package/dist/src/datasets/deleteDatasetSplit.js +34 -0
  60. package/dist/src/datasets/deleteDatasetSplit.js.map +1 -0
  61. package/dist/src/datasets/index.d.ts +4 -0
  62. package/dist/src/datasets/index.d.ts.map +1 -1
  63. package/dist/src/datasets/index.js +3 -0
  64. package/dist/src/datasets/index.js.map +1 -1
  65. package/dist/src/datasets/resolveDatasetIdentifier.d.ts +4 -0
  66. package/dist/src/datasets/resolveDatasetIdentifier.d.ts.map +1 -0
  67. package/dist/src/datasets/resolveDatasetIdentifier.js +8 -0
  68. package/dist/src/datasets/resolveDatasetIdentifier.js.map +1 -0
  69. package/dist/src/datasets/updateDatasetSplit.d.ts +48 -0
  70. package/dist/src/datasets/updateDatasetSplit.d.ts.map +1 -0
  71. package/dist/src/datasets/updateDatasetSplit.js +54 -0
  72. package/dist/src/datasets/updateDatasetSplit.js.map +1 -0
  73. package/dist/src/prompts/deletePromptVersionTag.d.ts +36 -0
  74. package/dist/src/prompts/deletePromptVersionTag.d.ts.map +1 -0
  75. package/dist/src/prompts/deletePromptVersionTag.js +47 -0
  76. package/dist/src/prompts/deletePromptVersionTag.js.map +1 -0
  77. package/dist/src/prompts/index.d.ts +2 -0
  78. package/dist/src/prompts/index.d.ts.map +1 -1
  79. package/dist/src/prompts/index.js +2 -0
  80. package/dist/src/prompts/index.js.map +1 -1
  81. package/dist/src/prompts/upsertPromptVersionTag.d.ts +40 -0
  82. package/dist/src/prompts/upsertPromptVersionTag.d.ts.map +1 -0
  83. package/dist/src/prompts/upsertPromptVersionTag.js +52 -0
  84. package/dist/src/prompts/upsertPromptVersionTag.js.map +1 -0
  85. package/dist/src/types/datasets.d.ts +10 -5
  86. package/dist/src/types/datasets.d.ts.map +1 -1
  87. package/dist/src/utils/resolvePromptVersionId.d.ts +11 -0
  88. package/dist/src/utils/resolvePromptVersionId.d.ts.map +1 -0
  89. package/dist/src/utils/resolvePromptVersionId.js +18 -0
  90. package/dist/src/utils/resolvePromptVersionId.js.map +1 -0
  91. package/dist/tsconfig.tsbuildinfo +1 -1
  92. package/docs/datasets.mdx +74 -1
  93. package/docs/prompts.mdx +30 -1
  94. package/package.json +7 -7
  95. package/src/__generated__/api/v1.ts +17 -4
  96. package/src/constants/serverRequirements.ts +40 -0
  97. package/src/datasets/createDatasetSplit.ts +80 -0
  98. package/src/datasets/deleteDatasetSplit.ts +46 -0
  99. package/src/datasets/index.ts +4 -0
  100. package/src/datasets/resolveDatasetIdentifier.ts +6 -0
  101. package/src/datasets/updateDatasetSplit.ts +99 -0
  102. package/src/prompts/deletePromptVersionTag.ts +64 -0
  103. package/src/prompts/index.ts +2 -0
  104. package/src/prompts/upsertPromptVersionTag.ts +69 -0
  105. package/src/types/datasets.ts +8 -3
  106. package/src/utils/resolvePromptVersionId.ts +18 -0
package/CHANGELOG.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # @arizeai/phoenix-client
2
2
 
3
+ ## 7.15.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 5b37f12: Add `upsertPromptVersionTag` and `deletePromptVersionTag` helpers to the `prompts` subpath for creating, moving, and deleting prompt-scoped version tags.
8
+
9
+ ## 7.14.0
10
+
11
+ ### Minor Changes
12
+
13
+ - aab229f: Add `createDatasetSplit`, `updateDatasetSplit`, and `deleteDatasetSplit` helpers to the `datasets` subpath. The helpers select datasets by name or GlobalID, create splits on existing datasets, partially update split fields, add or remove example memberships idempotently, and delete splits without deleting their examples. They require Phoenix server 19.20.0 or newer.
14
+
15
+ Also export the generated `DatasetSplit` response type and a `DatasetIdentifier` selector type from the datasets subpath.
16
+
3
17
  ## 7.13.0
4
18
 
5
19
  ### Minor Changes
@@ -2678,7 +2678,7 @@ export interface components {
2678
2678
  };
2679
2679
  /**
2680
2680
  * Example Ids
2681
- * @description Optional dataset example IDs (GlobalIDs) to seed the split with. Each example must belong to this dataset. Omit to create an empty split.
2681
+ * @description Optional dataset example identifiers (GlobalIDs or user-provided IDs) to seed the split with. Each example must belong to this dataset. Omit to create an empty split.
2682
2682
  */
2683
2683
  example_ids?: string[];
2684
2684
  };
@@ -3333,6 +3333,11 @@ export interface components {
3333
3333
  * @description The description of the experiment
3334
3334
  */
3335
3335
  description: string | null;
3336
+ /**
3337
+ * Sequence Number
3338
+ * @description The 1-based sequence number of the experiment within its dataset, in creation order.
3339
+ */
3340
+ sequence_number: number;
3336
3341
  /**
3337
3342
  * Repetitions
3338
3343
  * @description Number of times the experiment is repeated
@@ -6715,12 +6720,12 @@ export interface components {
6715
6720
  } | null;
6716
6721
  /**
6717
6722
  * Add Example Ids
6718
- * @description Dataset example IDs (GlobalIDs) to add to the split. Each example must belong to this dataset. Adding an example already in the split is a no-op.
6723
+ * @description Dataset example identifiers (GlobalIDs or user-provided IDs) to add to the split. Each example must belong to this dataset. Adding an example already in the split is a no-op.
6719
6724
  */
6720
6725
  add_example_ids?: string[];
6721
6726
  /**
6722
6727
  * Remove Example Ids
6723
- * @description Dataset example IDs (GlobalIDs) to remove from the split.
6728
+ * @description Dataset example identifiers (GlobalIDs or user-provided IDs) to remove from the split.
6724
6729
  */
6725
6730
  remove_example_ids?: string[];
6726
6731
  };
@@ -9382,6 +9387,10 @@ export interface operations {
9382
9387
  cursor?: string | null;
9383
9388
  /** @description The max number of experiments to return at a time. */
9384
9389
  limit?: number;
9390
+ /** @description Order by creation: 'desc' (default) returns newest experiments first, 'asc' returns oldest first so the lowest sequence numbers are on the first page. */
9391
+ sort_dir?: "asc" | "desc";
9392
+ /** @description When provided, return only the experiments with these 1-based per-dataset sequence numbers. */
9393
+ sequence_numbers?: number[] | null;
9385
9394
  };
9386
9395
  header?: never;
9387
9396
  path: {
@@ -10579,10 +10588,14 @@ export interface operations {
10579
10588
  getSpans: {
10580
10589
  parameters: {
10581
10590
  query?: {
10582
- /** @description Pagination cursor (Span Global ID) */
10591
+ /** @description Pagination cursor: the next_cursor of a previous response with the same sort */
10583
10592
  cursor?: string | null;
10584
10593
  /** @description Maximum number of spans to return */
10585
10594
  limit?: number;
10595
+ /** @description Sort field. 'id' orders by insertion; 'start_time' orders by when the span started, breaking ties by id. */
10596
+ sort?: "id" | "start_time";
10597
+ /** @description Sort direction */
10598
+ order?: "asc" | "desc";
10586
10599
  /** @description Inclusive lower bound time */
10587
10600
  start_time?: string | null;
10588
10601
  /** @description Exclusive upper bound time */