Circle V2 API Docs
    Preparing search index...

    Class SelectRelevantDocumentsPrompt

    Hierarchy

    Index

    Constructors

    constructor

    Properties

    modelOverride? outputSchema snapshot

    Accessors

    promptName

    Methods

    buildModel buildVariables invoke render traceInputs

    Constructors

    Properties

    modelOverride?: PromptModelConfig
    outputSchema: ZodObject<
        {
            documents: ZodArray<
                ZodObject<{ id: ZodString; title: ZodString }, $strip>,
            >;
        },
        $strip,
    > = documentSelectionSchema

    Structured shape the model must return. Stays in code (the hub resolves text + model).

    snapshot: {
        description: string;
        inputVariables: string[];
        model: { model: string; temperature: number };
        name: string;
        tags: string[];
        template: string;
        templateFormat: string;
    } = snapshot

    Committed cold-start snapshot (hub name, template, model).

    Accessors

    • get promptName(): string

      Hub identifier — derived from the committed snapshot.

      Returns string

    Methods

    • Build the ChatOpenAI instance. Default uses override → resolved hub/snapshot model. Tests override this to inject a fake.

      Parameters

      Returns ChatOpenAI

    • Pure: map typed input to the hub template's variables. Unit-testable without an LLM.

      Parameters

      Returns Record<string, unknown>

    • Parameters

      Returns Promise<{ documents: { id: string; title: string }[] }>

    • Resolve + format the prompt text without invoking the model. Useful for inspection, tests, and tooling that only needs the rendered string.

      Parameters

      Returns Promise<string>

    • Optional non-PII trace inputs for the child span.

      Parameters

      Returns Record<string, unknown>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods