Georeferencing API
    Preparing search index...

    Interface MatchResult

    Ranked placements and a non-probabilistic matching outcome. matched means the leading validated score is sufficiently separated from alternatives; ambiguous retains comparable alternatives for host review; not-found means no validated candidate survived, not proof of absence. All outcomes require host policy/UI before control points are changed.

    interface MatchResult {
        bestCandidateId?: string;
        candidates: MatchCandidate[];
        diagnostics: {
            backend: string;
            detector: Detector;
            estimatedMemoryBytes: number;
            initializationMs: number;
            matchingMs: number;
            options: MatchOptions;
            queryFeatures: number;
            referenceFeatures: number;
            rejected: Record<string, number>;
            scoreVersion: string;
            wasmHeapBytes: number;
        };
        referenceSnapshotId: string;
        status: "matched"
        | "ambiguous"
        | "not-found";
    }
    Index
    bestCandidateId? candidates diagnostics referenceSnapshotId status
    bestCandidateId?: string

    Leading placement, including in an ambiguous result; absent when not-found.

    candidates: MatchCandidate[]

    Validated placements sorted by descending score with deterministic ties.

    diagnostics: {
        backend: string;
        detector: Detector;
        estimatedMemoryBytes: number;
        initializationMs: number;
        matchingMs: number;
        options: MatchOptions;
        queryFeatures: number;
        referenceFeatures: number;
        rejected: Record<string, number>;
        scoreVersion: string;
        wasmHeapBytes: number;
    }

    Runtime, configuration, support and resource measurements.

    Type Declaration

    • backend: string

      Pinned backend/build identifier.

    • detector: Detector

      Descriptor detector and appropriate distance metric.

    • estimatedMemoryBytes: number

      Conservative input/descriptor/heap reservation checked before execution.

    • initializationMs: number

      Worker-local backend startup duration; excludes spawning and acquisition.

    • matchingMs: number

      Compute duration after initialization; excludes reference acquisition.

    • options: MatchOptions

      Full effective options, including defaults and request overrides.

    • queryFeatures: number

      Retained spatially deduplicated query features.

    • referenceFeatures: number

      Retained spatially deduplicated reference features.

    • rejected: Record<string, number>

      Counts of rejected hypotheses by validation reason, never selectable.

    • scoreVersion: string

      Ranking formula version for comparison/provenance.

    • wasmHeapBytes: number

      Allocated WASM linear-memory capacity at completion, not JS heap or live bytes.

    referenceSnapshotId: string

    Identity of the immutable snapshot that produced this result.

    status: "matched" | "ambiguous" | "not-found"

    Matched, ambiguous or no validated placement; not-found does not prove absence.

    Settings
    Member Visibility

    On This Page
    Properties