WING-NUS / SSID

Student Submission Integrity Diagnosis
18 stars 23 forks source link

Added Params for Submission Similarities #356

Closed mengyewgau closed 12 months ago

mengyewgau commented 12 months ago

Description

Added the params to query threshold, limit, and page. I set all 3 to optional parameters, thus by default it will pull all the submission similarities results

Related Issue

This PR is a part of the #324 integration

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

sibinhho99 commented 12 months ago

Perhaps the section of the doc should be updated as follows

- `threshold (Optional) number`: A number between 0 and 100. If specified, returns only submission similarities whose similarity percentage is between `threshold` and 100 inclusive. Otherwise, returns all submission similarities **[Note: Currently SSID stores and displays all submission similarities on its web interface. The function to display only submission similarities whose similarity percentage is greater than or equal to `threshold` is not yet available in the web interface so we need to build it for SSID]**.
- `page (Optional) number`: If specified, returns submission similarities in such page when sorted by highest maximum similarity percentage. Otherwise, returns all submission similarities.
- `limit (Optional) number`: If specified, returns such number of submission similarities with highest maximum similarity percentage. Otherwise, returns all submission similarities. **[Note: Currently SSID stores and displays all submission similarities on its web interface. The function to take top N submissions is not yet available in the web interface so we need to build it for SSID]**.`