Documentation for script.dlg and corpous.dlg

axa-group / nlp.js

An NLP library for building bots, with entity extraction, sentiment analysis, automatic language identify, and so more

MIT License

6.22k stars 616 forks source link

Documentation for script.dlg and corpous.dlg #928

Open obaid opened 3 years ago

obaid commented 3 years ago

I can't seem to find any documentation on how to generate script and corpous dlg files. Is this something that is currently not documented at all?

I am kinda reversing things from https://github.com/jesus-seijas-sp/nlpjs-examples

ericzon commented 3 years ago

I know that this is not "official" but take a look this: https://github.com/axa-group/nlp.js/issues/715

ericzon commented 2 years ago

FYI, we'll add more detailed documentation in next days.

sielay commented 1 year ago

I followed the docs and issues and would like to dig more, but while the repo is maintained I got confused by missing few bits:

is mentioned version 5 with bot orchestration happening, dead or just became part of 4?
is there specification of dlg and dlt fies (or even pipeline files) outside of tests?

Plus suggestion:

project uses a lot NLP jargon, it would be good to add a glossary to readme

ericzon commented 1 year ago

hi @sielay bot orchestration is included in v4. We are putting order and creating updated documentation of v4. Well, if you arrived here, implies that you need to get some notions about the topic before start playing but we'll take note of that, thanks!

sielay commented 1 year ago

Thanks @ericzon I'll be working on some tooling I feel like I'm missing too heavily using your lib. So please expect further questions. Anyhow thanks for the clarification regarding versioning.

To not reinvent the wheel: I don't see typings for the library nor schema validation for any input/output files like corpus, dlg etc. Is that right? It it's the case I'll start by adding to some open packages as I need them as well :)

I started work on https://github.com/sielay/nlp-manager as I have to type most of your libs at some point I'd be happy to export it as a separate package. Please feel free to share ideas/criticism/references.