CSC/ECE 517 Spring 2019 - Project E1937. Integrate suggestion detection algorithm.rb

From Expertiza_Wiki
Revision as of 20:07, 11 April 2019 by Bnmwanik (talk | contribs)
Jump to navigation Jump to search

Introduction

Team

Dr. Gehringer (mentor)

  • Sushan Basnet (sbasnet2)
  • Jasmine Wang (jfwang2)
  • Bill Mwaniki (bnmwanik)
  • Pratik Kumar Kundanmal Jain (pjain22)

Project plan

Problem statement

Peer-review systems like Expertiza utilize a lot of students’ input to determine each other’s performance. At the same time, we hope students learn from the reviews they receive to improve their own performance. In order to make this happen, we would like to have everyone give quality reviews instead of generic ones. Currently we have a few classifiers that can detect useful features of review comments, such as how many suggestions they contain. The suggestion-detection algorithm has been coded as a web service, and other detection algorithms will be so coded in the future.


How it will work

In order to make the API call, the response_controller.rb will be responsible for sending a JSON input to the web service. The input will contain the review comment submitted by the user in the following format:

Below is a sample input 

 Sample Input:
 {
 	"reviews":[{
 		"text":"review text here",
 		"metrics":["problem","suggestion","sentiment"]
 	},{
 		"text":"another review here",
 		"metrics":["problem"]
 	},{
 		"text":"more text, maybe a large para or whatever you like",
 		"metrics":["sentiment", "suggestion"]
 	},{
 		...
 	}]
 }

Once the request is send, we expect the output to be in the following format: 

Sample Output: (as 'suggestion' and 'volume' as you might expect)
{
	"metrics":[{
		"suggestion":{
			"suggestions_chances":30,
			"suggestions":"absent"
		},
		"volume":{
			"total_volume":10,
			"volume_without_stopwords":3
		}
	},{
		...
	},{
		...
	}]
}

The output (which is a JSON) will be parsed and the suggestion metrics such as the tone and presence of suggestion will be extracted so the user will be able to view a summarized result of how well their review comments were. In addition, an average score will be computed based on the scores they received for each comment section, and the result will be presented in a colorful format to the user after they hit the submit button.

Previous work

Fall 2018 pull request

  • They had a functional suggestion detection API call that successfully communicated with the PeerLogic Server and retrieved the output.
  • They included their API call in response.html.erb using JavaScript.
  • They were able to display the output for each review beside the review. They displayed all of the information returned from the endpoint, which can look clunky.
  • Since the code is added in the views, they performed manual testing in the views.

More information about the suggestion detection service can be found at https://www.peerlogic.org

Flowchart to Describe Plan of Action

File(s) involved in making API Call: response_controller.rb
FIle(s) involved in displaying the received output: response.html.erb

Proposed changes

  • Move API calls of suggestion-detection algorithm from view to response_controller.rb
  • Change default view from displaying analysis for each review to summarized analysis for all reviews
    • Do not include comment text in analysis view
    • Focus on sentiment_score, sentiment_tone, and suggestions metrics returned from API
  • Include displaying analysis for each review as a "debug" option
  • Ensure that CORS does not need to be enabled for API call to work
  • Write unit tests for our method(s) in response_controller.rb
  • Fix grammar issues in response.html.erb
  • evaluate how much time this API is taking and if possible work a way out to improve it.

Anticipated View

The user will be given a summary of the feedback in a colorful format. The user will not see all the fields of the JSON and only the necessary text fields, whereas currently the user sees all the fields in the output from the API call. We expect to make the detailed view optional so that it can be used for debug purposes, and not be seen in the production server.

Files that will change

  • app/views/response/response.html.erb: Fix grammar issues, generate view with metrics
  • app/controllers/response_controller.rb: Call API here to pass to view

Testing plan

Controller Tests

Use RSpec testing on response_controller.rb to test the method(s) we implement

View Tests

Use manual testing on response.html.erb to test view we create

Links to our work

Retrieved from "https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1937._Integrate_suggestion_detection_algorithm.rb&oldid=123770"