Skip to content

agentic.Run

Page status: scaffold Source state: generated Applies to: Shepherd v1.0-dev Owner: @docs-system-owner (TBD) Validation: scripts/gen_shepherd_api_inventory.py --check

This is reference — exact, generated facts. The mental model lives in concepts; recipes live in guides.

Pre-rename surface

Generated from the internal agentic facade; names and paths change at the Shepherd rename.

class

Run dataclass

Bases: Generic[T]

Inspectable task run result used by detailed calls.

artifacts instance-attribute

artifacts: tuple[object, ...]

duration instance-attribute

duration: float

effects instance-attribute

effects: tuple[object, ...]

outcome instance-attribute

outcome: Finished[T] | Exhausted | Stopped | Failed

ref instance-attribute

ref: RunRef | None

trace instance-attribute

trace: Trace | None

usage instance-attribute

usage: object | None

__init__

__init__(
    outcome: Finished[T] | Exhausted | Stopped | Failed,
    effects: tuple[object, ...],
    artifacts: tuple[object, ...],
    usage: object | None,
    duration: float,
    trace: Trace | None,
    ref: RunRef | None,
) -> None

unwrap

unwrap() -> T

See also