Skip to content

Commit

Permalink
add a few notes on search plugins
Browse files Browse the repository at this point in the history
  • Loading branch information
jillesvangurp committed Nov 26, 2023
1 parent 056b4f0 commit e7d6dca
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ Learn how to [get started ](https://youtu.be/Nxr2UVs_n74?si=YKslAJbY7-BojcmB) wi
- Use the search tool to create some test cases. Enter your search and click the "Add Testcase" button to convert the results in a testcase. Tweak, tag, and edit them in the test cases screen.
- Run and explore metrics for your test cases from the metrics screen.
- Export your configuration and testcases and use them on the command line using [rankquest-cli](https://github.com/jillesvangurp/rankquest-cli).
- Use any of the built in search plugins, or add your own javascript function in the UI.

## Search Relevance Metrics

Expand Down
13 changes: 10 additions & 3 deletions src/jsMain/resources/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,20 +38,27 @@ For more information on this, see the rankquest-cli project.

## Search Plugins

To get results from your search API, you need to use a search plugin. Rankquest Studio comes with four plugins. Three
To get results from your search API, you need to use a search plugin. A search plugin fetches results and picks
the response apart to extract the id and a label for each search result. Note. as this runs in a browser, your search API
must set the appropriate CORS headers.

Rankquest Studio comes with four plugins. Three
of those are provided by rankquest-core and are written in Kotlin:

- JsonGetAPIPlugin - allows you to do an HTTP GET against any API that returns Json
- JsonPostAPIPlugin - allows you to do an HTTP POST against any API that returns Json
- ElasticsearchPlugin - lets you query Elasticsearch

A fourth plugin is bundled with Rankquest Studio and allows you to run javascript in your browser. Note. while this works great inside the browser, this plugin does not work outside the browser and cannot be used with rankquest-cli. Using Javascript,
A fourth plugin is bundled with Rankquest Studio and allows you to **run javascript in your browser**. Note. while this works great inside the browser, this plugin does not work outside the browser and cannot be used with rankquest-cli. Using Javascript,
you can use the browser fetch API to access your server.

Finally, you can of course create your own plugin in Kotlin. However, this is a bit more involved and you will have to modify
rankquest studio in order to be able to edit your configuration. Additinoally, you may need to modify rankquest-cli as well
rankquest studio in order to be able to edit your configuration. Additionally, you may need to modify rankquest-cli as well
so that it can use your plugin. For this, refer to the source code and the existing plugins.

An **alternative to writing your own plugin may also be proxying** your search API such that you can use one of the builtin
plugins. This may be easier than customizing the UI for your plugin and is something you can do with a few lines of code in your preferred programming language.

## Why another tool?

I wanted to have an easy to use tool that removes all possible excuses for people to
Expand Down

0 comments on commit e7d6dca

Please sign in to comment.