adding iris_cluster api

moshaad7 commented 2 years ago

Fixes #258

Resolves

Resolves the problem of needing to store result of iris_module in a .json file and then supplying it to cluster_module

Changes

Added an option for directly supplying json object to cluster_module
Added a unified api called iris_cluster which first find result from iris_module then supply it as json object to cluster module and then finally return a output which contains both iris_serch_result and cluster_result

Checklist

[x] I have read the Contribution & Best practices Guideline.
[x] My branch is up-to-date with the Upstream master branch.
[x] The acceptance, integration, unit tests pass locally with my changes
[ ] I have added tests that prove my fix is effective or that my feature works
[x] I have added necessary documentation (if appropriate)

Using iris_cluster api

endpoint:http://127.0.0.1:1313/api/iris_cluster
query parameter: query or q
example http://127.0.0.1:1313/api/iris_cluster?q=owasp maryam

saeeddhqan commented 2 years ago

give me time to review it. For now, your method is not suitable. instead, write a module that gets a query and returns results along with clustered results. then, just use api/modules page in order to run your module.

moshaad7 commented 2 years ago

Ok I will

instead, write a module that gets a query and returns results along with clustered results. then, just use api/modules page in order to run your module.

Thank you for the feedback, I will try it this way

moshaad7 commented 2 years ago

As per ur feedback, I have created a new module that gets a query and returns results along with clustered results and raised a PR for it https://github.com/saeeddhqan/Maryam/pull/260

saeeddhqan / Maryam