@arizeai/phoenix-client 7.15.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 (74) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/README.md +47 -1
  3. package/dist/esm/__generated__/api/v1.d.ts +0 -9
  4. package/dist/esm/__generated__/api/v1.d.ts.map +1 -1
  5. package/dist/esm/constants/serverRequirements.d.ts +4 -0
  6. package/dist/esm/constants/serverRequirements.d.ts.map +1 -1
  7. package/dist/esm/constants/serverRequirements.js +28 -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/tsconfig.esm.tsbuildinfo +1 -1
  30. package/dist/esm/types/annotationConfigs.d.ts +35 -0
  31. package/dist/esm/types/annotationConfigs.d.ts.map +1 -0
  32. package/dist/esm/types/annotationConfigs.js +12 -0
  33. package/dist/esm/types/annotationConfigs.js.map +1 -0
  34. package/dist/src/__generated__/api/v1.d.ts +0 -9
  35. package/dist/src/__generated__/api/v1.d.ts.map +1 -1
  36. package/dist/src/constants/serverRequirements.d.ts +4 -0
  37. package/dist/src/constants/serverRequirements.d.ts.map +1 -1
  38. package/dist/src/constants/serverRequirements.js +29 -1
  39. package/dist/src/constants/serverRequirements.js.map +1 -1
  40. package/dist/src/projects/assignProjectAnnotationConfig.d.ts +41 -0
  41. package/dist/src/projects/assignProjectAnnotationConfig.d.ts.map +1 -0
  42. package/dist/src/projects/assignProjectAnnotationConfig.js +65 -0
  43. package/dist/src/projects/assignProjectAnnotationConfig.js.map +1 -0
  44. package/dist/src/projects/index.d.ts +5 -0
  45. package/dist/src/projects/index.d.ts.map +1 -1
  46. package/dist/src/projects/index.js +4 -0
  47. package/dist/src/projects/index.js.map +1 -1
  48. package/dist/src/projects/listProjectAnnotationConfigs.d.ts +37 -0
  49. package/dist/src/projects/listProjectAnnotationConfigs.d.ts.map +1 -0
  50. package/dist/src/projects/listProjectAnnotationConfigs.js +67 -0
  51. package/dist/src/projects/listProjectAnnotationConfigs.js.map +1 -0
  52. package/dist/src/projects/setProjectAnnotationConfigs.d.ts +52 -0
  53. package/dist/src/projects/setProjectAnnotationConfigs.d.ts.map +1 -0
  54. package/dist/src/projects/setProjectAnnotationConfigs.js +70 -0
  55. package/dist/src/projects/setProjectAnnotationConfigs.js.map +1 -0
  56. package/dist/src/projects/unassignProjectAnnotationConfig.d.ts +41 -0
  57. package/dist/src/projects/unassignProjectAnnotationConfig.d.ts.map +1 -0
  58. package/dist/src/projects/unassignProjectAnnotationConfig.js +59 -0
  59. package/dist/src/projects/unassignProjectAnnotationConfig.js.map +1 -0
  60. package/dist/src/types/annotationConfigs.d.ts +35 -0
  61. package/dist/src/types/annotationConfigs.d.ts.map +1 -0
  62. package/dist/src/types/annotationConfigs.js +15 -0
  63. package/dist/src/types/annotationConfigs.js.map +1 -0
  64. package/dist/tsconfig.tsbuildinfo +1 -1
  65. package/docs/projects.mdx +55 -2
  66. package/package.json +1 -1
  67. package/src/__generated__/api/v1.ts +0 -9
  68. package/src/constants/serverRequirements.ts +32 -0
  69. package/src/projects/assignProjectAnnotationConfig.ts +78 -0
  70. package/src/projects/index.ts +8 -0
  71. package/src/projects/listProjectAnnotationConfigs.ts +85 -0
  72. package/src/projects/setProjectAnnotationConfigs.ts +86 -0
  73. package/src/projects/unassignProjectAnnotationConfig.ts +71 -0
  74. package/src/types/annotationConfigs.ts +37 -0
@@ -0,0 +1,35 @@
1
+ import type { components } from "../__generated__/api/v1.js";
2
+ /**
3
+ * An annotation configuration as returned by the Phoenix REST API.
4
+ */
5
+ export type AnnotationConfig = components["schemas"]["CategoricalAnnotationConfig"] | components["schemas"]["ContinuousAnnotationConfig"] | components["schemas"]["FreeformAnnotationConfig"];
6
+ /**
7
+ * Identifies an annotation configuration. Accepts any of:
8
+ * - `config` — an annotation config ID or name (the server accepts either)
9
+ * - `configId` — an explicit annotation config ID
10
+ * - `configName` — an explicit annotation config name
11
+ *
12
+ * Exactly one of these may be given. All three are sent to the server as the
13
+ * same `config_identifier`, which is tried as a GlobalID before a name. Prefer
14
+ * `configId` when a name may contain `/`, which the server cannot route in a
15
+ * path parameter.
16
+ */
17
+ export type AnnotationConfigIdentifier = {
18
+ config: string;
19
+ configId?: never;
20
+ configName?: never;
21
+ } | {
22
+ configId: string;
23
+ config?: never;
24
+ configName?: never;
25
+ } | {
26
+ configName: string;
27
+ config?: never;
28
+ configId?: never;
29
+ };
30
+ /**
31
+ * Resolves an {@link AnnotationConfigIdentifier} union to a plain string
32
+ * suitable for the REST `config_identifier` path parameter.
33
+ */
34
+ export declare function resolveAnnotationConfigIdentifier(identifier: AnnotationConfigIdentifier): string;
35
+ //# sourceMappingURL=annotationConfigs.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"annotationConfigs.d.ts","sourceRoot":"","sources":["../../../src/types/annotationConfigs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB,UAAU,CAAC,SAAS,CAAC,CAAC,6BAA6B,CAAC,GACpD,UAAU,CAAC,SAAS,CAAC,CAAC,4BAA4B,CAAC,GACnD,UAAU,CAAC,SAAS,CAAC,CAAC,0BAA0B,CAAC,CAAC;AAEtD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,0BAA0B,GAClC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,KAAK,CAAC;IAAC,UAAU,CAAC,EAAE,KAAK,CAAA;CAAE,GACxD;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,KAAK,CAAC;IAAC,UAAU,CAAC,EAAE,KAAK,CAAA;CAAE,GACxD;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC;AAE7D;;;GAGG;AACH,wBAAgB,iCAAiC,CAC/C,UAAU,EAAE,0BAA0B,GACrC,MAAM,CAIR"}
@@ -0,0 +1,12 @@
1
+ /**
2
+ * Resolves an {@link AnnotationConfigIdentifier} union to a plain string
3
+ * suitable for the REST `config_identifier` path parameter.
4
+ */
5
+ export function resolveAnnotationConfigIdentifier(identifier) {
6
+ if (identifier.config !== undefined)
7
+ return identifier.config;
8
+ if (identifier.configId !== undefined)
9
+ return identifier.configId;
10
+ return identifier.configName;
11
+ }
12
+ //# sourceMappingURL=annotationConfigs.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"annotationConfigs.js","sourceRoot":"","sources":["../../../src/types/annotationConfigs.ts"],"names":[],"mappings":"AA0BA;;;GAGG;AACH,MAAM,UAAU,iCAAiC,CAC/C,UAAsC;IAEtC,IAAI,UAAU,CAAC,MAAM,KAAK,SAAS;QAAE,OAAO,UAAU,CAAC,MAAM,CAAC;IAC9D,IAAI,UAAU,CAAC,QAAQ,KAAK,SAAS;QAAE,OAAO,UAAU,CAAC,QAAQ,CAAC;IAClE,OAAO,UAAU,CAAC,UAAU,CAAC;AAC/B,CAAC"}
@@ -3333,11 +3333,6 @@ 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;
3341
3336
  /**
3342
3337
  * Repetitions
3343
3338
  * @description Number of times the experiment is repeated
@@ -9387,10 +9382,6 @@ export interface operations {
9387
9382
  cursor?: string | null;
9388
9383
  /** @description The max number of experiments to return at a time. */
9389
9384
  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;
9394
9385
  };
9395
9386
  header?: never;
9396
9387
  path: {