splainer-search - npm Package Compare versions

Comparing version 2.24.0 to 2.25.0

CHANGELOG.md

 Version numbers correspond to `package.json` version.  Follows the _major.minor.bugfix_ naming pattern as of 2.8.0.
 
+# 2.25.0 (2023-09-11)
+- Fixed bug in pagination that didn't respect the `apiMethod` setting for Solr.  If you used GET, splainer-search sent the request as JSONP anyway, causing errors in the Browser.  https://github.com/o19s/splainer-search/pull/130 by @epugh.
+
+- Vectara is the first Vector search engine to work with Splainer.  https://github.com/o19s/splainer-search/pull/128 by @mkr.
+
+
 # 2.24.0 (2023-08-28)
@@ -4,0 +10,0 @@ - Support using a prefix for a image path for thumbnails, the same way we support it for images.  https://github.com/o19s/splainer-search/pull/127 by @epugh fixes https://github.com/o19s/quepid/issues/790 by @OkkeKlein.

package.json

 {
   "name": "splainer-search",
-  "version": "2.24.0",
+  "version": "2.25.0",
   "main": "splainer-search.js",
@@ -5,0 +5,0 @@ "authors": [

README.md

@@ -6,6 +6,10 @@ [![Build Status](https://travis-ci.org/o19s/splainer-search.svg?branch=master)](https://travis-ci.org/o19s/splainer-search)
 
-Splainer Search is an Angular Solr and OpenSearch and Elasticsearch Search library focussed on relevance diagnostics. It's used in the relevancy tuning tools [Quepid](http://quepid.com) and [Splainer](http://splainer.io). Its available for anyone to use (see [license](LICENSE.txt)).
+Splainer Search is an Angular [Solr](https://solr.apache.org/), [OpenSearch](https://opensearch.org/) and [Elasticsearch](https://www.elastic.co/) search library
+focussed on relevance diagnostics with some experimental support for other search engines, starting with [Vectara](https://www.vectara.com).
+It's used in the relevancy tuning tools [Quepid](http://quepid.com) and [Splainer](http://splainer.io). It is available for anyone to use (see [license](LICENSE.txt)).
 
 
-Splainer search utilizes a JSONP wrapper for communication with Solr. Elasticsearch and OpenSearch communicate with simple HTTP and JSON via CORS. All fields are explained and highlighted if requested. A friendly interface is provided to specify the arguments in terms of a Javascript object. See below for basic examples.
+Splainer search utilizes a JSONP wrapper for communication with Solr. Elasticsearch, OpenSearch, and Vectara communication
+happens with simple HTTP and JSON via CORS.
+All fields are explained and highlighted if requested. A friendly interface is provided to specify the arguments in terms of a Javascript object. See below for basic examples.
 
@@ -63,2 +67,38 @@ ## Basic usage
 
+### Vectara
+
+Splainer-search has experimental support for Vectara. You can send queries in the Vectara format but must also pass in
+the authorization headers as custom headers, e.g.
+
+```js
+var searcher = searchSvc.createSearcher(
+  ['id:_id', 'title', 'body', 'author'],
+  'https://api.vectara.io:443/v1/query',
+  {
+    "query": [
+      {
+        "query": "#$query##",
+        "numResults": 10,
+        "corpusKey": [
+          {
+            "customerId": 123456789,
+            "corpusId": 1
+          }
+        ]
+      }
+    ]
+  }, 
+  {
+    'customHeaders': {
+      "customer-id": "123456789",
+      "x-api-key": "api_key"
+    }
+  },
+  'vectara'
+);
+```
+
+Please note that the Vectara integration currently does not support explain or other advanced Splainer-search
+functionality.
+
 ## Paging
@@ -65,0 +105,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

174912

increased by7.25%

Lines of code

3717

increased by8.46%

Number of lines in readme file

393

increased by11.33%

No dependency changes