Circle V2 API Docs
    Preparing search index...

    Type Alias ResolvedPrompt

    Resolution result. Carries the runnable template plus the metadata around it (name, the tag it resolved at, which source won, and optional model config). When model is undefined (hub text-only pull, or no model on the snapshot), callers should fall back to their committed snapshot's model.

    prompt is a safe-rendering template (see makeSafePrompt): its format/formatPromptValue try the resolved template and, if rendering throws, log and re-render from the committed snapshot — so a hub prompt promoted with a variable the code cannot supply degrades to last-known-good.

    type ResolvedPrompt = {
        commitHash?: string;
        model?: PromptModelConfig;
        name: string;
        prompt: BasePromptTemplate;
        source: PromptSource;
        tag?: string;
    }
    Index

    Properties

    commitHash? model? name prompt source tag?

    Properties

    commitHash?: string

    The resolved hub commit hash, when known. Reserved for the prompt-version telemetry follow-up — not populated yet (hub pulls do not surface it without an extra call, and the snapshot fallback does not thread it here).

    model?: PromptModelConfig

    Model config from the winning source, when available.

    name: string
    prompt: BasePromptTemplate
    source: PromptSource
    tag?: string

    The promotion tag the prompt resolved at, if any (else floats to latest).

    Settings

    Member Visibility

    On This Page

    Properties