Document initialization settings

[etiennellipse]

When trying to find the options that can be used to initialize NLP.js, I have to delve into the code and navigate through many files to find what I am looking for, if I am lucky. Also the structure of the settings are hard to figure out and require a lot of trial and error.

For example, we are using the NlpManager with these:

{
    ner: { builtins: [] },
    autoSave: false,
    languages: ["fr"],
    nlu: {
        spellCheck: true,
    },
    threshold: 0.7,
}

I consider most of these options essential to know about, so they should be clearly documented as well as the other ones available.

What I would like

A simple options section in the documentation, describing each one that can be passed, the possible values, default value and what it does. I guess since now the library is divided into small packages, each one should have it's own options section. But there should be one parent for the nlpManager which refers to the various packages.

Context

Using v4.0.2

[GuillermoPena]

Very agree @etiennellipse with your comment.

Taking a look at your nlp settings...

{ ner: { builtins: [] }, autoSave: false, languages: ["fr"], nlu: { spellCheck: true, }, threshold: 0.7, }

...i understand ner property, autoSave and languages but I think that threshold property should return 'None' if max score intent is less than 0.7 but, I have tried it without success. Am I understanding it wrong?

And, with nlu spellCheck property, which behaviour are you expecting?

[GuillermoPena]

Sorry @etiennellipse I have found an error in my code. 'threshold' property is working for me now but, spellCheck property seems make nothing...

[Apollon77]

builtins on ner should also have no effect when I check the code ...

[aigloss]

Closing due to inactivity. Please, re-open if you think the topic is still alive.