arize-dataset
Original:🇺🇸 English
Translated
INVOKE THIS SKILL when creating, managing, or querying Arize datasets and examples. Covers dataset CRUD, appending examples, exporting data, and file-based dataset creation using the ax CLI.
26installs
Sourcearize-ai/arize-skills
Added on
NPX Install
npx skill4agent add arize-ai/arize-skills arize-datasetTags
Translated version includes tags in frontmatterSKILL.md Content
View Translation Comparison →Arize Dataset Skill
Concepts
- Dataset = a versioned collection of examples used for evaluation and experimentation
- Dataset Version = a snapshot of a dataset at a point in time; updates can be in-place or create a new version
- Example = a single record in a dataset with arbitrary user-defined fields (e.g., ,
question,answer)context - Space = an organizational container; datasets belong to a space
System-managed fields on examples (, , ) are auto-generated by the server -- never include them in create or append payloads.
idcreated_atupdated_atPrerequisites
Three things are needed: CLI, an API key (env var or profile), and a space ID. A project name is also needed but usually comes from the user's message.
axInstall ax
Verify is installed and working before proceeding:
ax- Check if is on PATH:
ax(Unix) orcommand -v ax(Windows)where ax - If not found, check common install locations:
- macOS/Linux:
test -x ~/.local/bin/ax && export PATH="$HOME/.local/bin:$PATH" - Windows: check or
%APPDATA%\Python\Scripts\ax.exe%LOCALAPPDATA%\Programs\Python\Scripts\ax.exe
- macOS/Linux:
- If still not found, install it (requires shell access to install packages):
- Preferred:
uv tool install arize-ax-cli - Alternative:
pipx install arize-ax-cli - Fallback:
pip install arize-ax-cli
- Preferred:
- After install, if is not on PATH:
ax- macOS/Linux:
export PATH="$HOME/.local/bin:$PATH" - Windows (PowerShell):
$env:PATH = "$env:APPDATA\Python\Scripts;$env:PATH"
- macOS/Linux:
- If fails with an SSL/certificate error:
ax --version- macOS:
export SSL_CERT_FILE=/etc/ssl/cert.pem - Linux:
export SSL_CERT_FILE=/etc/ssl/certs/ca-certificates.crt - Windows (PowerShell): (or use
$env:SSL_CERT_FILE = "C:\Program Files\Common Files\SSL\cert.pem"to find the cert bundle)python -c "import certifi; print(certifi.where())"
- macOS:
- must succeed before proceeding. If it doesn't, stop and ask the user for help.
ax --version
Verify environment
Run a quick check for credentials:
macOS/Linux (bash):
bash
ax --version && echo "--- env ---" && echo "ARIZE_API_KEY: ${ARIZE_API_KEY:-(not set)}" && echo "ARIZE_SPACE_ID: ${ARIZE_SPACE_ID:-(not set)}" && echo "--- profiles ---" && ax profiles show 2>&1Windows (PowerShell):
powershell
ax --version; Write-Host "--- env ---"; Write-Host "ARIZE_API_KEY: $env:ARIZE_API_KEY"; Write-Host "ARIZE_SPACE_ID: $env:ARIZE_SPACE_ID"; Write-Host "--- profiles ---"; ax profiles show 2>&1Read the output and proceed immediately if either the env var or the profile has an API key. Only ask the user if both are missing. Resolve failures:
- No API key in env and no profile → AskQuestion: "Arize API key (https://app.arize.com/admin > API Keys)"
- Space ID unknown → AskQuestion, or run and search for a match
ax projects list -o json --limit 100 - Project unclear → ask, or run and present as selectable options
ax projects list -o json --limit 100
Space ID and Project
Both are needed for most commands. Resolve each:
- User provides it in the conversation -- use directly via /
--space-idflags.--project - Env var is set (,
ARIZE_SPACE_ID) -- use silently.ARIZE_DEFAULT_PROJECT - If missing, AskQuestion once. Tell the user:
- Space ID is in the Arize URL:
/spaces/{SPACE_ID}/... - Project is the project name as shown in the Arize UI.
- For convenience, recommend setting env vars so they don't get asked again:
and
export ARIZE_SPACE_ID="U3BhY2U6..."export ARIZE_DEFAULT_PROJECT="my-project"
- Space ID is in the Arize URL:
Prefer asking the user over searching or iterating through projects and API keys.
If you get a , tell the user their API key may not have access to
that space and ask them to verify.
401 UnauthorizedList Datasets: ax datasets list
ax datasets listBrowse datasets in a space. Output goes to stdout.
bash
ax datasets list
ax datasets list --space-id SPACE_ID --limit 20
ax datasets list --cursor CURSOR_TOKEN
ax datasets list -o jsonFlags
| Flag | Type | Default | Description |
|---|---|---|---|
| string | from profile | Filter by space |
| int | 15 | Max results (1-100) |
| string | none | Pagination cursor from previous response |
| string | table | Output format: table, json, csv, parquet, or file path |
| string | default | Configuration profile |
Get Dataset: ax datasets get
ax datasets getQuick metadata lookup -- returns dataset name, space, timestamps, and version list.
bash
ax datasets get DATASET_ID
ax datasets get DATASET_ID -o jsonFlags
| Flag | Type | Default | Description |
|---|---|---|---|
| string | required | Positional argument |
| string | table | Output format |
| string | default | Configuration profile |
Response fields
| Field | Type | Description |
|---|---|---|
| string | Dataset ID |
| string | Dataset name |
| string | Space this dataset belongs to |
| datetime | When the dataset was created |
| datetime | Last modification time |
| array | List of dataset versions (id, name, dataset_id, created_at, updated_at) |
Export Dataset: ax datasets export
ax datasets exportDownload all examples to a file. By default uses the REST API; pass to use Arrow Flight for bulk transfer.
--allbash
ax datasets export DATASET_ID
# -> dataset_abc123_20260305_141500/examples.json
ax datasets export DATASET_ID --all
ax datasets export DATASET_ID --version-id VERSION_ID
ax datasets export DATASET_ID --output-dir ./data
ax datasets export DATASET_ID --stdout
ax datasets export DATASET_ID --stdout | jq '.[0]'Flags
| Flag | Type | Default | Description |
|---|---|---|---|
| string | required | Positional argument |
| string | latest | Export a specific dataset version |
| bool | false | Use Arrow Flight for bulk export (see below) |
| string | | Output directory |
| bool | false | Print JSON to stdout instead of file |
| string | default | Configuration profile |
REST vs Flight (--all
)
--all- REST (default): Lower friction -- no Arrow/Flight dependency, standard HTTPS ports, works through any corporate proxy or firewall. Limited to 500 examples per page.
- Flight (): Required for datasets with more than 500 examples. Uses gRPC+TLS on a separate host/port (
--all) which some corporate networks may block.flight.arize.com:443
Agent auto-escalation rule: If a REST export returns exactly 500 examples, the result is likely truncated. Re-run with to get the full dataset.
--allOutput is a JSON array of example objects. Each example has system fields (, , ) plus all user-defined fields:
idcreated_atupdated_atjson
[
{
"id": "ex_001",
"created_at": "2026-01-15T10:00:00Z",
"updated_at": "2026-01-15T10:00:00Z",
"question": "What is 2+2?",
"answer": "4",
"topic": "math"
}
]Create Dataset: ax datasets create
ax datasets createCreate a new dataset from a data file.
bash
ax datasets create --name "My Dataset" --space-id SPACE_ID --file data.csv
ax datasets create --name "My Dataset" --space-id SPACE_ID --file data.json
ax datasets create --name "My Dataset" --space-id SPACE_ID --file data.jsonl
ax datasets create --name "My Dataset" --space-id SPACE_ID --file data.parquetFlags
| Flag | Type | Required | Description |
|---|---|---|---|
| string | yes (prompted) | Dataset name |
| string | yes (prompted) | Space to create the dataset in |
| path | yes (prompted) | Data file: CSV, JSON, JSONL, or Parquet |
| string | no | Output format for the returned dataset metadata |
| string | no | Configuration profile |
Supported file formats
| Format | Extension | Notes |
|---|---|---|
| CSV | | Column headers become field names |
| JSON | | Array of objects |
| JSON Lines | | One object per line |
| Parquet | | Column names become field names |
Append Examples: ax datasets append
ax datasets appendAdd examples to an existing dataset. Two input modes -- use whichever fits.
Inline JSON (agent-friendly)
Generate the payload directly -- no temp files needed:
bash
ax datasets append DATASET_ID --json '[{"question": "What is 2+2?", "answer": "4"}]'
ax datasets append DATASET_ID --json '[
{"question": "What is gravity?", "answer": "A fundamental force..."},
{"question": "What is light?", "answer": "Electromagnetic radiation..."}
]'From a file
bash
ax datasets append DATASET_ID --file new_examples.csv
ax datasets append DATASET_ID --file additions.jsonTo a specific version
bash
ax datasets append DATASET_ID --json '[{"q": "..."}]' --version-id VERSION_IDFlags
| Flag | Type | Required | Description |
|---|---|---|---|
| string | yes | Positional argument |
| string | mutex | JSON array of example objects |
| path | mutex | Data file (CSV, JSON, JSONL, Parquet) |
| string | no | Append to a specific version (default: latest) |
| string | no | Output format for the returned dataset metadata |
| string | no | Configuration profile |
Exactly one of or is required.
--json--fileValidation
- Each example must be a JSON object with at least one user-defined field
- Fields ,
id,created_atare auto-generated -- do not include themupdated_at - Maximum 100,000 examples per request
Delete Dataset: ax datasets delete
ax datasets deletebash
ax datasets delete DATASET_ID
ax datasets delete DATASET_ID --force # skip confirmation promptFlags
| Flag | Type | Default | Description |
|---|---|---|---|
| string | required | Positional argument |
| bool | false | Skip confirmation prompt |
| string | default | Configuration profile |
Workflows
Create a dataset from file for evaluation
- Prepare a CSV/JSON/Parquet file with your evaluation columns (e.g., ,
input)expected_output ax datasets create --name "eval-set-v1" --space-id SPACE_ID --file eval_data.csv- Verify:
ax datasets get DATASET_ID - Use the dataset ID to run experiments
Add examples to an existing dataset
bash
# Find the dataset
ax datasets list
# Append inline (e.g., from an LLM-generated payload)
ax datasets append DATASET_ID --json '[
{"question": "What is gravity?", "answer": "A fundamental force..."},
{"question": "What is light?", "answer": "Electromagnetic radiation..."}
]'
# Or append from a file
ax datasets append DATASET_ID --file additional_examples.csvDownload dataset for offline analysis
- -- find the dataset
ax datasets list - -- download to file
ax datasets export DATASET_ID - Parse the JSON:
jq '.[] | .question' dataset_*/examples.json
Export a specific version
bash
# List versions
ax datasets get DATASET_ID -o json | jq '.versions'
# Export that version
ax datasets export DATASET_ID --version-id VERSION_IDIterate on a dataset
- Export current version:
ax datasets export DATASET_ID - Modify the examples locally
- Append new rows:
ax datasets append DATASET_ID --file new_rows.csv - Or create a fresh version:
ax datasets create --name "eval-set-v2" --space-id SPACE_ID --file updated_data.json
Pipe export to other tools
bash
# Count examples
ax datasets export DATASET_ID --stdout | jq 'length'
# Extract a single field
ax datasets export DATASET_ID --stdout | jq '.[].question'
# Convert to CSV with jq
ax datasets export DATASET_ID --stdout | jq -r '.[] | [.question, .answer] | @csv'Dataset Example Schema
Examples are free-form JSON objects. There is no fixed schema -- columns are whatever fields you provide. System-managed fields are added by the server:
| Field | Type | Managed by | Notes |
|---|---|---|---|
| string | server | Auto-generated UUID. Required on update, forbidden on create/append |
| datetime | server | Immutable creation timestamp |
| datetime | server | Auto-updated on modification |
| (any user field) | any JSON type | user | String, number, boolean, null, nested object, array |
Troubleshooting
| Problem | Solution |
|---|---|
| Check |
| API key may not have access to this space. Verify the key and space ID are correct. Keys are scoped per space -- get the right one from https://app.arize.com/admin > API Keys. |
| Run |
| Verify dataset ID with |
| Supported: CSV, JSON, JSONL, Parquet |
| Remove |
| Remove |
| Append requires exactly one input source |
| Ensure your JSON array or file contains at least one example |
| Each element in the |
Save Credentials for Future Use
At the end of the session, if the user manually provided any of the following during this conversation (via AskQuestion response, pasted text, or inline values) and those values were NOT already loaded from a saved profile or environment variable, offer to save them for future use.
| Credential | Where it gets saved |
|---|---|
| API key | |
| Space ID | macOS/Linux: shell config ( |
Skip this entirely if:
- The API key was already loaded from an existing profile or env var
ARIZE_API_KEY - The space ID was already set via env var
ARIZE_SPACE_ID - The user only used base64 project IDs (no space ID was needed)
How to offer: Use AskQuestion: "Would you like to save your Arize credentials so you don't have to enter them next time?" with options / .
"Yes, save them""No thanks"If the user says yes:
-
API key — Check ifexists. If it does, read it and update the
~/.arize/config.tomlsection. If not, create it with this minimal content:[auth]toml[profile] name = "default" [auth] api_key = "THE_API_KEY" [output] format = "table"Verify with:ax profiles show -
Space ID — Persist the space ID as an environment variable:macOS/Linux — Detect the user's shell config file (for zsh,
~/.zshrcfor bash). Append:~/.bashrcbashexport ARIZE_SPACE_ID="THE_SPACE_ID"Tell the user to run(or restart their terminal) for it to take effect.source ~/.zshrcWindows (PowerShell) — Set a persistent user environment variable:powershell[System.Environment]::SetEnvironmentVariable('ARIZE_SPACE_ID', 'THE_SPACE_ID', 'User')Tell the user to restart their terminal for it to take effect.