Circle V2 API Docs
    Preparing search index...

    Type Alias PromptScope

    Per-run overrides for prompt resolution.

    Ambient rather than a parameter: one chart-review run resolves a dozen prompts from agents, prompts, and preprocess steps constructed at many depths, so a tag argument would have to be threaded through every constructor in the hierarchy to serve the one caller that varies it (the superadmin compare bench). The scope propagates through async work instead.

    type PromptScope = {
        snapshotOnly?: boolean;
        tag?: string;
    }
    Index

    Properties

    Properties

    snapshotOnly?: boolean

    Resolve from committed snapshots only, never the hub — the reproducible baseline, since a snapshot is in the repo while a tag moves whenever someone promotes. Wins over tag.

    tag?: string

    Pin hub pulls to this promotion tag instead of the process-wide LANGSMITH_PROMPT_TAG, e.g. run staging prompts from a production deployment.