Circle V2 API Docs
    Preparing search index...

    Type Alias ExtendFormDetectionRun

    type ExtendFormDetectionRun = {
        conditionalRules: ExtendConditionalRules;
        credits: number | null;
        engineVersion: string | null;
        fileId: string | null;
        fileName: string | null;
        nativeFieldsOnly: boolean | null;
        properties: ExtendDetectedProperty[];
        runId: string;
        status: ExtendFormDetectionStatus;
    }
    Index

    Properties

    conditionalRules credits engineVersion fileId fileName nativeFieldsOnly properties runId status

    Properties

    conditionalRules: ExtendConditionalRules

    PROPOSALS ONLY: these may be normalized and shown for review, but nothing may store or apply one without an explicit human accept. The generator measurably hallucinates.

    credits: number | null

    null while the run is still processing.

    engineVersion: string | null

    What actually ran, as opposed to the pinned ENGINE_VERSION we asked for.

    fileId: string | null

    The handle a caller needs to delete the upload once the run settles.

    fileName: string | null
    nativeFieldsOnly: boolean | null

    true means the boxes came off the PDF's own widgets; false means they were detected on a flat page. null when the vendor sent no config — consumers must fail closed and adjust nothing unless the run positively says the boxes were detected flat.

    properties: ExtendDetectedProperty[]

    Populated only once status is PROCESSED.

    runId: string
    status: ExtendFormDetectionStatus

    Settings

    Member Visibility

    On This Page

    Properties