document session traces format#2613
Merged
Merged
Conversation
julien-c
requested review from
cfahlgren1,
davanstrien,
gary149,
mishig25 and
pcuenca
July 1, 2026 16:37
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
Member
Author
|
live doc page: https://huggingface.co/docs/hub/session-traces-format |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
add a page describing the session traces format (STS-Format) so harness authors can make their sessions render in the trace viewer
link it from the end of the Agents section and add a callout on the Agent Traces page
disclaimer: my julien-cto agent helped me write this
Note
Low Risk
Documentation-only changes with no runtime, API, or security impact.
Overview
Adds Session Traces Format documentation so custom agent harness authors can emit JSONL sessions that render in the Hub trace viewer.
The new page defines STS-Format: a first-line session header (
type,harness,id, optional metadata) followed bymessageenvelopes with roles, content, tool calls, and tool results. It notes howharnessdrives viewer branding, lists recognized harness ids, and points to Pi’s native format as an alternative with aharnessfield on the header.Navigation is wired by adding the page to the Agents section in
_toctree.yml, and Agent Traces gets a tip linking harness builders to this spec.Reviewed by Cursor Bugbot for commit 9d14846. Bugbot is set up for automated code reviews on this repo. Configure here.