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.
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.
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
Add doc for neural-sparse-query-two-phase-processor. #7306
Add doc for neural-sparse-query-two-phase-processor. #7306
Changes from 4 commits
b188880
7a0df87
22d4739
d11c412
33a7c6e
e1fd8dd
074f340
61f74ee
d05dc86
d5f068b
7f4b04f
5fa2306
0442dd9
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@conggguan: Would there be a reason for someone not to create and enable a two-phase processor?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Going to remove this sentence for now.
Check failure on line 270 in _search-plugins/neural-sparse-search.md
GitHub Actions / style-job
Check warning on line 272 in _search-plugins/neural-sparse-search.md
GitHub Actions / style-job
Check failure on line 289 in _search-plugins/neural-sparse-search.md
GitHub Actions / style-job
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we give some example API calling like the section
## Setting a default model on an index or field
? Using all default values is also good, this would help users a lotThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should also mention that this processor is strongly recommended to set
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Gave a example API for set a default 2-phase pipeline.
Add a explanation for why we recommend this pipeline.
Check failure on line 13 in _search-plugins/search-pipelines/neural-sparse-query-two-phase-processor.md
GitHub Actions / style-job
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"max score * prune_ratio" => "maximum score multiplied by its
prune_ratio
"?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we want to use mathematical expressions, they need to be formatted as such. Otherwise, this looks like it should be something like "The second-phase document number equals the query size (default is 10) multiplied by its expansion rate."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not following the description. Please revise and tag me on the rewrite.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not following the end here. Do we mean something like "to the name of the pipeline for the index on which you want to use the two-phase pipeline"?
Check failure on line 85 in _search-plugins/search-pipelines/neural-sparse-query-two-phase-processor.md
GitHub Actions / style-job
Check failure on line 85 in _search-plugins/search-pipelines/neural-sparse-query-two-phase-processor.md
GitHub Actions / style-job
Check failure on line 108 in _search-plugins/search-pipelines/neural-sparse-query-two-phase-processor.md
GitHub Actions / style-job
Check failure on line 108 in _search-plugins/search-pipelines/neural-sparse-query-two-phase-processor.md
GitHub Actions / style-job
Check failure on line 132 in _search-plugins/search-pipelines/neural-sparse-query-two-phase-processor.md
GitHub Actions / style-job
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On an OpenSearch cluster set up on" => "For an OpenSearch cluster configured with"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be "On" or "Using" since the testing is done internally.