Circle V2 API Docs
    Preparing search index...

    Hierarchy

    Index

    Constructors

    Properties

    runnerName: "chart-review.audit-run-summary"

    Stable, human-readable name for the runner. Must be set explicitly on each subclass so we don't break the logger and trace span names when minified.

    Accessors

    • get logger(): BaseLogger

      Returns BaseLogger

    • get name(): string

      Returns string

    Methods

    • Primary entry point for the runner. Subclass must implement this method to provide the runner's logic. The optional ctx carries cross-cutting concerns (cancellation via ctx.signal, request/user identity); simple runners may ignore it.

      Parameters

      Returns Promise<{ summary: string }>

    • Add a component's token usage to this run's total, surfaced as RunnerRun.usage. Call it for every agent / prompt the runner invokes; anything not recorded is invisible to cost reporting.

      Parameters

      Returns void

    • Parameters

      Returns Promise<RunnerRun<{ summary: string }>>

    • Optional hook for subclasses to record the root LangSmith span's INPUTS — what was asked, rather than the metadata facets you filter runs by.

      Returns {} by default, which is what every runner recorded before this hook existed: a root span you had to open a child span to understand. Unlike traceMetadata this is the place free text legitimately belongs, so only override it on surfaces where the payload is acceptable in the trace, and keep it to what a human reading the run needs.

      Parameters

      Returns Record<string, unknown>

    • Optional hook for subclasses to attach non-PII metadata to the root LangSmith span. Merged on top of the auto-extracted metadata and ctx.metadata Safe by default: returns {} when not overridden. Never include emails, names, dob, free-text, etc.

      Parameters

      Returns Record<string, unknown>