diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 20 insertions, 1 deletions
@@ -3,7 +3,26 @@ [](https://github.com/psf/black) # devourer -A knowledge aggregator +devourer is an api server that currently has the following endpoints and does the following things:<br/> + +## /summ +```sh +https://localhost:19019/mila/summ?url=https://dilipkumar.medium.com/standalone-mongodb-on-kubernetes-cluster-19e7b5896b27&summary=newspaper&audio=true +``` +The `/summ` endpoint optionally summarizes the article and can also optionally send the article as an audio file.<br/> +The parameters are `url`,`summary` tells the server which summarization method to use. the last parameter `audio` tells the server whether to just send the text result or an audio equivalent.<br/> + +## /wiki +```sh +https://localhost:19019/mila/wiki?term=iommu&summary=newspaper&audio=true +``` +Searches wikipedia for the given `term` parameter. Like other endpoints, can optionally summarize the result and turn it into audio with `summary` and `audio` parameters.<br/> + +## /reqs +```sh +https://localhost:19019/mila/reqs?url=https://www.ietf.org/rfc/rfc2865.txt&sourcetype=text +``` +Extracts the requirements from the contents inside a given url. The `sourcetype` parameter tells the server how to interpret the url contents. currently only `text` and `html` are supported as valid values.<br/> ## Usage Example |