updating querqy documentation for OS 2 3 (#1451)

Signed-off-by: ariamarble <armarble@amazon.com>

Signed-off-by: ariamarble <armarble@amazon.com>
This commit is contained in:
Aria Marble 2022-10-06 09:44:45 -07:00 committed by GitHub
parent 2c7494309a
commit 9233787024
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 41 deletions

View File

@ -13,51 +13,34 @@ Querqy is a community plugin for query rewriting that helps to solve relevance i
## Querqy plugin installation
Querqy is currently only compatible with OpenSearch 1.3.1
{: .note }
The Querqy plugin is now available for OpenSearch 2.3.0. Run the following command to install the Querqy plugin.
1. The Querqy plugin code is located here: [querqy-opensearch](https://github.com/querqy/querqy-opensearch). To download the plugin code ZIP file, select the green "Code" button, then select "Download ZIP"
````bash
./bin/opensearch-plugin install \
"https://repo1.maven.org/maven2/org/querqy/opensearch-querqy/1.0.os2.3.0/opensearch-querqy-1.0.os2.3.0.zip"
````
1. Install JDK 11. On Amazon Linux 2, install JDK11 with the following command:
Answer `yes` to the security prompts during the installation as Querqy requires additional permissions to load query rewriters.
```bash
sudo yum install java-11-amazon-corretto
```
After installing the Querqy plugin you can find comprehensive documentation on the Querqy.org site: [Querqy](https://docs.querqy.org/querqy/index.html)
1. Uncompress the ZIP file:
## Path and HTTP methods
```bash
unzip querqy-opensearch-main.zip
```
```
POST /myindex/_search
```
1. Change to the uncompressed Querqy directory:
## Example query
```bash
cd querqy-opensearch-main
```
1. Compile the plugin:
```bash
./gradlew build
```
1. The compiled plugin is stored in this directory:
```bash
/path/to/file/querqy-opensearch-main/build/distributions/opensearch-querqy-1.3.1.0.zip`
```
1. The compiled Querqy plugin is installed the same as [any OpenSearch plugin](https://opensearch.org/docs/latest/opensearch/install/plugins/#install):
```bash
/path/to/opensearch/bin/opensearch-plugin install file:///path/to/file/opensearch-querqy-1.3.1.0.zip
```
1. Reboot the OpenSearch node:
```bash
sudo reboot
```
After installing the Querqy plugin you can find comprehensive documentation on the Querqy.org site: [Querqy](https://docs.querqy.org/querqy/index.html)
````json
{
"query": {
"querqy": {
"matching_query": {
"query": "books"
},
"query_fields": [ "title^3.0", "words^2.1", "shortSummary"]
}
}
}
````