Zvec Node.js API Reference
    Preparing search index...

    Interface ZVecFtsIndexParams

    Configuration parameters for a full-text search index on a scalar string field.

    interface ZVecFtsIndexParams {
        indexType: 11;
        tokenizerName?: string;
        filters?: string[];
        extraParams?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    indexType tokenizerName? filters? extraParams?

    Properties

    indexType: 11

    Must be ZVecIndexType.FTS (11).

    tokenizerName?: string

    Tokenizer name. Supported values are standard, ngram, jieba, and whitespace. The standard tokenizer follows Unicode word boundaries.

    "standard"
    filters?: string[]

    Token filters. Supported values include lowercase, ascii_folding, and stemmer.

    ["lowercase"]
    extraParams?: string

    Additional tokenizer and filter parameters as a JSON object string. Supported options include max_token_length, ngram_min, ngram_max, token_chars, jieba_dict_dir, user_dict_path, cut_mode, and stemmer_lang.

    ""

    Settings

    Member Visibility

    On This Page

    Properties