Askarl, a simple RESTful interface to a KaaS (Karlettin as a Service) implementation.
A working version is available at http://ask.dataninja.it/. First you have to register a personal account, obtain a token for your later requests and add money to your budget: http://ask.dataninja.it/for/token?name=Your+Name&budget=2k (change "Your+Name" with your url encoded name).
Finally you can ask Karl (don't forget the offer!): http://ask.dataninja.it/to/karl?token=your-token&budget=5&question=Dove+trovo+i+dati+sulle+frodi+informatiche (change "your-token" with your token).
Be careful, every answered question decreases your budget of your offer. When all your money has gone, you can refill the budget (http://ask.dataninja.it/for/user?token=your-token&budget=100) and keep asking karl.
If you have bonus, every question decreases bonus and not budget.
If something goes wrong, please read the error description carefully. And if you think there is a bug, please open a new issue.
And remember: don't ask to ask karl, just ask karl!
Prefix to manage your personal account.
Register a new user providing your name. Managed parameters are listed if no one is provided.
- n or name (required): user name
- b or budget (required): money to add to budget (in euros, ie. 5 or 2k)
- r or reply-to: how do you want to get the answer if not provided when asking?
- now (wait for the reply, default)
- a valid email address
- a valid callback url (webhook)
Success response register the user and return the personal token. Annotate it for later queries!
Examples:
- http://ask.dataninja.it/for/token?name=Your+Name (no budget)
- http://ask.dataninja.it/for/token?name=Your+Name&budget=2k (start with 2,000 €)
WARNING: data are not crypted, nor safely stored and can be public available, so don't send sensitive data in your name.
Show informations about registered user from token and add money to personal budget. Managed parameters are listed if no one is provided.
- t or token (required): a valid token of a registered user
- b or budget (required): money to add to budget (in euros, ie. 5 or 2k)
Examples:
- http://ask.dataninja.it/for/user?token=your-token (show info)
- http://ask.dataninja.it/for/user?token=your-token&budget=100 (add 100 € to your budget)
Remove a registered user. Managed parameters are listed if no one is provided.
- t or token (required): a valid token of a registered user
Prefix to query available bots of the installed KaaS instance.
Query to [bot]. Available bots are listed at /to. Managed parameters are listed if no one is provided.
- t or token (required): a valid token of a registered user
- q or question (required): the question, an URL encoded text (ie. "Dove trovo dati sul tasso di natalità?")
- b or budget (required): how much money are you willing to offer (in euros, ie. 5 or 2k)?
- m or mode: you hurry?
- fast (default)
- accurate
- fa (fast AND accurate)
- r or reply-to: how do you want to get the answer?
- now (wait for the reply, default)
- a valid email address (not implemented)
- a valid callback url (webhook, not implemented)
Examples:
- http://ask.dataninja.it/to/karl?token=your-token&budget=5&question=Dove+trovo+i+dati+sulle+frodi+informatiche (5 € waiting for a fast response)
- ...
Clone the repository and run the service: python askarl.py [port]. Default port is 51345.
Open http://localhost:51345 (or using your customized port) and use the service.
Registered accounts are stored in a users.db file in pickle format and listed at /for/users. Asked questions are listed at /for/questions.
Made with love by Alessio "jenkin" Cimarelli for Dataninja & friends.
Freely inspired by dottorblaster/stocazzo and thepressmatch.help/generatoreComunicati.