Skip to content

Add semantic-highlighter system-generated processor documentation #11198

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 9, 2025
Merged

Add semantic-highlighter system-generated processor documentation #11198

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4aa1ccd
Add semantic-highlighter system-generated processor documentation
junqiu-lei Oct 9, 2025
12b6e4c
Update _search-plugins/search-pipelines/system-generated-search-proce…
kolchfa-aws Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions _search-plugins/search-pipelines/system-generated-search-processors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,16 @@ System-generated search processors are processors that OpenSearch creates automa

## Enabling system-generated search processors

To enable system-generated search processor creation, set the `cluster.search.enabled_system_generated_factories` cluster setting to `*` (all factories) or explicitly list the factories you want to enable. The following example enables `mmr_over_sample_factory` and `mmr_rerank_factory`:
To enable system-generated search processor creation, set the `cluster.search.enabled_system_generated_factories` cluster setting to `*` (all factories) or explicitly list the factories you want to enable. The following example enables `mmr_over_sample_factory`, `mmr_rerank_factory`, and `semantic-highlighter`:

```json
PUT _cluster/settings
{
"persistent": {
"cluster.search.enabled_system_generated_factories": [
"mmr_over_sample_factory",
"mmr_rerank_factory"
"mmr_rerank_factory",
"semantic-highlighter"
]
}
}
Expand Down Expand Up @@ -54,6 +55,7 @@ The following table lists the available system-generated search response process
| Processor name | Processor factory name | Execution stage | Trigger condition | Description |
| -------------- | ---------------------- | ------------------ | ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `mmr_rerank` | `mmr_rerank_factory` | Runs before any user-defined response processors. | Triggered when a search request includes the `mmr` parameter in the `ext` object. See [Vector search with MMR reranking]({{site.url}}{{site.baseurl}}/vector-search/specialized-operations/vector-search-mmr/). | Reranks the oversampled results using MMR and reduces them to the original query size. |
| `semantic-highlighter` | `semantic-highlighter` | Runs after any user-defined response processors. | Triggered when a search request contains `semantic` type highlight with `options.batch_inference` set to `true`. See [Using semantic highlighting]({{site.url}}{{site.baseurl}}/tutorials/vector-search/semantic-highlighting-tutorial/). | Performs batch inference processing for semantic highlighting. |

## Limitations

Expand Down