The
datasets functions are currently in BETA. The API may change without notice. A one-time warning is emitted on first use.List Datasets
import { listDatasets } from "@arizeai/ax-client";
const datasets = await listDatasets({
space: "my-space", // space name or ID (optional)
limit: 10,
});
Create a Dataset
import { createDataset } from "@arizeai/ax-client";
const dataset = await createDataset({
space: "my-space", // space name or ID
name: "your_dataset_name",
examples: [{ question: "What is 2+2?", answer: "4", topic: "math" }],
});
Get a Dataset
import { getDataset } from "@arizeai/ax-client";
// By ID
const dataset = await getDataset({ dataset: "your_dataset_id" });
// By name (requires space)
const dataset = await getDataset({ dataset: "my-dataset", space: "my-space" });
Delete a Dataset
import { deleteDataset } from "@arizeai/ax-client";
// By ID
await deleteDataset({ dataset: "your_dataset_id" });
// By name (requires space)
await deleteDataset({ dataset: "my-dataset", space: "my-space" });
List Dataset Examples
import { listDatasetExamples } from "@arizeai/ax-client";
const examples = await listDatasetExamples({
dataset: "your_dataset_id",
datasetVersionId: "your_dataset_version_id", // optional
limit: 10,
});
Append Examples
import { appendExamples } from "@arizeai/ax-client";
const dataset = await appendExamples({
dataset: "my-dataset", // dataset name or ID
space: "my-space", // required when dataset is a name
examples: [
{ question: "What is 3+3?", answer: "6", topic: "math" },
],
});
Update Dataset Examples
import { updateExamples } from "@arizeai/ax-client";
const dataset = await updateExamples({
dataset: "my-dataset", // dataset name or ID
space: "my-space", // required when dataset is a name
examples: [
{
id: "your_example_id",
question: "What is 2+2?",
answer: "4",
topic: "math",
},
],
newVersionName: "v2", // optional: create a new version instead of updating in place
});