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

    Interface FuzzProbeOptions

    Options for fuzzTest / scoreCorpus.

    export interface FuzzProbeOptions {
    /** Which caches to draw titles from: `"cache"`, `"results"`, or `"both"`. Default `"both"`. */
    source?: CorpusSourceOption;
    /** Rows to show/return per scorer. `0` or `Infinity` means all. Default 15. */
    limit?: number;
    /** Drop titles whose best score across the active scorers is under this. Default 0. */
    minScore?: number;
    /** One or more suppliers to narrow to; case-insensitive, partial names allowed. */
    suppliers?: string | string[];
    /** Subset of scorers to run. Default: all of {@link FUZZ_SCORER_NAMES}. */
    scorers?: FuzzScorerName[];
    /** Print console tables. Default true. */
    print?: boolean;
    }
    interface FuzzProbeOptions {
        source?: CorpusSourceOption;
        limit?: number;
        minScore?: number;
        suppliers?: string | string[];
        scorers?: (
            | "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"
        )[];
        print?: boolean;
    }
    Index

    Properties

    Which caches to draw titles from: "cache", "results", or "both". Default "both".

    limit?: number

    Rows to show/return per scorer. 0 or Infinity means all. Default 15.

    minScore?: number

    Drop titles whose best score across the active scorers is under this. Default 0.

    suppliers?: string | string[]

    One or more suppliers to narrow to; case-insensitive, partial names allowed.

    scorers?: (
        | "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"
    )[]

    Subset of scorers to run. Default: all of FUZZ_SCORER_NAMES.

    print?: boolean

    Print console tables. Default true.