Skip to main content

TokenizerConfig

Struct TokenizerConfig 

Source
pub struct TokenizerConfig {
    pub profile: Profile,
    pub segmenter: Segmenter,
    pub folding: FoldingForm,
    pub stopwords: StopwordList,
    pub stemmer: Stemmer,
    pub decompose_words: bool,
    pub emit_catenation: bool,
    pub number_words: bool,
    pub drop_single_char_parts: bool,
    pub vocabulary: Vocabulary,
}
Expand description

The complete analysis configuration.

Every field is an epoch-digest input. Changing any one of them produces a different epoch and therefore a different index meaning.

Fields§

§profile: Profile

The named profile this configuration started from.

§segmenter: Segmenter

Word segmentation strategy.

§folding: FoldingForm

Character folding form.

§stopwords: StopwordList

Stopword list.

§stemmer: Stemmer

Stemming algorithm.

§decompose_words: bool

Split words at joiners, case changes, and letter/digit transitions.

§emit_catenation: bool

Emit the joiner-free catenation of a decomposed word.

§number_words: bool

Emit digit and word variants for spelled numbers.

§drop_single_char_parts: bool

Drop single-LETTER decomposition parts.

The k of 401k, the t of don't, the s of investor's: one-letter parts of a decomposed word are stop-level noise in linguistic text — they carry no identity the whole word and the catenation do not already carry, and they pollute document length and document frequency. One-DIGIT parts are kept: type-2 and SARS-CoV-2 are discriminated by exactly that digit. Dropping a part leaves its position spent, exactly as a removed stopword does, so phrase adjacency and the analyzed length are unchanged. Identifier-heavy profiles keep every part: the x of x_max is a real search target in code.

§vocabulary: Vocabulary

User vocabulary and synonyms.

Implementations§

Source§

impl TokenizerConfig

Source

pub fn text_default() -> Self

The general-purpose text profile.

Source

pub fn code() -> Self

The identifier-heavy profile for source code and tickets.

Source

pub fn voice() -> Self

The spoken-text profile.

Source

pub fn with_vocabulary(self, vocabulary: Vocabulary) -> Self

Replaces the user vocabulary.

Source

pub fn epoch(&self) -> TokenizerEpoch

Computes the epoch digest for this configuration.

Trait Implementations§

Source§

impl Clone for TokenizerConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for TokenizerConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Eq for TokenizerConfig

Source§

impl PartialEq for TokenizerConfig

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for TokenizerConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.