Add serving configs to Search Admin #1373
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This represents a serving config(uration) on Discovery Engine, which is an endpoint on an engine that can be used for querying. The main purpose of serving configs is to have controls attached which modify their behaviour, and each of an engine's serving configs can have zero-to-many of that engine's controls attached. Having several serving configs means we can test out different sets of controls and how they affect search results. Serving configs have one of three use cases: - `live` serving configs are used somewhere in our search stack to provide results to the public - `preview` serving configs are for use by Search Admin users to test new configurations (for example, when adding new controls) - `system` serving configs are for internal programmatic use and cannot be modified through the Search Admin UI (for example, we have an "empty" serving config to test having no controls at all) Serving configs also have a display name and remote resource identifier (like other Discovery Engine resources). As we cannot currently create or delete serving configs through the Discovery Engine Ruby client, initial creation of three serving configs has been done in `govuk-infrastructure` [1] and we use a Rake task to create the model records on this end. Depending on whether these three are enough for the long term, we may or may not want to add the ability to create, edit, and delete serving configs to Search Admin in the future. [1]: alphagov/govuk-infrastructure#1680
As these aren't currently user-manageable in Search Admin, we don't need any UI to create, edit, or delete them.
This allows users to preview the results from a serving config on Finder Frontend using the `debug_serving_config` parameter.
leenagupte
approved these changes
Feb 12, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Discovery Engine serving config(uration)s are individual endpoints on an engine that can be used for querying. Their main purpose is to have controls attached which modify their behaviour, and each of an engine's serving configs can have zero-to-many of that engine's controls attached. Having several serving configs means we can test out different sets of controls and how they affect search results.
This adds a
ServingConfigmodel representing a serving config on Discovery Engine, and some initial UI for it.In order to keep track of the different types of serving config we have, a "use case" enum tracks what each serving config is for:
liveserving configs are used somewhere in our search stack to provide results to the publicpreviewserving configs are for use by Search Admin users to test new configurations (for example, when adding new controls)systemserving configs are for internal programmatic use and cannot be modified through the Search Admin UI (for example, we have a "raw" serving config to test how the engine behaves without any controls)As we cannot currently create or delete serving configs through the Discovery Engine Ruby client, initial creation of three serving configs has been done in
govuk-infrastructure1 and we use a Rake task to create the model records on this end. Depending on whether these three are enough for the long term, we may or may not want to add the ability to create, edit, and delete serving configs to Search Admin in the future.Screenshots