search

snipsco / snips-issues

Feel free to share your bugs with us.
14 stars 5 forks source link

Documentation for the built in slots #184

Closed flatsiedatsie closed 5 years ago

flatsiedatsie commented 5 years ago

Is your feature request related to a problem? Please describe. I was happy to see that the built in time slot understood "midnight" and "noon". I was happily surprised to see that it even understood lunch time as a time. Very cool.

My issue is that in the documentation I can't find a list of what is supported and what isn't. I'd love to have known beforehand that 'lunch time' was supported, and to know from when till when that actually is. (I believe it's 11 to 13h). I'd also like to know if a user can say "at dinner time" and "during dinner time", and if these differences then lead to different output (a single value time moment or a to-from duo)

What are the use cases of this feature I want to support as many natural ways of setting a time as possible. Therefore I created a custom slot called 'alternative time' which can handle when the user asks "turn on the kitchen light at sunset". It's obvious that sunset won't be handled by Snips since it's a relative time. But I hope it can be an example of how I'd like to know which 'alternative times' to put in, and which ones Snips already supports.

Does Snips support "tea time"? If so, at what time is Snips' tea time?

Similarly, just knowing if the time element supports "tomorrow morning at 11".

Describe the solution you'd like It would be great it some documentation of the built in slots was made available.

Describe alternatives you've considered The alternative is just to test what is available yourself. For example, I believe Snips also supports "afternoon". But I had to find out by testing it.

Additional context

davidleroy commented 5 years ago

Thanks a lot for your interest in Snips @flatsiedatsie !

Actually the built-in entities are documented here and more specifically, here is the link for datetime entities.

The reason why we're not providing the exact list of all covered values as it's actually grammar-based with a fairly high combinatory (!!) and that it varies across languages. You can safely assume that most datetime variations will be covered and properly resolved off-the-shelf as it's been built with maximal coverage in mind by our team of computational linguists.

You can also dig into the source code of the datetime parser/resolver called Rustling if you want to have more details about this, as it's actually open source.

flatsiedatsie commented 5 years ago

Thanks! I suspect I missed it because was looking under NLU instead of Dialogue.