@predictive-text-studio/lexical-model-compiler/dist/lexical-model-compiler/lexical-model-source.d.ts

Keyman Developer lexical model compiler

/**
 * @file
 * Interfaces and constants used by the lexical model compiler. These target
 * the LMLayer's internal worker code, so we provide those definitions too.
 */
/// <reference types="models-types" />
import { WordListSource } from "./wordlist";
/**
 * Possible sources
 */
declare type SourceFile = string | WordListSource;
/**
 * Required information for the Lexical Model Compiler.
 *
 */
export interface LexicalModelSource {
    /**
     * What format this model's data is in. Each format dictates its list of
     * options, as well as what each source file means.
     */
    readonly format: 'trie-1.0' | 'fst-foma-1.0' | 'custom-1.0';
    /**
     * Data sources; this depends on each model type.
     */
    readonly sources: SourceFile[];
    /**
     * The name of the type to instantiate (without parameters) as the base object for a custom predictive model.
     */
    readonly rootClass?: string;
    /**
     * Which word breaker to use. Choose from:
     *
     *  - 'default' -- breaks according to Unicode UAX #29 §4.1 Default Word
     *    Boundary Specification, which works well for *most* languages.
     *  - 'ascii' -- a very simple word breaker, for demonstration purposes only.
     *  - word breaking function -- provide your own function that breaks words.
     *  - class-based word-breaker - may be supported in the future.
     */
    readonly wordBreaker?: WordBreakerSpec | SimpleWordBreakerSpec;
    /**
     * How to simplify words, to convert them into simplifired search keys
     * This often involves removing accents, lowercasing, etc.
     */
    readonly searchTermToKey?: (term: string) => string;
    /**
     * Punctuation and spacing suggested by the model.
     *
     * @see LexicalModelPunctuation
     */
    readonly punctuation?: LexicalModelPunctuation;
}
/**
 * Keyman 14.0+ word breaker specification:
 *
 * Can support all old word breaking specification,
 * but can also be extended with options.
 *
 * @since 14.0
 */
export interface WordBreakerSpec {
    readonly use: SimpleWordBreakerSpec;
    /**
     * If present, joins words that were split by the word breaker
     * together at the given strings. e.g.,
     *
     *    joinWordsAt: ['-'] // to keep hyphenated items together
     *
     * @since 14.0
     */
    readonly joinWordsAt?: string[];
    /**
     * Overrides word splitting behaviour for certain scripts.
     * For example, specifing that spaces break words in certain South-East
     * Asian scripts that otherwise do not use spaces.
     *
     * @since 14.0
     */
    readonly overrideScriptDefaults?: OverrideScriptDefaults;
}
/**
 * Simplified word breaker specification.
 *
 * @since 11.0
 */
export declare type SimpleWordBreakerSpec = 'default' | 'ascii' | WordBreakingFunction;
/**
 * Override the default word breaking behaviour for some scripts.
 *
 * There is currently only one option:
 *
 * 'break-words-at-spaces'
 * : some South-East Asian scripts conventionally do not use space or any
 * explicit word boundary character to write word breaks. These scripts are:
 *
 *   * Burmese
 *   * Khmer
 *   * Thai
 *   * Laos
 *
 * (this list may be incomplete and extended in the future)
 *
 * For these scripts, the default word breaker breaks at **every**
 * letter/syllable/ideograph. However, in languages that use these scripts BUT
 * use spaces (or some other delimier) as word breaks, enable
 * 'break-words-at-spaces'; enabling 'break-words-at-spaces' prevents the word
 * breaker from making too many breaks in these scripts.
 *
 * @since 14.0
 */
export declare type OverrideScriptDefaults = 'break-words-at-spaces';
export {};