Circle V2 API Docs
    Preparing search index...

    Type Alias FormFillingAgentInput

    What the agent needs to answer exactly one field. The runner resolves all of it per field.

    type FormFillingAgentInput = {
        chartToolsAvailable: boolean;
        currentDate: string;
        exclusiveOptions: string[] | null;
        field: FormFieldWorkItem;
        formPurpose: string | null;
        lengthRetry?: { characterBudget: number; previousLength: number };
        listPositions?: string[] | null;
        mustSearchFirst?: boolean;
        patientBlock: string;
        question: string;
        sessionNotes: readonly FormFillingSessionNote[];
        toolContext: FormFillingToolContext;
    }
    Index

    Properties

    chartToolsAvailable currentDate exclusiveOptions field formPurpose lengthRetry? listPositions? mustSearchFirst? patientBlock question sessionNotes toolContext

    Properties

    chartToolsAvailable: boolean

    False when the run selected no documents and no EMR: the chart tools are then withheld and the model told so.

    currentDate: string

    Pre-rendered current date, so the model never does calendar arithmetic.

    exclusiveOptions: string[] | null

    Option names when the field is a mutually-exclusive group, else null.

    field: FormFieldWorkItem
    formPurpose: string | null

    The form's forms.context. Injected on EVERY path; v1 only injected it on the batched one.

    lengthRetry?: { characterBudget: number; previousLength: number }

    Set on the re-ask after a first answer ran past its box: how long it was and what the box holds.

    listPositions?: string[] | null

    One qualifier per box when the field is answered as a single ordered list, else null/absent.

    mustSearchFirst?: boolean
    patientBlock: string

    Pre-rendered patient block (name, dob, admission) — the demographics forms keep asking for.

    question: string

    The question as the model should see it — the field's prompt, with the exclusivity instruction stripped when the group is modelled structurally instead.

    sessionNotes: readonly FormFillingSessionNote[]

    The run's session notes, inlined whole into the user turn as citable evidence. Empty when none were selected.

    toolContext: FormFillingToolContext

    Settings

    Member Visibility

    On This Page

    Properties