Datasets - Phoenix

Datasets are the foundation for experiment runs. The dataset helpers cover creation (which upserts by name), record inspection, and example appends.

Relevant Source Files

src/datasets/createDataset.ts for the exact return shape and upsert-by-name behavior

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" },
    },
  ],
});

Upsert Or Append

createDataset() upserts by name: re-running it with the same name updates the existing dataset to match the examples you pass, and an unchanged upload is a no-op. To keep existing examples and add more, use appendDatasetExamples() instead of re-running createDataset() with the extra examples.

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

const dataset = 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." },
    },
  ],
});

await appendDatasetExamples({
  dataset,
  examples: [
    {
      input: { question: "How do I reset my password?" },
      output: { answer: "Use the forgot password flow." },
    },
  ],
});

createDataset() 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/appendDatasetExamples.ts
src/datasets/getDataset.ts
src/datasets/getDatasetExamples.ts
src/datasets/getDatasetInfo.ts

⌘I