Skip to content

Commit 4f47e7c

Browse files
docs: update validation usage examples and API key description in README
1 parent b6b9149 commit 4f47e7c

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -162,9 +162,9 @@ Full docs at **[altimate.ai](https://altimate.ai)**.
162162
The `/validate` skill lets you audit past AI agent sessions against a set of quality criteria — checking whether the agent's reasoning, tool calls, and final response were correct, grounded, and complete. It pulls conversation traces from the backend, runs them through an evaluation pipeline, and reports per-criterion pass/fail results with details.
163163
164164
You can validate:
165-
- **A single trace**: `/validate <trace_id>`
166-
- **All traces in a session**: `/validate --session-id <session_id>`
167-
- **A date range for a user**: `/validate --from <datetime> --to <datetime> --user-id <user_id>`
165+
- **A single trace**: `/validate <trace_id> or /validate the trace <trace-id>`
166+
- **All traces in a session**: `/validate --session-id <session_id> or /validate all the traces in session id <session-id>`
167+
- **A date range for a user**: `/validate --from <datetime> --to <datetime> --user-id <user_id> or /validate for user id <user id> for <relative duration>/ from <start date time> to <end date time>`
168168
169169
### Setup
170170
@@ -174,7 +174,7 @@ You can validate:
174174
altimate-code validate configure --api-key <your-key>
175175
```
176176
177-
This registers your key with the Altimate validation server and saves it to `~/.altimate-code/settings.json`. The `/validate` skill reads credentials from that file when running evaluations.
177+
The api key is got from your altimate account API KEY.
178178
179179
**2. That's it** — the skill files are installed automatically the next time you start `altimate-code`.
180180

0 commit comments

Comments
 (0)