splainer-search - npm Package Compare versions

Comparing version 2.6.11 to 2.7.0

CHANGELOG.md

 Version numbers correspond to `package.json` version
 
+# 2.7.0 (2021-07-28)
+- Introduce to `searchFactory` the property `parsedQueryDetails` that stores details about the query
+  being processed by the search engine.  Works with Solr and Elasticsearch.
+- Using Querqy with Solr?   We now return the `querqy.infoLog` details in the `parsedQueryDetails` property.
+
 # 2.6.11 (2021-06-30)
 - Introduce translate:content field type (similar to thumb:image_url), that lets you tag which fields
-  you want to translate.  We need to move this formatting logic over to Quepid instead of splainer-search ;-). 
+  you want to translate.  We need to move this formatting logic over to Quepid instead of splainer-search ;-).
 
@@ -7,0 +12,0 @@ # 2.6.10 (2021-05-27)

package.json

 {
   "name": "splainer-search",
-  "version": "2.6.11",
+  "version": "2.7.0",
   "main": "splainer-search.js",
@@ -45,3 +45,3 @@ "authors": [
   "devDependencies": {
-    "angular-mocks": "^1.7.9",
+    "angular-mocks": "^1.8.2",
     "grunt": "~0.4.1",
@@ -52,9 +52,9 @@ "grunt-contrib-concat": "~0.3.0",
     "grunt-karma": "^0.12.0",
-    "jasmine": "^2.8.0",
-    "jasmine-core": "^3.5.0",
-    "karma": "^1.7.0",
-    "karma-chrome-launcher": "^2.2.0",
-    "karma-coverage": "^1.1.1",
-    "karma-jasmine": "^3.1.1",
-    "puppeteer": "^3.0.0"
+    "jasmine": "^3.7.1",
+    "jasmine-core": "^3.7.1",
+    "karma": "^6.3.2",
+    "karma-chrome-launcher": "^3.1.0",
+    "karma-coverage": "^2.0.3",
+    "karma-jasmine": "^4.0.1",
+    "puppeteer": "10.1.0"
   },
@@ -61,0 +61,0 @@ "scripts": {

README.md

@@ -258,2 +258,29 @@ [![Build Status](https://travis-ci.org/o19s/splainer-search.svg?branch=master)](https://travis-ci.org/o19s/splainer-search)
 
+## Understanding query input parsing
+
+Frequently we want to understand what the search engine is doing to the raw query input.  
+Consult the `searcher.parsedQueryDetails` property to get a search engine specific JSON data structure.
+
+### Solr
+
+For Solr we filter through all the keys in the `debug` section of the output, filtering out the
+keys `var keysToIgnore = ['track', 'timing', 'explain', 'explainOther'];`.  Everything else is
+added to the `searcher.parsedQueryDetails` property.
+
+### Elasticsearch
+
+In ES we default `profile=true` property, and nest everything under the `profile` key in the
+response is to the `searcher.parsedQueryDetails` property.
+
+## Querqy Rules Library Support
+
+[Querqy](https://querqy.org/) is a query rewriting library. It helps you to tune your search results for specific search terms.  Understanding what Querqy is doing to your queries is critical to achieving great search results.
+
+### Solr
+
+The `searcher.parsedQueryDetails` property surfaces all the debugging information about what rewriting Querqy is doing to the input query. Assuming you are also requesting the details on what rules are being matched via the `querqy.infoLogging=on` query parameter, then
+you will also see that information in the `searcher.parsedQueryDetails` structure.
+
+
+
 ## Development Notes
@@ -285,3 +312,3 @@
 We use NP to publish splainer-search to npmjs.org.  You need to update the
-`CHANGELOG.md` with your new version, but you don't need to touch `package.json`,
+`CHANGELOG.md` with your new version and the date, but you don't need to touch `package.json`,
 the `np` script bumps that file!
@@ -288,0 +315,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

142539

increased by2.11%

Lines of code

3188

increased by1.11%

Number of lines in readme file

327

increased by9%

No dependency changes