@arizeai/phoenix-client 7.15.0 → 7.16.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @arizeai/phoenix-client
 
+## 7.16.0
+
+### Minor Changes
+
+- f8ae2fc: Add `listProjectAnnotationConfigs`, `assignProjectAnnotationConfig`, `unassignProjectAnnotationConfig`, and `setProjectAnnotationConfigs` helpers to the `projects` subpath for managing which annotation configs a project uses.
+
 ## 7.15.0
 
 ### Minor Changes

package/README.md

@@ -750,7 +750,7 @@ await addSessionNote({
 
 ## Projects
 
-The `@arizeai/phoenix-client` package provides a `projects` export for listing projects and managing their retention-policy assignments.
+The `@arizeai/phoenix-client` package provides a `projects` export for listing projects and managing their retention-policy and annotation-config assignments.
 
 ### Fetching Projects
 
@@ -797,6 +797,52 @@ await setProjectRetentionPolicy({
 
 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.
 
+### Assigning Annotation Configs
+
+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.
+
+```ts
+import {
+  assignProjectAnnotationConfig,
+  listProjectAnnotationConfigs,
+  setProjectAnnotationConfigs,
+  unassignProjectAnnotationConfig,
+} from "@arizeai/phoenix-client/projects";
+
+await assignProjectAnnotationConfig({
+  projectName: "support-bot",
+  configName: "correctness",
+});
+
+await unassignProjectAnnotationConfig({
+  projectName: "support-bot",
+  configName: "correctness",
+});
+```
+
+Use `setProjectAnnotationConfigs` to replace the whole set by config GlobalID. Pass an empty list to clear every assignment:
+
+```ts
+const configs = await listProjectAnnotationConfigs({
+  projectName: "support-bot",
+});
+
+// Keep only the categorical configs
+await setProjectAnnotationConfigs({
+  projectName: "support-bot",
+  configIds: configs
+    .filter((config) => config.type === "CATEGORICAL")
+    .map((config) => config.id),
+});
+
+await setProjectAnnotationConfigs({
+  projectName: "support-bot",
+  configIds: [],
+});
+```
+
+If a config name contains `/`, select it by `configId` instead. The server can't route a `/` in the URL path.
+
 ## Secrets
 
 Use the `secrets` entrypoint to atomically create, update, or delete encrypted

package/dist/esm/__generated__/api/v1.d.ts

@@ -3333,11 +3333,6 @@ export interface components {
              * @description The description of the experiment
              */
             description: string | null;
-            /**
-             * Sequence Number
-             * @description The 1-based sequence number of the experiment within its dataset, in creation order.
-             */
-            sequence_number: number;
             /**
              * Repetitions
              * @description Number of times the experiment is repeated
@@ -9387,10 +9382,6 @@ export interface operations {
                 cursor?: string | null;
                 /** @description The max number of experiments to return at a time. */
                 limit?: number;
-                /** @description Order by creation: 'desc' (default) returns newest experiments first, 'asc' returns oldest first so the lowest sequence numbers are on the first page. */
-                sort_dir?: "asc" | "desc";
-                /** @description When provided, return only the experiments with these 1-based per-dataset sequence numbers. */
-                sequence_numbers?: number[] | null;
             };
             header?: never;
             path: {