Skip to main content
Datasets are the foundation for experiment runs. The dataset helpers cover creation, idempotent creation, record inspection, and example appends.

​
Relevant Source Files

  • src/datasets/createOrGetDataset.ts for the exact return shape of the idempotent helper

​
Create A Dataset

import { createDataset } from "@arizeai/phoenix-client/datasets";

const { datasetId } = await createDataset({
  name: "support-eval",
  description: "Support questions with expected answers",
  examples: [
    {
      input: { question: "Where is my order?" },
      output: { answer: "Use the tracking page in your account." },
      metadata: { channel: "chat" },
    },
  ],
});

​
Reuse Or Append

import {
  appendDatasetExamples,
  createOrGetDataset,
} from "@arizeai/phoenix-client/datasets";

const dataset = await createOrGetDataset({
  name: "support-eval",
  description: "Support questions with expected answers",
  examples: [],
});

await appendDatasetExamples({
  dataset,
  examples: [
    {
      input: { question: "How do I reset my password?" },
      output: { answer: "Use the forgot password flow." },
    },
  ],
});
createOrGetDataset() returns { datasetId }, so you can pass that object directly as the dataset selector for append or experiment calls.

​
Read Back Dataset State

Use getDataset, getDatasetExamples, and getDatasetInfo to inspect datasets after creation.

​
Source Map

  • src/datasets/createDataset.ts
  • src/datasets/createOrGetDataset.ts
  • src/datasets/appendDatasetExamples.ts
  • src/datasets/getDataset.ts
  • src/datasets/getDatasetExamples.ts
  • src/datasets/getDatasetInfo.ts