Silverstripe Search customer guides

This is major release that marks the first full release of Silverstripe Search. It has some notable changes to feature availability and some API changes.

Feature Changes

Elastic Enterprise Search has been removed from Silverstripe Search as part of ongoing work to replace its deprecated functionality and ensure security compliance. Features will be gradually replaced as they are ready with Synonyms being available via the new Silverstripe Search Administration module.

Login to the Enterprise search dashboards is no longer available. This affects the following features:

1. Synonyms (available in the Silverstripe Search Administration module)
2. Analytics
3. Curations
4. Relevance tuning (AKA weights and boosts)
5. Log viewing

Synonyms are available via the new Silverstripe Search Administration module.

Weights are available in the API and SDK modules. For example the Discoverer module documentation shows how to apply weights when making a search.

Other features will not be available until they can be released in later versions.

API changes

As part of the feature changes some API endpoints have been added and some removed.

Added endpoints

• Synonym management
• Settings management

Removed endpoints

• Analytics click endpoint: /{engine_name}/click

The analytics click endpoint is designed to be used via the discoverer module with our Bifröst provider and it will ignore any calls to this endpoint to prevent sites from breaking after the release.

Other changes

• Search endpoint(/api/v1/docs/#/search/) is now stricter and will not allow fields that are not part of the specification. There are no changes for valid queries.

Silverstripe Search Administration module

In order to make dashboard features available to Silverstripe Search customers quickly a new Administration module is provided with this release. It can be installed on any Silverstripe site compatible with Silverstripe Search (version 5 at the time of release). This release includes support for Synonym management and viewing your engine's Schema.

It can be installed with composer composer require silverstripeltd/silverstripe-bifrost-admin. It depends on the silverstripe/silverstripe-forager module to provide credentials and does not require any user login beyond the CMS. Permission to access the dashboard can be configured in the CMS. For all other details please refer to the module's documentation.