ChemPal Documentation - v1.6.0
    Preparing search index...

    Interface AstProbeResult

    Result of evaluating a corpus against a parsed search query.

    export interface AstProbeResult {
    query: string;
    isAdvanced: boolean;
    ast: SearchAst;
    /** One-line rendering of {@link ast}, e.g. `(sodium AND NOT borohydride)`. */
    astText: string;
    corpusSize: number;
    scorer: FuzzScorerName;
    threshold: number;
    fuzzyWords: boolean;
    /** Titles satisfying the predicate, ranked by score descending. */
    matched: ScoredEntry[];
    /** Titles the predicate rejected, each with the phrase(s) that weren't present. */
    dropped: DroppedEntry[];
    /** Titles whose survival flips with `fuzzyWords`. Empty when `compareFuzzyWords` is false. */
    fuzzyWordsDelta: Array<CorpusEntry & { onlyWith: 'fuzzyWords' | 'exact' }>;
    }
    interface AstProbeResult {
        query: string;
        isAdvanced: boolean;
        ast: SearchAst;
        astText: string;
        corpusSize: number;
        scorer:
            | "ratio"
            | "partial_ratio"
            | "token_sort_ratio"
            | "token_set_ratio"
            | "token_similarity_sort_ratio"
            | "partial_token_sort_ratio"
            | "partial_token_set_ratio"
            | "partial_token_similarity_sort_ratio"
            | "WRatio";
        threshold: number;
        fuzzyWords: boolean;
        matched: ScoredEntry[];
        dropped: DroppedEntry[];
        fuzzyWordsDelta: (CorpusEntry & { onlyWith: "fuzzyWords" | "exact" })[];
    }
    Index

    Properties

    query: string
    isAdvanced: boolean
    astText: string

    One-line rendering of ast, e.g. (sodium AND NOT borohydride).

    corpusSize: number
    scorer:
        | "ratio"
        | "partial_ratio"
        | "token_sort_ratio"
        | "token_set_ratio"
        | "token_similarity_sort_ratio"
        | "partial_token_sort_ratio"
        | "partial_token_set_ratio"
        | "partial_token_similarity_sort_ratio"
        | "WRatio"
    threshold: number
    fuzzyWords: boolean
    matched: ScoredEntry[]

    Titles satisfying the predicate, ranked by score descending.

    dropped: DroppedEntry[]

    Titles the predicate rejected, each with the phrase(s) that weren't present.

    fuzzyWordsDelta: (CorpusEntry & { onlyWith: "fuzzyWords" | "exact" })[]

    Titles whose survival flips with fuzzyWords. Empty when compareFuzzyWords is false.