-
Invite your friends to join your team on Quepid! You can now send an email with an invite code to join Quepid and your specific team. o19s#259 by @epugh.
-
Add support for sending emails via SMTP, or use Postmark, or don't send emails. o19s#276 by @gabauer fixes o19s#275.
-
Upgrade to Rails 5 and Ruby 2.7.2! We have been stuck on Rails 4.2 for years, and this unlocks a lot of new capabilities. o19s#256 by @epugh with inspiration from @worleydl.
-
Renamed "Export Case" and "Import Ratings" to just "Export" and "Import". o19s#270 by @abhishekChoudhary93 fixes o19s#195.
-
Pay down some tech debt by removing our use of Coffee Script in Quepid. o19s#283 by @epugh.
-
Build time on CircleCI dropped from ~135 seconds down to ~105 seconds by removing
sass
gem in favour ofsassc
. o19s#285 by @epugh. -
We have simplified our queries that involve cases and users that are part of teams by making the simplifying assumption that all owners of teams are also members, which turns out to be true in practice. We also have audited our use of
.includes
to load child objects (avoiding the N+1 problem), and used more.preload
to try and deal with running out of temp space in our database. o19s#286 by @epugh. -
Turns out we had a ERD diagram all along, but it was hidden. Now you can see it on our Data Mapping page, plus we have how to recreate it documented and integrated. o19s#287 by @epugh.
-
You can now Delete a case altogether! Historically we had an Archive function, so that you could restore an old case. However, if you are like me, you create lots and lots of throwaway cases, so this allows you to clean up your Quepid setup. This PR also fixed some data modeling issues, and the problem of sometimes have a Try of zero, instead of the default first try of One! We also always include the Try number even if you have named the Try, since that is a big deal. o19s#288 by @epugh fixes o19s#250. Thanks @DmitryKey for help QA'ing this code.
-
Remove obscure
quepidIf.js
file that doesn't seem to do anything. o19s#293 by @worleydl. -
The Export All Cases feature only supported the old "Detail" format, and none of the other export formats, like LTR, Basic, or RRE. Plus the filtering options of "All, Owned, Shared" was pretty simplistic. It wasn't being used, and it added some complexity and performance issues to List All Cases page. So we removed it. o19s#295 by @epugh fixes o19s#294.
-
Unit Test style custom scorers let you run a unit test that asserted specific things about specific docs at specific ranks in your search results. This logic however was always convoluted, and only 15 people since 2019 have used it, and I suspect by accident ;-) We want better ways of handling this type of function, so removing this to pay down some tech debt, simplify the database architecture, and open the door to new approach. o19s#296 by @epugh fixes o19s#290.
-
You can export a rating that has no actual rating value chosen! o19s#266 by @epugh fixes o19s#265.
-
Fixing typo in defining aria-hidden html tag. o19s#269 by @abhishekChoudhary93 fixes o19s#268.
-
Rails 5 Upgrade Hangover: fixed strong parameters validation issues, fixed wonky left outer joins on cases showing duplicate cases (and killed performance), eliminated the
user_case_finder.rb
class in favour of simpler scopes. o19s#292 by @epugh w/ assist from @worleydl.
In the 6.4.0 release, the correct splainer-search NPM package was missed in the production Docker image.
This release resolves that oversight. Thanks @LiuCao0614 for testing the upgrade process and reporting the issue.
-
Small housekeeping update for the hosted app version running on Heroku. o19s#267 by @dworley.
-
Clean up last scoring run details on the Cases Listing page. Now better iconography to call out cases that have queries that need rating. o19s#261 by @epugh fixes o19s#219.
- Don't export ratings that don't have a rating set for RRE and Basic export formats. o19s#266 by @epugh fixes o19s#265.
Only Rated toggle is a powerful new feature added to Quepid, our first relevancy centric feature in a long while.
In certain relevancy cases, you may only care about the ordering of a subset of documents within the entire result set. One particular use case may be in e-commerce where you want certain products to be boosted and others to be demoted in the ranking algorithm. While this was doable in previous versions of Quepid, it could get difficult to manage the list of rated documents, especially if the list went many pages deep into the results.
To help solve this problem we worked with Kobler to introduce several new features to Quepid. We strived to make it easier to work with your corpus of rated documents in the main case view, inside of Explain Missing Documents and within the scorers themselves.
This feature was developed by @worleydl in o19s#229, with an initial POC by @janhoy in o19s#220, and resolves issue o19s#163. Much thanks to @janhoy and the folks at Kobler for this feature.
- Added "Show Only Rated" toggle to the main searchResult listing
- Explain Missing Documents modal now defaults to showing all of your rated documents when you first open it up
- Added eachRatedDoc function to ScorerFactory to iterate over rated documents in scoring
- Provided refreshRatedDocs(k) in ScorerFactory for loading a custom amount of rated documents up to k
- Migrated scoring to an asynchronous pipeline
- Fixed stuck "Updating queries" message when creating a new case
-
Round trip export and import LTR ranking files! o19s#204 by @epugh fixes o19s#162 by @DmitryKey.
-
Disable web signups by setting
SIGNUP_ENABLED=false
. o19s#238 by @tonomonic.
-
Easy in-place editing of case name and the try name to encourage using those features! Microinteration FTW! o19s#242 by @epugh.
-
Demonstrate richness of queries in Quepid when you use the TMDB dataset. o19s#236 by @epugh fixes o19s#224.
-
Update Javascript references to
application/javascript
. Pay down some tech debt! o19s#223 by @epugh -
Simplify handling doc id's that have periods or slashes in then, and avoid base64 issues by passing that in the JSON payload. o19s#233 by @epugh fixes o19s#228 and o19s#221.
-
Some Solr collections need manual setup of the
wt=json
mimetype. Add better text message for users. o19s#235 by @epugh fixes o19s#178. -
The CSV export format has a CSV injection vulnerability that is now fixed. o19s#245 by @nicholaskwan fixes o19s#231.
-
The Javascript based scorers could be used maliciously, so we've added an environment variable COMMUNAL_SCORERS_ONLY that controls if only Admins can create communal scorers for use by users. o19s#246 by @jacobgraves fixes o19s#232.
-
Don't show the Sharing icon for communal scorers, since they are implicitly shared globally! o19s#251 by @epugh fixes o19s#247.
-
Allow the export and import cycle of ratings using both CSV and RRE formats to include queries with no rated documents. Don't create a partial rating on import where we only have a doc id but no rating. o19s#252 by @epugh fixes o19s#244 by @LiuCao0614
-
Make it easier for scrapers and automated test tools to log into Quepid by adding some id and class tags to the login forms. o19s#257 by @epugh.
-
Discovered that the migrations from communal scorers being
@5
to@10
didn't always run cleanly. Commits 94dd23990422901082d79b121c1ca86a76907dc3, 8317b543530cc387d5cb89b4942acea5da57ce23, and 19b046485db530162c213a593e5b2e9df8fbbf07 to deal with this. -
Discovered that DELETE of ratings didn't work, and had to work around that. Commit 153047cd4b75d626695f5fc38832f6202eed9007.
-
Missing authorization check for Team Owner. o19s#230 by @jacobgraves fixes o19s#230 by @testerTester0123456789.
-
Can't rename a case on the Teams page. o19s#240 by @epugh fixes o19s#213
-
Fixed scoring of AP@10 and NDCG@10 when you have fewer then 10 results. o19s#253 by @nathancday fixes o19s#225 by @epugh.
- Silly cut'n'paste error that should have been caught with more testing before the 6.3.1.1 release, not the day after. Fixed in commit 2e322b337cc62895847df0ed95ba6a68683dad5f by @epugh.
- Default communal scorer was set to AP@5, however in release 6.3.1 we renamed it to AP@10, so doing a quick release. Fixed in commit 182f14d8a667759cdda559fd0ed5e063167b6914 and ad29ad199dcd25231d364e2ca95d2c09cac195ac by @epugh.
- Also found some issues with the
seeds.db
names being used. Commit 26edccfa407119b46b6f4316f44f34d0e3e87a9f by @epugh.
-
When we rolled out classic graded scorers (CG, DCT, NDCG) we used a 5 point scale, that allows you to pick a "no choice" middle option. However industry standard (for example RRE) is 4 point scale, so lets use 0,1,2,3 as our choices. New Best Practices document https://github.com/o19s/quepid/wiki/Judgement-Rating-Best-Practices by @binarymax is availble to help educate you. o19s#206 by @epugh fixes o19s#205.
-
Closely related to the scale change, all the classic scorers used a @5 depth of scoring, however the other industry standard in rating is to score ten deep documents, @10, so o19s#209 by @epugh makes this change as well.
-
Encourage use of profile pics by adding help text in Profile page that they come from Gravatar.com. o19s#202 by @epugh fixes o19s#201.
-
Use the same header navigation bar in both the main application and the Admin screens. o19s#203 by @epugh refactors this logic.
-
Added
bin/docker c
option to jump into the Rails Console during development, and cleaned up the other options. o19s#200 by @epugh.
-
Running
bin/setup_docker
more than once always had hiccups on dropping MySQL, and needed adocker-compose -v
, so just make that part of the script. o19s#208 by @epugh fixes this. -
Making HTTP links clickable wasn't working in some cases. o19s#211 by @e-budur fixes o19s#183.
- We want to export unrated query/doc pairs, which is only supported via exporting a previously created Snapshot. Add support for exporting a Snapshot to the Basic format on the Export screen. o19s#191 by @epugh fixes o19s#185.
-
When importing queries, you can have it clear all existing queries. This feature only worked for CSV files, not other formats like RRE. o19s#193 by @epugh solves this.
-
You can now import queries using the Import Ratings screen. Most of this was already supported, however now the modal dialog has better instructions to the user, and nicer validation of CSV formatting. o19s#192 by @epugh solves this.
-
When sharing Cases or Scorers, the lookup for what Teams you are part of created a really large JSON response (@epugh would get back a 1.4 MB payload!). We put this API response on a diet! o19s#197 by @epugh solves this.
- When exporting for RRE, we need the ES or Solr index name. Extract this from the url for the most recent try and save a step! o19s#167 by @epugh fixes o19s#159.
- If you link to either a case that doesn't exist, or you don't have permission for, or a try that doesn't exist for a case, then provide messaging back in the UI! Let's share some Quepid Cases! 933ed257198ebe21ff86b7e35573d3172cc2e593, 99ac27c1f8698ed726580a4c46eaf6810a4372d2, and 37b95b89fa848b0af2bae3d5a9541141e5d80d62 by @epugh to master branch fixes o19s#158.
getCaseByNo
only used in tests. o19s#173 by @epugh removes code.- There was a partially working attempt at a result grid view instead of list view. It wasn't rendering in the UI, and we want to have a more general solution in the future, so removing the code to simplify Quepid. o19s#174 by @epugh fixes o19s#171.
- When using the case wizard, you couldn't cut'n'paste in a long list of fields like
overview_en, overview_idioms
as they became a single tag. o19s#166 by @epugh fixes o19s#165. - A
:
in the case name was converted to a - The implementation of autosaving your notes per query didn't work well. Going back to an explicit save button. o19s#170 by @epugh fixes o19s#164. Thanks @DmitryKey for the issue!
- Remove warning in server log on parameters. o19s#182 by @epugh fixes o19s#180.
- Community member spotted that doc id's with
blah-http-blah
triggered base64 encoding. Simplified handling docs with an id with a.
or/
in them. o19s#179 by @worleydl and @epugh fixes o19s#175.
Thanks to some feedback from the community, we figured out that the SQL script for
migrating data from the DefaultScorer table to the Scorers table (and being tagged
as communal
) didn't run reliably. We've pulled it out as db/release_6_2_0_merge_default_scorer_into_scorer.sql
for folks to look at.
- o19s#157 identified the issue and fixed by @worleydl.
- Commits a1fc942d32e3d524836492f745735ce4ec4972ff and 029dd0cafe8caa492095c9483617b623a6a4e437 and 1a3c997f59b144a1cbffa59a04c67cb3e051b32d cover the migration fixes.
This release of Quepid finally introduces the classical search geek scorers like NDCG, DCG, Average Precision, and friends by default. We've also fixed a large number of bugs introduced by changes in Firefox and Chrome browser security models that happened in the first part of 2020, as well as recent updates to Elasticsearch and Solr.
The burgeoning suite of open source tools for relevancy all require judgement lists. We revamped Quepid to handle exporting and importing from your favorite tools like Quaerite and RRE, as well as a Learning to Rank formatted export. You can see this in action in Chorus, an ecommerce search focused stack that includes Quepid.
Ease of development has long been an issue with Quepid. In this release we've worked on developer happiness by auditing all of the dependencies we include. We're removed quite a few Ruby gems and Node packages that weren't used, and upgraded the rest (replacing PhantomJS with Puppeteer for headless testing). yarn.lock
dropped from 6706 lines to 1525 and Gemfile.lock
from 448 to 330! This allowed us to finally move to ECMAScript 6 and Node version 10. Lastly we have cut the production Quepid Docker image from almost 3 GB down to 2.3 GB.
Follow the steps outlined at https://github.com/o19s/quepid/wiki/Installation-Guide#updating-quepid.
You will need to run some database migrations to update the database and insert the new classical scorers (NDCG, AP, etc).
There is a sql migration script in ./db/release_6_2_0_merge_default_scorer_into_scorer.sql
that you might want to look if you have been using Quepid locally for a while. This script is primarily meant to support updating http://app.quepid.com database for the 6.2.0 schema.
QUEPID_DEFAULT_SCORER is a new environment variable specifying the name of the default scorer for users when they create a new case. QUEPID_DEFAULT_SCORER=AP@10 is what app.quepid.com uses.
- Quepid Default Scorer Admin screen is buried in UI. Add it to the dropdown menu. o19s#96 by @epugh.
- Support Basic Auth in Quepid with Elasticsearch. o19s#114 and o19s/splainer-search#79 by @CGamesPlay fixes o19s#109.
- When installing Quepid, use
thor user:create
to create an administrator! o19s#112 by @epugh fixes o19s#107. - Enhanced export ratings function that follows the standard
query,docid,rating
supports full export/import lifecycle and easier integration with other tools. o19s#128 by @epugh fixes o19s#126. - Export ratings in RRE and LTR file formats. Import ratings from RRE Judgement JSON file. o19s#137 and o19s#139 and o19s#152 by @epugh fixes o19s#133
- Classical scorers like AP, DCG, and NDCG are now shipping by default. All new users who sign up on Quepid will start with AP@5. This effort is still in progress, for example right now the scorers are named AP@5, DCG@5, NDCG@5 because they are hard coded to only look at the first five ranks. We also need to work on the Q Score Graph's vertical axis handling. Huge effort in o19s#100 by @nathancday and @epugh to get this done. This change also removes the individual query level scorer being assignable, which was a bad idea (o19s#132) and restores the ability to write a custom unit test for a query in Javascript (o19s#120) which is an interesting idea! Thanks to @janhoy for being the impetuous to get this work done!
- Community member reported the default demo TMDB Elasticsearch server on port 9200 had no data. Having seem random "drive by vandalism" of our demo Solr and ES servers that run on default ports, we want to move away. Yes, security by obscurity. o19s#103 by @epugh changes default used in Wizard to port 8985 and 9206. o19s#125 and o19s#104 migrate existing URLs to the new ones.
- Increase Developer Happiness by speeding up the
bin/setup_docker
script by caching RubyGems. 50% speed up! o19s#105 by @nathancday. - Remove the concept of "communal" i.e shared with everyone scorers. This feature has been in Quepid for years, yet even @softwaredoug didn't remember it! o19s#99 by @epugh fixes o19s#98.
- In the beginning of Quepid, before there was a Search Relevancy community, there was just one, slightly janky scorer, that wasn't like any of the standard search geek scorers (looking at you NDCG) that we use today. We are building towards supporting many scorers, so it's time to remove the
DEFAULTS
definition of a scorer, and the related scope in ActiveRecord. o19s#97 by @epugh. - Solr 8.2 tightened up the security profile for accessing it that we depend on via JSONP to have Quepid work. Now the wizard provides you the command to run on your Solr if it can't connect. o19s#95 by @epugh fixes o19s#92.
- Using the default
tmdb
dataset? Demonstrate thethumb:poster_path
feature. o19s#94 by @epugh fixed o19s#72. - Rename
user.username
in database touser.email
since that is what we use. Clean up API. o19s#113 by @epugh fixes o19s#111. You will need to run database migration for this release! - Audited code base to prune dependencies and remove unused code. o19s#121, o19s#119, o19s#118, o19s#116 all worked towards this goal.
- Turns out Quepid has a Curate interface. It isn't supported, so in the interest of reducing our codebase, removing it. Points the way for the future however! o19s#123.
- Deal with sameSite cookie warnings from Firefox. o19s#131 by @epugh fixes o19s#130.
- curator variables (i.e knobs and dials) that aren't used in query cause weird UI. o19s#135 by @epugh fixes o19s#64.
- Saving two annotations in a row doesn't work, you need to rescore per annotation. Fixed in o19s#136 by @epugh.
- Users can opt out of community marketing emails. Add a
/admin/users.csv
export to make keeping track of that easier. Thanks @flaxsearch for the suggestion. - Inconsistent use of X icon in modal popups is frustrating. o19s#148 and o19s#149 by @worleydl fixes o19s#146 and o19s#145.
- Swap the sorting of tries in the history tab to the newest first, going back in time. o19s#151 by @epugh fixes o19s#143 by @renekrie.
- Be clearer that MySQL is the only supported database platform. o19s#156 by @epugh fixes o19s#155 by @janhoy.
- Wizard Autocomplete Didn't work well with Keyboard. Autocomplete suggestion had to be clicked with a Mouse. o19s#94 by @epugh fixes this by upgrading package.
- Multivalued and nest JSON fields didn't display well, you would get
[object Object]
instead. Now we display arrays and Json properly. o19s#117 by @CGamesPlay fixes o19s#52. - fixed highlighting throwing an error on Solr date fields by using
hl.method=unified
in Splainer-Search v2.5.9. o19s#84 created by @janhoy. - fixed fields with a
.
likefoo.bar
failing to be rendered in UI in Splainer-Search v2.5.9. o19s#106 created by @rjurney. - When a try number is not specified for a case, automatically redirect to the most recent try. o19s#122 by @epugh fixes o19s#110 by @binarymax.
- Case shared via Team with me has NaN for the Try. o19s#134 by @epugh fixes o19s#83.
- Not able to export cases from a Team page. Commit quepid@021bda8627463986f1ff04ffb1c290195c428c5b by @epugh fixed this.
- Race condition in laying out the main Quepid Screen and the Tune Relevance screen. o19s#147 by @worleydl fixes o19s#144 by @epugh.
- Using the "peek" function to page to deeper search results would lose your
escapeQueries
choice. o19s/splainer-search#87 by @jorgelbg fies this. Bump to splainer search 2.6.0 to include the fix.
- Community member reported race condition in standing up Rails and MySQL and issues with PhantomJS install in the developer
docker-compose.yml
andDockerfile.dev
setups. o19s#75 by @epugh fixes o19s#76 and o19s#73. - Add .dockerignore file to prevent unrelated changes from breaking Docker layer cache fixes by @TheSench o19s#80
- Fix issue where you couldn't clone a case without including the full history. o19s#89 by @worleydl fixes o19s#37 Thanks @janhoy for submitting this bug.
- Fixed display of notes for query disappearing after collapse and then expand of query window. o19s#88 by @dworley fixes o19s#87
- NDCG@10 doesn't include documents that are rated via Explain Other, it only looks at the documents returned by the search engine. We want to be able to have NDCG look globally at all rated documents. o19s#90 by @nathancday and @worleydl fixes o19s#78. Note: We currently have the NDCG@10 scorer in app.quepid.com, however it hasn't been backported to the Docker image or the dev setup in Quepid. See o19s#91.
This release changes the database schema, so you will need to run docker-compose run --rm app bin/rake db:migrate
if you have an existing Quepid.
- Cloning cases now carries any magic variables and their values along to the new case o19s#55 by @epugh fixes o19s#37
- Only treat field content that begins with "http" as a link. o19s#35 by @pfries fixes o19s#34
- Update Elasticsearch logo. o19s#38 by @moshebla
- Remove sqlite from gem, no longer used. o19s#41 by @epugh fixes o19s#40
- Better look and UI experience for the dev panel. o19s#39 by @moshebla
- Show or don't show the T&C's link based on the Quepid configuration. o19s#42 by @epugh fixes o19s#44 by @flaxsearch.
- Add Query button activates in response to query text entered. o19s#43 by @moshebla
- Prevent duplicate queries when using bulk query importer. o19s#49 by @epugh fixes o19s#48
- Production oriented Docker Compose setup for Quepid is ready! Install guide at https://github.com/o19s/quepid/wiki/Installation-Guide. o19s#36 by @epugh was based on original work in o19s#33 by @synhershko. Thanks!
- Update the sample TMDB dataset for Elasticsearch to support
thumb:poster_path
in the field listing. o19s#53 by @epugh - Collapse query results well from bottom (in addition to the top) o19s#28 by @epugh fixes o19s#20 by @peterdm. Thanks @ychaker for reviewing PR.
- Explain Other on ES 6 and 7 Broken. o19s/splainer-search#74 by @worleydl fixes o19s#25.
- Support for embeds of audio/image/video via
media:
. o19s#62 by @worleydl fixes o19s#56 by @flaxsearch - Autocomplete in Case Setup Wizard properly handles
media:
andthumb:
prefixes. Nice refactoring for more prefixes. o19s#46 by @moshebla with refactor by @worleydl. - Post the onboarding wizard you would often see your queries being stalled in loading. Only workaround was to reload the Javascript app. o19s#69 by @worleydl fixes o19s#66
- app.quepid.com needs to get explicit consent from users to receive emails related to Quepid and related features. Introducing a new
customize_quepid.rb
file in initializers to start supporting more customizations of Quepid. o19s#68 by @worleydl. - Only show cookie acceptance popup if COOKIES_URL is set. o19s#71 by @epugh fixes o19s#70 by @epugh.
- Deprecate www.quepid.com/support in favor of linking to wiki. o19s#18 by @epugh fixes o19s#17
- More informative error message when you delete a custom scorer and its in use. o19s#22 by @epugh fixes o19s#21.
- Update to splainer-search 2.5.0.
- Fix setting the default case for exporting when you first load Quepid. o19s#15 by @worleydl fixes o19s#12
- Allow a document to be rated to have an id with a period in it like
mydoc.pdf
. o19s#6 by @epugh fixes o19s#5 - Default query when setting up a new case works across Elasticsearch versions 5, 6, and 7. o19s#3 by epugh fixes o19s#2
- Updates to CircleCI and update Ruby 2.5.7 by @ychaker
- Removes everything related to payments, and makes Quepid "free"
- Adds support for using a CORS proxy for Solr instances that are not configured to allow connections from Quepid
- Replaces use of Vagrant in development in favor of Docker
- Adds support for GDPR
- Adds support for deploying Quepid on Heroku
- Upgrades Ruby version
- Upgrades Angular from 1.4.x to 1.7.x
- A bunch of bug fixes
- bugfix-888 Fixes #886: Locks version number for CSV module.
- bugfix: ES5 displaying attributes - fields are not automatically stored so
stored_fields
will not return anything, instead get the data from the_source
field
- feature: q-score - Added graph for score history
- feature: annotations - User can now take a snapshot of the score with an annotation to describe that point in time
- bugfix-879-880-heatmap-safari Fixes heatmap in Safari
- add support for ES 5+ with
stored_fields
vsfields
- bugfix: Prevent re-escaping % when it's part of an escape char
- bugfix-873-change-try-name Fixes renaming try and reloading name in list
- bugfix-872-duplicate-try Fixes #872: Duplicating a try
- bugfix-852-redraw-results-with-snapshot-open Fixes updating results in open query while comparing with a snapshot
- bugfix-848-close-modal-after-deleting-try Closes modal after deleting try
- enhancement-862-document-qa-workflow Adding documentation for QA flow
- feature-863-explain-disabled-features-for-trial-user Enable popups that explain why trial user cannot perform action
- enhancement-document-magic-variables Adds documentation for Magic Variables
- bugfix-844-add-non-existing-user-to-enterprise Fixes feedback when adding non existent user to enterprise
- bugfix-857-case-insensitive-emails Fixes logging in with emails (making them case insensitive)
- bugfix-845-add-team-member Fixes feedback when adding a team member
- bugfix-843-user-autocomplete Removing entire list of users from autocomplete when adding team member
- feature-use-n-docs-in-scoring Allow users to set how many results to display by default instead of the default 10 results
- feature-company-name-in-profile Adds ability to specify company name in user profile
- feature-120-clone-case Adds ability to clone a case
- bug-796-mass-import-ratings Fixes bug in mass import of ratings
- bugfix-767-viewing-snapshots Fixes bug while views snapshots
- bugfix-big-snapshot Fixes bug while viewing large snapshots