Circle V2 API Docs
    Preparing search index...

    Type Alias FormFieldAnswer

    One field's resolved answer — the unit PR7 persists (incrementally, as fields complete).

    type FormFieldAnswer = {
        checkboxState: CheckboxState | null;
        citations: FormFillingEvidence[];
        confidence: number | null;
        degradations: FormFillingDegradation[];
        error: string | null;
        fieldId: string;
        status: FormFieldStatus;
        subFieldValues: FormSubFieldAnswer[] | null;
        value: string | null;
    }
    Index

    Properties

    checkboxState: CheckboxState | null

    Present for checkbox fields. unknown is what a no_answer checkbox carries.

    citations: FormFillingEvidence[]

    Only citations whose quote was proven present in what the agent was actually shown.

    confidence: number | null
    degradations: FormFillingDegradation[]

    Everything that went wrong short of failing the field. Also aggregated onto the run.

    error: string | null

    The failure, when status is error. Null otherwise.

    fieldId: string
    subFieldValues: FormSubFieldAnswer[] | null

    Present for sub-field fields. An exclusive group resolves to exactly one "true".

    value: string | null

    The v1-compatible persisted string: the text value, "true" / "false" for a checkbox, or null when nothing was answered. Null is deliberate — never the literal string "N/A".