Circle V2 API Docs
    Preparing search index...

    Type Alias DetectedField

    One field a detector suggests for a template. Not a persisted shape: recomputed on every request.

    type DetectedField = {
        boxes: FormFieldBox[];
        confidence: number;
        isExclusive?: boolean;
        key: string;
        label: string;
        labelSource: DetectedLabelSource;
        options?: DetectedFieldOption[];
        source: DetectionSource;
        type: DetectedFieldType;
    }
    Index

    Properties

    boxes confidence isExclusive? key label labelSource options? source type

    Properties

    boxes: FormFieldBox[]

    PDF points, top-left origin, 1-based page.

    confidence: number
    isExclusive?: boolean

    true for a native radio group, absent when the detector cannot say. Absent seeds annotations.is_exclusive as the tri-state null, never false.

    key: string

    Unique within ONE detection result, and nothing more. Extend's is an LLM-generated slug that differs between runs of the same file — never persist it as an id, and never join on it.

    label: string
    labelSource: DetectedLabelSource
    options?: DetectedFieldOption[]

    The choices of a radio/checkbox group; absent for a field that is not one.

    source: DetectionSource
    type: DetectedFieldType

    Settings

    Member Visibility

    On This Page

    Properties