Experiments

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

// By dataset ID
const { data: experiments, pagination } = await listExperiments({
  dataset: "your_dataset_id",
  limit: 10,
});

// By dataset name (requires space)
const result = await listExperiments({
  dataset: "my-dataset",
  space: "my-space",
});
console.log(result.data);

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

// Using dataset ID
const experiment = await createExperiment({
  experimentName: "your_experiment",
  dataset: "your_dataset_id",
  experimentRuns: [{ exampleId: "your_example_id", output: "output" }],
});

// Using dataset name (requires space)
const experiment = await createExperiment({
  experimentName: "your_experiment",
  dataset: "my-dataset",
  space: "my-space",
  experimentRuns: [{ exampleId: "your_example_id", output: "output" }],
});

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

// By experiment ID
const experiment = await getExperiment({ experiment: "your_experiment_id" });

// By experiment name (requires dataset; space is required when dataset is a name)
const experiment = await getExperiment({
  experiment: "my-experiment",
  dataset: "my-dataset",
  space: "my-space",
});

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

// By experiment ID
await deleteExperiment({ experiment: "your_experiment_id" });

// By experiment name (requires dataset; space is required when dataset is a name)
await deleteExperiment({
  experiment: "my-experiment",
  dataset: "my-dataset",
  space: "my-space",
});

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

const { data: experimentRuns, pagination } = await listExperimentRuns({
  experiment: "your_experiment_id",
  limit: 10,
});
console.log(experimentRuns);

// Or resolve by experiment name:
const result = await listExperimentRuns({
  experiment: "my-experiment",
  dataset: "my-dataset",  // optional, used to resolve experiment by name
  space: "my-space",      // optional, used to resolve dataset by name
});
console.log(result.data);

// Paginating through all runs
let cursor: string | undefined;
do {
  const page = await listExperimentRuns({ experiment: "your_experiment_id", cursor });
  console.log(page.data);
  cursor = page.pagination.nextCursor ?? undefined;
} while (cursor);

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

const result = await appendExperimentRuns({
  experiment: "my-experiment",  // experiment name or ID
  dataset: "my-dataset",        // optional, used to resolve experiment by name
  space: "my-space",            // optional, used to resolve dataset by name
  experimentRuns: [
    { exampleId: "your_example_id", output: "The answer is 42" },
  ],
});
console.log(result.runIds); // IDs of the inserted runs

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

await annotateExperimentRuns({
  experiment: "my-experiment",  // experiment name or ID
  dataset: "my-dataset",        // optional, used to resolve experiment by name
  space: "my-space",            // optional, used to resolve dataset by name
  annotations: [
    {
      recordId: "your_run_id",
      values: [
        { name: "accuracy", label: "correct", score: 1.0 },
        { name: "notes", text: "Well-structured output" },
      ],
    },
  ],
});