@arizeai/phoenix-client 7.14.0 → 7.16.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 (111) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +47 -1
  3. package/dist/esm/__generated__/api/v1.d.ts +5 -1
  4. package/dist/esm/__generated__/api/v1.d.ts.map +1 -1
  5. package/dist/esm/constants/serverRequirements.d.ts +6 -0
  6. package/dist/esm/constants/serverRequirements.d.ts.map +1 -1
  7. package/dist/esm/constants/serverRequirements.js +42 -0
  8. package/dist/esm/constants/serverRequirements.js.map +1 -1
  9. package/dist/esm/projects/assignProjectAnnotationConfig.d.ts +41 -0
  10. package/dist/esm/projects/assignProjectAnnotationConfig.d.ts.map +1 -0
  11. package/dist/esm/projects/assignProjectAnnotationConfig.js +58 -0
  12. package/dist/esm/projects/assignProjectAnnotationConfig.js.map +1 -0
  13. package/dist/esm/projects/index.d.ts +5 -0
  14. package/dist/esm/projects/index.d.ts.map +1 -1
  15. package/dist/esm/projects/index.js +4 -0
  16. package/dist/esm/projects/index.js.map +1 -1
  17. package/dist/esm/projects/listProjectAnnotationConfigs.d.ts +37 -0
  18. package/dist/esm/projects/listProjectAnnotationConfigs.d.ts.map +1 -0
  19. package/dist/esm/projects/listProjectAnnotationConfigs.js +59 -0
  20. package/dist/esm/projects/listProjectAnnotationConfigs.js.map +1 -0
  21. package/dist/esm/projects/setProjectAnnotationConfigs.d.ts +52 -0
  22. package/dist/esm/projects/setProjectAnnotationConfigs.d.ts.map +1 -0
  23. package/dist/esm/projects/setProjectAnnotationConfigs.js +63 -0
  24. package/dist/esm/projects/setProjectAnnotationConfigs.js.map +1 -0
  25. package/dist/esm/projects/unassignProjectAnnotationConfig.d.ts +41 -0
  26. package/dist/esm/projects/unassignProjectAnnotationConfig.d.ts.map +1 -0
  27. package/dist/esm/projects/unassignProjectAnnotationConfig.js +55 -0
  28. package/dist/esm/projects/unassignProjectAnnotationConfig.js.map +1 -0
  29. package/dist/esm/prompts/deletePromptVersionTag.d.ts +36 -0
  30. package/dist/esm/prompts/deletePromptVersionTag.d.ts.map +1 -0
  31. package/dist/esm/prompts/deletePromptVersionTag.js +44 -0
  32. package/dist/esm/prompts/deletePromptVersionTag.js.map +1 -0
  33. package/dist/esm/prompts/index.d.ts +2 -0
  34. package/dist/esm/prompts/index.d.ts.map +1 -1
  35. package/dist/esm/prompts/index.js +2 -0
  36. package/dist/esm/prompts/index.js.map +1 -1
  37. package/dist/esm/prompts/upsertPromptVersionTag.d.ts +40 -0
  38. package/dist/esm/prompts/upsertPromptVersionTag.d.ts.map +1 -0
  39. package/dist/esm/prompts/upsertPromptVersionTag.js +49 -0
  40. package/dist/esm/prompts/upsertPromptVersionTag.js.map +1 -0
  41. package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
  42. package/dist/esm/types/annotationConfigs.d.ts +35 -0
  43. package/dist/esm/types/annotationConfigs.d.ts.map +1 -0
  44. package/dist/esm/types/annotationConfigs.js +12 -0
  45. package/dist/esm/types/annotationConfigs.js.map +1 -0
  46. package/dist/esm/utils/resolvePromptVersionId.d.ts +11 -0
  47. package/dist/esm/utils/resolvePromptVersionId.d.ts.map +1 -0
  48. package/dist/esm/utils/resolvePromptVersionId.js +15 -0
  49. package/dist/esm/utils/resolvePromptVersionId.js.map +1 -0
  50. package/dist/src/__generated__/api/v1.d.ts +5 -1
  51. package/dist/src/__generated__/api/v1.d.ts.map +1 -1
  52. package/dist/src/constants/serverRequirements.d.ts +6 -0
  53. package/dist/src/constants/serverRequirements.d.ts.map +1 -1
  54. package/dist/src/constants/serverRequirements.js +43 -1
  55. package/dist/src/constants/serverRequirements.js.map +1 -1
  56. package/dist/src/projects/assignProjectAnnotationConfig.d.ts +41 -0
  57. package/dist/src/projects/assignProjectAnnotationConfig.d.ts.map +1 -0
  58. package/dist/src/projects/assignProjectAnnotationConfig.js +65 -0
  59. package/dist/src/projects/assignProjectAnnotationConfig.js.map +1 -0
  60. package/dist/src/projects/index.d.ts +5 -0
  61. package/dist/src/projects/index.d.ts.map +1 -1
  62. package/dist/src/projects/index.js +4 -0
  63. package/dist/src/projects/index.js.map +1 -1
  64. package/dist/src/projects/listProjectAnnotationConfigs.d.ts +37 -0
  65. package/dist/src/projects/listProjectAnnotationConfigs.d.ts.map +1 -0
  66. package/dist/src/projects/listProjectAnnotationConfigs.js +67 -0
  67. package/dist/src/projects/listProjectAnnotationConfigs.js.map +1 -0
  68. package/dist/src/projects/setProjectAnnotationConfigs.d.ts +52 -0
  69. package/dist/src/projects/setProjectAnnotationConfigs.d.ts.map +1 -0
  70. package/dist/src/projects/setProjectAnnotationConfigs.js +70 -0
  71. package/dist/src/projects/setProjectAnnotationConfigs.js.map +1 -0
  72. package/dist/src/projects/unassignProjectAnnotationConfig.d.ts +41 -0
  73. package/dist/src/projects/unassignProjectAnnotationConfig.d.ts.map +1 -0
  74. package/dist/src/projects/unassignProjectAnnotationConfig.js +59 -0
  75. package/dist/src/projects/unassignProjectAnnotationConfig.js.map +1 -0
  76. package/dist/src/prompts/deletePromptVersionTag.d.ts +36 -0
  77. package/dist/src/prompts/deletePromptVersionTag.d.ts.map +1 -0
  78. package/dist/src/prompts/deletePromptVersionTag.js +47 -0
  79. package/dist/src/prompts/deletePromptVersionTag.js.map +1 -0
  80. package/dist/src/prompts/index.d.ts +2 -0
  81. package/dist/src/prompts/index.d.ts.map +1 -1
  82. package/dist/src/prompts/index.js +2 -0
  83. package/dist/src/prompts/index.js.map +1 -1
  84. package/dist/src/prompts/upsertPromptVersionTag.d.ts +40 -0
  85. package/dist/src/prompts/upsertPromptVersionTag.d.ts.map +1 -0
  86. package/dist/src/prompts/upsertPromptVersionTag.js +52 -0
  87. package/dist/src/prompts/upsertPromptVersionTag.js.map +1 -0
  88. package/dist/src/types/annotationConfigs.d.ts +35 -0
  89. package/dist/src/types/annotationConfigs.d.ts.map +1 -0
  90. package/dist/src/types/annotationConfigs.js +15 -0
  91. package/dist/src/types/annotationConfigs.js.map +1 -0
  92. package/dist/src/utils/resolvePromptVersionId.d.ts +11 -0
  93. package/dist/src/utils/resolvePromptVersionId.d.ts.map +1 -0
  94. package/dist/src/utils/resolvePromptVersionId.js +18 -0
  95. package/dist/src/utils/resolvePromptVersionId.js.map +1 -0
  96. package/dist/tsconfig.tsbuildinfo +1 -1
  97. package/docs/projects.mdx +55 -2
  98. package/docs/prompts.mdx +30 -1
  99. package/package.json +7 -7
  100. package/src/__generated__/api/v1.ts +5 -1
  101. package/src/constants/serverRequirements.ts +48 -0
  102. package/src/projects/assignProjectAnnotationConfig.ts +78 -0
  103. package/src/projects/index.ts +8 -0
  104. package/src/projects/listProjectAnnotationConfigs.ts +85 -0
  105. package/src/projects/setProjectAnnotationConfigs.ts +86 -0
  106. package/src/projects/unassignProjectAnnotationConfig.ts +71 -0
  107. package/src/prompts/deletePromptVersionTag.ts +64 -0
  108. package/src/prompts/index.ts +2 -0
  109. package/src/prompts/upsertPromptVersionTag.ts +69 -0
  110. package/src/types/annotationConfigs.ts +37 -0
  111. package/src/utils/resolvePromptVersionId.ts +18 -0
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @arizeai/phoenix-client
2
2
 
3
+ ## 7.16.0
4
+
5
+ ### Minor Changes
6
+
7
+ - f8ae2fc: Add `listProjectAnnotationConfigs`, `assignProjectAnnotationConfig`, `unassignProjectAnnotationConfig`, and `setProjectAnnotationConfigs` helpers to the `projects` subpath for managing which annotation configs a project uses.
8
+
9
+ ## 7.15.0
10
+
11
+ ### Minor Changes
12
+
13
+ - 5b37f12: Add `upsertPromptVersionTag` and `deletePromptVersionTag` helpers to the `prompts` subpath for creating, moving, and deleting prompt-scoped version tags.
14
+
3
15
  ## 7.14.0
4
16
 
5
17
  ### Minor Changes
package/README.md CHANGED
@@ -750,7 +750,7 @@ await addSessionNote({
750
750
 
751
751
  ## Projects
752
752
 
753
- The `@arizeai/phoenix-client` package provides a `projects` export for listing projects and managing their retention-policy assignments.
753
+ The `@arizeai/phoenix-client` package provides a `projects` export for listing projects and managing their retention-policy and annotation-config assignments.
754
754
 
755
755
  ### Fetching Projects
756
756
 
@@ -797,6 +797,52 @@ await setProjectRetentionPolicy({
797
797
 
798
798
  This helper only changes a project's assignment to an existing policy. Creating, reading, updating, and deleting retention policies is outside the scope of the TypeScript projects helper.
799
799
 
800
+ ### Assigning Annotation Configs
801
+
802
+ Use `assignProjectAnnotationConfig` and `unassignProjectAnnotationConfig` to add or remove a single annotation config. Select the project and the config by name or GlobalID. Both calls are idempotent. These helpers require Phoenix server `17.16.0` or newer.
803
+
804
+ ```ts
805
+ import {
806
+ assignProjectAnnotationConfig,
807
+ listProjectAnnotationConfigs,
808
+ setProjectAnnotationConfigs,
809
+ unassignProjectAnnotationConfig,
810
+ } from "@arizeai/phoenix-client/projects";
811
+
812
+ await assignProjectAnnotationConfig({
813
+ projectName: "support-bot",
814
+ configName: "correctness",
815
+ });
816
+
817
+ await unassignProjectAnnotationConfig({
818
+ projectName: "support-bot",
819
+ configName: "correctness",
820
+ });
821
+ ```
822
+
823
+ Use `setProjectAnnotationConfigs` to replace the whole set by config GlobalID. Pass an empty list to clear every assignment:
824
+
825
+ ```ts
826
+ const configs = await listProjectAnnotationConfigs({
827
+ projectName: "support-bot",
828
+ });
829
+
830
+ // Keep only the categorical configs
831
+ await setProjectAnnotationConfigs({
832
+ projectName: "support-bot",
833
+ configIds: configs
834
+ .filter((config) => config.type === "CATEGORICAL")
835
+ .map((config) => config.id),
836
+ });
837
+
838
+ await setProjectAnnotationConfigs({
839
+ projectName: "support-bot",
840
+ configIds: [],
841
+ });
842
+ ```
843
+
844
+ If a config name contains `/`, select it by `configId` instead. The server can't route a `/` in the URL path.
845
+
800
846
  ## Secrets
801
847
 
802
848
  Use the `secrets` entrypoint to atomically create, update, or delete encrypted
@@ -10579,10 +10579,14 @@ export interface operations {
10579
10579
  getSpans: {
10580
10580
  parameters: {
10581
10581
  query?: {
10582
- /** @description Pagination cursor (Span Global ID) */
10582
+ /** @description Pagination cursor: the next_cursor of a previous response with the same sort */
10583
10583
  cursor?: string | null;
10584
10584
  /** @description Maximum number of spans to return */
10585
10585
  limit?: number;
10586
+ /** @description Sort field. 'id' orders by insertion; 'start_time' orders by when the span started, breaking ties by id. */
10587
+ sort?: "id" | "start_time";
10588
+ /** @description Sort direction */
10589
+ order?: "asc" | "desc";
10586
10590
  /** @description Inclusive lower bound time */
10587
10591
  start_time?: string | null;
10588
10592
  /** @description Exclusive upper bound time */