Annotation Configs

import { listAnnotationConfigs } from "@arizeai/ax-client";

const { data: annotationConfigs, pagination } = await listAnnotationConfigs({
  space: "my-space",   // space name or ID (optional)
  name: "accuracy",    // substring filter on annotation config name (optional)
  limit: 10,
});

import { createContinuousAnnotationConfig } from "@arizeai/ax-client";

const annotationConfig = await createContinuousAnnotationConfig({
  name: "quality-score",
  space: "my-space",  // space name or ID
  minimumScore: 0,
  maximumScore: 1,
  optimizationDirection: "MAXIMIZE",  // optional
});

import { createCategoricalAnnotationConfig } from "@arizeai/ax-client";

const annotationConfig = await createCategoricalAnnotationConfig({
  name: "correctness",
  space: "my-space",  // space name or ID
  values: [
    { label: "correct", score: 1 },
    { label: "incorrect", score: 0 },
  ],
  optimizationDirection: "MAXIMIZE",  // optional
});

import { createFreeformAnnotationConfig } from "@arizeai/ax-client";

const annotationConfig = await createFreeformAnnotationConfig({
  name: "reviewer-notes",
  space: "my-space",  // space name or ID
});

import { getAnnotationConfig } from "@arizeai/ax-client";

// By ID
const annotationConfig = await getAnnotationConfig({
  annotationConfig: "your_annotation_config_id",
});

// By name (requires space)
const annotationConfig = await getAnnotationConfig({
  annotationConfig: "Accuracy",
  space: "my-space",
});

import { updateContinuousAnnotationConfig } from "@arizeai/ax-client";

const annotationConfig = await updateContinuousAnnotationConfig({
  annotationConfig: "quality-score",  // annotation config name or ID
  space: "my-space",                  // required when annotationConfig is a name
  name: "quality-score-v2",           // optional new name
  minimumScore: 0,                    // optional
  maximumScore: 10,                   // optional
  optimizationDirection: "MAXIMIZE",  // optional
});

import { updateCategoricalAnnotationConfig } from "@arizeai/ax-client";

const annotationConfig = await updateCategoricalAnnotationConfig({
  annotationConfig: "correctness",  // annotation config name or ID
  space: "my-space",                // required when annotationConfig is a name
  name: "correctness-v2",           // optional
  values: [                         // optional full replacement
    { label: "correct", score: 1 },
    { label: "incorrect", score: 0 },
  ],
  optimizationDirection: "MAXIMIZE",  // optional
});

import { updateFreeformAnnotationConfig } from "@arizeai/ax-client";

const annotationConfig = await updateFreeformAnnotationConfig({
  annotationConfig: "reviewer-notes",  // annotation config name or ID
  space: "my-space",                   // required when annotationConfig is a name
  name: "reviewer-notes-v2",           // optional new name
});

import { deleteAnnotationConfig } from "@arizeai/ax-client";

// By ID
await deleteAnnotationConfig({
  annotationConfig: "your_annotation_config_id",
});

// By name (requires space)
await deleteAnnotationConfig({
  annotationConfig: "Accuracy",
  space: "my-space",
});