Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion docs/COMMANDS.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ pup <domain> <subgroup> <action> [options] # Nested commands
| data-deletion | requests (list, create, cancel) | src/commands/data_deletion.rs | ✅ |
| data-governance | scanner-rules (list) | src/commands/data_governance.rs | ✅ |
| obs-pipelines | list, get, create, update, diff, delete, validate | src/commands/obs_pipelines.rs | ✅ |
| llm-obs | projects (create, list), experiments (create, list, update, delete, summary, events (list, get, submit), metric-values, dimension-values), datasets (create, list, batch-update, clone, restore, records, records-add, records-all, records-full), spans (search), patterns (configs (list, get), runs (list, status), topics, topics-with-points, points), agent-insights (list, get, update-status, submit-feedback), annotation-queues (create, list, update, delete, interactions (add, delete, list), schema (get, update), annotations (upsert, delete)), model-pricing | src/commands/llm_obs.rs | ✅ |
| llm-obs | projects (create, list), experiments (create, list, update, delete, summary, events (list, get, submit), metric-values, dimension-values), datasets (create, list, batch-update, clone, restore, records, records-add, records-all, records-full), spans (search), patterns (configs (list, get), runs (list, status), topics, topics-with-points, points), agent-insights (list, get, update-status, submit-feedback), annotations (export), annotation-queues (create, list, update, delete, interactions (add, delete, list), schema (get, update), annotations (upsert, delete)), model-pricing | src/commands/llm_obs.rs | ✅ |
| reference-tables | list, get, create, batch-query | src/commands/reference_tables.rs | ✅ |
| network | flows list, devices (list, get, interfaces, tags), interfaces (list, update) | src/commands/network.rs | ✅ |
| cloud | aws, gcp, azure, oci | src/commands/cloud.rs | ✅ |
Expand Down Expand Up @@ -94,6 +94,18 @@ pup <domain> <subgroup> <action> [options] # Nested commands

## Common Patterns

### Export an LLM Observability annotated interaction

Export one annotation together with all event data for its trace, span, experiment trace, or session. `--queue` accepts either the queue ID or its exact name. Without `--out`, the command uses Pup's standard output formatter (JSON by default) and honors global `--output` and `--jq` flags. File exports default to JSON; pass `--format jsonl` for JSONL. Existing files are not replaced unless `--force` is provided.

```bash
pup llm-obs annotations export \
--queue quality-review \
--interaction-id 23851556-a8c7-41c1-be75-03eb665a132f \
--format jsonl \
--out interaction.jsonl
```

### List Operations
```bash
pup <domain> list [--flags]
Expand Down
22 changes: 22 additions & 0 deletions docs/EXAMPLES.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,28 @@ export DD_APP_KEY="your-app-key"
export DD_SITE="datadoghq.com"
```

## LLM Observability

### Export an Annotated Interaction
```bash
# Print the annotation and complete interaction data as JSON
pup llm-obs annotations export \
--queue quality-review \
--interaction-id 23851556-a8c7-41c1-be75-03eb665a132f

# Select part of the standard JSON output
pup --jq '.interaction_data.events' llm-obs annotations export \
--queue 13851556-a8c7-41c1-be75-03eb665a132f \
--interaction-id 23851556-a8c7-41c1-be75-03eb665a132f

# Write JSONL to a file; --force is required to replace an existing file
pup llm-obs annotations export \
--queue quality-review \
--interaction-id 23851556-a8c7-41c1-be75-03eb665a132f \
--out interaction.jsonl \
--format jsonl
```

## Metrics

### List Metrics
Expand Down
Loading